Listar marcas - Fire spark

{
  "data": [
    {
      "id": "0001",
      "uid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "merchant_id": "c1d2e3f4-a5b6-7890-cdef-123456789abc",
      "name": "Burger Co.",
      "status": "ACTIVE",
      "cms_template_id": "d4e5f6a7-b8c9-0123-def4-567890abcdef",
      "cms": {
        "id": "d4e5f6a7-b8c9-0123-def4-567890abcdef",
        "name": "Landing de marca",
        "entity": "BRANDS",
        "status": "ACTIVE",
        "fields": [
          {
            "name": "tagline",
            "type": "TEXT",
            "label": { "en_us": "Eslogan" },
            "required": false,
            "value": "A la parrilla desde 1987"
          }
        ]
      }
    }
  ]
}

Devuelve todas las marcas activas configuradas para el comercio autenticado. Usa este endpoint para mapear marcas de Fire spark con conceptos en tu POS o RMS antes de filtrar tiendas y menús con brand_id.

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

Solicitud

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

Respuesta

La respuesta envuelve un arreglo de marcas en data. Solo se incluyen marcas ACTIVE.

{
  "data": [
    {
      "id": "0001",
      "uid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "merchant_id": "c1d2e3f4-a5b6-7890-cdef-123456789abc",
      "name": "Burger Co.",
      "status": "ACTIVE",
      "cms_template_id": "d4e5f6a7-b8c9-0123-def4-567890abcdef",
      "cms": {
        "id": "d4e5f6a7-b8c9-0123-def4-567890abcdef",
        "name": "Landing de marca",
        "entity": "BRANDS",
        "status": "ACTIVE",
        "fields": [
          {
            "name": "tagline",
            "type": "TEXT",
            "label": { "en_us": "Eslogan" },
            "required": false,
            "value": "A la parrilla desde 1987"
          }
        ]
      }
    }
  ]
}

Objeto brand

Campo	Tipo	Descripción
`id`	string	Identificador externo de la marca. Caracteres alfanuméricos, `_` y `-`. 1–64 caracteres. Usa este valor en `brand_id` al filtrar tiendas y menús.
`uid`	string (UUID)	Identificador interno de Fire spark.
`merchant_id`	string (UUID)	Identificador de comercio en Fire spark.
`name`	string	Nombre visible. 1–100 caracteres.
`status`	string	`ACTIVE` o `INACTIVE`.
`cms_template_id`	string (UUID)	Plantilla CMS vinculada. `null` si no hay plantilla asignada.
`cms`	object	Solo lectura. `null` cuando `cms_template_id` es `null`. Plantilla CMS resuelta para la marca.

Errores

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