Create a Shipment

This endpoint can be used to create a shipment for an order.

Endpoint details

POST /api/v1.0/orders/{id}/shipments

Try it out ↗

Create Order Shipment

Creates shipment in packed state for the specified order.

Path Parameters

id integer required

Order id

Request Headers

X-Thredup-Access-Token string required

Authentication token

Request Body

carrier string optional

tracking_number string optional

tracking_url string optional

warehouse_id integer required

order_line_ids array[integer] required

packed_at string required

UTC ISO8601 Timestamp when the shipment was packed

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

Example Request Body

{
  "carrier": "USPS",
  "tracking_number": "1Z999AA1234567890",
  "tracking_url": "https://tracking.example.com/CP123456789US",
  "warehouse_id": 5770,
  "order_line_ids": [
    100
  ],
  "packed_at": "2023-01-10T12:00:00Z",
  "shipped_at": "2023-01-05T10:00:00Z",
  "expected_to_deliver_at": "2023-01-10T12:00:00Z"
}

Responses

201 Created401 Unauthorized422 Unprocessable Entity

Order shipment saved

Returns a OrderShipmentCreateResponse object.

Example Response Body

{
  "id": 5163
}

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.