Skip to content

API reference · Schema

StorefrontOrderPlaced

StorefrontOrderPlacedcontract storefront.order.placed

order_idUuid7required
statusenum (7)required
placedacceptedrejectedpreparingreadycompletedcancelled
ticket_nointegerrequired
≥ 1≤ 9007199254740991
total_minorintegerrequired
≥ -9007199254740991≤ 9007199254740991
tax_minorintegerrequired
≥ -9007199254740991≤ 9007199254740991
prices_include_taxboolean | nullrequired
currencystringrequired
pattern ^[A-Z]{3}$
promised_atIsoDatetime | nullrequired
pay_at_counterconst truerequired
guest_access_tokenstring | nullrequired

Used by

post/v1/storefront/ordersGuest or signed-in checkout in one transaction; pay at the counter. A refusal's 409 / 422 body carries `params`