> ## Documentation Index
> Fetch the complete documentation index at: https://www.zinc.com/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# Get Order Timeline

> Retrieve the customer-facing lifecycle timeline of events for a Zinc order.

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.

<Info>
  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.
</Info>

## 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.

| `type` | Label | When it appears | `detail` |
| - | - | - | - |
| `order_created` | Order placed | Always, as the first milestone. Marks when you submitted the order. | — |
| `order_placed` | Order confirmed | The retailer accepted the order. Shown even if earlier attempts failed and a retry succeeded. | `merchant_order_ids`, when known |
| `order_failed` | Order failed | The order ended failed. Takes the place of `order_placed`. | — |
| `cancelled` | Cancelled / Cancelled by retailer | The order was cancelled. | — |
| `tracking_acquired` | Tracking received | The first tracking number was recorded. | `carrier`, `tracking_number`, `count` (number of tracking numbers on the order) |
| `shipped` | Shipped | The first carrier scan showing a package moving. | `carrier`, `message`, `location` |
| `available_for_pickup` | Ready for pickup | A package is waiting at a carrier facility. One per package, at its first pickup scan. | `carrier`, `tracking_number`, `message`, `location` |
| `undeliverable` | The carrier's own wording, e.g. "Delivery on hold" | The carrier couldn't deliver a package. One per affected package, so a multi-package order shows which one is missing. | `carrier`, `tracking_number` |
| `delivered` | Delivered | Every package on the order has been delivered. | `location` |

