Saltar para o conteúdo principal
GET
/
api
/
v1
/
external
/
channels
/
config
GET https://app.fire.rest/api/v1/external/channels/config
x-api-key: <sua_api_key>

{
  "accountId": "550e8400-e29b-41d4-a716-446655440000",
  "countries": [
    {
      "countryCode": "EC",
      "vendors": [
        {
          "vendorId": "100.1.10",
          "vendorName": "Sandbox Ecuador",
          "channels": [
            {
              "uuid": "9f3a-...-e1",
              "code": "APP",
              "name": "App Móvel",
              "description": "Canal de venda por aplicativo móvel",
              "enabled": true,
              "fulfillmentTypes": [
                {
                  "uuid": "abcf-...-2d",
                  "code": "DELIVERY",
                  "name": "Delivery",
                  "referenceName": "DELIVERY",
                  "description": null,
                  "enabled": true
                }
              ]
            },
            {
              "uuid": "7e2b-...-c8",
              "code": "KIOSK",
              "name": "Quiosque",
              "description": null,
              "enabled": true,
              "fulfillmentTypes": []
            }
          ]
        }
      ]
    }
  ]
}
Retorna a configuração completa de canais de venda para o vendor vinculado à sua API key, enriquecida com dados do catálogo global (uuid, name, description) e os tipos de fulfillment configurados para cada canal. O endpoint não aceita query params — accountId e vendorId são derivados da API key. Apenas canais com enabled !== false são retornados. Canais do JSONB do account sem match no catálogo são excluídos da resposta.

​
Autenticação

​
x-api-key
string
obrigatório
Sua API key do Fire com scope channels:read. A key deve ser vendor-scoped (binding account + vendor) — keys sem vendorId são rejeitadas com 403.

​
Requisição

GET https://app.fire.rest/api/v1/external/channels/config
x-api-key: <sua_api_key>

​
Resposta

​
accountId
string
UUID do account ao qual a API key pertence.
​
countries
object[]
{
  "accountId": "550e8400-e29b-41d4-a716-446655440000",
  "countries": [
    {
      "countryCode": "EC",
      "vendors": [
        {
          "vendorId": "100.1.10",
          "vendorName": "Sandbox Ecuador",
          "channels": [
            {
              "uuid": "9f3a-...-e1",
              "code": "APP",
              "name": "App Móvel",
              "description": "Canal de venda por aplicativo móvel",
              "enabled": true,
              "fulfillmentTypes": [
                {
                  "uuid": "abcf-...-2d",
                  "code": "DELIVERY",
                  "name": "Delivery",
                  "referenceName": "DELIVERY",
                  "description": null,
                  "enabled": true
                }
              ]
            },
            {
              "uuid": "7e2b-...-c8",
              "code": "KIOSK",
              "name": "Quiosque",
              "description": null,
              "enabled": true,
              "fulfillmentTypes": []
            }
          ]
        }
      ]
    }
  ]
}

​
Notas

  • uuid vem do catálogo global de channels, não do JSONB por account.
  • fulfillmentTypes inclui apenas os tipos configurados para esse canal no vendor. Tipos sem match no catálogo são excluídos.
  • countries agrupa pelo código de país do JSONB. Um vendor pode aparecer em múltiplos países se tiver configuração por país.

​
Relacionados

Configuração de métodos de pagamento

Endpoint companion para ler os métodos de pagamento configurados.

Autenticação

Como funcionam as API keys vendor-scoped e os scopes.