Get Shopping List

GET

https://api-b2b.bigcommerce.com/api/v3/io/shopping-list/:shoppingListId

GET

/api/v3/io/shopping-list/:shoppingListId

curl -G https://api-b2b.bigcommerce.com/api/v3/io/shopping-list/1 \
     -H "X-Auth-Token: <apiKey>" \
     -d orderBy=DESC \
     -d sortBy=sortOrder

{
  "code": 200,
  "meta": {
    "message": "SUCCESS",
    "pagination": {
      "limit": 10,
      "offset": 0,
      "totalCount": 1
    }
  },
  "data": {
    "channelId": 1,
    "channelName": "string",
    "companyId": 1,
    "createdAt": 1631495936,
    "description": "this is my first shopping list",
    "id": 1,
    "items": [
      {
        "id": 1,
        "optionList": {
          "optionId": "string",
          "optionValue": "string"
        },
        "productId": 123,
        "productNote": "string",
        "quantity": 5,
        "sortOrder": 0,
        "variantId": 321
      }
    ],
    "name": "my first shopping list",
    "status": 0,
    "updatedAt": 1631495936,
    "userId": 12
  }
}

Get a shopping list detail information

Authentication

X-Auth-Tokenstring

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

For example requests and more information about authenticating BigCommerce APIs, see Authentication and Example Requests.

For more about BigCommerce OAuth scopes, see our Guide to API Accounts.

For a list of API status codes, see API Status Codes.

X-Store-Hashstring

Header	Argument	Description
`X-Store-Hash`	`store_hash`	The unique store hash associated with a BigCommerce store that has B2B Edition enabled.

Path parameters

shoppingListIdintegerRequired

The unique ID for a shopping list.

Query parameters

userIdintegerOptional

B2B Edition buyer user ID, you can enter a user ID to check if this user can view this shopping list.

sortByenumOptional

the field to sort by

Allowed values:

orderByenumOptional

desc or asc for sort by

Allowed values:

customerIdintegerOptional

BigCommerce customer ID, passing this parameter will obtain the shopping list according to the b2c user.

offsetintegerOptional>=0Defaults to 0

Pagination offset for shopping list items

limitintegerOptional1-250Defaults to 250

Pagination limit for shopping list items

Response

codeintegerOptional

Response code of success request.

metaobjectOptional

dataobjectOptional

Response data

Errors

404

Not Found Error