List Shopping Lists

GET

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

GET

/api/v3/io/shopping-list

$ curl -G https://api-b2b.bigcommerce.com/api/v3/io/shopping-list \
>      -H "X-Auth-Token: <apiKey>" \
>      -H "Content-Type: application/json" \
>      -d userId=1 \
>      -d customerId=1

1 {
2   "code": 200,
3   "meta": {
4     "message": "SUCCESS",
5     "pagination": {
6       "limit": 10,
7       "offset": 0,
8       "totalCount": 3
9     }
10   },
11   "data": [
12     {
13       "status": 0,
14       "id": 101,
15       "name": "Office Supplies Q2",
16       "description": "Quarter 2 office supplies restock",
17       "companyId": 45,
18       "userId": 12,
19       "createdAt": 1688006400,
20       "updatedAt": 1688592000,
21       "channelId": 2,
22       "channelName": "Main Storefront"
23     },
24     {
25       "status": 40,
26       "id": 102,
27       "name": "Marketing Event Materials",
28       "description": "Materials needed for upcoming marketing event",
29       "companyId": 45,
30       "userId": 15,
31       "createdAt": 1688082800,
32       "updatedAt": 1688169200,
33       "channelId": 2,
34       "channelName": "Main Storefront"
35     },
36     {
37       "status": 30,
38       "id": 103,
39       "name": "New Product Launch",
40       "description": "Supplies for new product launch campaign",
41       "companyId": 45,
42       "userId": 12,
43       "createdAt": 1687756800,
44       "updatedAt": 1687843200,
45       "channelId": 3,
46       "channelName": "Wholesale Channel"
47     }
48   ]
49 }

Get a list of shopping lists viewable based on user permissions of a buyer user ID. A junior buyer can see all of the lists they create and no one else's. A senior buyer or admin can see all of the companies approved or ready for approval lists. This would include lists sent by junior buyers.

List Shopping Lists

GET

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

GET

/api/v3/io/shopping-list

$ curl -G https://api-b2b.bigcommerce.com/api/v3/io/shopping-list \
>      -H "X-Auth-Token: <apiKey>" \
>      -H "Content-Type: application/json" \
>      -d userId=1 \
>      -d customerId=1

1 {
2   "code": 200,
3   "meta": {
4     "message": "SUCCESS",
5     "pagination": {
6       "limit": 10,
7       "offset": 0,
8       "totalCount": 3
9     }
10   },
11   "data": [
12     {
13       "status": 0,
14       "id": 101,
15       "name": "Office Supplies Q2",
16       "description": "Quarter 2 office supplies restock",
17       "companyId": 45,
18       "userId": 12,
19       "createdAt": 1688006400,
20       "updatedAt": 1688592000,
21       "channelId": 2,
22       "channelName": "Main Storefront"
23     },
24     {
25       "status": 40,
26       "id": 102,
27       "name": "Marketing Event Materials",
28       "description": "Materials needed for upcoming marketing event",
29       "companyId": 45,
30       "userId": 15,
31       "createdAt": 1688082800,
32       "updatedAt": 1688169200,
33       "channelId": 2,
34       "channelName": "Main Storefront"
35     },
36     {
37       "status": 30,
38       "id": 103,
39       "name": "New Product Launch",
40       "description": "Supplies for new product launch campaign",
41       "companyId": 45,
42       "userId": 12,
43       "createdAt": 1687756800,
44       "updatedAt": 1687843200,
45       "channelId": 3,
46       "channelName": "Wholesale Channel"
47     }
48   ]
49 }

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](/developer/docs/overview/api-fundamentals/api-accounts). | For example requests and more information about authenticating BigCommerce APIs, see [Authentication and Example Requests](/developer/docs/overview/api-fundamentals/api-accounts#x-auth-token-header-example-requests). For more about BigCommerce OAuth scopes, see our [Guide to API Accounts](/developer/docs/overview/api-fundamentals/api-accounts#oauth-scopes). For a list of API status codes, see [API Status Codes](/developer/api-reference/rest/overview#rest-http-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. |

Query parameters

userIdintegerRequired

B2B Edition buyer user ID (Either userId or customerId must be passed, but not both.)

limitintegerOptionalDefaults to 10

Pagination limit default: 10

offsetintegerOptional>=0

Pagination offset default: 0

channelIddoubleOptional

BigCommerce channel ID

customerIdintegerRequired

BigCommerce customer ID (Either userId or customerId must be passed, but not both.)

createdUserIdintegerOptional

B2B Edition buyer user ID, if the userId has permissions to view all shopping lists of the company, entering this parameter will filter out the shopping lists created by that user.

Response

codeinteger

Response code of success request.

metaobject

Used to response pagination information

datalist of objects

Errors

422

Unprocessable Entity Error