Skip to main content
View Markdown

OrderFilterInput Input Type

No description

input OrderFilterInput {
  paymentStatus: [PaymentChargeStatusEnum!] @deprecated
  status: [OrderStatusFilter!]
  customer: String
  created: DateRangeInput
  search: String
  metadata: [MetadataFilter!]
  channels: [ID!]
  authorizeStatus: [OrderAuthorizeStatusEnum!]
  chargeStatus: [OrderChargeStatusEnum!]
  updatedAt: DateTimeRangeInput
  isClickAndCollect: Boolean
  isPreorder: Boolean @deprecated
  ids: [ID!]
  checkoutTokens: [UUID!]
  giftCardUsed: Boolean
  giftCardBought: Boolean
  numbers: [String!]
  checkoutIds: [ID!]
}

Fields​

status ● [OrderStatusFilter!]​

customer ● String​

created ● DateRangeInput​

metadata ● [MetadataFilter!]​

channels ● [ID!]​

authorizeStatus ● [OrderAuthorizeStatusEnum!]​

chargeStatus ● [OrderChargeStatusEnum!]​

updatedAt ● DateTimeRangeInput​

isClickAndCollect ● Boolean​

ids ● [ID!]​

checkoutTokens ● [UUID!]​

giftCardUsed ● Boolean​

giftCardBought ● Boolean​

numbers ● [String!]​

checkoutIds ● [ID!]​

Show deprecatedHide deprecated

paymentStatus ● [PaymentChargeStatusEnum!]​

DEPRECATED

The legacy Payments API is deprecated and will be removed. Use the Transactions API instead.

Filter orders by payment charge status.

isPreorder ● Boolean​

DEPRECATED

Preorder is deprecated and will be removed. Model pre-sales with regular stock instead: create the planned quantity in a warehouse, or set trackInventory to false to sell without a stock limit.

Filter by orders containing a variant that is currently in preorder.

Member Of​

orders query