Skip to main content

Shipment

A logistics record tracking the physical movement of goods to a customer.

shipmentNumberstring

Human-readable shipment identifier displayed in Keychain OS.

Example: SHP-2025-0042
salesOrderNumberstring

The sales order this shipment fulfills.

Example: SO-2025-0189
customerNamestring

Display name of the customer receiving the shipment.

Example: Sunrise Craft Beverages
statusstring

Current status of the shipment: pending — created, awaiting dispatch. dispatched — handed to carrier. in_transit — carrier confirmed pickup. delivered — goods received by customer. cancelled — shipment was cancelled.

Possible values: [pending, dispatched, in_transit, delivered, cancelled]

Example: dispatched
directionstring

outbound (to customer) or inbound (customer return).

Possible values: [outbound, inbound]

Example: outbound
carrierstring

Shipping carrier name.

Example: FedEx
trackingNumberstring

Carrier tracking number.

Example: 794644790132
trackingUrlstring

Direct link to carrier tracking page.

Example: https://www.fedex.com/track?trknbr=794644790132
estimatedDispatchDatestring<date>

Expected ship date (ISO 8601).

Example: 2025-03-10
shippedDatestring<date>

Actual ship date (ISO 8601). Null if not yet dispatched.

Example: 2025-03-10
estimatedDeliveryDatestring<date>

Expected delivery date (ISO 8601).

Example: 2025-03-15
deliveredDatestring<date>

Actual delivery date (ISO 8601). Null if not yet delivered.

Example: 2025-03-14
Shipment
{
  "shipmentNumber": "SHP-2025-0042",
  "salesOrderNumber": "SO-2025-0189",
  "customerName": "Sunrise Craft Beverages",
  "status": "dispatched",
  "direction": "outbound",
  "carrier": "FedEx",
  "trackingNumber": "794644790132",
  "trackingUrl": "https://www.fedex.com/track?trknbr=794644790132",
  "estimatedDispatchDate": "2025-03-10",
  "shippedDate": "2025-03-10",
  "estimatedDeliveryDate": "2025-03-15",
  "deliveredDate": "2025-03-14"
}