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

allOrders

Example Query
1query ExampleQuery($companyIds: [Int], $offset: Int, $before: String, $after: String, $first: Int, $last: Int, $q: String, $companyId: Decimal, $bcOrderId: Decimal, $poNumber: String, $extraInt1: Decimal, $extraInt2: Decimal, $extraInt3: Decimal, $extraInt4: Decimal, $extraInt5: Decimal, $extraStr1: String, $extraStr2: String, $extraStr3: String, $extraStr4: String, $extraStr5: String, $beginDateAt: Date, $endDateAt: Date, $companyName: String, $search: String, $status: String, $email: String, $orderBy: String, $extraStr1_In: String, $isShowMy: String, $createdBy: String) {
2 allOrders(companyIds: $companyIds, offset: $offset, before: $before, after: $after, first: $first, last: $last, q: $q, companyId: $companyId, bcOrderId: $bcOrderId, poNumber: $poNumber, extraInt1: $extraInt1, extraInt2: $extraInt2, extraInt3: $extraInt3, extraInt4: $extraInt4, extraInt5: $extraInt5, extraStr1: $extraStr1, extraStr2: $extraStr2, extraStr3: $extraStr3, extraStr4: $extraStr4, extraStr5: $extraStr5, beginDateAt: $beginDateAt, endDateAt: $endDateAt, companyName: $companyName, search: $search, status: $status, email: $email, orderBy: $orderBy, extraStr1_In: $extraStr1_In, isShowMy: $isShowMy, createdBy: $createdBy) {
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 "companyIds": [],
3 "offset": 0,
4 "before": "example",
5 "after": "example",
6 "first": 0,
7 "last": 0,
8 "q": "example",
9 "companyId": "Decimal",
10 "bcOrderId": "Decimal",
11 "poNumber": "example",
12 "extraInt1": "Decimal",
13 "extraInt2": "Decimal",
14 "extraInt3": "Decimal",
15 "extraInt4": "Decimal",
16 "extraInt5": "Decimal",
17 "extraStr1": "example",
18 "extraStr2": "example",
19 "extraStr3": "example",
20 "extraStr4": "example",
21 "extraStr5": "example",
22 "beginDateAt": "Date",
23 "endDateAt": "Date",
24 "companyName": "example",
25 "search": "example",
26 "status": "example",
27 "email": "example",
28 "orderBy": "example",
29 "extraStr1_In": "example",
30 "isShowMy": "example",
31 "createdBy": "example"
32}
Example response
1{
2 "data": {
3 "allOrders": {
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 "bcOrderId": null,
17 "bcCustomerId": null,
18 "companyId": null,
19 "totalIncTax": null,
20 "currencyCode": null,
21 "usdIncTax": null,
22 "money": null
23 },
24 "cursor": "example"
25 }
26 ],
27 "totalCount": 0
28 }
29 }
30}
Get orders. Requires a B2B Token.
Was this page helpful?
Previous

order

Next

orderProducts

Built with

Arguments

companyIdslist of optional IntegersOptional
Filter by one or more company IDs.
offsetIntegerOptional
beforeStringOptional
afterStringOptional
firstIntegerOptional
lastIntegerOptional
qStringOptional
companyIdDecimalOptional
bcOrderIdDecimalOptional
poNumberStringOptional
extraInt1DecimalOptional
extraInt2DecimalOptional
extraInt3DecimalOptional
extraInt4DecimalOptional
extraInt5DecimalOptional
extraStr1StringOptional
extraStr2StringOptional
extraStr3StringOptional
extraStr4StringOptional
extraStr5StringOptional
beginDateAtDateOptional
endDateAtDateOptional
companyNameStringOptional
searchStringOptional
statusStringOptional
emailStringOptional
orderByStringOptional
Ordering
extraStr1_InStringOptional
isShowMyStringOptional
createdByStringOptional

Returns

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