GET https://api.fire.rest/api/v1/fire/external/stores/550e8400-e29b-41d4-a716-446655440000/orders?size=20
x-api-key: <your_api_key>
{
"orders": [
{
"id": "7e2b8c10-1a2b-4c3d-8e9f-0a1b2c3d4e5f",
"orderCode": "OC-1024",
"storeId": "550e8400-e29b-41d4-a716-446655440000",
"status": "COMPLETED",
"paymentStatus": "SUCCEEDED",
"channel": "APP",
"businessDayDate": "2026-07-01",
"createdAt": "2026-07-01T14:03:00Z",
"updatedAt": "2026-07-01T14:20:00Z"
}
],
"pagination": { "page": 1, "size": 20, "total": 1, "totalPages": 1 }
}
API
List store orders
List the orders of a specific store. Same as List orders, scoped to one store by path.
GET
/
api
/
v1
/
fire
/
external
/
stores
/
{storeId}
/
orders
GET https://api.fire.rest/api/v1/fire/external/stores/550e8400-e29b-41d4-a716-446655440000/orders?size=20
x-api-key: <your_api_key>
{
"orders": [
{
"id": "7e2b8c10-1a2b-4c3d-8e9f-0a1b2c3d4e5f",
"orderCode": "OC-1024",
"storeId": "550e8400-e29b-41d4-a716-446655440000",
"status": "COMPLETED",
"paymentStatus": "SUCCEEDED",
"channel": "APP",
"businessDayDate": "2026-07-01",
"createdAt": "2026-07-01T14:03:00Z",
"updatedAt": "2026-07-01T14:20:00Z"
}
],
"pagination": { "page": 1, "size": 20, "total": 1, "totalPages": 1 }
}
The nested variant of List orders: the store is identified by the
{storeId} path parameter instead of a query filter. All other query parameters — pagination,
filters and field projection — behave the same.
The tenant guard guarantees that a storeId belonging to another account/vendor returns an empty
list — never another tenant’s orders.
Authentication
string
required
Your Fire API key with the
orders:read scope. The key must be vendor-scoped — keys without a
vendorId are rejected with 403.Path parameters
string
required
Store UUID (
stores.id).Query parameters
The account and vendor are derived from your API key (vendor-scoped) — you do not send them as query params.
string
Projection — see Field projection.
string
OPEN, COMPLETED, FORCE_CLOSED, CANCELLED.string
PENDING, SUCCEEDED, FAILED.string
Exact business day,
YYYY-MM-DD.string
Range start,
YYYY-MM-DD.string
Range end,
YYYY-MM-DD.string
default:"business_day"
business_day or created_at.string
default:"+00:00"
Timezone offset for
created_at mode.string
Channel code.
string
Fulfillment service code.
string
Payment method code.
string
Partial match on order code.
string
Exact UUID, or partial external order id / order code.
integer
default:"1"
Page number (1-based).
integer
default:"20"
Page size (1–100).
Request
GET https://api.fire.rest/api/v1/fire/external/stores/550e8400-e29b-41d4-a716-446655440000/orders?size=20
x-api-key: <your_api_key>
Response
Same shape as List orders:{ orders, pagination }.
To see how each order’s collection is going, project settlement — see
Payment progress.
{
"orders": [
{
"id": "7e2b8c10-1a2b-4c3d-8e9f-0a1b2c3d4e5f",
"orderCode": "OC-1024",
"storeId": "550e8400-e29b-41d4-a716-446655440000",
"status": "COMPLETED",
"paymentStatus": "SUCCEEDED",
"channel": "APP",
"businessDayDate": "2026-07-01",
"createdAt": "2026-07-01T14:03:00Z",
"updatedAt": "2026-07-01T14:20:00Z"
}
],
"pagination": { "page": 1, "size": 20, "total": 1, "totalPages": 1 }
}
Related
List orders
List all orders of your account and vendor.
Get store
Read the store this listing belongs to.