Shipment Fields
Core Fields
| Field | Type | Req | Description |
|---|---|---|---|
| id | string (UUID) | Orderly internal ID | |
| organizationId | string (UUID) | Owning organization | |
| orderId | string (UUID) | Linked order ID | |
| bridgeId | string (UUID) | Source bridge | |
| externalId | string | ID from the carrier/platform | |
| status | ShipmentStatus | Current lifecycle status | |
| carrier | string | Carrier name (e.g., "fedex", "ups") | |
| trackingNumber | string | Carrier tracking number | |
| trackingUrl | string | Public tracking page URL | |
| service | string | Service level (e.g., "ground", "express") |
Package Details
| Field | Type | Req | Description |
|---|---|---|---|
| weight | object | Weight: { value, unit } | |
| dimensions | object | Dimensions: { length, width, height, unit } | |
| packageType | string | Package type (box, envelope, pallet) |
Addresses
| Field | Type | Req | Description |
|---|---|---|---|
| shipFrom | Address | Origin address | |
| shipTo | Address | Destination address |
Label Data
| Field | Type | Req | Description |
|---|---|---|---|
| labelUrl | string | URL to the shipping label PDF | |
| labelFormat | string | Label format (PDF, ZPL, PNG) | |
| cost | number | Shipping cost paid | |
| insuranceAmount | number | Insurance value |
Tracking Events
| Field | Type | Req | Description |
|---|---|---|---|
| events | TrackingEvent[] | Array of tracking events | |
| events[].timestamp | Date | When the event occurred | |
| events[].description | string | Event description | |
| events[].location | string | Event location | |
| events[].status | string | Status at this event |
Timestamps
| Field | Type | Req | Description |
|---|---|---|---|
| createdAt | Date | When created in Orderly | |
| updatedAt | Date | Last update time | |
| shippedAt | Date | When picked up by carrier | |
| deliveredAt | Date | When delivered | |
| estimatedDelivery | Date | Estimated delivery date |