OrderShipping

Tracking and delivery details for a shipped order.

  • carrier
    Type: string nullable
    required

    The carrier, e.g. Colissimo. null when unknown.

  • deliveredAt
    Type: string · DateStringFormat: date-timenullable
    required

    When the parcel was delivered. null until it arrives.

    An ISO 8601 date-time in UTC, e.g. 2024-08-14T10:23:11.000Z.

  • history
    Type: array object[] | null · OrderTrackingEvent[]nullable
    required

    The carrier scan history, oldest first. null when none is available.

    A single carrier scan in a parcel's tracking history.

    • description
      Type: string nullable
      required

      Carrier description. null when none.

    • location
      Type: string nullable
      required

      Where the scan happened. null when unknown.

    • occurredAt
      Type: string Format: date-time
      required

      When the scan happened.

    • status
      Type: string
      required

      Carrier status for this scan.

  • shippedAt
    Type: string Format: date-time
    required

    When the order was marked shipped.

  • status
    Type: string nullable
    required

    The latest carrier status. null before the first scan.

  • trackingNumber
    Type: string
    required

    The carrier tracking number.

  • trackingUrl
    Type: string nullable
    required

    A link to track the parcel. null when unavailable.

Examples 
{
  "trackingNumber": "6A18432197431",
  "carrier": "Colissimo",
  "trackingUrl": "https://www.laposte.fr/outils/suivre-vos-envois?code=6A18432197431",
  "status": "in_transit",
  "shippedAt": "2026-06-14T09:12:00.000Z",
  "deliveredAt": null,
  "history": [
    {
      "status": "in_transit",
      "occurredAt": "2026-06-14T18:03:00.000Z",
      "location": "Lyon",
      "description": "Parcel handed to carrier"
    }
  ]
}