Wishlist
Get All Wishlists
GET /stores/{store_hash}/v3/wishlists
Request
Returns a list of wishlists. Optional filter parameters can be passed in.
Authentication
- X-Auth-Token in headerrequired
Parameters
- store_hash in path - string
- customer_id in query - integer
All wishlists relating to the customer.
- page in query with default of 1 - integer
The page number of results to return. 1 is the default and starts from record 0. Use in conjunction with the limit query parameter to request a specific set of records.
- limit in query with default of 50 - integer
The number of items to return per page. Default is 50 and maximum is 250.
- Accept in header with default of application/json - stringrequired
The MIME type of the response body.
example
Response
Body
dataarray[object]
metaobject
example
Create a Wishlist
POST /stores/{store_hash}/v3/wishlists
Request
Creates a wishlist and wishlist item. More than one item can be added in the POST.
Required Fields
- name
- customer_id
Authentication
- X-Auth-Token in headerrequired
Parameters
- store_hash in path - string
- Accept in header with default of application/json - stringrequired
The MIME type of the response body.
- Content-Type in header with default of application/json - stringrequired
The MIME type of the request body.
Body
customer_idinteger
requiredThe customer id.
Example: 12
is_publicboolean
Whether the wishlist is available to the public.
namestring
The title of the wishlist.
Example: School Shopping
itemsarray[object]
Array of wishlist items.
example
Response
Body
dataobject
metaobject
Response metadata.
example
Get a Wishlist
GET /stores/{store_hash}/v3/wishlists/{wishlist_id}
Request
Returns a single wishlist.
Authentication
- X-Auth-Token in headerrequired
Parameters
- store_hash in path - string
- wishlist_id in path - integerrequired
ID of the Wishlist.
- Accept in header with default of application/json - stringrequired
The MIME type of the response body.
example
Response
Body
dataobject
metaobject
Response metadata.
example
Update a Wishlist
PUT /stores/{store_hash}/v3/wishlists/{wishlist_id}
Request
Updates a wishlist.
Use this endpoint to update existing wishlist items, change the wishlistʼs name and whether the wishlist is available publicly. To add or delete a wishlist item, see Wishlist Items.
Authentication
- X-Auth-Token in headerrequired
Parameters
- store_hash in path - string
- Content-Type in header with default of application/json - stringrequired
The MIME type of the request body.
Body
customer_idinteger
requiredThe customer ID. A read-only value.
is_publicboolean
Whether the wishlist is available to the public.
namestring
The title of the wishlist.
itemsarray[object]
requiredArray of wishlist items.
example
Response
Body
dataobject
metaobject
Response metadata.
example
Delete a Wishlist
DELETE /stores/{store_hash}/v3/wishlists/{wishlist_id}
Request
Deletes a wishlist.
Authentication
- X-Auth-Token in headerrequired
Parameters
- store_hash in path - string
- wishlist_id in path - integerrequired
ID of the Wishlist.
- Accept in header with default of application/json - stringrequired
The MIME type of the response body.