OrdersExportInput

Parameters to filter an orders export.

input OrdersExportInput {
  b2bOrder: Boolean
  brandId: ID
  brandIds: [ID!] @deprecated
  carrierIds: [ID!]
  createdById: ID
  customerRefNumber: String
  endDate: ISO8601DateTime
  endShippingDateFrom: ISO8601DateTime
  endShippingDateTo: ISO8601DateTime
  fulfillmentMethods: [OrderFulfillmentMethodEnum!]
  includeArchived: Boolean
  integrationId: ID
  keyword: String
  level: OrdersExportLevelEnum
  orderType: OrderTypeEnum
  poNumber: String
  productIds: [ID!]
  responsibleId: ID
  salesChannelIds: [ID!]
  shipmentCreatedAtFrom: ISO8601DateTime
  shipmentCreatedAtTo: ISO8601DateTime
  shipmentShippedDateFrom: ISO8601DateTime
  shipmentShippedDateTo: ISO8601DateTime
  sourceIntegrationIds: [ID!]
  startDate: ISO8601DateTime
  startShippingDateFrom: ISO8601DateTime
  startShippingDateTo: ISO8601DateTime
  status: [OrderStatusEnum!]
  statusAlertSeverity: [OrderStatusAlertSeverityEnum!]
  tagNames: [String!]
  templateId: ID
}

Fields

`OrdersExportInput.b2bOrder` ● `Boolean` scalar common

Filter by special orders. If true, only special orders will be returned.

`OrdersExportInput.brandId` ● `ID` scalar common

Filter by order's brand. If omitted, exports all orders in the company.

`OrdersExportInput.brandIds` ● `[ID!]` deprecated list scalar common

DEPRECATED

This argument will be removed in the future. Brand is becoming a product-only attribute. Use company context instead.

`OrdersExportInput.carrierIds` ● `[ID!]` list scalar common

Carrier IDs to filter orders by.

`OrdersExportInput.createdById` ● `ID` scalar common

`OrdersExportInput.customerRefNumber` ● `String` scalar common

Filter special orders by customer reference number.

`OrdersExportInput.endDate` ● `ISO8601DateTime` scalar common

End date to filter orders by.

`OrdersExportInput.endShippingDateFrom` ● `ISO8601DateTime` scalar common

Filter special orders by end shipping date (from).

`OrdersExportInput.endShippingDateTo` ● `ISO8601DateTime` scalar common

Filter special orders by end shipping date (to).

`OrdersExportInput.fulfillmentMethods` ● `[OrderFulfillmentMethodEnum!]` list enum orders

Fulfillment methods to filter orders by.

`OrdersExportInput.includeArchived` ● `Boolean` scalar common

Include archived orders in the export.

`OrdersExportInput.integrationId` ● `ID` scalar common

Filter orders by source integration ID.

`OrdersExportInput.keyword` ● `String` scalar common

Keyword to search for in orders. This keyword will be searched in order number, ship to name, ship to email, ship to phone, ship to company, bill to name, bill to email, bill to phone, and bill to company.

`OrdersExportInput.level` ● `OrdersExportLevelEnum` enum orders

Controls row grain: ORDERS_AND_ITEMS (one row per item; default), ORDERS_COMPACT (one row per order with collapsed fulfillment/shipment data), SHIPMENTS_COMPLETE (one row per shipment), CARTON_LEVEL (one row per carton line).