List Shopping Lists | BigCommerce Developer Center

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.

Authentication

X-Auth-Tokenstring

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.

### 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](/developer/docs/overview/api-fundamentals/api-accounts). | ### Further reading 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

Authentication header

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

### Authentication header | 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

1	import requests
2
3	url = "https://api-b2b.bigcommerce.com/api/v3/io/shopping-list"
4
5	querystring = {"userId":"1","customerId":"1"}
6
7	headers = {"X-Auth-Token": "<apiKey>"}
8
9	response = requests.get(url, headers=headers, params=querystring)
10
11	print(response.json())

1	{
2	"code": 200,
3	"meta": {
4	"message": "SUCCESS",
5	"pagination": {
6	"limit": 10,
7	"offset": 0,
8	"totalCount": 1
9	}
10	},
11	"data": [
12	{
13	"status": 0,
14	"id": 1,
15	"name": "my first shopping list",
16	"description": "this is my first shopping list",
17	"companyId": 1,
18	"userId": 12,
19	"createdAt": 1631495936,
20	"updatedAt": 1631495936,
21	"channelId": 1,
22	"channelName": "string"
23	}
24	]
25	}