Preview Packing Slip for a Sales Order
POST/api/pdf-templates/preview-sales-order
Renders the saved packing-slip template against a real sales order and returns a base64-encoded PDF in data.pdf.
This endpoint currently requires session authentication; Personal Access Token scope support is in progress.
Authentication: Bearer Personal Access Token with the settings scope (read access).
Fields:
- sales_order_id (required): the sales order to render.
Request
Responses
- 200
- 401
- 403
- 422
- 429
OK
Response Headers
Unauthenticated — the bearer token is missing, revoked, expired, or malformed. Never retry automatically; fix the credential. See the Errors guide.
Forbidden — the token lacks a required scope, the endpoint is not available to API tokens, or the user behind the token lacks the permission. A human must adjust the token scopes or user permissions; do not retry.
Unprocessable Entity
Response Headers
Rate limited — platform limit is 1,000 requests/min; individual tokens may carry lower limits. Honor the Retry-After header before retrying. See the Rate Limits guide.