---
title: "Shipment data model"
url: "https://docs.unified.to/shipping/shipment/model"
description: "API reference for Shipment data model. Launch multiple pre-built Shipment integrations today with zero maintenance — all through a single API."
generated_at: "2026-05-29T17:54:04.961Z"
---
# Shipment data model

 View field support, webhooks, and list parameters for each integration on the [Supported Integrations](/shipping/integrations) page. 

### 

* Data Model
* Typescript Type
* Zod Shape
* Python Class

Data Model

**id**string 

Unique identifier for this shipment object

**created\_at**date 

The date that this shipment object was created (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)

**updated\_at**date 

The last date that this shipment object was updated (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)

**order\_id**string 

Reference to commerce\_order or accounting\_order

**from\_address**object 

Origin address

**to\_address**object 

Destination address

**packages** array 

Array of packages in this shipment

**carrier\_id**string 

Reference to the carrier

**service\_code**string 

Code for the shipping service used

**status** enum

Valid values:

 "PENDING" 

 "PROCESSING" 

 "IN\_TRANSIT" 

 "DELIVERED" 

 "EXCEPTION" 

Current status of the shipment

**rate\_id**string 

Optional reference to the selected rate (for traceability)

**label\_id**string 

Optional reference to the shipping label

**tracking\_id**string 

Optional reference to the tracking information

**shipped\_at**date 

When shipment was createddispatched (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)

**rate\_amount**number 

The rate amount used (may differ from shipping\_cost due to adjustments)

**rate\_currency**string 

Currency for rate\_amount

**rate\_service\_name**string 

Service name from the rate (e.g., "Priority Mail")

**rate\_estimated\_days**number 

Estimated delivery days from the rate

**rate\_estimated\_delivery\_at**date 

Estimated delivery date from the rate (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)

**is\_rate\_guaranteed**boolean 

Whether delivery is guaranteed (from rate)

**return\_address**object 

Return address (may differ from from\_address)

**return\_authorization\_number**string 

RMA number if return shipment

**warehouse\_location\_id**string 

Origin warehouselocation ID; points to CommerceLocation

**warehouse\_location\_name**string 

Origin warehouse location name

**customs**object 

Customs information

**is\_international**boolean 

Whether shipment is international

**insurance**object 

Insurance details

**special\_instructions**string array 

Array of special instructions

**is\_signature\_required**boolean 

Signature required on delivery

**is\_adult\_signature\_required**boolean 

Adult signature required

**reference\_number**string 

Customer reference number

**is\_return**boolean 

Whether this is a return shipment

**original\_shipment\_id**string 

Reference to original shipment if return; points to ShippingShipment

**return\_reason**string 

Reason for return

**return\_type** enum

Valid values:

 "CUSTOMER" 

 "VENDOR" 

 "WARRANTY" 

 "DEFECTIVE" 

 "OTHER" 

Type of return

**raw**any 

The raw data returned by the integration for this shipment