Skip to main content
GET
/
api
/
rest
/
carrier_invoices
/
{carrierInvoiceId}
/
documents
Get Many Carrier Invoice Documents
curl --request GET \
  --url https://api.upwell.com/api/rest/carrier_invoices/{carrierInvoiceId}/documents
{
  "carrierInvoiceDocumentsByCarrierInvoiceId": [
    {
      "carrierInvoiceId": "<string>",
      "createdAt": "<unknown>",
      "documentId": "<string>",
      "filename": "<string>",
      "id": "<string>",
      "isPod": true,
      "sourceSystem": "<string>",
      "sourceSystemId": "<string>",
      "type": "<string>",
      "updatedAt": "<unknown>",
      "uploadToTms": true,
      "url": "<string>"
    }
  ]
}

Headers

authorization
string

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

Path Parameters

carrierInvoiceId
string
required

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

Response

200 - application/json

Responses for GET /api/rest/carrier_invoices/{carrierInvoiceId}/documents

carrierInvoiceDocumentsByCarrierInvoiceId
CarrierInvoiceDocument · object[]