Shipping Orders Queries

Track shipping orders, carrier details, and delivery status.

ShippingOrder — Returns a single shipping order by id

GraphQL

query GetShippingOrder($id: Int!) {
  ShippingOrder(id: $id) {
    id
    label
    status
    dated_at
    shipping_at
    total_units
    customer { id label }
    line_items {
      id
      variant { id label }
      quantity
    }
    orders {
      paginatorInfo { total }
      data { id label }
    }
    invoices {
      paginatorInfo { total }
      data { id label }
    }
    shipping_address {
      address_1
      city
      postal_code
      country
    }
  }
}

ShippingOrders — Returns a list of shipping orders with sorting and filters

GraphQL

query ShippingOrders(
  $where: QueryShippingOrdersWhereWhereConditions,
  $orderBy: [QueryShippingOrdersOrderByOrderByClause!],
  $search: String,
  $first: Int,
  $page: Int
) {
  ShippingOrders(
    where: $where,
    orderBy: $orderBy,
    search: $search,
    first: $first,
    page: $page
  ) {
    paginatorInfo {
      total
      currentPage
    }
    data {
      id
      label
      status
      dated_at
      total_units
      customer { id label }
    }
  }
}

---

Available fields

Field	Type	Description
id	Int	Unique identifier.
label	String	Shipping order number.
status	ShippingOrderStatus	Current status.
dated_at	Date	Document date.
shipping_at	Date	Expected shipping date.
total_units	Float	Total quantity to ship.
notes	String	Public notes.
internal_notes	String	Private notes.
for_the_attention_of	String	Contact person name.
external_reference	String	Customer reference.
billing_status	BillingStatus	Invoicing status.
payment_status	PaymentStatus	Payment progress.
committed_quantity	Float	Stock committed quantity.
uncommitted_quantity	Float	Awaiting commitment.
reserved_quantity	Float	Quantity reserved for this shipment.
delivered_quantity	Float	Quantity received by customer.
shipped_quantity	Float	Quantity left the warehouse.
billed_quantity	Float	Quantity already invoiced.
unbilled_quantity	Float	Quantity remaining to be invoiced.
paid_quantity	Float	Paid quantity.
unpaid_quantity	Float	Unpaid quantity.
billed_amount	Float	Amount already invoiced.
unbilled_amount	Float	Amount remaining to be invoiced.
paid_amount	Float	Total paid amount.
unpaid_amount	Float	Total unpaid amount.
order_number	String	Related order label.
location_label	String	Assigned location label.
customer	Customer	Associated customer.
line_items	[LineItemShippingOrder]	List of items.
orders	[Order]	Related sales orders.
invoices	[Invoice]	Related invoices.
season	Season	Linked season.
account_representative	AccountRepresentative	Assigned representative.
pdf_template	PdfTemplate	Shipping order PDF design.
picking_list_pdf_template	PdfTemplate	Picking list PDF design.
shipping_address	Address	Shipping destination.
files	[File]	Attachments.
created_at	Date	Creation date.
tracking_completed	Boolean	True if all tracking info (batches, etc) is entered.
has_batch_numbers	Boolean	True if items have batch tracking.
invoices_count	Int	Number of linked invoices.
orders_count	Int	Number of linked sales orders.
subscriptions_count	Int	Number of linked subscriptions.
custom_fields	[EntityCustomField]	Custom fields for this entity.

---

Filters

The following fields can be used in the where parameter:

id, label, status, total_units, dated_at, created_at, updated_at, shipping_at, customer_id, committed_quantity, uncommitted_quantity, delivered_quantity, shipped_quantity, reserved_quantity, orders_count, invoices_count, variant_id, variant_label, variant_sku, location_id, batch_number_id, has_batch_numbers, tracking_completed.

Example Filters:

Field	Example
id	{ "column": "ID", "operator": "EQ", "value": 200050 }
label	{ "column": "LABEL", "operator": "LIKE", "value": "%SHIP-2025%" }
status	{ "column": "STATUS", "operator": "EQ", "value": "ready_to_ship" }
customer_id	{ "column": "CUSTOMER_ID", "operator": "EQ", "value": 100001 }
variant_id	{ "column": "VARIANT_ID", "operator": "EXISTS", "value": 200500 }
variant_sku	{ "column": "VARIANT_SKU", "operator": "EQ", "value": "SKU-RED" }
location_id	{ "column": "LOCATION_ID", "operator": "EXISTS", "value": 100 }
dated_at	{ "column": "DATED_AT", "operator": "GTE", "value": "2025-01-01" }

---

Sorting

You can sort results using the orderBy parameter:

• id
• label
• notes
• total_units
• status
• dated_at
• created_at
• shipping_at
• order_number
• customer_id
• customer_label

---

Grouping Options

You can group shipping orders using the groupBy parameter for totals aggregate:

Field	Description
id	Group by internal ID.
status	Group by current status.
year	Group by year of dated_at.
month	Group by month of dated_at.
day	Group by day of dated_at.

---

Enums

ShippingOrderStatus

Value	Description
unpublished	Draft status.
pending	Document processed, shipment pending.
make_the_shipment	Ready for pick & pack.
in_preparation	Packing in progress.
ready_to_ship	Box labeled and ready.
shipped	Left the warehouse.
delivered	Received by customer.
cancelled	Document cancelled.

BillingStatus

Value	Description
not_billed	Not invoiced.
partially_billed	Partial invoicing.
billed	Fully invoiced.

PaymentStatus

Value	Description
unpaid	No payment received.
partially_paid	Partial payment received.
paid	Fully paid.