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.
Dev Portal
DocsAPI ReferenceLearnCommunityChangelog
DocsAPI ReferenceLearnCommunityChangelog
    • About Our APIs
  • REST
    • Overview
  • GraphQL
    • Overview
      • Playground
          • QUERYcompanyRoles
          • QUERYcompanyRole
          • QUERYcompanyPermissions
          • QUERYaccountSettings
          • QUERYcustomerAccountSettings
          • QUERYinvoices
          • QUERYinvoice
          • QUERYinvoiceStats
          • QUERYinvoiceCustomerInformation
          • QUERYinvoicePaymentModules
          • QUERYinvoiceBcOrderAllowMethods
          • QUERYinvoicePaymentBcCart
          • QUERYinvoicePaymentFees
          • QUERYreceipts
          • QUERYreceipt
          • QUERYallReceiptLines
          • QUERYreceiptLine
          • QUERYreceiptLines
          • QUERYorder
          • QUERYallOrders
          • QUERYorderProducts
          • QUERYorderedProducts
          • QUERYcustomerOrders
          • QUERYcustomerOrder
          • QUERYcreatedByUser
          • QUERYshoppingLists
          • QUERYshoppingList
          • QUERYshoppingListsIdName
          • QUERYcustomerShoppingLists
          • QUERYcustomerShoppingList
          • QUERYcustomerShoppingListsIdName
          • QUERYcompanyExtraFields
          • QUERYuserCompany
          • QUERYcompanyValidateEmail
          • QUERYcompanyUserInfo
          • QUERYaccountFormFields
          • QUERYcompanyCreditConfig
          • QUERYcompanyPaymentTerms
          • QUERYcompanySubsidiaries
          • QUERYsuperAdminCompanies
          • QUERYsuperAdminMasquerading
          • QUERYquotes
          • QUERYcustomerQuotes
          • QUERYquote
          • QUERYquoteUserStoreInfo
          • QUERYquoteConfig
          • QUERYquoteExtraFieldsConfig
          • QUERYusers
          • QUERYuser
          • QUERYuserEmailCheck
          • QUERYcustomerEmailCheck
          • QUERYuserExtraFields
          • QUERYcurrentUser
          • QUERYcustomerInfo
          • QUERYuserLoginState
          • QUERYuserMasqueradingCompany
          • QUERYorderStatuses
          • QUERYbcOrderStatuses
          • QUERYcurrencies
          • QUERYautoLoader
          • QUERYstoreLimitations
          • QUERYstoreBasicInfo
          • QUERYstorefrontScript
          • QUERYstorefrontDefaultLanguage
          • QUERYstorefrontProductSettings
          • QUERYstorefrontSettings
          • QUERYstoreConfigSwitchStatus
          • QUERYstoreCheckoutConfig
          • QUERYstorefrontConfig
          • QUERYstorefrontConfigs
          • QUERYproductVariantsInfo
          • QUERYvariantSku
          • QUERYproductsInventory
          • QUERYproductsLoad
          • QUERYproductsSearch
          • QUERYtaxZoneRates
          • QUERYproductPurchasable
          • QUERYvalidateProduct
          • QUERYvalidateProducts
          • QUERYpriceProducts
          • QUERYaddresses
          • QUERYaddress
          • QUERYcountries
          • QUERYdefaultShippingAddress
          • QUERYdefaultBillingAddress
          • QUERYcustomerAddresses
          • QUERYcustomerAddress
          • QUERYaddressConfig
          • QUERYaddressExtraFields
  • MCP
    • Overview
Dev Portal
LogoLogo
GraphQLB2BQueries

orderedProducts

Example Query
1query ExampleQuery($channelId: Int, $offset: Int, $before: String, $after: String, $first: Int, $last: Int, $q: String, $productId: Decimal, $beginDateAt: Date, $endDateAt: Date, $minOrderedTimes: Decimal, $maxOrderedTimes: Decimal, $orderBy: String) {
2 orderedProducts(channelId: $channelId, offset: $offset, before: $before, after: $after, first: $first, last: $last, q: $q, productId: $productId, beginDateAt: $beginDateAt, endDateAt: $endDateAt, minOrderedTimes: $minOrderedTimes, maxOrderedTimes: $maxOrderedTimes, orderBy: $orderBy) {
3 pageInfo {
4 hasNextPage
5 hasPreviousPage
6 startCursor
7 endCursor
8 }
9 edges {
10 node
11 cursor
12 }
13 totalCount
14 }
15}
Variables
1{
2 "channelId": 0,
3 "offset": 0,
4 "before": "example",
5 "after": "example",
6 "first": 0,
7 "last": 0,
8 "q": "example",
9 "productId": "Decimal",
10 "beginDateAt": "Date",
11 "endDateAt": "Date",
12 "minOrderedTimes": "Decimal",
13 "maxOrderedTimes": "Decimal",
14 "orderBy": "example"
15}
Example response
1{
2 "data": {
3 "orderedProducts": {
4 "pageInfo": {
5 "hasNextPage": true,
6 "hasPreviousPage": true,
7 "startCursor": "example",
8 "endCursor": "example"
9 },
10 "edges": [
11 {
12 "node": {
13 "id": null,
14 "createdAt": null,
15 "updatedAt": null,
16 "productName": null,
17 "productBrandName": null,
18 "variantSku": null,
19 "productId": null,
20 "variantId": null,
21 "optionList": null,
22 "orderedTimes": null
23 },
24 "cursor": "example"
25 }
26 ],
27 "totalCount": 0
28 }
29 }
30}
Get an ordered list of the products. Requires a B2B or BC Token.
Was this page helpful?
Previous

orderProducts

Next

customerOrders

Built with

Arguments

channelIdIntegerOptional
Filter by BC channel id. Supported in MSF stores
offsetIntegerOptional
beforeStringOptional
afterStringOptional
firstIntegerOptional
lastIntegerOptional
qStringOptional
productIdDecimalOptional
beginDateAtDateOptional
endDateAtDateOptional
minOrderedTimesDecimalOptional
maxOrderedTimesDecimalOptional
orderByStringOptional
Ordering

Returns

an optional OrderedProductTypeCountableConnection
pageInfoPageInfo
Pagination data for this connection.
edgeslist of OrderedProductTypeCountableEdges
totalCountInteger
A total count of items in the collection.