For AI agents: a documentation index is available at the root level at /llms.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Search docs
/
Ask AI
Dev Portal
Docs
API Reference
Learn
Community
Changelog
GraphQL
B2B
Queries
customerShoppingList
Copy page
Get a the shopping list by ID. Requires a BC Token.
Developer
Developer
Developer
Developer
Arguments
id
Integer
Required
Shopping list id. This field is required.
Returns
an optional CustomerShoppingListType
id
String
createdAt
Integer
The created timestamp of the shopping list
updatedAt
Integer
The updated timestamp of the shopping list
name
String
Shopping list name
description
String
Shopping list description
reason
String
Shopping list reason
grandTotal
String
grand total amount of shopping list
totalDiscount
String
Total discount of shopping list
totalTax
String
Total tax of shopping list
isShowGrandTotal
Boolean
If show grand total amount of shopping list
products
ShoppingListItemCountableConnection
products of shopping list (only active catalog products are returned)
channelId
Integer
The channel id of the shopping list
channelName
String
The channel name of the shopping list
