VenddorDocumentação API
API atualAPI legada
Guia rápidoReferência completa
Carregando índice…
API legada/Guia rápido/Produtos

Categorias do produto

Lista as categorias em que um produto está, com qual é a principal e os dados do vínculo.

Um produto fica em uma categoria principal e, se quiser, em várias categorias adicionais. É a principal que define o caminho da URL e a trilha de navegação (Início / Casa / Cozinha / Caneca); as adicionais só fazem o produto aparecer também nas outras listagens. Esta página mostra como ler esse vínculo.

Para trocar a categoria principal, use o campo category_id do PUT, que mantém a categoria antiga como adicional.

GET/api/v1.0/products/{id}/categoriesAutenticada

Categorias de um produto

Autenticação: HTTP Basic com e-mail:chave_de_api, ou Authorization: Bearer <JWT>; a leitura aceita qualquer usuário autenticado. A rota também responde em /api/products/{id}/categories, com ids decimais em string. Um produto que não existe devolve 200 com listas vazias (e não 404).

Parâmetros de caminho

idstringobrigatório
Id do produto: o product_id, em UUID (na rota /api/products/{id}/categories, também o id decimal).

Exemplo de requisição

bash
curl -u "$EMAIL:$API_KEY" \
  "$BASE_URL/api/v1.0/products/0497b6a8-c868-43be-ac21-2abddd24cd3c/categories"

Resposta

200Categorias do produto
json
{
  "product_id": "0497b6a8-c868-43be-ac21-2abddd24cd3c",
  "categories": [
    {
      "category_id": "345ac33e-4dcd-4d60-bedf-a2c2d47897d9",
      "category": "Escritório",
      "parent_id": "0",
      "id_path": "345ac33e-4dcd-4d60-bedf-a2c2d47897d9",
      "status": "A",
      "position": 0,
      "product_count": 0,
      "company_id": "0",
      "description": "",
      "seo_name": "escritorio",
      "page_title": "",
      "meta_description": "",
      "meta_keywords": "",
      "timestamp": 1788959480,
      "updated_timestamp": 1788959480
    }
  ],
  "links": [
    {
      "category_id": "345ac33e-4dcd-4d60-bedf-a2c2d47897d9",
      "product_id": "0497b6a8-c868-43be-ac21-2abddd24cd3c",
      "position": 0,
      "is_primary": "Y"
    }
  ],
  "total": 1
}

Campos da resposta

product_idstring
Id do produto consultado (UUID em /api/v1.0; decimal em /api/).
categoriesarray
As categorias do produto. Cada item é a categoria no formato da API.
categories[].category_idstring
Id da categoria.
categories[].categorystring
Nome da categoria.
categories[].parent_idstring
Id da categoria-pai. "0" na raiz.
categories[].id_pathstring
Caminho de ids da raiz até a categoria, separados por /.
categories[].statusstring
ADH
Status da categoria: A ativa, D desativada, H oculta.
categories[].positioninteger
Posição entre as irmãs.
categories[].product_countinteger
Número de produtos da categoria.
categories[].company_idstring
Seller dono da categoria. "0" para categoria da loja.
categories[].descriptionstring
Descrição.
categories[].seo_namestring
Slug da URL.
categories[].page_titlestring
Título SEO.
categories[].meta_descriptionstring
Descrição SEO.
categories[].meta_keywordsstring
Palavras-chave SEO.
categories[].timestampinteger
Criação, Unix timestamp em segundos.
categories[].updated_timestampinteger
Última alteração, Unix timestamp em segundos.
categories[].main_pairobject
Imagem da categoria (pair_id, image_id, detailed.image_path). Ausente quando não há imagem.
linksarray
Um item por categoria, com os dados do vínculo.
links[].category_idstring
Id da categoria.
links[].product_idstring
Id do produto.
links[].positioninteger
Posição do vínculo (a ordem em que as categorias foram gravadas).
links[].is_primarystring
YN
Y na categoria principal.
totalinteger
Quantidade de categorias.

Erros

StatusQuandoCorpo
401Sem credenciais, chave inválida ou token expirado{"message":"Authentication required. Use HTTP Basic with email:api_key or Bearer <jwt>.","status":401}
429Limite de requisições{"error":"rate limit exceeded","detail":"too many requests, please try again later"}
500{id} que não é UUID{"message":"Failed to retrieve product categories","status":500}

Veja também

  • Alterar produto
  • Criar produto
  • Consultar produto
Anterior
Excluir produto
Próxima
Produtos por token de app
Nesta página
  • Exemplo de requisição
  • Resposta
  • Erros
  • Veja também