Docs
Management API
Wishlists
Wishlists Items

Wishlists Items

Delete Wishlist Item

DELETE /wishlists/{wishlist_id}/items/{item_id}

Request

Deletes a wishlist item.

Authentication

  • X-Auth-Token in header

Parameters

  • store_hash in path - string
  • wishlist_id in path - integer
    required
    ID of the Wishlist.
  • Accept in header with default of application/json - string
    required
    The MIME type of the response body.
  • item_id in path - integer
    required

example

curl --request DELETE \
--url 'https://api.bigcommerce.com/stores/[store_hash]/v3/wishlists/[wishlist_id]/items/[item_id]' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--header 'X-Auth-Token: {{token}}'

Response

Body

object | application/json

  • data    object

  • meta    object

    Response metadata.

example

{
"data": {
"id": 30,
"customer_id": 10,
"name": "Christmas List",
"is_public": true,
"token": "d2d55481-13eb-4d1e-9d79-9062b518570d",
"items": [
{
"id": 44,
"product_id": 77,
"variant_id": 1
},
{
"id": 45,
"product_id": 80,
"variant_id": 1
},
{
"id": 46,
"product_id": 81,
"variant_id": 1
},
{
"id": 47,
"product_id": 86,
"variant_id": 1
},
{
"id": 48,
"product_id": 88,

Add Wishlist Item

POST /wishlists/{wishlist_id}/items

Request

Adds a wishlist item. More than one item can be added at a time.

Authentication

  • X-Auth-Token in header

Parameters

  • store_hash in path - string
  • wishlist_id in path - integer
    required
    ID of the Wishlist.
  • Accept in header with default of application/json - string
    required
    The MIME type of the response body.
  • Content-Type in header with default of application/json - string
    required
    The MIME type of the request body.

Body

object | application/json

  • items    array[object]

example

{
"items": [
{
"product_id": 12,
"variant_id": 152
}
]
}

Response

Body

object | application/json

  • data    object

  • meta    object

    Response metadata.

example

{
"data": {
"id": 30,
"customer_id": 10,
"name": "Christmas List",
"is_public": true,
"token": "d2d55481-13eb-4d1e-9d79-9062b518570d",
"items": [
{
"id": 44,
"product_id": 77,
"variant_id": 1
},
{
"id": 45,
"product_id": 80,
"variant_id": 1
},
{
"id": 46,
"product_id": 81,
"variant_id": 1
},
{
"id": 47,
"product_id": 86,
"variant_id": 1
},
{
"id": 48,
"product_id": 88,
Did you find what you were looking for?
Delete a WishlistDelete Wishlist Item