Skip to main content
POST
Create Shipment Document

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.

Path Parameters

shipmentId
string
required

"shipmentId" is required (enter it either in parameters or request body)

Body

application/json

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

input
CreateShipmentDocumentInput · object

Object containing the fields to create or update. Only the fields in this endpoint schema are accepted.

shipmentId
string

Shipment identifier. On a shipment record this is the source load/shipment number; on invoiceShipments it is the Upwell shipment id (shi_…).

Response

Responses for POST /api/rest/shipments/{shipmentId}/documents

createShipmentDocument
ShipmentDocument · object

Create shipment document. See the schema for its JSON type and allowed values.