Shopping
Get Shopping Lists
GET https://api-b2b.bigcommerce.com/api/v2/shoppinglistsRequest
Get all shopping lists.
Equivalent Storefront GraphQL API Query: shoppingLists
. For more information, see the GraphQL Playground.
Authentication
- Authorization in header in the format of Bearer {{token}}
Parameters
- offset in query with default of 0 - stringPagination offset
- limit in query with default of 20 - stringPagination limit
- isShowAll in query with default of 1 - stringIf show all
- orderBy in query with default of -created_at - stringOrder by
example
Response
Body
codenumber
requireddataobject
required
example-1
Create Shopping List
POST https://api-b2b.bigcommerce.com/api/v2/shoppinglistsRequest
Create a shopping list.
Equivalent Storefront GraphQL API Mutation: shoppingListsCreate
. For more information, see the GraphQL Playground.
Authentication
- Authorization in header in the format of Bearer {{token}}
Body
namestring
required>= 1 charactersdescriptionstring
required>= 1 charactersstatusstring
required0: Approved 20: Deleted 30: Draft 40: Ready for approval
Allowed: 0 | 20 | 30 | 40
>= 1 characters
Response
Body
codenumber
requireddataobject
required
example-1
Update Shopping List
PUT https://api-b2b.bigcommerce.com/api/v2/shoppinglistsRequest
Update a shopping list.
Equivalent Storefront GraphQL API Mutation: shoppingListsUpdate
. For more information, see the GraphQL Playground.
Authentication
- Authorization in header in the format of Bearer {{token}}
Body
namestring
requiredShopping list name>= 1 charactersdescriptionstring
requiredDescription of this shopping list>= 1 charactersstatusnumber
required0: Approved 20: Deleted 30: Draft 40: Ready for approval
idstring
requiredShopping list’s ID>= 1 characters
example
Response
Body
codenumber
requireddataobject
required
example-1
Get Shopping List ID and Name
GET https://api-b2b.bigcommerce.com/api/v2/shoppinglists/listsRequest
This endpoint is deprecated.
Get all the shopping lists that contains both ID and name.
Authentication
- Authorization in header in the format of Bearer {{token}}
Parameters
- status in query - string0:Approved 20:Deleted 30:Draft 40:Ready for approval
example
Response
Body
codenumber
requireddataobject
required
example-1
Add shopping List Items
POST https://api-b2b.bigcommerce.com/api/v2/shoppinglists/itemsRequest
Add items to an existed shopping list.
Equivalent Storefront GraphQL API Mutation: shoppingListsItemsCreate
. For more information, see the GraphQL Playground.
Authentication
- Authorization in header in the format of Bearer {{token}}
Body
idstring
requiredShopping list ID>= 1 charactersitemsarray[object]
required
example-1
Response
Body
codenumber
requireddataobject
required
example-1
Update Shopping List Items
PUT https://api-b2b.bigcommerce.com/api/v2/shoppinglists/itemsRequest
Update shopping lists items.
Equivalent Storefront GraphQL API Mutation: shoppingListsItemsUpdate
. For more information, see the GraphQL Playground.
Authentication
- Authorization in header in the format of Bearer {{token}}
Body
shoppinglistIdstring
requiredShopping list ID field>= 1 charactersitemIdstring
requiredShopping list item ID field>= 1 charactersqtystring
requiredQuantity of product in shopping list>= 1 charactersoptionListarray[object]
requiredProduct option of shopping list itemvariantIdstring
requiredProduct SKU ID>= 1 characterssortOrderinteger
The sort order for item
example
Response
Body
codenumber
requireddataobject
required
example-1
Get Shopping List Items Extension
GET https://api-b2b.bigcommerce.com/api/v2/shoppinglists/items-extensionRequest
Get a shopping list detail information.
Equivalent Storefront GraphQL API Query: shoppingList
. For more information, see the GraphQL Playground.
Authentication
- Authorization in header in the format of Bearer {{token}}
Parameters
- id in query - stringShopping list ID
- offset in query with default of 0 - stringPagination offset
- limit in query with default of 100 - stringPagination limit
- sortBy in query - stringthe field to sort byExample: sort_order
Allowed: product_name | quantity | product_sku | updated_at | created_at | sort_order
example
Response
Body
codenumber
requireddataobject
required
example-1
Delete Shopping List Item
DELETE https://api-b2b.bigcommerce.com/api/v2/shoppinglists/{shoppingListId}/items/{itemId}Request
Delete shopping list item using shoppingListId and itemId.
Equivalent Storefront GraphQL API Mutation: shoppingListsItemsDelete
. For more information, see the GraphQL Playground.
Authentication
- Authorization in header in the format of Bearer {{token}}
Parameters
- shoppingListId in path - stringrequiredShopping list ID
- itemId in path - stringrequiredItem id
example
Response
Body
codenumber
requireddataobject
required
example-1
Delete Shopping List
DELETE https://api-b2b.bigcommerce.com/api/v2/shoppinglists/{shoppingListId}Request
Delete a shopping list.
Equivalent Storefront GraphQL API Mutation: shoppingListsDelete
. For more information, see the GraphQL Playground.
Authentication
- Authorization in header in the format of Bearer {{token}}
Parameters
- shoppingListId in path - stringrequiredShopping list ID
example
Response
Body
codenumber
requireddataobject
required
example-1
Duplicate a Shopping List
POST https://api-b2b.bigcommerce.com/api/v2/shoppinglists/duplicateRequest
Duplicate a shopping list.
Equivalent Storefront GraphQL API Mutation: shoppingListsDuplicate
. For more information, see the GraphQL Playground.
Authentication
- Authorization in header in the format of Bearer {{token}}
Body
sampleShoppingListIdnumber
requirednamestring
required>= 1 charactersdescriptionstring
required>= 1 characters
Response
Body
codenumber
requireddataobject
required