List Wishlists

GET

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

GET

/stores/:store_hash/v3/wishlists

curl https://api.bigcommerce.com/stores/store_hash/v3/wishlists \
     -H "Accept: application/json" \
     -H "X-Auth-Token: <apiKey>"

{
  "data": [
    {
      "id": 1,
      "customer_id": 4,
      "name": "My Wish List",
      "is_public": false,
      "token": "02d55481-13eb-4d1e-9d79-9062b518570d",
      "items": []
    },
    {
      "id": 2,
      "customer_id": 11,
      "name": "Christmas",
      "is_public": false,
      "token": "02d55481-13eb-4d1e-9d79-9062b518570d",
      "items": [
        {
          "id": 1,
          "product_id": 167
        },
        {
          "id": 2,
          "product_id": 174
        },
        {
          "id": 3,
          "product_id": 184
        }
      ]
    },
    {
      "id": 3,
      "customer_id": 20,
      "name": "Birthday",
      "is_public": false,
      "token": "02d55481-13eb-4d1e-9d79-9062b518570d",
      "items": [
        {
          "id": 4,
          "product_id": 184
        },
        {
          "id": 5,
          "product_id": 183
        }
      ]
    },
    {
      "id": 4,
      "customer_id": 20,
      "name": "Christmas",
      "is_public": false,
      "token": "02d55481-13eb-4d1e-9d79-9062b518570d",
      "items": [
        {
          "id": 6,
          "product_id": 201
        }
      ]
    },
    {
      "id": 5,
      "customer_id": 19,
      "name": "Wish List",
      "is_public": false,
      "token": "02d55481-13eb-4d1e-9d79-9062b518570d",
      "items": [
        {
          "id": 7,
          "product_id": 173
        },
        {
          "id": 8,
          "product_id": 176
        }
      ]
    }
  ],
  "meta": {
    "pagination": {
      "total": 0,
      "count": 5,
      "per_page": 50,
      "current_page": 1,
      "total_pages": 0
    }
  }
}

Returns a list of wishlists. Optional filter parameters can be passed in.

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.

Query parameters

customer_idintegerOptional

All wishlists relating to the customer.

pageintegerOptionalDefaults to 1

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.

limitintegerOptional<=250Defaults to 50

The number of items to return per page. Default is 50 and maximum is 250.

Response

datalist of objectsOptional

metaobjectOptional

Errors

401

Unauthorized Error

500

Internal Server Error