OrderTrackingEvent

A single carrier or mail scan in a shipment's tracking history.

description
Type: stringnullable
required

Carrier description. null when none.
location
Type: stringnullable
required

Where the scan happened. null when unknown.
occurredAt
Type: stringFormat: date-time
required

When the scan happened.
source
Type: stringenum
required

Where the scan came from: cardnexus when CardNexus received it from the carrier, application when an application connected to the seller sent it.
values
- cardnexus
  
  CardNexus received the scan from the carrier.
- application
  
  An application connected to the seller sent the scan with POST /v1/tracking/events.
status
Type: string
required

Carrier status for this scan.

Examples

{
  "status": "in_transit",
  "occurredAt": "2026-06-14T18:03:00.000Z",
  "location": "Lyon",
  "description": "Parcel handed to carrier",
  "source": "cardnexus"
}

OrderShipping

OrderCancellation