orders

Arguments

ArgumentTypeRequiredDefaultDescription
ids[String]No

List of ids of orders to include in the query

shop_nameStringNo
partner_order_idStringNo
order_numberStringNo
warehouse_idStringNo
allocated_warehouse_idStringNo
fulfillment_statusStringNo
skuStringNo
emailStringNo
updated_fromISODateTimeNo
updated_toISODateTimeNo
order_date_fromISODateTimeNo
order_date_toISODateTimeNo
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.

customer_account_idStringNo

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

has_holdBooleanNo
operator_holdBooleanNo
address_holdBooleanNo
payment_holdBooleanNo
fraud_holdBooleanNo
ready_to_shipBooleanNo
profileStringNo
tagStringNo
has_backorderBooleanNo
is_wholesale_orderBooleanNo
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,
  $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,
  $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,
  $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,
    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,
    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,
    analyze: $analyze
  ) {
    request_id
    complexity
    data {
      ...OrderConnectionFragment
    }
  }
}

Variables

{
  "ids": ["abc123"],
  "shop_name": "abc123",
  "partner_order_id": "abc123",
  "order_number": "abc123",
  "warehouse_id": "abc123",
  "allocated_warehouse_id": "abc123",
  "fulfillment_status": "abc123",
  "sku": "abc123",
  "email": "abc123",
  "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,
  "customer_account_id": "abc123",
  "has_hold": true,
  "operator_hold": true,
  "address_hold": true,
  "payment_hold": true,
  "fraud_hold": true,
  "ready_to_ship": true,
  "profile": "abc123",
  "tag": "abc123",
  "has_backorder": true,
  "is_wholesale_order": true,
  "analyze": true
}

Response

{
  "data": {
    "orders": {
      "request_id": "abc123",
      "complexity": 987,
      "data": OrderConnection
    }
  }
}