For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.

Docs API Reference Learn Community Changelog

Docs API Reference Learn Community Changelog

- About Our APIs
REST
GraphQL
MCP
- Overview

GraphQL B2B Queries

shoppingList

Example Query

1 query ExampleQuery($id: Int) {
2   shoppingList(id: $id) {
3     id
4     createdAt
5     updatedAt
6     name
7     description
8     reason
9     status
10     approvedFlag
11     customerInfo {
12       firstName
13       lastName
14       userId
15       email
16       role
17     }
18     isOwner
19   }
20 }

Variables

1 {
2   "id": 0
3 }

Example response

1 {
2   "data": {
3     "shoppingList": {
4       "id": "example",
5       "createdAt": 0,
6       "updatedAt": 0,
7       "name": "example",
8       "description": "example",
9       "reason": "example",
10       "status": 0,
11       "approvedFlag": true,
12       "customerInfo": {
13         "firstName": "example",
14         "lastName": "example",
15         "userId": 0,
16         "email": "example",
17         "role": "example"
18       },
19       "isOwner": true
20     }
21   }
22 }

Get a shopping list by id. Requires a B2B Token.

Was this page helpful?

shoppingLists

shoppingListsIdName

Arguments

idIntegerRequired

Shopping list id. This field is required.

Returns

an optional ShoppingListType

idString

createdAtInteger

The created timestamp of the shopping list

updatedAtInteger

The updated timestamp of the shopping list

nameString

Shopping list name

descriptionString

Shopping list description

reasonString

Shopping list reason

statusInteger

Shopping list status. 0: Approved 20: Deleted 30: Draft 40: Ready for approval 50:Rejected

approvedFlagBoolean

Has the shopping list been submitted for approval

customerInfoCustomerInfo

Shopping list customer information

isOwnerBoolean

If owner of shopping list

grandTotalString

grand total amount of shopping list

totalDiscountString

Total discount of shopping list

totalTaxString

Total tax of shopping list

isShowGrandTotalBoolean

If show grand total amount of shopping list

productsShoppingListItemCountableConnection

products of shopping list

channelIdInteger

The channel id of the shopping list

channelNameString

The channel name of the shopping list

companyInfoCompanyInfoType

Company information of shopping list