object Order

Fields

Field Type Description

id

String

Public API ID for this identifiable.

legacy_id

BigInt

Numeric legacy ID for this identifiable; use only where legacy IDs are required.

order_number

String

The store's internal order number.

partner_order_id

String

The order ID assigned by the storefront.

shop_name

String

Shop name for this order.

fulfillment_status

String

Status of the order (pending, fulfilled, cancelled, etc).

order_date

ISODateTime

Order date in ISO-8601 date or datetime format, returned in UTC when time is included.

total_tax

String

Monetary amount as a decimal value in the record currency; not cents.

subtotal

String

Customer-facing charge amount as a decimal monetary value in the order currency; distinct from value/customs_value used for declared value.

total_discounts

String

Monetary amount as a decimal value in the record currency; not cents.

total_price

String

Customer-facing charge amount as a decimal monetary value in the order currency; distinct from value/customs_value used for declared value.

box_name

String

Box name for this order.

ready_to_ship

Boolean

DEPRECATED This field is no longer being updated and should not be used or relied on

Deprecated ready-to-ship flag; this field is no longer updated reliably.

auto_print_return_label

Boolean

Whether a return label should be printed automatically for this order.

custom_invoice_url

String

URL for the custom invoice URL resource.

account_id

String

Public API account ID that identifies the related record.

updated_at

ISODateTime

Updated at as an ISO-8601 datetime, returned in UTC unless otherwise noted.

created_at

ISODateTime

Created at as an ISO-8601 datetime, returned in UTC unless otherwise noted.

email

String

Email address for the contact.

profile

String

Profile for this order.

gift_note

String

Gift note for this order.

packing_note

String

Packing note for this order.

required_ship_date

ISODateTime

Required ship date in ISO-8601 date or datetime format, returned in UTC when time is included.

shipping_lines

ShippingLines

Shipping lines for this order.

shipping_address

OrderAddress

Shipping address details for this order.

billing_address

OrderAddress

Billing address details for this order.

tags

[String]

List of tags for this order.

line_items

LineItemQuerySpecConnection

List of line items associated with this order.

Argument	Type	Required
`sort`	`String`	No
`search`	GenericScalar	No
`before`	`String`	No
`after`	`String`	No
`first`	`Int`	No
`last`	`Int`	No

authorizations

[Authorization]

List of authorizations for this order.

holds

OrderHolds

Holds for this order.

shipments

[Shipment]

List of shipments for this order.

returns

[Return]

List of returns for this order.

rma_labels

[RMALabel]

List of RMA labels for this order.

flagged

Boolean

Whether this order is flagged for attention.

saturday_delivery

Boolean

Whether Saturday delivery is requested for this order.

ignore_address_validation_errors

Boolean

Whether to ignore address validation errors for this order.

skip_address_validation

Boolean

Whether to skip address validation for this order.

priority_flag

Boolean

Whether this order is marked as priority.

allocation_priority

Int

Allocation priority as a numeric value.

allocations

[OrderWarehouseAllocation]

List of allocations for this order.

source

String

Source for this order.

third_party_shipper

OrderThirdPartyShipper

Third party shipper for this order.

gift_invoice

Boolean

Whether this order should use a gift invoice.

allow_partial

Boolean

True when this order allows partial; false otherwise.

require_signature

Boolean

Whether this order requires a delivery signature.

adult_signature_required

Boolean

Whether this order requires an adult delivery signature.

alcohol

Boolean

Whether this order contains alcohol and requires alcohol shipping handling.

expected_weight_in_oz

String

Expected weight in oz in ounces.

insurance

Boolean

Whether shipping insurance is enabled for this order.

insurance_amount

String

Monetary amount as a decimal value in the record currency; not cents.

currency

String

ISO 4217 currency code for the monetary values on this order.

has_dry_ice

Boolean

True when this order has dry ice; false otherwise.

allow_split

Boolean

True when this order allows split; false otherwise.

hold_until_date

ISODateTime

Hold until date in ISO-8601 date or datetime format, returned in UTC when time is included.

incoterms

String

Incoterms for this order.

tax_id

String

Public API tax ID that identifies the related record.

tax_type

String

Tax type for this order.

dry_ice_weight_in_lbs

String

Dry ice weight in lb in pounds.

ftr_exemption

Decimal

DEPRECATED Use ftr_exemption_value instead

Foreign Trade Regulations exemption value. Deprecated; use ftr_exemption_value.

ftr_exemption_value

String

Foreign Trade Regulations exemption value used for export documentation.

address_is_business

Boolean

Whether the ship-to address is a business address.

tote_qa

