curl --request GET \
--url https://api.upwell.com/api/rest/shipments/{shipmentId}/documents{
"shipmentDocumentsByShipmentId": [
{
"createdAt": "<unknown>",
"documentId": "<string>",
"documents": [
{
"id": "<string>",
"sourceSystem": "<string>",
"sourceSystemId": "<string>",
"type": "<string>",
"visibleToCarrier": true,
"visibleToCustomer": true
}
],
"file": {
"filename": "<string>",
"id": "<string>",
"url": "<string>"
},
"id": "<string>",
"shipment": {
"id": "<string>",
"number": "<string>"
},
"updatedAt": "<unknown>"
}
]
}Query a list of shipment documents
curl --request GET \
--url https://api.upwell.com/api/rest/shipments/{shipmentId}/documents{
"shipmentDocumentsByShipmentId": [
{
"createdAt": "<unknown>",
"documentId": "<string>",
"documents": [
{
"id": "<string>",
"sourceSystem": "<string>",
"sourceSystemId": "<string>",
"type": "<string>",
"visibleToCarrier": true,
"visibleToCustomer": true
}
],
"file": {
"filename": "<string>",
"id": "<string>",
"url": "<string>"
},
"id": "<string>",
"shipment": {
"id": "<string>",
"number": "<string>"
},
"updatedAt": "<unknown>"
}
]
}Your API key will be used for authentication of the request. Authorization: YOUR_API_KEY
"shipmentId" is required (enter it either in parameters or request body)
Responses for GET /api/rest/shipments/{shipmentId}/documents
Show child attributes
The javascript Date as string. Type represents date and time as the ISO Date string.
Show child attributes
The javascript Date as string. Type represents date and time as the ISO Date string.