Skip to main content
GET
/
api
/
rest
/
shipments
/
{shipmentId}
/
documents
Get Many 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>"
    }
  ]
}

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)

Response

200 - application/json

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

shipmentDocumentsByShipmentId
ShipmentDocument Ā· object[]