<Info>
  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](/docs/v2/api-reference/orders/tracking#tracking-status) for each
  package's current state.
</Info>


## OpenAPI

````yaml versions/latest.json GET /orders/{order_id}/timeline
openapi: 3.1.0
info:
  title: Zinc
  summary: >-
    Zinc lets you search, buy, and return items from top online retailers with a
    single API.
  description: >-
    Search, buy, and return items from top online retailers with a single API.
    Supports AI agent ordering via MPP (HTTP 402) — no account required.
    Supported retailers include 1-800-Flowers, Ace Hardware, Amazon, Amazon CA,
    Amazon DE, Amazon FR, Amazon MX, Amazon UK, Barnes & Noble, Best Buy, Chewy,
    Gap, and 18 more. Ships to the US and 6 other countries (CA, DE, FR, GB, IT,
    MX). The listed retailers are the ones Zinc verifies with daily test orders,
    not the limit of what Zinc can buy from: checkout is attempted at most
    online stores, including Shopify-hosted ones. To ask about a specific store
    before ordering, call GET /retailers/check?url=... — it answers whether Zinc
    will attempt that URL.
  version: '2026-10-09'
  x-logo:
    url: https://mintlify.s3.us-west-1.amazonaws.com/zinc/logo/light.png
  contact:
    name: Zinc API Support
    email: support@zinc.com
    url: https://zinc.com/docs
  x-guidance: >-
    Zinc lets AI agents buy products from online retailers via a single API. Use
    POST /agent/orders to place an order — no Zinc account needed, payment is
    handled via MPP (HTTP 402 flow). Provide a product URL from a supported
    retailer, a shipping address, and max_price in cents. The API charges
    max_price + $1 API fee upfront and refunds the difference on completion. To
    find products first, the /agent/* data endpoints (search, products/search,
    products/offers, products/details) are MPP-paid at $0.01 per call;
    /agent/search returns orderable URLs to feed straight into /agent/orders.
    GET /retailers lists supported retailers for free (no payment or account).
    Authenticated equivalents (orders, products, managed-accounts) require a
    Bearer token (API key prefixed zn_); those orders are paid from a prefunded
    wallet — GET /wallet/me returns the spendable balance and per-order fee, so
    check it before POST /orders to avoid a 402. Orders are strict by default:
    if the gift option can't be applied or any item can't be bought, the whole
    order fails. When the user wants whatever can be shipped, send fulfillment:
    {"gift": "best_effort", "items": "best_effort"} and read
    fulfillment.concessions on the order to see what was relaxed. max_price is
    never relaxed. Docs: https://zinc.com/docs Supported retailers include
    1-800-Flowers, Ace Hardware, Amazon, Amazon CA, Amazon DE, Amazon FR, Amazon
    MX, Amazon UK, Barnes & Noble, Best Buy, Chewy, Gap, and 18 more, shipping
    to the US and 6 other countries (CA, DE, FR, GB, IT, MX). The listed
    retailers are the ones Zinc verifies with daily test orders, not the limit
    of what Zinc can buy from: checkout is attempted at most online stores,
    including Shopify-hosted ones. To ask about a specific store before
    ordering, call GET /retailers/check?url=... — it answers whether Zinc will
    attempt that URL.
  x-supported-retailers:
    - 1-800-Flowers
    - Ace Hardware
    - Amazon
    - Amazon CA
    - Amazon DE
    - Amazon FR
    - Amazon MX
    - Amazon UK
    - Barnes & Noble
    - Best Buy
    - Chewy
    - Gap
    - Grainger
    - IBS
    - Lowe's
    - Macys
    - McMaster-Carr
    - Partstown
    - Pokémon Center
    - Sephora
    - Target
    - The Home Depot
    - TikTok
    - Uniqlo
    - Walmart
    - Wayfair
    - Zinc
    - eBay
    - libraccio
    - zazzle
  x-supported-countries:
    - US
    - CA
    - DE
    - FR
    - GB
    - IT
    - MX
servers:
  - url: https://api.zinc.com
    description: Production
security:
  - BearerAuth: []
paths:
  /orders/{order_id}/timeline:
    get:
      tags:
        - orders
      summary: Get Order Timeline
      description: >-
        Customer-facing lifecycle timeline for an order.


        Derived on read from existing data — no dedicated storage. Merges the

        placement outcome (OrderLog) with carrier tracking state (TrackingNumber
        /

        TrackingCheckpoint) into an ordered list of milestones. This is the
        order's

        story to the customer, distinct from the admin-only job/automation log.
      operationId: get_order_timeline_orders__order_id__timeline_get
      parameters:
        - name: order_id
          in: path
          required: true
          schema:
            type: string
            format: uuid
            title: Order Id
        - name: authorization
          in: header
          required: false
          schema:
            anyOf:
              - type: string
              - type: 'null'
            title: Authorization
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OrderTimelineResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
components:
  schemas:
    OrderTimelineResponse:
      properties:
        order_id:
          type: string
          format: uuid
          title: Order Id
        current_status:
          $ref: '#/components/schemas/OrderStatus'
        milestones:
          items:
            $ref: '#/components/schemas/OrderMilestone'
          type: array
          title: Milestones
      type: object
      required:
        - order_id
        - current_status
        - milestones
      title: OrderTimelineResponse
      description: >-
        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.
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    OrderStatus:
      type: string
      enum:
        - pending
        - in_progress
        - order_placed
        - order_failed
        - cancelled
        - cancelled_by_retailer
      title: OrderStatus
    OrderMilestone:
      properties:
        type:
          type: string
          enum:
            - order_created
            - order_placed
            - tracking_acquired
            - shipped
            - available_for_pickup
            - delivered
            - undeliverable
            - order_failed
            - cancelled
          title: Type
        label:
          type: string
          title: Label
        occurred_at:
          type: string
          format: date-time
          title: Occurred At
        source:
          type: string
          title: Source
        detail:
          anyOf:
            - additionalProperties: true
              type: object
            - type: 'null'
          title: Detail
      type: object
      required:
        - type
        - label
        - occurred_at
        - source
      title: OrderMilestone
      description: A single point on the customer-facing order timeline.
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
              - type: string
              - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
      type: object
      required:
        - loc
        - msg
        - type
      title: ValidationError
  securitySchemes:
    BearerAuth:
      type: apiKey
      in: header
      name: Authorization
      description: Zinc API key (Bearer zn_...)

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.