Requires a Storefront API access token from Token
exchange.
Path parameters
Request
Response
The response wraps the order indata, including lines, customer, payment_intents, totals, and status fields.
Documentation Index
Fetch the complete documentation index at: /docs/llms.txt
Use this file to discover all available pages before exploring further.
{
"data": {
"id": "ord-48291",
"store_id": "downtown",
"channel_id": "app",
"fulfillment_id": "delivery",
"status": "OPEN",
"payment_status": "IDLE",
"fulfillment_status": "IDLE",
"lines": [],
"payment_intents": [
{
"id": "pi_card",
"status": "DRAFT",
"is_mixed": false,
"primary_tender_id": "tnd_card",
"tenders": [
{
"id": "tnd_card",
"sequence": 0,
"attempt_reference": "att_card_1",
"method": "CARD",
"provider": "kushki",
"collect_at": "DEVICE",
"status": "IDLE",
"allocation": null,
"amount": {
"currency": "USD",
"total": 14.94
}
}
]
}
],
"totals": {
"currency": "USD",
"total": 14.94
}
}
}
Retrieve a single customer order by external id.
| Parameter | Required | Description |
|---|---|---|
id | Yes | External order identifier |
curl "https://firespark.cloud/api/storefront/v1/orders/ord-48291" \
-H "Authorization: Bearer ACCESS_TOKEN"
data, including lines, customer, payment_intents, totals, and status fields.
| Field | Description |
|---|---|
status | OPEN, CLOSED, COMPLETED, VOIDED, REVERSED, REFUNDED, or CANCELLED (legacy; new cancels write VOIDED) |
payment_status | IDLE, PENDING, PAID, FAILED, CANCELLED, or REFUNDED. Derived from the live tenders. |
payment_intents | Intents for this order. Each has status (DRAFT, LOCKED, COMPLETED, ABANDONED), is_mixed, primary_tender_id, totals, and tenders[]. A tender has method, provider, collect_at, status, amount, allocation, and details. |
metadata.reopen | After reopen: as_order_id is this order’s replacement, from_order_id is the order it replaced. Both can be set along a chain. |
fulfillment_status | Kitchen and delivery progress (PREPARING, PREPARED, DELIVERING, DELIVERED, …) |
{
"data": {
"id": "ord-48291",
"store_id": "downtown",
"channel_id": "app",
"fulfillment_id": "delivery",
"status": "OPEN",
"payment_status": "IDLE",
"fulfillment_status": "IDLE",
"lines": [],
"payment_intents": [
{
"id": "pi_card",
"status": "DRAFT",
"is_mixed": false,
"primary_tender_id": "tnd_card",
"tenders": [
{
"id": "tnd_card",
"sequence": 0,
"attempt_reference": "att_card_1",
"method": "CARD",
"provider": "kushki",
"collect_at": "DEVICE",
"status": "IDLE",
"allocation": null,
"amount": {
"currency": "USD",
"total": 14.94
}
}
]
}
],
"totals": {
"currency": "USD",
"total": 14.94
}
}
}
| Status | Description |
|---|---|
401 | Missing or invalid access token |
404 | Order not found |