orders

Fetch orders matching the supplied arguments.

Arguments

ArgumentTypeRequiredDefaultDescription
ids[String]No

List of ids of orders to include in the query.

shop_nameStringNo

Filter by shop name.

partner_order_idStringNo

Filter by partner order ID; use the external/store order identifier.

order_numberStringNo

Filter by order number.

warehouse_idStringNo

Filter by public API warehouse ID. Use this ID field when selecting a warehouse; warehouse fields are display values or nested objects.

allocated_warehouse_idStringNo

Filter by allocated warehouse ID; pass the public API ID unless the field name says legacy ID.

fulfillment_statusStringNo

Status to include. Use values returned by Order.fulfillment_status.

fulfillment_status_not_in[String!]No

List of fulfillment statuses to exclude. Use values returned by Order.fulfillment_status. Accepts up to 100 statuses, each up to 32 characters. Blank values are ignored; canceled and cancelled are treated as equivalent.

skuStringNo

Filter by SKU. SKU matching is case-insensitive and ignores surrounding whitespace.

emailStringNo

Filter by email.

updated_fromISODateTimeNo

Inclusive start of the updated range, in ISO-8601 datetime format.

updated_toISODateTimeNo

Inclusive end of the updated range, in ISO-8601 datetime format.

order_date_fromISODateTimeNo

Inclusive start of the order date range, in ISO-8601 datetime format.

order_date_toISODateTimeNo

Inclusive end of the order date range, in ISO-8601 datetime format.

created_fromISODateTimeNo

Creation date start filter. Defaults to 30-day range if only one is provided. When both given, enforces max 1 year back from end date.

created_toISODateTimeNo

Creation date end filter. Defaults to 30-day range if only one is provided. When both given, enforces max 1 year back from this date.

required_ship_date_fromISODateTimeNo

Required ship date start filter. Defaults to 30-day range if only one is provided. When both given, enforces max 1 year back from end date.

required_ship_date_toISODateTimeNo

Required ship date end filter. Defaults to 30-day range if only one is provided. When both given, enforces max 1 year back from this date.

allocated_fromISODateTimeNo

Allocation creation date start filter. Combine with ready_to_ship to poll for recently allocated orders. If allocations are recalculated, an order can appear in consecutive polling windows. When this filter is set, ready_to_ship is evaluated only against allocations created in the window, and orders that were never allocated are not returned. Defaults to a 30-day range if only one bound is provided; when both are given, enforces a maximum 1-year lookback from the end date.

allocated_toISODateTimeNo

Allocation creation date end filter. Combine with ready_to_ship to poll for recently allocated orders. If allocations are recalculated, an order can appear in consecutive polling windows. When this filter is set, ready_to_ship is evaluated only against allocations created in the window, and orders that were never allocated are not returned. Defaults to a 30-day range if only one bound is provided; when both are given, enforces a maximum 1-year lookback from this date.

customer_account_idStringNo

If you are a 3PL you can specify one of your customer's account.

has_holdBooleanNo

When true, filters results where has hold applies; when false, filters where it does not.

operator_holdBooleanNo

When true, filters results where operator hold applies; when false, filters where it does not.

address_holdBooleanNo

When true, filters results where address hold applies; when false, filters where it does not.

payment_holdBooleanNo

When true, filters results where payment hold applies; when false, filters where it does not.

fraud_holdBooleanNo

When true, filters results where fraud hold applies; when false, filters where it does not.

ready_to_shipBooleanNo

When true, filters results where ready to ship applies; when false, filters where it does not.

profileStringNo

Filter by profile.

tagStringNo

Filter by tag.

has_backorderBooleanNo

When true, filters results where has backorder applies; when false, filters where it does not.

is_wholesale_orderBooleanNo

When true, filters results where is wholesale order applies; when false, filters where it does not.

pause_shippingBooleanNo

If you are a 3PL, filter orders by the customer's pause_shipping relationship setting.

analyzeBooleanNo

If true, the query will only be analyzed (cost estimated) without executing it.

Return Type

OrdersQueryResult

Query

