Orders

​

Queries

• order — Fetch a single order by its id (a branded order id or a legacy Mongo ObjectId hex).
• orders — List orders, optionally filtered by customer email or created/updated date range.
• tracker — Fetch a single shipment tracker by its id.
• trackers — List shipment trackers, optionally filtered by status, tracking number, or created/updated date range.

​

Objects

• Order — A customer order ingested from the merchant’s ecommerce platform.
• OrderCustomer — The customer who placed an order.
• OrderFulfillment — A shipment fulfilling some or all of an order’s items.
• OrderFulfillmentLineItem — A line item included in a fulfillment shipment.
• OrderLineItem — A single purchased item on an order.
• OrderProtection — The Redo coverage the customer bought on an order.
• OrderShipping — How an order ships: method, cost, and destination address.
• OrderTrackingEvent — A single carrier tracking event for a fulfillment.
• OrderTrackingEventLocation — Where a tracking event was reported from.
• Tracker — A carrier shipment tracker: the live delivery state of a shipment, with its full carrier scan history.
• TrackerOrder — An order fulfilled by a shipment tracker. Tracker webhook payloads carry these ids in their orderIds; reach them by traversing tracker(id:) — they are not fetchable via node(id:).
• TrackerScan — A single carrier scan event in a shipment tracker’s history.

​

Enums

• OrderFulfillmentStatus — The tracked shipment status of a fulfillment.
• OrderSortKey — A field this list can be ordered by; pass to the list’s orderBy argument and pair with reverse to flip direction.
• TrackerSortKey — A field this list can be ordered by; pass to the list’s orderBy argument and pair with reverse to flip direction.
• TrackerStatus — The carrier-tracked delivery status of a shipment tracker.