Update Shipment

{
  "order_number": "UPDATED-ORD-12345",
  "complete_at_start": "2023-11-09T09:00:00-05:00",
  "complete_at_end": "2023-11-09T17:00:00-05:00",
  "receiver": {
    "name": "Jane Doe Updated",
    "street": "789 New Street",
    "city": "Los Angeles",
    "state": "CA",
    "zip": "90001"
  },
  "update_reason": "Customer requested address change"
}

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "order_number": "UPDATED-ORD-12345",
  "shipment_type": "delivery",
  "shipment_date": "2023-11-09T10:00:00Z",
  "complete_at_start": "2023-11-09T14:00:00Z",
  "complete_at_end": "2023-11-09T22: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",
  "inserted_at": "2023-11-07T10:00:00Z",
  "updated_at": "2023-11-08T15:30:00Z"
}

PUT

api

shipments

{id}

{
  "order_number": "UPDATED-ORD-12345",
  "complete_at_start": "2023-11-09T09:00:00-05:00",
  "complete_at_end": "2023-11-09T17:00:00-05:00",
  "receiver": {
    "name": "Jane Doe Updated",
    "street": "789 New Street",
    "city": "Los Angeles",
    "state": "CA",
    "zip": "90001"
  },
  "update_reason": "Customer requested address change"
}

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "order_number": "UPDATED-ORD-12345",
  "shipment_type": "delivery",
  "shipment_date": "2023-11-09T10:00:00Z",
  "complete_at_start": "2023-11-09T14:00:00Z",
  "complete_at_end": "2023-11-09T22: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",
  "inserted_at": "2023-11-07T10:00:00Z",
  "updated_at": "2023-11-08T15:30:00Z"
}

Request Parameters

Path Parameters

string

required

The unique identifier of the shipment to update

Request Body

string

Order reference number

string

Date and time for the shipment in ISO 8601 format

string

Type of shipment. Must be one of: delivery, return, exchange

string

Start of pickup window in ISO 8601 format

string

End of pickup window in ISO 8601 format

string

UUID of the carrier service level

object

Shipper address information

Show properties

string

Shipper name

string

Street address

string

City

string

State/Province code

string

ZIP/Postal code

string

Country code (default: US)

string

Contact phone number

string

Contact email

object

Receiver address information

Show properties

string

Receiver name

string

Street address

string

City

string

State/Province code

string

ZIP/Postal code

string

Country code (default: US)

string

Contact phone number

string

Contact email

boolean

Is this a residential address? (default: false)

string

Reason for the update (for audit trail)

string

IANA timezone identifier (default: America/New_York)

string

URL to the shipping label

object

Additional metadata for the shipment

array

List of items in the shipment

Show item properties

number

Declared value of the item

number

Weight of the item

number

Length of the item

number

Width of the item

number

Height of the item

string

Unit for dimensions (in, cm)

string

Unit for weight (lb, kg)

string

Currency for the value (default: USD)

string

URL to item image

object

Additional item metadata

{
  "order_number": "UPDATED-ORD-12345",
  "complete_at_start": "2023-11-09T09:00:00-05:00",
  "complete_at_end": "2023-11-09T17:00:00-05:00",
  "receiver": {
    "name": "Jane Doe Updated",
    "street": "789 New Street",
    "city": "Los Angeles",
    "state": "CA",
    "zip": "90001"
  },
  "update_reason": "Customer requested address change"
}

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "order_number": "UPDATED-ORD-12345",
  "shipment_type": "delivery",
  "shipment_date": "2023-11-09T10:00:00Z",
  "complete_at_start": "2023-11-09T14:00:00Z",
  "complete_at_end": "2023-11-09T22: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",
  "inserted_at": "2023-11-07T10:00:00Z",
  "updated_at": "2023-11-08T15:30:00Z"
}

Shipments

Availability

Webhooks

Request Parameters

Path Parameters

Request Body

​Request Parameters

​Path Parameters

​Request Body

Request Parameters

Path Parameters

Request Body