Skip to Content
Documentação de integração da plataforma — em evolução contínua.
CatálogoMarcas e categorias

Marcas e categorias

Marcas

POST /v1/batch/Brands

[ { "externalReference": "MARCA-001", "name": "Fazenda Boa Vista", "title": "Fazenda Boa Vista", "description": "Laticínios artesanais", "punctuation": 10, "similarTerms": "boa vista, fazenda" } ]
CampoObrigatórioObservação
externalReferencesimcódigo da marca no seu ERP; é a chave de idempotência
namesimnome interno
titlesimtítulo exibido na vitrine
descriptionsimusado na página da marca
punctuationsimpeso de relevância na busca — maior aparece antes
similarTermsnãosinônimos que também encontram a marca na busca

similarTerms é o campo que resolve busca por apelido regional (“miojo”, “bombril”). Vale a pena preencher para as marcas líderes da operação.

Para remover: DELETE /v1/batch/Brands com uma lista de externalReference.

Categorias

POST /v1/batch/Categories

A árvore inteira pode ir em uma chamada usando children:

[ { "externalReference": "DEP-MERCEARIA", "name": "Mercearia", "title": "Mercearia", "description": "Itens de mercearia seca", "isCategoryDepartmentToo": true, "showInStoreFront": true, "activeStoreFrontLink": true, "position": 1, "children": [ { "externalReference": "CAT-MASSAS", "parentExternalReference": "DEP-MERCEARIA", "name": "Massas", "title": "Massas", "description": "Massas secas e frescas", "showInStoreFront": true, "position": 1 } ] } ]
CampoEfeito na vitrine
showInStoreFrontse false, a categoria existe mas não aparece no menu
activeStoreFrontLinkse false, aparece como rótulo mas não é clicável
isCategoryDepartmentTootrata a categoria também como departamento de primeiro nível
positionordem de exibição entre categorias irmãs

Ao enviar categoria filha em chamada separada, parentExternalReference é obrigatório. Sem ele a categoria é criada na raiz e some do menu esperado — o sintoma típico é “a subcategoria sumiu do departamento”.

Ordem de envio

Marcas e categorias são independentes entre si, mas ambas precisam existir antes dos produtos. Um produto que referencia categoryExternalReference inexistente é criado sem categoria e não aparece na navegação, só na busca.