Endpoint Categorias

Esta seção mostra como utilizar as categorias para organização dos produtos enviados para a API

Este recurso foi descontinuado [ver comunicado "Inativação do endpoint /categories"].

A categorização de produtos é opcional é não irá gerar impacto na criação dos anúncios no marketplace.

O marketplace Americanas possui um categorizador automático chamado Minos que atua da seguinte maneira: Após a conexão do SKU, o sistema analisa o título e sua descrição, identifica a similaridade entre as categorias existentes e realiza a classificação automática que será refletida para os sites de venda.

Uma vez que a categorização ocorre diretamente pelo marketplace, as categorias adicionadas na estrutura do produto não possuem relação com a estrutura do item nos sites de venda e caíram em desuso na API.

Caso deseje categorizar os SKUs enviados para a API, é importante atentar-se ao melhor padrão: Para simular a hierarquia, o nome da categoria na API deve ser a junção de todos os nomes das categorias e subcategorias separados por um ">".

Exemplos

Árvores de categorias

Exemplo 1

Dormitórios > Casal > Guarda Roupas > 2 Portas

Exemplo 2

Eletrônicos > Computadores > Notebook > Dual Core

Exemplo 3

Eletrônicos > Celulares > Fone de ouvido > Headphone

O que não é uma boa prática?

Ao atuar com a categorização, não recomendamos que sejam adicionadas categorias genéricas para os itens criados.

Categorias

Porquê não recomendamos

Eletrônicos > LG

A marca LG dispõe de outros tipos de produtos, como monitores e televisores

Eletrônicos | Celulares | LG

Ao separar as categorias por pipe (|), a API não entende que são categorias distintas

ATENÇÃO: Limite de 10 categorias por produto.

Como enviar a categoria no JSON

Era disposto pela API o endpoint /categories para a inclusão prévia das categorias a serem utilizadas pela conta. Uma vez que o endpoint foi descontinuado, como citado no início desta seção, a inclusão de categorias deve ser realizada diretamente na estrutura do produto, como exemplos dispostos abaixo:

Exemplo 1
curl --location --request POST 'https://api.skyhub.com.br/products' \
--header 'X-User-Email: email_de_usuario' \
--header 'X-Api-Key: token_de_integracao de sua conta SkyHub' \
--header 'X-Accountmanager-Key: token_account único de cada Plataforma/ERP' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data-raw '{
  "product": {
    "sku": "2022004",
    "name": "Produto Variável Para Categorização",
    "description": "Produto variável criado com o intuito de exemplificar a inclusão de categorias",
    "status": "enabled",
    "price": 600.00,
    "promotional_price": 590.00,
    "cost": 0.0,
    "weight": 50,
    "height": 175,
    "width": 137,
    "length": 39,
    "brand": "SkyHub",
    "nbm": "98769898",
    "categories": [
      {
        "code": "Exemplo1",
        "name": "Dormitórios > Casal > Guarda Roupas > 2 Portas"
      }
    ],
    "images": [
      "url_da_imagem"
    ],
    "specifications": [
      {
        "key": "Especicações do Produto Pai/Agrupador",
        "value": "Especificações do Produto Pai/Agrupador"
      }
    ],
    "variations": [
      {
        "sku": "2022004A",
        "qty": 10,
        "ean": "9876543210987",
        "images": [
          "url_da_imagem"
        ],
        "specifications": [
          {
            "key": "atributo_que_define_a_variacao_do_sku_1",
            "value": "atributo_que_define_a_variacao_do_sku_1"
          }
        ]
      }
    ],
    "variation_attributes": [
      "atributo_que_define_a_variacao_do_sku_1"
    ]
  }
}'
Exemplo 2
curl --location --request POST 'https://api.skyhub.com.br/products' \
--header 'X-User-Email: email_de_usuario' \
--header 'x-Api-Key: token_de_integracao de sua conta SkyHub' \
--header 'x-accountmanager-key: token_account único de cada Plataforma/ERP' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data-raw '{
	"product": {
    "sku": "2022005",
    "name": "Produto Simples Para Categorização",
    "description": "Criação de produto simples com o intuito de exemplificar a inclusão de categorias",
    "status": "enabled",
    "qty": 0,
    "price": 100,
    "promotional_price": 89.99,
    "cost": 49.00,
    "weight": 3,
    "height": 1,
    "width": 1,
    "length": 1,
    "brand": "SkyHub",
    "ean": "9876549876598",
    "nbm": "45678765",
    "categories": [
        {
        "code": "Exemplo2",
        "name": "Eletrônicos > Computadores > Notebook > Dual Core"
        }
    ],
    "images": [
      "url_da_imagem"
    ],
    "specifications": [
      {
        "key": "Especicações do Produto",
        "value": "Especicações do Produto"
      }
    ]
  }
}'
Exemplo 3
curl --location --request POST 'https://api.skyhub.com.br/products' \
--header 'X-User-Email: email_de_usuario' \
--header 'x-Api-Key: token_de_integracao de sua conta SkyHub' \
--header 'x-accountmanager-key: token_account único de cada Plataforma/ERP' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data-raw '{
	"product": {
    "sku": "2022006",
    "name": "Produto Simples Para Categorização",
    "description": "Criação de produto simples com o intuito de exemplificar a inclusão de categorias",
    "status": "enabled",
    "qty": 0,
    "price": 100,
    "promotional_price": 89.99,
    "cost": 49.00,
    "weight": 3,
    "height": 1,
    "width": 1,
    "length": 1,
    "brand": "SkyHub",
    "ean": "3456789123456",
    "nbm": "78923456",
    "categories": [
        {
        "code": "Exemplo3",
        "name": "Eletrônicos > Celulares > Fone de ouvido > Headphone"
        }
    ],
    "images": [
      "url_da_imagem"
    ],
    "specifications": [
      {
        "key": "Especicações do Produto",
        "value": "Especicações do Produto"
      }
    ]
  }
}'

As categorias adicionadas servirão para organização dos itens dentro da plataforma, pois não serão visualizadas na estrutura do produto na API ao realizar um GET no /products.

Last updated