Preview PDF Template
POST/api/pdf-templates/:id/preview
Renders a preview of draft template content without saving it, using sample data.
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:
- content (required): the draft markup to render.
- format (optional):
pdf(default) returns a base64-encoded PDF indata.pdf;htmlreturns rendered markup indata.html. - sales_order_id (optional): render against a real sales order's data instead of sample data. Only applied for packing-slip templates; ignored for other types.
Invalid template markup returns a 422 with the offending line rather than a server error.
Request
Responses
- 200
- 401
- 403
- 404
- 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.
Not found — no record with the given identifier (or the route does not exist). Verify the ID before retrying.
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.