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

orderProducts

Example Query

1 query ExampleQuery($bcOrderId: Int) {
2   orderProducts(bcOrderId: $bcOrderId) {
3     notes
4     quantity
5     productId
6     variantId
7     optionList
8   }
9 }

Variables

1 {
2   "bcOrderId": 0
3 }

Example response

1 {
2   "data": {
3     "orderProducts": [
4       {
5         "notes": "example",
6         "quantity": "example",
7         "productId": "example",
8         "variantId": "example",
9         "optionList": "GenericScalar"
10       }
11     ]
12   }
13 }

Get a list of the products in an order. Requires a B2B Token.

Was this page helpful?

allOrders

orderedProducts

Arguments

bcOrderIdIntegerRequired

The BC order id. This field is required.

Returns

an optional list of optional OrderProductType

notesString

Product notes

quantityString

Product quantity in this order

productIdString

Unique order product ID

variantIdString

Unique variant ID

optionListGenericScalar

Product option list