Wishlist
Get All Wishlists
GET https://api.bigcommerce.com/stores/{store_hash}/v3/wishlistsRequest
Returns a list of wishlists. Optional filter parameters can be passed in.
Authentication
- X-Auth-Token in headerrequired
Parameters
- store_hash in path - string
example
Response
Body
object | application/json
dataarray[object]
example
Create a Wishlist
POST https://api.bigcommerce.com/stores/{store_hash}/v3/wishlistsRequest
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
Body
object | application/json
customer_idinteger
requiredThe customer id.
Example: 12is_publicboolean
Whether the wishlist is available to the public.
namestring
The title of the wishlist.
Example: School Shoppingitemsarray[object]
Array of wishlist items.
example
Response
Body
object | application/json
dataobject
example
Get a Wishlist
GET https://api.bigcommerce.com/stores/{store_hash}/v3/wishlists/{wishlist_id}Request
Returns a single wishlist.
Authentication
- X-Auth-Token in headerrequired
Parameters
- store_hash in path - string
example
Response
Body
object | application/json
dataobject
example
Update a Wishlist
PUT https://api.bigcommerce.com/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
Body
object | application/json
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
object | application/json
dataobject
example
Did you find what you were looking for?