BigCommerce Docs

Get all shopping lists. Equivalent Storefront GraphQL API Query: shoppingLists. For more information, see the GraphQL Playground.

Get all shopping lists. Equivalent Storefront GraphQL API Query: `shoppingLists`. For more information, see the [GraphQL Playground](https://api-b2b.bigcommerce.com/graphql/playground).

Authentication

AuthorizationBearer

Authentication header

Header	Argument	Description
`Authorization`	`Bearer {{B2B_JWT_TOKEN}}`	You can obtain this token using the steps described in the REST Storefront API section[…]

Query parameters

offsetstringOptionalDefaults to 0

Pagination offset

limitstringOptionalDefaults to 20

Pagination limit

isShowAllstringOptionalDefaults to 1

If show all

orderBystringOptionalDefaults to -created_at

Order by

Response

codedouble

messagestring>=1 character

dataobject

1	{
2	"code": 200,
3	"message": "SUCCESS",
4	"data": {
5	"list": [
6	{
7	"id": 441,
8	"name": "shopping list name",
9	"status": 0,
10	"description": "Shopping list desc",
11	"updatedAt": 1622601337,
12	"createdAt": 1622601337,
13	"totalCount": 0,
14	"customerInfo": {
15	"firstName": "Jo",
16	"lastName": "Sweet",
17	"userId": 7831,
18	"email": "example@example.com"
19	}
20	}
21	],
22	"pagination": {
23	"totalCount": 1,
24	"offset": 0,
25	"limit": 20
26	}
27	}
28	}

1	{
2	"code": 200,
3	"message": "SUCCESS",
4	"data": {
5	"list": [
6	{
7	"id": 441,
8	"name": "shopping list name",
9	"status": 0,
10	"description": "Shopping list desc",
11	"updatedAt": 1622601337,
12	"createdAt": 1622601337,
13	"totalCount": 0,
14	"customerInfo": {
15	"firstName": "Jo",
16	"lastName": "Sweet",
17	"userId": 7831,
18	"email": "example@example.com"
19	}
20	}
21	],
22	"pagination": {
23	"totalCount": 1,
24	"offset": 0,
25	"limit": 20
26	}
27	}
28	}

List Shopping Lists

List Shopping Lists

Authentication

Authentication header

Query parameters

Response

Authentication

Authentication header

Query parameters

Response

$	curl https://api-b2b.bigcommerce.com/api/v2/shoppinglists \
>	-H "Authorization: Bearer <token>"