Order API

the orders endpoint in our public rest api returns detailed information about each order placed at your store this includes order status, customer information, payment details, item data, and timestamps below is a breakdown of the key fields and what they mean included in this response is an attribution field this allows for you to add an ?attr= parameter to your url shopping expierence and to pull these values via rest api we will update the attribution property in the response to include whatever attr was based on the menus 🧾 order overview field description id unique identifier for the order (internal id) orderid numeric identifier visible to customers created timestamp when the order was created (iso 8601 format) modified timestamp of the last modification status high level order status (e g , cancelled, pending, completed) substatus additional status detail (e g , packed, ready) statuschangedon when the status was last updated substatuschangedon when the sub status was last updated confirmed boolean indicating if the order has been confirmed cancelled boolean indicating if the order has been cancelled cancelledon timestamp of cancellation cancelledby who cancelled the order (store, pos or customer) printed boolean indicating if a receipt was printed fullfilled boolean indicating if the order was fulfilled 👤 customer details field description name, firstname, lastname customer’s full name email, phone customer’s contact info birthday, birthdayday, birthdaymonth, birthdayyear customer’s birth date and parsed values idphotourl url to the uploaded id image user internal user id (platform specific) customer internal customer id 💳 medical information field description medicalid medical id number provided by the patient medicalexpiration date when the medical id expires 💰 pricing breakdown field description subtotal pre tax, pre discount total subtotalwithoutdiscounts same as above (useful if discounts are applied later) tax, totaltax total tax value taxpercent combined tax rate (as a decimal) taxes array of tax breakdowns by name, rate, and amount fees array of applicable fees (empty in this example) feetotal sum of all fees discounts, discounttotal list and total value of applied discounts discountsrejected discounts attempted but not applied tipamount any optional tip included total final total including all charges and discounts items an array of items in the order containing full product details 🔗 related ids field description venue id of the store where order was placed organization id of the larger org the venue belongs to attribution (optional) source or marketing attribution 🧠 tips timestamps are in iso 8601 utc format always check the status and cancelled fields to determine current state prices are returned in usd unless otherwise specified via currencycode