Marcas
Documentação
Marcas
Liste as marcas do restaurante e consulte sua identificação.
Listar marcas
GET /v1/brands?restaurant_id=2 exige brands:read via OAuth. Envie Authorization: Bearer <access_token>; uma sessão autenticada de restaurante também é aceita e permanece limitada ao restaurante assinado. Parceiros com vários restaurantes devem informar restaurant_id.
Retorna um array de todas as marcas não excluídas, incluindo inativas, ordenadas pela marca padrão primeiro, nome e ID. Credenciais fiscais e cursores de distribuição não são expostos.
Campos das marcas
| Campo | Tipo | Descrição |
|---|---|---|
id | integer | Identificador do registro na Takeat. |
restaurant_id | integer | Restaurante autorizado ao qual o registro pertence. |
identity | object | Identificação comercial e fiscal da marca. |
identity.name | string | Nome cadastrado. |
identity.fantasy_name | string / null | Nome fantasia. |
identity.cnpj | string / null | CNPJ preservado como texto, incluindo zeros à esquerda. |
status | object | Situação fiscal e disponibilidade do documento completo. |
status.active | boolean | Indica se a marca está ativa. Marcas inativas não excluídas também são retornadas. |
status.default | boolean | Indica a marca padrão do restaurante. |
image | object / null | Arquivo da imagem ou null; URL derivada como no legado. |
image.id | integer | Identificador do registro na Takeat. |
image.path | string | Caminho armazenado do arquivo. |
image.url | string | URL armazenada; na imagem, URL derivada usando a configuração de arquivos. |
timestamps | object | Datas do registro. A emissão do detalhe vem da Focus e pode manter seu offset. |
timestamps.created_at | string / null | Data de criação do registro local, em UTC. |
timestamps.updated_at | string / null | Data da última atualização local, em UTC. |
Consulte a referência do método. Use o ID da marca ao criar complementos e categorias ou consultar NF-e recebidas.