Boolean

Requires users to scan and verify all items from a tote before shipping.

do_not_print_invoice

Boolean

Whether invoices should be suppressed when printing documents for this order.

ignore_payment_capture_errors

Boolean

Whether to ignore payment capture errors for this order.

service_point_id

String

Public API service point ID that identifies the related record.

partner_source_name

String

Partner source identifier (e.g., web, pos, shopify_draft_order, etc.).

order_history

[OrderHistory]

List of order history for this order.

merged_orders

[MergedOrder]

List of merged orders for this order.

attachments

OrderAttachmentQuerySpecConnection

List of attachments associated with this order.

Argument	Type	Required
`sort`	`String`	No
`search`	GenericScalar	No
`before`	`String`	No
`after`	`String`	No
`first`	`Int`	No
`last`	`Int`	No

wholesale_order

WholesaleOrder

Wholesale order associated with this order.

Referenced By

Example

{
  "id": "UmVjb3JkOjEyMzQ=",
  "legacy_id": 1234,
  "order_number": "SO-100045",
  "partner_order_id": "SHOPIFY-100045",
  "shop_name": "SO-100045",
  "fulfillment_status": "pending",
  "order_date": "2026-07-09T15:30:00Z",
  "total_tax": "19.99",
  "subtotal": "19.99",
  "total_discounts": "19.99",
  "total_price": "19.99",
  "box_name": "SO-100045",
  "ready_to_ship": true,
  "auto_print_return_label": true,
  "custom_invoice_url": "https://example.com/resource",
  "account_id": "QWNjb3VudDoxMjM0",
  "updated_at": "2026-07-09T15:30:00Z",
  "created_at": "2026-07-09T15:30:00Z",
  "email": "customer@example.com",
  "profile": "default",
  "gift_note": "Customer requested expedited handling.",
  "packing_note": "Customer requested expedited handling.",
  "required_ship_date": "2026-07-09T15:30:00Z",
  "shipping_lines": {id: "T3JkZXI6MTIzNA==", order_number: "SO-100045"},
  "shipping_address": {address1: "123 Fulfillment Ave", city: "New York", country: "US"},
  "billing_address": {address1: "123 Fulfillment Ave", city: "New York", country: "US"},
  "tags": ["priority", "vip"],
  "line_items": [{sku: "BLUE-TEE-M", quantity: 2}],
  "authorizations": [[{id: "T3JkZXI6MTIzNA==", order_number: "SO-100045"}]],
  "holds": {id: "T3JkZXI6MTIzNA==", order_number: "SO-100045"},
  "shipments": [[{id: "T3JkZXI6MTIzNA==", order_number: "SO-100045"}]],
  "returns": [[{id: "T3JkZXI6MTIzNA==", order_number: "SO-100045"}]],
  "rma_labels": ["RMA"],
  "flagged": true,
  "saturday_delivery": true,
  "ignore_address_validation_errors": false,
  "skip_address_validation": false,
  "priority_flag": true,
  "allocation_priority": 1,
  "allocations": [[{id: "T3JkZXI6MTIzNA==", order_number: "SO-100045"}]],
  "source": "shopify",
  "third_party_shipper": {id: "T3JkZXI6MTIzNA==", order_number: "SO-100045"},
  "gift_invoice": true,
  "allow_partial": true,
  "require_signature": true,
  "adult_signature_required": true,
  "alcohol": true,
  "expected_weight_in_oz": "1.25",
  "insurance": true,
  "insurance_amount": "19.99",
  "currency": "19.99",
  "has_dry_ice": true,
  "allow_split": true,
  "hold_until_date": "2026-07-09T15:30:00Z",
  "incoterms": "DAP",
  "tax_id": "T3JkZXI6MTIzNA==",
  "tax_type": "19.99",
  "dry_ice_weight_in_lbs": "1.25",
  "ftr_exemption": 1.5,
  "ftr_exemption_value": "19.99",
  "address_is_business": true,
  "tote_qa": true,
  "do_not_print_invoice": false,
  "ignore_payment_capture_errors": false,
  "service_point_id": "T3JkZXI6MTIzNA==",
  "partner_source_name": "shopify",
  "order_history": [[{id: "T3JkZXI6MTIzNA==", order_number: "SO-100045"}]],
  "merged_orders": [[{id: "T3JkZXI6MTIzNA==", order_number: "SO-100045"}]],
  "attachments": [{id: "T3JkZXI6MTIzNA==", order_number: "SO-100045"}],
  "wholesale_order": {id: "T3JkZXI6MTIzNA==", order_number: "SO-100045"}
}