GET https://api.fire.rest/api/v1/fire/external/stores/550e8400-e29b-41d4-a716-446655440000/terminals?type=KIOSK,POS
x-api-key: <your_api_key>
{
"terminals": [
{
"id": "8d0f6b1e-3c2a-4f57-9a61-0e2d4b7c9a10",
"storeId": "550e8400-e29b-41d4-a716-446655440000",
"name": "Caixa 1",
"type": "POS",
"status": "ACTIVE",
"externalId": null,
"lastSeenAt": "2026-10-06T15:02:11Z",
"createdAt": "2026-09-01T10:00:00Z"
},
{
"id": "2b7e4a90-61d3-4c0e-8f2b-7a5c1d9e3f44",
"storeId": "550e8400-e29b-41d4-a716-446655440000",
"name": "Quiosque Entrada",
"type": "KIOSK",
"status": "ACTIVE",
"externalId": "K082-94",
"lastSeenAt": "2026-10-06T14:58:40Z",
"createdAt": "2026-09-03T12:30:00Z"
}
],
"total": 2
}
{
"success": false,
"error": "VALIDATION_ERROR",
"message": "Datos de entrada inválidos",
"details": [
{ "code": "custom", "path": ["status"], "message": "Invalid status: BROKEN. Allowed: ACTIVE, SUSPENDED, REVOKED" }
]
}
{
"success": false,
"error": "NOT_FOUND",
"message": "Store not found with ID 550e8400-e29b-41d4-a716-446655440000"
}
API
Listar terminais de uma loja
Lista os caixas POS, quiosques e telas de cozinha registrados em uma loja, com o status atual.
GET
/
api
/
v1
/
fire
/
external
/
stores
/
{storeId}
/
terminals
GET https://api.fire.rest/api/v1/fire/external/stores/550e8400-e29b-41d4-a716-446655440000/terminals?type=KIOSK,POS
x-api-key: <your_api_key>
{
"terminals": [
{
"id": "8d0f6b1e-3c2a-4f57-9a61-0e2d4b7c9a10",
"storeId": "550e8400-e29b-41d4-a716-446655440000",
"name": "Caixa 1",
"type": "POS",
"status": "ACTIVE",
"externalId": null,
"lastSeenAt": "2026-10-06T15:02:11Z",
"createdAt": "2026-09-01T10:00:00Z"
},
{
"id": "2b7e4a90-61d3-4c0e-8f2b-7a5c1d9e3f44",
"storeId": "550e8400-e29b-41d4-a716-446655440000",
"name": "Quiosque Entrada",
"type": "KIOSK",
"status": "ACTIVE",
"externalId": "K082-94",
"lastSeenAt": "2026-10-06T14:58:40Z",
"createdAt": "2026-09-03T12:30:00Z"
}
],
"total": 2
}
{
"success": false,
"error": "VALIDATION_ERROR",
"message": "Datos de entrada inválidos",
"details": [
{ "code": "custom", "path": ["status"], "message": "Invalid status: BROKEN. Allowed: ACTIVE, SUSPENDED, REVOKED" }
]
}
{
"success": false,
"error": "NOT_FOUND",
"message": "Store not found with ID 550e8400-e29b-41d4-a716-446655440000"
}
Retorna os terminais registrados em uma loja: caixas POS, quiosques de autoatendimento e
telas de cozinha KDS. Por padrão, retorna o que a loja tem habilitado hoje, ou seja, terminais
ativos e suspensos. Os revogados só vêm se você pedir com
status.
Se a loja não existir ou pertencer a outro tenant, a resposta é 404 (nunca se revela se ela
existe em outro tenant).
Autenticação
string
obrigatório
Sua API key do Fire com o scope
store:read. A key deve estar vinculada a um vendor. Keys
sem vendorId são rejeitadas com 403.Path params
string
obrigatório
UUID da loja (
stores.id).Query params
string
Tipos de terminal separados por vírgula:
POS, KIOSK, KDS. Se omitido, retorna os três.string
padrão:"ACTIVE,SUSPENDED"
Status separados por vírgula:
ACTIVE, SUSPENDED, REVOKED.string
Lista de campos a retornar, separados por vírgula (projection). Veja
Projeção de campos. Se omitido, retorna
todos os campos.
Requisição
GET https://api.fire.rest/api/v1/fire/external/stores/550e8400-e29b-41d4-a716-446655440000/terminals?type=KIOSK,POS
x-api-key: <your_api_key>
Resposta
object[]
Mostrar terminal
Mostrar terminal
string
UUID do terminal.
string
UUID da loja.
string
Nome exibido do terminal.
string
POS, KIOSK ou KDS.string
ACTIVE operando, SUSPENDED pausado por um administrador, REVOKED desativado.string | null
Identificador externo do equipamento. Em quiosques, o device ID exibido na tela QR.
null em POS e KDS.string | null
Última vez que o terminal se comunicou com o Fire (ISO 8601).
null se nunca se conectou.string
Quando o terminal foi registrado (ISO 8601).
number
Quantidade de terminais retornados.
{
"terminals": [
{
"id": "8d0f6b1e-3c2a-4f57-9a61-0e2d4b7c9a10",
"storeId": "550e8400-e29b-41d4-a716-446655440000",
"name": "Caixa 1",
"type": "POS",
"status": "ACTIVE",
"externalId": null,
"lastSeenAt": "2026-10-06T15:02:11Z",
"createdAt": "2026-09-01T10:00:00Z"
},
{
"id": "2b7e4a90-61d3-4c0e-8f2b-7a5c1d9e3f44",
"storeId": "550e8400-e29b-41d4-a716-446655440000",
"name": "Quiosque Entrada",
"type": "KIOSK",
"status": "ACTIVE",
"externalId": "K082-94",
"lastSeenAt": "2026-10-06T14:58:40Z",
"createdAt": "2026-09-03T12:30:00Z"
}
],
"total": 2
}
{
"success": false,
"error": "VALIDATION_ERROR",
"message": "Datos de entrada inválidos",
"details": [
{ "code": "custom", "path": ["status"], "message": "Invalid status: BROKEN. Allowed: ACTIVE, SUSPENDED, REVOKED" }
]
}
{
"success": false,
"error": "NOT_FOUND",
"message": "Store not found with ID 550e8400-e29b-41d4-a716-446655440000"
}
Relacionado
Obter loja
Leia a configuração completa da loja.
Administração de terminais
Suspenda, reative ou revogue terminais pelo backoffice.