Saltar al contenido principal
GET
/
api
/
v1
/
external
/
channels
/
config
GET https://app.fire.rest/api/v1/external/channels/config
x-api-key: <tu_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óvil",
              "description": "Canal de venta por aplicación móvil",
              "enabled": true,
              "fulfillmentTypes": [
                {
                  "uuid": "abcf-...-2d",
                  "code": "DELIVERY",
                  "name": "Delivery",
                  "referenceName": "DELIVERY",
                  "description": null,
                  "enabled": true
                }
              ]
            },
            {
              "uuid": "7e2b-...-c8",
              "code": "KIOSK",
              "name": "Kiosco",
              "description": null,
              "enabled": true,
              "fulfillmentTypes": []
            }
          ]
        }
      ]
    }
  ]
}
Devuelve la configuración completa de canales de venta para el vendor asociado a tu API key, enriquecida con datos del catálogo global (uuid, name, description) y los tipos de fulfillment configurados para cada canal. El endpoint no acepta query params — accountId y vendorId se derivan de la API key. Solo retorna canales con enabled !== false. Los canales del JSONB del account que no tengan match en el catálogo se excluyen de la respuesta.

​
Autenticación

​
x-api-key
string
requerido
Tu API key de Fire con scope channels:read. La key debe ser vendor-scoped (binding account + vendor) — las keys sin vendorId se rechazan con 403.

​
Petición

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

​
Respuesta

​
accountId
string
UUID del account al que pertenece la API key.
​
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óvil",
              "description": "Canal de venta por aplicación móvil",
              "enabled": true,
              "fulfillmentTypes": [
                {
                  "uuid": "abcf-...-2d",
                  "code": "DELIVERY",
                  "name": "Delivery",
                  "referenceName": "DELIVERY",
                  "description": null,
                  "enabled": true
                }
              ]
            },
            {
              "uuid": "7e2b-...-c8",
              "code": "KIOSK",
              "name": "Kiosco",
              "description": null,
              "enabled": true,
              "fulfillmentTypes": []
            }
          ]
        }
      ]
    }
  ]
}

​
Notas

  • uuid viene del catálogo global de channels, no del JSONB por account.
  • fulfillmentTypes solo incluye los tipos configurados para ese canal en el vendor. Tipos sin match en el catálogo se excluyen.
  • countries agrupa por código de país del JSONB. Un vendor puede aparecer en múltiples países si tiene configuración por país.

​
Relacionado

Configuración de métodos de pago

Endpoint companion para leer los métodos de pago configurados.

Autenticación

Cómo funcionan las API keys vendor-scoped y los scopes.