Skip to content

Update a Shipment

POST /api/v1.0/orders/{order_id}/shipments/{shipment_id}
Try it out ↗

Update Shipment State

Updates shipment carrier, tracking number, tracking url, state and corresponding timestamps. Carrier, tracking number and tracking url cannot be updated after the shipment is shipped. Shipment cannot be canceled after it's shipped. Timestamps are required based on the state provided: 'shipped' requires 'shipped_at' and 'expected_to_deliver_at', 'delivered' requires 'delivered_at', 'canceled' requires 'canceled_at'.

Path Parameters

order_id integer required

shipment_id integer required

Request Headers

X-Thredup-Access-Token string required

Authentication token

Request Body

carrier string optional

tracking_number string optional

tracking_url string optional

state string required

shipped_at string optional

UTC ISO8601 Timestamp when the shipment was shipped

expected_to_deliver_at string optional

UTC ISO8601 Timestamp of when the shipment is expected to be delivered

delivered_at string optional

UTC ISO8601 Timestamp when the shipment was delivered

canceled_at string optional

UTC ISO8601 Timestamp when the shipment was canceled

Example Request Body
{
  "carrier": "USPS",
  "tracking_number": "DHL987654321",
  "tracking_url": "https://tracking.example.com/FDX123456789012",
  "state": "packed",
  "shipped_at": "2023-01-05T10:00:00Z",
  "expected_to_deliver_at": "2023-01-10T12:00:00Z",
  "delivered_at": "2023-01-09T09:00:00Z",
  "canceled_at": "2023-01-02T19:00:00Z"
}

Responses

Order shipment updated

No response body

This endpoint returns no response body for current status code.

Unauthorized

No response body

This endpoint returns no response body for current status code.

Unprocessable entity

No response body

This endpoint returns no response body for current status code.