Shipments
Availability
Copy
{
"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": "[email protected]"
},
"receiver": {
"name": "Jane Smith",
"street": "456 Oak Ave",
"city": "Los Angeles",
"state": "CA",
"zip": "90001",
"country": "US",
"phone": "+1-555-987-6543",
"email": "[email protected]"
},
"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"
}
]
}
Copy
{
"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
Copy
{
"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": "[email protected]"
},
"receiver": {
"name": "Jane Smith",
"street": "456 Oak Ave",
"city": "Los Angeles",
"state": "CA",
"zip": "90001",
"country": "US",
"phone": "+1-555-987-6543",
"email": "[email protected]"
},
"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"
}
]
}
Copy
{
"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
Shipment date in ISO 8601 format
Type of shipment. Must be one of:
delivery, return, exchangePickup window start time in ISO 8601 format
Pickup window end time in ISO 8601 format
Carrier service level UUID
Shipper address information
Show properties
Show properties
Contact name
Street address
City
State/Province code
ZIP/Postal code
Country code
Contact phone
Contact email
Latitude
Longitude
Receiver address information
Show properties
Show properties
Is receiver address residential
Order number
Shipping label URL
IANA timezone identifier
Additional shipment metadata
List of items in shipment
Show item properties
Show item properties
Item title/name (1-255 characters)
Length
Width
Height
Unit of distance (in, cm)
Weight
Unit of mass (lb, kg)
Declared value
Currency code (USD)
Item description (max 1000 characters)
Item image URL
Additional item metadata
Copy
{
"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": "[email protected]"
},
"receiver": {
"name": "Jane Smith",
"street": "456 Oak Ave",
"city": "Los Angeles",
"state": "CA",
"zip": "90001",
"country": "US",
"phone": "+1-555-987-6543",
"email": "[email protected]"
},
"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"
}
]
}
Copy
{
"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