Support

filterOrders

View as Markdown

Query `filterOrders` on the order subgraph (Order).

query

Requires commerce.order:read.

Query filterOrders on the order subgraph (Order).

Required headers

HeaderRequiredDescription
x-store-idYesID of the store the operation targets. Omitting it returns HTTP 200 with a GraphQL error: extensions.code: "UNAUTHENTICATED".

Go to Authentication for credential setup.

Arguments

  • processedAtStart DateTime optional
  • processedAtEnd DateTime optional
  • updatedAtStart DateTime optional
  • updatedAtEnd DateTime optional
  • number String optional
  • status [FilterOrdersStatus!] optional
  • paymentStatus [FilterOrdersPaymentStatus!] optional
  • fulfillmentMode [FilterOrdersFulfillmentMode!] optional
  • channelId [String!] optional
  • tags [String!] optional
  • sortBy FilterOrdersSortBy optional Default: "processedAt".
  • sortOrder SortOrder optional Default: "ASC".
  • email [String!] optional
  • name String optional
  • staffUserIds [String!] optional
  • externalIdType String optional — ExternalId Type. Must be used along with externalIdValue
  • externalIdValue String optional — ExternalId Value. Must be used along with externalIdType
  • customerId String optional
  • excludeTags [String!] optional Default: ["standalone-transaction"]. — Tags to exclude from the search.
  • before ID optional — Look for entries before that cursor
  • after ID optional — Look for entries after that cursor
  • first Int optional — Look for the first entries (paginate forward)
  • last Int optional — Look for the last entries (paginate backward)

Possible returns

  • QueryFilterOrdersConnection QueryFilterOrdersConnection

Last updated on

How is this guide?