BackchannelDocumentos
🇺🇸 English🇧🇷 Português
Contato
Sistema/Marcas

Marcas

O objeto Brand é a raiz da sua hierarquia multilocatário. Cada marca gerencia seu próprio estoque, lógica de atendimento e endpoints de ERP.

Hierarquia de Marcas

Uma única Organização pode ter várias Marcas. Cada Marca atua como um sandbox isolado para estoque e pedidos.

Organização
Marca A
Marca B

O Objeto Marca

Referência detalhada para todos os campos na entidade de marca.

Perfil e Categoria

FieldTypeDescription
idRequired
string

Identificador único da marca. Prefixado com 'brand_'.

Example: brand_01JGK9
nameRequired
string

Nome legal oficial da unidade de negócios.

Example: Nike Brasil
slug
string

Identificador amigável para URLs e roteamento de front-end.

Example: nike-brasil
category
enum

Vertical de negócios: 'fashion', 'electronics', 'food'.

Example: fashion

Configuração de ERP

FieldTypeDescription
erp_provider
enum

O tipo de sistema de back-end conectado. Valores: 'sap', 'linx', 'oracle', 'netsuite'.

Example: linx
erp_status
string

Estado atual de conectividade: 'connected', 'degrading', 'disconnected'.

last_sync_at
datetime

Timestamp ISO 8601 do último envio de dados mestre bem-sucedido.

Listar Marcas

GET /v1/brands

Parâmetros de Paginação

FieldTypeDescription
limit
integer

Número de registros a retornar. Padrão 20, Máximo 100.

offset
integer

Número de marcas a pular para paginação.

Criar Marca

POST /v1/brands

Provisione um novo nó de marca. Isso preparará o ambiente para ingestão de SKU e roteamento de pedidos.

{
  "name": "Puma Heritage",
  "category": "Footwear",
  "erp_provider": "oracle",
  "metadata": {
    "region": "LATAM"
  }
}