GET https://api.fire.rest/api/v1/fire/external/stores/550e8400-e29b-41d4-a716-446655440000/orders?size=20
x-api-key: <sua_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
Listar pedidos da loja
Lista os pedidos de uma loja específica. Igual a Listar pedidos, restrito a uma loja por 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: <sua_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 }
}
A variante aninhada de Listar pedidos: a loja é identificada pelo
path param
{storeId} em vez de um filtro de query. Os demais query params — paginação, filtros e
projeção de campos — comportam-se da mesma forma.
O guard de tenant garante que um storeId de outro account/vendor retorne uma lista vazia — nunca
pedidos de outro tenant.
Autenticação
string
obrigatório
Sua API key do Fire com scope
orders:read. A key deve ser vendor-scoped — keys sem vendorId
são rejeitadas com 403.Path params
string
obrigatório
UUID da loja (
stores.id).Query params
O account e o vendor são derivados da sua API key (vendor-scoped) — não são enviados por query.
string
Projeção — veja Projeção de campos.
string
OPEN, COMPLETED, FORCE_CLOSED, CANCELLED.string
PENDING, SUCCEEDED, FAILED.string
Dia de negócio exato,
YYYY-MM-DD.string
Início do intervalo,
YYYY-MM-DD.string
Fim do intervalo,
YYYY-MM-DD.string
padrão:"business_day"
business_day ou created_at.string
padrão:"+00:00"
Offset de timezone para o modo
created_at.string
Código de canal.
string
Código de serviço de fulfillment.
string
Código de método de pagamento.
string
Match parcial sobre order code.
string
UUID exato, ou external order id / order code parcial.
integer
padrão:"1"
Número da página (base 1).
integer
padrão:"20"
Tamanho da página (1–100).
Requisição
GET https://api.fire.rest/api/v1/fire/external/stores/550e8400-e29b-41d4-a716-446655440000/orders?size=20
x-api-key: <sua_api_key>
Resposta
Mesmo formato de Listar pedidos:{ orders, pagination }.
Para ver como vai a cobrança de cada pedido, projete settlement — veja
Progresso da cobrança.
{
"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 }
}
Relacionado
Listar pedidos
Lista todos os pedidos do seu account e vendor.
Obter loja
Leia a loja à qual esta listagem pertence.