Skip to main content
GET
Get Order Timeline
Retrieve the customer-facing lifecycle timeline for an order. The timeline merges the order’s placement outcome with carrier tracking state into an ordered list of milestones.
The timeline is derived from existing order and tracking data on every request, so it is available for all orders — including orders placed before this endpoint was introduced.

Milestones

Milestones are sorted by occurred_at, oldest first. Each one has a type, a human-readable label, the source it was derived from, and an optional detail object.
An available_for_pickup milestone stays on the timeline after the package is collected, so the history shows it waited at a carrier facility. Use tracking for each package’s current state.

Authorizations

Authorization
string
header
required

Zinc API key (Bearer zn_...)

Headers

authorization
string | null

Path Parameters

order_id
string<uuid>
required

Response

Successful Response

Customer-facing lifecycle timeline for an order.

Derived on read by merging placement logs (OrderLog) with carrier tracking state (TrackingNumber / TrackingCheckpoint). No dedicated storage — works retroactively on every historical order.

order_id
string<uuid>
required
current_status
enum<string>
required
Available options:
pending,
in_progress,
order_placed,
order_failed,
cancelled,
cancelled_by_retailer
milestones
OrderMilestone · object[]
required