Create Wishlist

POST

https://api.bigcommerce.com/stores/:store_hash/v3/wishlists

POST

/stores/:store_hash/v3/wishlists

curl -X POST https://api.bigcommerce.com/stores/store_hash/v3/wishlists \
     -H "Accept: application/json" \
     -H "X-Auth-Token: <apiKey>" \
     -H "Content-Type: application/json" \
     -d '{
  "customer_id": 12
}'

{
  "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,
        "variant_id": 1
      }
    ]
  },
  "meta": {}
}

Creates a wishlist and wishlist item. More than one item can be added in the POST.

Required Fields

name
customer_id

Authentication

X-Auth-Tokenstring

OAuth scopes

UI Name	Permission	Parameter
Customers	modify	`store_v2_customers`
Customers	read-only	`store_v2_customers_read_only`

Authentication header

Header	Argument	Description
`X-Auth-Token`	`access_token`	For more about API accounts that generate `access_token`s, see our Guide to API Accounts.

Path parameters

store_hashstringRequired

Permanent ID of the BigCommerce store.

Request

This endpoint expects an object.

customer_idintegerRequired

The customer id.

is_publicbooleanOptional

Whether the wishlist is available to the public.

namestringOptional

The title of the wishlist.

itemslist of objectsOptional

Array of wishlist items.

Response

Created

dataobjectOptional

metaobjectOptional

Response metadata.

Errors

401

Unauthorized Error

500

Internal Server Error