Skip to main content

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.

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​

Successful response