Saltar al contenido principal
Versión: 1.x

Receipt Data Reference

Every receipt template has access to a standardised data payload with 13 sections. Use {{section.field}} syntax in HTML and thermal templates.

All currency fields have a corresponding _display variant (e.g., grand_totalgrand_total_display) that contains a locale-aware formatted string like $12.50.

Display Convenience Fields

Line items, fees, and totals include convenience fields that automatically resolve to the tax-inclusive or tax-exclusive value based on your WooCommerce tax display setting:

Convenience fieldResolves to
unit_priceunit_price_incl or unit_price_excl
line_totalline_total_incl or line_total_excl
subtotalsubtotal_incl or subtotal_excl
grand_totalgrand_total_incl or grand_total_excl
unit_subtotalPre-coupon unit price (for showing original vs discounted)

Use these convenience fields in templates — they respect your store's tax display configuration automatically.

meta

Order metadata.

FieldTypeExample
meta.schema_versionstring"1.0.0"
meta.modestring"fiscal" or "live"
meta.created_atstring"2026-04-15T10:30:00"
meta.order_idnumber1234
meta.order_numberstring"1234"
meta.currencystring"USD"

store

Store information. In multi-store setups (Pro), this reflects the store the order was placed at.

FieldTypeExample
store.namestring"My Shop"
store.address_1string"123 Main St"
store.address_2string"Suite 100"
store.citystring"Portland"
store.statestring"OR"
store.postcodestring"97201"
store.countrystring"US"
store.tax_idstring"123-456-789"
store.phonestring"+1 555-0100"
store.emailstring"store@example.com"
store.logostringURL to store logo
store.opening_hoursstringFormatted opening hours

cashier

The user who processed the order.

FieldTypeExample
cashier.idnumber1
cashier.display_namestring"Jane Smith"

customer

Customer details. Empty for guest orders.

FieldTypeExample
customer.idnumber42
customer.first_namestring"John"
customer.last_namestring"Doe"
customer.billing.address_1string"456 Oak Ave"
customer.billing.citystring"Portland"
customer.billing.statestring"OR"
customer.billing.postcodestring"97201"
customer.billing.countrystring"US"
customer.billing.emailstring"john@example.com"
customer.billing.phonestring"+1 555-0200"
customer.shipping.*Same fields as billing
customer.tax_idstring"987-654-321"

lines

Array of line items. Loop with {{#lines}}...{{/lines}}.

FieldTypeDescription
namestringProduct name
quantitynumberQuantity ordered
skustringProduct SKU
unit_pricenumberUnit price (tax display aware)
unit_price_displaystringFormatted unit price
unit_price_inclnumberUnit price including tax
unit_price_exclnumberUnit price excluding tax
unit_subtotalnumberPre-coupon unit price
unit_subtotal_displaystringFormatted pre-coupon unit price
subtotalnumberLine subtotal before discounts
discountnumberDiscount amount
discount_displaystringFormatted discount
line_totalnumberLine total (tax display aware)
line_total_displaystringFormatted line total
line_total_inclnumberLine total including tax
line_total_exclnumberLine total excluding tax
tax_breakdownarrayPer-rate tax breakdown (same structure as tax_summary: code, rate, label, taxable, tax_amount, tax_amount_display)

fees

Array of fee items. Loop with {{#fees}}...{{/fees}}.

FieldTypeDescription
namestringFee name
total_inclnumberFee total including tax
total_exclnumberFee total excluding tax
total_incl_displaystringFormatted inclusive total
total_excl_displaystringFormatted exclusive total

shipping

Array of shipping items. Loop with {{#shipping}}...{{/shipping}}.

FieldTypeDescription
namestringShipping method name
total_inclnumberShipping total including tax
total_exclnumberShipping total excluding tax

discounts

Discount totals for the order.

FieldTypeDescription
discounts.total_inclnumberTotal discount including tax
discounts.total_exclnumberTotal discount excluding tax
discounts.total_incl_displaystringFormatted inclusive discount
discounts.total_excl_displaystringFormatted exclusive discount

totals

Order totals.

FieldTypeDescription
totals.subtotalnumberOrder subtotal
totals.subtotal_displaystringFormatted subtotal
totals.discount_total_inclnumberTotal discount including tax
totals.discount_total_exclnumberTotal discount excluding tax
totals.taxnumberTotal tax amount
totals.tax_displaystringFormatted tax
totals.grand_totalnumberGrand total (tax display aware)
totals.grand_total_displaystringFormatted grand total
totals.grand_total_inclnumberGrand total including tax
totals.grand_total_exclnumberGrand total excluding tax
totals.paid_totalnumberAmount paid
totals.paid_total_displaystringFormatted amount paid
totals.change_totalnumberChange given
totals.change_total_displaystringFormatted change

tax_summary

Array of per-rate tax breakdowns. Loop with {{#tax_summary}}...{{/tax_summary}}.

FieldTypeExample
codestring"US-OR-TAX-1"
ratenumber10
labelstring"Sales Tax"
taxablenumberTaxable amount
tax_amountnumberTax collected
tax_amount_displaystringFormatted tax amount

payments

Array of payment methods used. Loop with {{#payments}}...{{/payments}}.

FieldTypeDescription
methodstringPayment gateway ID
titlestringDisplay name (e.g., "Cash")
amountnumberAmount paid via this method
amount_displaystringFormatted amount
tenderednumberAmount tendered (cash payments)
tendered_displaystringFormatted tendered amount
changenumberChange given
change_displaystringFormatted change

fiscal

Fiscal compliance fields. Populated by Pro via the woocommerce_pos_fiscal_snapshot_enrich filter.

FieldTypeDescription
fiscal.immutable_idstringUnique fiscal receipt ID
fiscal.receipt_numberstringSequential receipt number
fiscal.sequencenumberSequence counter
fiscal.hashstringSHA-256 checksum
fiscal.qr_payloadstringQR code data
fiscal.tax_agency_codestringTax authority code
fiscal.signed_timestampstringSigned timestamp
fiscal.signature_excerptstringSignature excerpt for display
fiscal.document_labelstringDocument type label
fiscal.is_reprintbooleanWhether this is a reprint
fiscal.reprint_countnumberNumber of reprints
fiscal.extra_fieldsarrayCountry-specific label/value pairs

presentation_hints

Display configuration from WooCommerce settings.

FieldTypeDescription
presentation_hints.tax_displaystring"incl" or "excl"
presentation_hints.prices_entered_with_taxbooleanWhether catalogue prices include tax
presentation_hints.rounding_modestringTax rounding method
presentation_hints.localestringStore locale (e.g., "en-US")

i18n

Translatable labels. Use {{i18n.key}} in templates.

Common keys include: subtotal, tax, total, discount, quantity, price, date, order_number, cashier, customer, payment_method, change, tendered.