Commerce Webstore Wishlist

Get, update the name of, and delete a wishlist.

Resource

1/commerce/webstores/webstoreId/wishlists/wishlistId

Available version

49.0

Requires Chatter

HTTP methods

GET, PATCH, DELETE

PATCH is supported in version 50.0 and later.

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
`pageSize`	Integer	Specifies the number of items per page. Valid values are from 1 through 100. If you don’t specify a value, the default size is 25.	Optional	51.0
`productFields`	String	Comma-separated list of custom product fields. Fields aren’t case-sensitive. For example, `ProductCode` and `productcode` return the same results.	Optional	51.0
`sortItemsBy`	String	Sort order for wishlist items. Values are: `CreatedDateAsc`—Sorts by oldest creation date. `CreatedDateDesc`—Sorts by most recent creation date. The default sort order is `CreatedDateDesc`.	Optional	51.0

Response body for GET

Wishlist

Request body for PATCH

Root XML tag

<wishlistUpdateInput>

JSON example

1{
2"name":"My List"
3}

Properties

Name	Type	Description	Required or Optional	Available Version
`name`	String	Wishlist name to update.	Required	50.0

Request parameters for PATCH

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	50.0

Response body for PATCH

Wishlist Summary

Request parameters for DELETE

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	51.0

Response for DELETE

204: Successful Delete

Connect REST API Developer Guide