Preview Template
POST/api/store-email-templates/preview
Previews a template with rendered variable substitutions. For bulk_purchase_order type, uses the bulk preview renderer.
settings:writeGrant this scope to your token under Settings → Developer → Personal Access Tokens.
Authentication: Requires Bearer token.
Body fields:
- id: Order or entity ID to use for variable substitution
- type: Template type (e.g. purchase_order, purchase_order_updated, bulk_purchase_order)
- subject: Subject line template string
- body: HTML body template string
- variables (optional): Boolean — if true, returns variable placeholders instead of rendered values
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.
Validation failed — the body is a field → messages map (Laravel shape) or the platform envelope with a stable machine-readable code. Fix the payload and resubmit.
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.