Consultar atributos por categoria

Nesta seção indicaremos como realizar a consulta nos atributos de categorias da Americanas.

Consultando os atributos por categorias, será possível identificar aqueles que serão obrigatórios a presença no JSON do produto.

Como funciona?

Haverá atributos com os seguintes tipos:

• Text

• Multi-Line Text

• Number

• Indexed Text

• Indexed Multi-Line Text

• Combo

• Radio

• Checkbox

Atributos em verde são conhecidos como "atributos de preenchimento livre", já os atributos em vermelho vão precisar seguir um padrão já determinado pela Americanas.

Isso significa que ao criar um produto na Americanas, será necessário identificar o tipo do atributo. Sendo um atributo de preenchimento livre, haverá a possibilidade de ser enviado um texto livre no atributo, já os atributos "combo, radio e checkbox", serão preenchidos com valores já pré-determinados pelo Marketplace.

Detalharemos mais na documentação de Criação de Produtos.

GET - Consultar atributos por Categoria

https://api.skyhub.com.br/categories/{id}/attributes

Atributos ajudam na filtragem e visibilidade do produto no e-commerce, além de serem essenciais para a integração com o marketplace. Porém, não serão todos os atributos de categorias obrigatórios, será necessário atentar-se ao valor do atributo required.

A consulta de atributos por categoria retornará um campo chamado "toSKU", onde este define se o atributo deve ser enviado no produto PAI ou na sua variação. Caso o "toSKU" seja false, o atributo deve ser enviado nas especificações do produto pai. Caso true, deverá ser enviado nas especificações do produto filho. Porém, se por acaso o "toSKU" seja true e o produto se tratar de um produto simples, o atributo deverá ser enviado no "specifications" do produto normalmente.

Request headers:

Key	Value
X-User-Email	email_de_usuario
X-Api-Key	token_de_integracao de sua conta SkyHub
X-Accountmanager-key	token_account único de cada Plataforma/ERP
Accept	application/json
Content-Type	application/json

Estrutura de resposta:

[
  {
    "marketplace": "string",
    "id": "string", // id do atributo
    "name": "string",
    "group": "string",
    "groupId": "string",
    "type": "string", // tipo do atributo
    "typeId": "string", 
    "toSKU": "boolean", // define se o atributo deve ser enviado no PAI ou Variação
    "variant": "boolean",
    "binary": "boolean",
    "active": "boolean",
    "required": "boolean",
    "valueData": []
  }
]

Example request:

curl --location -g --request GET 'https://api.skyhub.com.br/categories/55/attributes' \
--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'

Response esperado:

200 [Success] - OK: Haverá um response body com os atributos da categoria:

// Atributo de preenchimento Livre

[
  {
    "marketplace": "TALD00776574000660",
    "id": "22066",
    "name": "Cor",
    "group": "Especificações - Caixas e embalagens para delivery",
    "groupId": "15401",
    "type": "Texto",
    "typeId": "1",
    "toSKU": false,
    "variant": false,
    "binary": false,
    "active": true,
    "required": false,
    "valueData": []
  }
]

// Atributo com valores pré-determinados

[
  {
    "marketplace": "TALD00776574000660",
    "id": "28966",
    "name": "É kit",
    "group": "Especificações - Agro, indústria e comércio",
    "groupId": "19785",
    "type": "Radio",
    "typeId": "6",
    "toSKU": false,
    "variant": false,
    "binary": false,
    "active": true,
    "required": false,
    "valueData": [
      {
        "id": "49068",
        "value": "Sim",
        "descriptionValue": "Sim",
        "name": "Sim",
        "code": "49068",
        "active": true
      },
      {
        "id": "49069",
        "value": "Não",
        "descriptionValue": "Não",
        "name": "Não",
        "code": "49069",
        "active": true
      }
    ]
  }
]