Skip to main content
POST
Create One Shipment
Not retry-safe (400 Uniqueness violation on a duplicate external key), and shipmentId is required with no server default. See Idempotency & retries.

Authorizations

Authorization
string
header
required

Your API key, sent in the Authorization header: Authorization: YOUR_API_KEY. A Bearer prefix is also accepted (Authorization: Bearer YOUR_API_KEY). Keys are created in the Upwell dashboard (Account → API keys) and are scoped to one organization.

Body

application/json

Query parameters can also be provided in the request body as a JSON object

input
ShipmentsInsertInput · object

input type for inserting data into table "shipments"

Response

Responses for POST /api/rest/shipments

createShipment
Shipments · object | null

columns and relationships of "shipments"