{
"shipment_date": "2023-11-07T10:00:00Z",
"shipment_type": "delivery",
"complete_at_start": "2023-11-07T14:00:00Z",
"complete_at_end": "2023-11-07T18:00:00Z",
"carrier_service_level_id": "550e8400-e29b-41d4-a716-446655440000",
"shipper": {
"name": "John Doe",
"street": "123 Main St",
"city": "Brooklyn",
"state": "NY",
"zip": "11201",
"country": "US",
"phone": "+1-555-123-4567",
"email": "john@example.com"
},
"receiver": {
"name": "Jane Smith",
"street": "456 Oak Ave",
"city": "Los Angeles",
"state": "CA",
"zip": "90001",
"country": "US",
"phone": "+1-555-987-6543",
"email": "jane@example.com"
},
"receiver_is_residential": true,
"order_number": "ORD-12345",
"label_url": "https://example.com/labels/123.pdf",
"items": [
{
"title": "Laptop",
"length": 10.0,
"width": 8.0,
"height": 6.0,
"distance_unit": "in",
"weight": 2.5,
"mass_unit": "lb",
"value": 99.99,
"currency": "USD"
}
]
}
{
"id": "123e4567-e89b-12d3-a456-426614174000",
"order_number": "ORD-12345",
"shipment_type": "delivery",
"shipment_date": "2023-11-07T10:00:00Z",
"complete_at_start": "2023-11-07T14:00:00Z",
"complete_at_end": "2023-11-07T18:00:00Z",
"carrier_id": "660e8400-e29b-41d4-a716-446655440000",
"carrier_service_level_id": "550e8400-e29b-41d4-a716-446655440000",
"pickup_id": "770e8400-e29b-41d4-a716-446655440000",
"timezone": "America/New_York",
"label_url": "https://example.com/labels/123.pdf",
"inserted_at": "2023-11-07T10:00:00Z",
"updated_at": "2023-11-07T10:00:00Z"
}
Shipments
Create a Shipment
Creates a new shipment with addresses and items
POST
/
api
/
shipments
{
"shipment_date": "2023-11-07T10:00:00Z",
"shipment_type": "delivery",
"complete_at_start": "2023-11-07T14:00:00Z",
"complete_at_end": "2023-11-07T18:00:00Z",
"carrier_service_level_id": "550e8400-e29b-41d4-a716-446655440000",
"shipper": {
"name": "John Doe",
"street": "123 Main St",
"city": "Brooklyn",
"state": "NY",
"zip": "11201",
"country": "US",
"phone": "+1-555-123-4567",
"email": "john@example.com"
},
"receiver": {
"name": "Jane Smith",
"street": "456 Oak Ave",
"city": "Los Angeles",
"state": "CA",
"zip": "90001",
"country": "US",
"phone": "+1-555-987-6543",
"email": "jane@example.com"
},
"receiver_is_residential": true,
"order_number": "ORD-12345",
"label_url": "https://example.com/labels/123.pdf",
"items": [
{
"title": "Laptop",
"length": 10.0,
"width": 8.0,
"height": 6.0,
"distance_unit": "in",
"weight": 2.5,
"mass_unit": "lb",
"value": 99.99,
"currency": "USD"
}
]
}
{
"id": "123e4567-e89b-12d3-a456-426614174000",
"order_number": "ORD-12345",
"shipment_type": "delivery",
"shipment_date": "2023-11-07T10:00:00Z",
"complete_at_start": "2023-11-07T14:00:00Z",
"complete_at_end": "2023-11-07T18:00:00Z",
"carrier_id": "660e8400-e29b-41d4-a716-446655440000",
"carrier_service_level_id": "550e8400-e29b-41d4-a716-446655440000",
"pickup_id": "770e8400-e29b-41d4-a716-446655440000",
"timezone": "America/New_York",
"label_url": "https://example.com/labels/123.pdf",
"inserted_at": "2023-11-07T10:00:00Z",
"updated_at": "2023-11-07T10:00:00Z"
}
Request Body
string
required
Shipment date in ISO 8601 format
string
required
Type of shipment. Must be one of:
delivery, return, exchangestring
required
Pickup window start time in ISO 8601 format
string
required
Pickup window end time in ISO 8601 format
string
required
Carrier service level UUID
object
required
Shipper address information
object
required
Receiver address information
boolean
default:false
Is receiver address residential
string
Order number
string
Shipping label URL
string
default:"America/New_York"
IANA timezone identifier
object
Additional shipment metadata
array
List of items in shipment
Show item properties
Show item properties
string
required
Item title/name (1-255 characters)
number
required
Length
number
required
Width
number
required
Height
string
required
Unit of distance (in, cm)
number
required
Weight
string
required
Unit of mass (lb, kg)
number
Declared value
string
Currency code (USD)
string
Item description (max 1000 characters)
string
Item image URL
object
Additional item metadata
{
"shipment_date": "2023-11-07T10:00:00Z",
"shipment_type": "delivery",
"complete_at_start": "2023-11-07T14:00:00Z",
"complete_at_end": "2023-11-07T18:00:00Z",
"carrier_service_level_id": "550e8400-e29b-41d4-a716-446655440000",
"shipper": {
"name": "John Doe",
"street": "123 Main St",
"city": "Brooklyn",
"state": "NY",
"zip": "11201",
"country": "US",
"phone": "+1-555-123-4567",
"email": "john@example.com"
},
"receiver": {
"name": "Jane Smith",
"street": "456 Oak Ave",
"city": "Los Angeles",
"state": "CA",
"zip": "90001",
"country": "US",
"phone": "+1-555-987-6543",
"email": "jane@example.com"
},
"receiver_is_residential": true,
"order_number": "ORD-12345",
"label_url": "https://example.com/labels/123.pdf",
"items": [
{
"title": "Laptop",
"length": 10.0,
"width": 8.0,
"height": 6.0,
"distance_unit": "in",
"weight": 2.5,
"mass_unit": "lb",
"value": 99.99,
"currency": "USD"
}
]
}
{
"id": "123e4567-e89b-12d3-a456-426614174000",
"order_number": "ORD-12345",
"shipment_type": "delivery",
"shipment_date": "2023-11-07T10:00:00Z",
"complete_at_start": "2023-11-07T14:00:00Z",
"complete_at_end": "2023-11-07T18:00:00Z",
"carrier_id": "660e8400-e29b-41d4-a716-446655440000",
"carrier_service_level_id": "550e8400-e29b-41d4-a716-446655440000",
"pickup_id": "770e8400-e29b-41d4-a716-446655440000",
"timezone": "America/New_York",
"label_url": "https://example.com/labels/123.pdf",
"inserted_at": "2023-11-07T10:00:00Z",
"updated_at": "2023-11-07T10:00:00Z"
}
⌘I