filterOrders
View as MarkdownQuery `filterOrders` on the order subgraph (Order).
query
Requires commerce.order:read.
Query filterOrders on the order subgraph (Order).
Required headers
| Header | Required | Description |
|---|---|---|
x-store-id | Yes | ID 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
processedAtStartDateTimeoptionalprocessedAtEndDateTimeoptionalupdatedAtStartDateTimeoptionalupdatedAtEndDateTimeoptionalnumberStringoptionalstatus[FilterOrdersStatus!]optionalpaymentStatus[FilterOrdersPaymentStatus!]optional
fulfillmentMode[FilterOrdersFulfillmentMode!]optionalchannelId[String!]optionaltags[String!]optionalsortByFilterOrdersSortByoptional Default:"processedAt".sortOrderSortOrderoptional Default:"ASC".email[String!]optionalnameStringoptionalstaffUserIds[String!]optionalexternalIdTypeStringoptional — ExternalId Type. Must be used along with externalIdValueexternalIdValueStringoptional — ExternalId Value. Must be used along with externalIdTypecustomerIdStringoptionalexcludeTags[String!]optional Default:["standalone-transaction"]. — Tags to exclude from the search.beforeIDoptional — Look for entries before that cursorafterIDoptional — Look for entries after that cursorfirstIntoptional — Look for the first entries (paginate forward)lastIntoptional — Look for the last entries (paginate backward)
Possible returns
QueryFilterOrdersConnectionQueryFilterOrdersConnection
Last updated on
How is this guide?