Skip to main content
POST
/
api
/
rest
/
shipments
/
{shipmentId}
/
documents
Create Shipment Document
curl --request POST \
  --url https://api.upwell.com/api/rest/shipments/{shipmentId}/documents \
  --header 'Content-Type: application/json' \
  --data '
{
  "input": {
    "base64": "<string>",
    "filename": "<string>",
    "mimeType": "<string>",
    "sourceSystem": "<string>",
    "sourceSystemId": "<string>",
    "type": "<string>",
    "visibleToCarrier": true,
    "visibleToCustomer": true
  },
  "shipmentId": "<string>"
}
'
{
  "createShipmentDocument": {
    "documentId": "<string>",
    "id": "<string>"
  }
}

Headers

authorization
string

Your API key will be used for authentication of the request. Authorization: YOUR_API_KEY

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
shipmentId
string

Response

200 - application/json

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

createShipmentDocument
ShipmentDocument Ā· object