How to Use 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
Need Help?
If you need assistance, reach out to AIQ Support anytime via chat widget within your AIQ Dashboard.