order_id but does not include the full payload, or when you need to reconcile state between Fire spark and your POS.
Requires an access token with the
orders:read scope. See
Token to obtain a token.Path parameters
| Parameter | Required | Description |
|---|---|---|
id | Yes | External order identifier from the webhook or channel. Alphanumeric characters, _, and - only. 1–64 characters. |
Request
curl "https://firespark.cloud/api/integrations/v1/orders/ord-48291" \
-H "Authorization: Bearer ACCESS_TOKEN"
Response
The response wraps the order object indata.
{
"data": {
"uid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
"id": "ord-48291",
"brand_id": "0001",
"store_id": "downtown",
"channel_id": "app",
"customer_id": "cust-001",
"is_anonymous": false,
"fulfillment_id": "delivery",
"status": "OPEN",
"payment_status": "IDLE",
"fulfillment_status": "PREPARING",
"lines": [],
"customer": {},
"payment_intents": [],
"totals": {
"currency": "USD",
"subtotal": 12.99,
"discount_rate": 0,
"discount_total": 0,
"tax_rate": 0.15,
"tax_total": 1.95,
"total": 14.94
},
"metadata": {},
"issued_at": "2026-06-17T14:31:45.000Z",
"resolved_at": null
}
}
Order object
| Field | Required | Type | Description |
|---|---|---|---|
uid | Yes | string (UUID) | Fire spark internal identifier |
id | Yes | string | External order identifier |
brand_id | No | string \ | null | External brand identifier when the order belongs to a brand |
store_id | Yes | string | External store where the order is prepared |
channel_id | Yes | string | External channel where the customer ordered |
customer_id | Yes | string | External customer identifier linked to the order |
is_anonymous | Yes | boolean | true when the customer checked out as a guest without a registered profile |
fulfillment_id | Yes | string | External fulfillment option selected |
lines | Yes | array | Line items with pricing, tax, modifier hierarchy, and per-line metadata |
customer | Yes | object | Customer, delivery address, and billing details |
payment_intents | Yes | array | Payment intents. Each has status (DRAFT, LOCKED, COMPLETED, ABANDONED), is_mixed, primary_tender_id, totals, and tenders[] (method, provider, collect_at, status, amount, allocation, details). Tender amount is { currency, total }: what that tender pays. |
redeem | Yes | array | Order redeems: reward_id, quantity, payment_id, amount, before_taxes, expires_at. amount is the discount shown, paid by the REDEMPTION tender of payment_id; totals stay full. |
totals | Yes | object | Order-level subtotal, tax, discount, and total |
metadata | No | object | Partner-specific metadata. Defaults to {}. After a successful INJECTING callback, includes order_authorization_id and injection_order_id. |
payment_status | Yes | string | IDLE | PENDING | PAID | FAILED | CANCELLED | REFUNDED |
fulfillment_status | Yes | string | Merchant fulfillment label (for example INJECTING, PREPARING). Not a fixed enum. |
status | Yes | string | OPEN | CLOSED | COMPLETED | VOIDED | REVERSED | REFUNDED | CANCELLED (legacy; new cancels write VOIDED) |
issued_at | No | string | ISO 8601 datetime when the order was placed. Optional. |
resolved_at | No | string | ISO 8601 datetime when the order reached a terminal state. Optional. |
lines
lines
Each entry in
lines represents a product, fee, or modifier row:| Field | Required | Type | Description |
|---|---|---|---|
type | Yes | string | PRODUCT or FEE |
uid | Yes | string (UUID) | Fire spark internal line identifier |
id | Yes | string | External product or modifier identifier |
parent_uid | Yes | string (UUID) | null | Parent line uid for nested modifiers. null for root lines. |
parent_id | Yes | string | null | Parent line external id for nested modifiers. null for root lines. |
name | Yes | string | Display name on the ticket |
image_url | No | string | Product image URL. Optional. |
menu_id | No | string | Menu the product was added from. Optional. |
internal_attribution_source | No | string | Free-text source (SEARCH, CATEGORY, UPSELL, CROSS_SELL, DOWNSELL, or custom). Optional. |
internal_attribution_id | No | string | Source-specific id (search, category id, recommendation id, or custom). Optional. |
metadata | No | object | Partner-specific data for this line. Defaults to {}. |
quantity | Yes | number | Units ordered. Minimum 1. |
tax_rate | Yes | number | Tax rate as a decimal (for example 0.15) |
discount_rate | Yes | number | Discount rate as a decimal |
unit_subtotal | Yes | number | Subtotal for one unit, excluding children |
unit_discount | Yes | number | Discount for one unit |
unit_tax_total | Yes | number | Tax for one unit |
unit_total | Yes | number | Total for one unit |
subtotal | Yes | number | Line subtotal for quantity, excluding children |
discount_total | Yes | number | Line discount total |
tax_total | Yes | number | Line tax total |
total | Yes | number | Line total for quantity |
unit_group_* | Yes | number | Same pricing fields including all child lines at quantity 1 |
group_* | Yes | number | Same pricing fields including all child lines for quantity |
redeem | No | array | Redeems for this root line, same shape as the order redeem. The line money stays full. |
On
order.status.changed, Fire spark
already sends this object in the webhook payload. Use GET only when you need
a fresh copy or missed the webhook body.Error responses
| Status | Description |
|---|---|
401 | Missing or invalid access token |
403 | Token does not include the orders:read scope |
404 | No order exists for this id |