Skip to main content
PUT
/
v1
/
shipments
/
:id
curl --location --request PUT 'https://api.stateset.com/v1/shipments/ship_0901f083-aa1c-43c5-af5c-0a9d2fc64e30' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer YOUR_API_KEY' \
--data-raw '{
    "ship_date": "2024-01-21T08:00:00Z",
    "service_type": "express",
    "insurance": {
        "enabled": true,
        "amount": 20000
    }
}'

{
  "id": "ship_0901f083-aa1c-43c5-af5c-0a9d2fc64e30",
  "object": "shipment",
  "status": "label_created",
  "updated_at": "2024-01-19T16:00:00Z",
  "ship_date": "2024-01-21T08:00:00Z",
  "carrier": "ups",
  "service_type": "express",
  "rate": {
    "amount": 2850,
    "currency": "USD",
    "estimated_delivery_date": "2024-01-22T18:00:00Z"
  },
  "insurance": {
    "enabled": true,
    "amount": 20000,
    "currency": "USD"
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.stateset.com/llms.txt

Use this file to discover all available pages before exploring further.

This endpoint updates shipment details. Only shipments with status “label_created” can be modified. Once picked up, use the cancel endpoint to void.

​
Authentication

This endpoint requires a valid API key with shipments:write permissions. 
Authorization: Bearer YOUR_API_KEY

​
Path Parameters

​
id
string
required
The unique identifier of the shipment

​
Request Body

​
ship_date
string
New scheduled ship date (ISO 8601)
​
service_type
string
Updated service level
​
signature_required
boolean
Update signature requirement
​
saturday_delivery
boolean
Update Saturday delivery option
​
insurance
object
Update insurance options
​
reference_numbers
object
Update reference numbers
​
metadata
object
Update custom fields

​
Response

Returns the updated shipment object. 
curl --location --request PUT 'https://api.stateset.com/v1/shipments/ship_0901f083-aa1c-43c5-af5c-0a9d2fc64e30' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer YOUR_API_KEY' \
--data-raw '{
    "ship_date": "2024-01-21T08:00:00Z",
    "service_type": "express",
    "insurance": {
        "enabled": true,
        "amount": 20000
    }
}'

{
  "id": "ship_0901f083-aa1c-43c5-af5c-0a9d2fc64e30",
  "object": "shipment",
  "status": "label_created",
  "updated_at": "2024-01-19T16:00:00Z",
  "ship_date": "2024-01-21T08:00:00Z",
  "carrier": "ups",
  "service_type": "express",
  "rate": {
    "amount": 2850,
    "currency": "USD",
    "estimated_delivery_date": "2024-01-22T18:00:00Z"
  },
  "insurance": {
    "enabled": true,
    "amount": 20000,
    "currency": "USD"
  }
}