Download PDF
Download a generated PDF document for a specific sales order.
Endpoint
GET /sales-orders/{{salesOrderId}}
Authentication
X-API-Key (passed in the Authorization header)
Request Parameters
Path Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
salesOrderId | string | Yes | The unique identifier of the sales order to download the PDF for. |
Query Parameters
| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
format | string | No | — | The PDF format to download. Should match the format used when generating. |
download | boolean | No | false | Set to true to force download as an attachment. |
Request Headers
| Header | Value | Required | Description |
|---|---|---|---|
Authorization | X-API-Key: {{apiKey}} | Yes | X-API-Key for authentication. |
Example Request
curl -X GET "https://api.example.com/sales-orders/{{salesOrderId}}?download=true" \
-H "X-API-Key: {{apiKey}}" \
--output sales-order.pdf
Request Schema
No request body is required for this endpoint.