Commerce Webstore Wishlists

Get wishlists and create a wishlist.

Resource

1/commerce/webstores/webstoreId/wishlists

Available version

49.0

Requires Chatter

HTTP methods

GET, POST

Request parameters for GET

Parameter Name	Type	Description	Required or Optional	Available Version
`effectiveAccountId`	String	ID of the account for which the request is made. If unspecified, defaults to the account ID for the context user.	Optional	49.0
`includeDisplayedList`	Boolean	Specifies whether to include the displayed list (`true`) or not (`false`). If unspecified, defaults to `false`.	Optional	49.0
`wishlistId`	String	ID of the wishlist. If unspecified, all the wishlist summaries are returned.	Optional	49.0

Response body for GET

Wishlist Summaries

Request body for POST

Root XML tag

<wishlistInput>

JSON example

1{
2"name":"My List",
3"products": [
4   {
5   "productId": "01tRM000000Osl0YAC"
6   },
7   {
8   "productId": "01tRM000000Oi92YAC"
9   },
10   {
11   "productId": "01tRM000000NJCeYAO"
12   }]
13}

Properties

Name	Type	Description	Required or Optional	Available Version
`name`	String	Name of the wishlist.	Required	49.0
`products`	Wishlist Item Input[]	List of products to add to the wishlist.	Optional	49.0

Request parameters for POST

Parameter Name	Type	Description	Required or Optional	Available Version
`effectiveAccountId`	String	ID of the account for which the request is made. If unspecified, defaults to the account ID for the context user.	Optional	49.0

Response body for POST

Wishlist

Connect REST API Developer Guide

Commerce Webstore Wishlists