Listar canales

Devuelve todos los canales configurados para el comercio autenticado. Usa este endpoint para mapear canales de Fire spark con superficies de pedido en tu POS o RMS antes de sincronizar menús y enrutar pedidos.

Requiere un access token con el scope channels:read. Consulta Token para obtener un token.

Solicitud

curl "https://firespark.cloud/api/integrations/v1/channels" \
  -H "Authorization: Bearer ACCESS_TOKEN"

Respuesta

La respuesta envuelve un arreglo de canales en data. Cada canal representa una superficie de venta — canales propios como app o web, o agregadores como Uber Eats.

{
  "data": [
    {
      "id": "app",
      "uid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "merchant_id": "c1d2e3f4-a5b6-7890-cdef-123456789abc",
      "name": "App móvil",
      "type": "APP",
      "status": "ACTIVE",
      "cms_template_id": "d4e5f6a7-b8c9-0123-def4-567890abcdef",
      "cms": {
        "id": "d4e5f6a7-b8c9-0123-def4-567890abcdef",
        "name": "Landing de la app",
        "entity": "CHANNELS",
        "status": "ACTIVE",
        "fields": [
          {
            "name": "hero_title",
            "type": "TEXT",
            "label": { "en_us": "Título principal" },
            "required": true,
            "value": "Pide desde nuestra app"
          }
        ]
      }
    },
    {
      "id": "uber-eats",
      "uid": "b2c3d4e5-f6a7-8901-bcde-f12345678901",
      "merchant_id": "c1d2e3f4-a5b6-7890-cdef-123456789abc",
      "name": "Uber Eats",
      "type": "AGGREGATOR",
      "status": "ACTIVE",
      "cms_template_id": null,
      "cms": null
    }
  ]
}

Objeto channel

Campo	Tipo	Descripción
`id`	string	Identificador externo del canal. Solo alfanuméricos, `_` y `-`. 1–64 caracteres. Único por comercio.
`uid`	string (UUID)	Identificador interno de Fire spark.
`merchant_id`	string (UUID)	Comercio al que pertenece el canal.
`name`	string	Nombre visible. 1–100 caracteres.
`type`	string	Superficie del canal. Uno de `APP`, `WEB`, `KIOSK`, `POS`, `CALL_CENTER` o `AGGREGATOR`. Se define al crear; no puede cambiar.
`status`	string	`ACTIVE` o `INACTIVE`.
`cms_template_id`	string (UUID)	Plantilla CMS vinculada al canal. `null` si no hay plantilla asignada.
`cms`	object	Solo lectura. `null` cuando `cms_template_id` es `null`. Plantilla CMS resuelta para este canal.

cms

Presente solo cuando cms_template_id no es null. Contiene la plantilla CMS asignada al canal.

Campo	Requerido	Tipo	Descripción
`id`	Sí	string (UUID)	Identificador de la plantilla. Coincide con `cms_template_id`.
`name`	Sí	string	Nombre de la plantilla. 1–100 caracteres.
`entity`	Sí	string	Siempre `CHANNELS` en respuestas de canales.
`status`	Sí	string	`ACTIVE` o `INACTIVE`.
`fields`	Sí	array	Campos de la plantilla con sus valores almacenados.

Cada campo en fields:

Campo	Requerido	Tipo	Descripción
`name`	Sí	string	Clave del campo.
`type`	Sí	string	`TEXT`, `SELECT`, `IMAGE` o `LIST`.
`label`	No	object	Etiqueta localizada por locale.
`required`	No	boolean	Si el campo es obligatorio.
`placeholder`	No	string	Texto placeholder opcional.
`options`	No	array	Para campos `SELECT` — objetos con `label` y `value`.
`altText`	No	string	Para campos `IMAGE` — texto alternativo.
`src`	No	string	Para campos `IMAGE` — URL de la imagen.
`href`	No	string	Para campos `IMAGE` — URL de enlace opcional.
`value`	No	varies	Valor almacenado para este canal. Omitido si está vacío.

Mapear canales con tu POS

Relaciona el campo id con el identificador de canal en tu POS o RMS. Fire spark usa este ID externo al componer menús y enrutar pedidos por superficie.

Los valores uid del canal son identificadores estables de Fire spark. Usa id para mapeo entre sistemas y uid al referenciar canales en otras llamadas a la API de Fire spark.

Respuestas de error

Estado	Descripción
`401`	Access token ausente o inválido.
`403`	El token no incluye el scope `channels:read`.

Documentación de API

Endpoints

Guías

Recursos

Solicitud

Respuesta

Objeto channel

Mapear canales con tu POS

Respuestas de error

​Solicitud

​Respuesta

​Objeto channel

​Mapear canales con tu POS

​Respuestas de error

Solicitud

Respuesta

Objeto channel

Mapear canales con tu POS

Respuestas de error