OrderShipping

Tracking and delivery details for a shipped order.

carrier
Type: stringnullable
required

The carrier, e.g. Colissimo. null when unknown.
deliveredAt
Type: Format: date-timenullable
required

When the parcel was delivered. null until it arrives.
history
Type: nullable
required

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

Properties: 5
shippedAt
Type: Format: date-timenullable
required

When the parcel shipped (first carrier scan). null before it ships.
status
Type: stringnullable
required

The latest carrier status. null before the first scan.
trackingNumber
Type: stringnullable
required

The carrier tracking number. null when an untracked order shipped as a letter without one.
trackingUrl
Type: stringnullable
required

A link to track the parcel. null when unavailable.
type
Type: stringenumnullable
required

How the order travels: parcel, tracked by the carrier, or letter, an envelope tracked by the mail scans of its USPS Intelligent Mail barcode. null when an untracked order shipped as a letter without a tracking number.
values
- parcel
  
  A parcel tracked by its carrier.
- letter
  
  An envelope with a USPS Intelligent Mail barcode, tracked by its mail scans.

Examples

{
  "trackingNumber": "6A18432197431",
  "type": "parcel",
  "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",
      "source": "cardnexus"
    }
  ]
}

OrderShippingAddress

OrderTrackingEvent