Sign in

v1

latestOpenAPI 3.1.02026-07-2296226496.3 KB
Order

Get order documents

Retrieve documents associated with an order such as shipping labels or proof of delivery. Set load_data=true to include the document content in the response.

get/v1/order/{id}/documents

Path parameters

idstring required

Unique reference number for the order: either order.id (starts with "ord_") or order.externalId

Example:ord_1234567890

Unique reference number for the order: either order.id (starts with "ord_") or order.externalId

Query parameters

loadDataboolean required

Whether to load the document data and return it as part of the response.

Whether to load the document data and return it as part of the response.

Response

OK

createdAtstring date-time required

The date and time when the document was created

idstring required

The id of the document

type'shipping_label' | 'pickup_label' | 'manifest' | 'packing_slip_label' | 'proof_of_delivery' required
contentTypestring required

The content type of the document

urlstring nullable

The URL of the document

datastring nullable

The data of the document

Example response

[
  {
    "createdAt": "2023-08-29T19:17:46.264523",
    "id": "doc_1234567890",
    "contentType": "application/pdf",
    "url": "https://example.com/document.pdf",
    "data": "SGVsbG8gd29ybG="
  }
]