query orders(
  $ids: [String],
  $shop_name: String,
  $partner_order_id: String,
  $order_number: String,
  $warehouse_id: String,
  $allocated_warehouse_id: String,
  $fulfillment_status: String,
  $fulfillment_status_not_in: [String!],
  $sku: String,
  $email: String,
  $updated_from: ISODateTime,
  $updated_to: ISODateTime,
  $order_date_from: ISODateTime,
  $order_date_to: ISODateTime,
  $created_from: ISODateTime,
  $created_to: ISODateTime,
  $required_ship_date_from: ISODateTime,
  $required_ship_date_to: ISODateTime,
  $allocated_from: ISODateTime,
  $allocated_to: ISODateTime,
  $customer_account_id: String,
  $has_hold: Boolean,
  $operator_hold: Boolean,
  $address_hold: Boolean,
  $payment_hold: Boolean,
  $fraud_hold: Boolean,
  $ready_to_ship: Boolean,
  $profile: String,
  $tag: String,
  $has_backorder: Boolean,
  $is_wholesale_order: Boolean,
  $pause_shipping: Boolean,
  $analyze: Boolean
) {
  orders(
    ids: $ids,
    shop_name: $shop_name,
    partner_order_id: $partner_order_id,
    order_number: $order_number,
    warehouse_id: $warehouse_id,
    allocated_warehouse_id: $allocated_warehouse_id,
    fulfillment_status: $fulfillment_status,
    fulfillment_status_not_in: $fulfillment_status_not_in,
    sku: $sku,
    email: $email,
    updated_from: $updated_from,
    updated_to: $updated_to,
    order_date_from: $order_date_from,
    order_date_to: $order_date_to,
    created_from: $created_from,
    created_to: $created_to,
    required_ship_date_from: $required_ship_date_from,
    required_ship_date_to: $required_ship_date_to,
    allocated_from: $allocated_from,
    allocated_to: $allocated_to,
    customer_account_id: $customer_account_id,
    has_hold: $has_hold,
    operator_hold: $operator_hold,
    address_hold: $address_hold,
    payment_hold: $payment_hold,
    fraud_hold: $fraud_hold,
    ready_to_ship: $ready_to_ship,
    profile: $profile,
    tag: $tag,
    has_backorder: $has_backorder,
    is_wholesale_order: $is_wholesale_order,
    pause_shipping: $pause_shipping,
    analyze: $analyze
  ) {
    request_id
    complexity
    data {
      ...OrderConnectionFragment
    }
  }
}

Variables

{
  "ids": ["T3JkZXI6MTIzNA==", "T3JkZXI6NTY3OA=="],
  "shop_name": "SO-100045",
  "partner_order_id": "SHOPIFY-100045",
  "order_number": "SO-100045",
  "warehouse_id": "V2FyZWhvdXNlOjEyMzQ=",
  "allocated_warehouse_id": "V2FyZWhvdXNlOjEyMzQ=",
  "fulfillment_status": "pending",
  "fulfillment_status_not_in": ["pending", "shipped"],
  "sku": "BLUE-TEE-M",
  "email": "customer@example.com",
  "updated_from": "2026-07-09T15:30:00Z",
  "updated_to": "2026-07-09T15:30:00Z",
  "order_date_from": "2026-07-09T15:30:00Z",
  "order_date_to": "2026-07-09T15:30:00Z",
  "created_from": "2026-07-09T15:30:00Z",
  "created_to": "2026-07-09T15:30:00Z",
  "required_ship_date_from": "2026-07-09T15:30:00Z",
  "required_ship_date_to": "2026-07-09T15:30:00Z",
  "allocated_from": "2026-07-09T15:30:00Z",
  "allocated_to": "2026-07-09T15:30:00Z",
  "customer_account_id": "QWNjb3VudDoxMjM0",
  "has_hold": true,
  "operator_hold": true,
  "address_hold": true,
  "payment_hold": true,
  "fraud_hold": true,
  "ready_to_ship": true,
  "profile": "default",
  "tag": "priority",
  "has_backorder": true,
  "is_wholesale_order": true,
  "pause_shipping": true,
  "analyze": true
}

Response

{
  "data": {
    "orders": {
      "request_id": "UmVjb3JkOjEyMzQ=",
      "complexity": 100,
      "data": [{id: "T3JkZXI6MTIzNA==", order_number: "SO-100045"}]
    }
  }
}