Endpoint Atributos
Os atributos são elementos que ajudam a diferenciar ou descrever características de especificação técnica do produto criado
Por que algo simples é tão importante para o produto?
Os atributos são informações importantes para os filtros de categorias e para diferenciar os SKUs de um produto; quanto mais atributos/composição o produto tiver, mais chances terá de aparecer no filtro de categorias.
Abaixo temos alguns exemplos de atributos que são obrigatórios no marketplace (mktp) por categoria:
Atributos | Categoria |
Cor | Moda |
Sabor | Nutrição/Suplementos |
Tamanho | Moda |
Voltagem | Eletrodomésticos |
Volumetria | Perfumes |
Os produtos não devem se limitar apenas aos atributos mencionados acima, por exemplo, no seguimento de moda temos outros atributos/composição do produto, tais como marca, fabricante, dentre outros.
Para melhor compreensão de atributos obrigatórios, imagine uma loja do seguimento de moda vendendo no marketplace, o mktp precisa ter a informação de cor e tamanho de uma camiseta, pois estes são atributos de diferenciação para cada SKU do produto; através destes atributos será possível que o marketplace disponibilize as opções disponíveis para venda.
Agora que mencionamos a importância dessas informações, vamos à prática!
A API disponibiliza um endpoint para a criação de atributos que poderão ser utilizados para a caracterização dos produtos, assim como através do mesmo também é possível realizar a consulta dos atributos existentes na conta.
POST - Criando um atributo
A criação de atributos se dá a partir de um POST no endpoint a seguir:
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 |
Request body:
Example request:
Response esperado:
201 - Created
Para visualizar o atributo diretamente no front da API, deve ser acessado o menu SkyHub > Atributos. A seguir temos a visualização retirada do front atual da API:
Na tela acima, o Código traz o campo name definido via API. Já o Título traz o valor preenchido para o campo label.
Caso esteja utilizando o antigo front da API, a sequência vista será Label e Código, que representam, respectivamente os campos label e name.
Dentre as melhores práticas, recomendamos fortemente que o atributo seja criado à parte, para posterior envio (vínculo) junto ao produto que deseja criar na API.
Não seguir a prática acima eleva a taxa de processamento da API, podendo ocasionar retornos menos eficientes: Os atributos também são criados ao serem incluídos na estrutura do produto; cada vez que um SKU é enviado para a API, nossa ferramenta verifica se seus atributos já existem para que seja realizada ou não a criação dos mesmos.
Com o atributo previamente criado, é possível seguir com a sua inclusão na estrutura do produto, ação que é exemplificada a seguir utilizando a base de um produto variável:
O campo a ser inserido no array specifications é o valor da coluna Código (aquele que demonstramos na tela de atributos do painel SkyHub), ou seja, será incluído o campo que via API foi identificado como name.
GET - Consultando os atributos existentes
A consulta visa listar todos os atributos criados em uma conta. A partir dos headers padronizados e sinalizados acima basta executar um GET no endpoint:
Example request:
Response esperado:
200 - Success [OK]: O retorno da requisição trará uma lista com os atributos existentes na conta, sendo eles os padrões (como sku, status, description, entre outros) ou aqueles criados via API:
Como informado em nosso guia de melhores práticas, nossa estrutura de criação de atributos não possibilita que trabalhe com a mesma string de um atributo com case sensitive tentando diferenciar essa criação.
Devido a esta regra é necessário que sempre utilize em seus produtos o atributo que foi usado pela primeira vez, o que torna a consulta de atributos um recurso extremamente importante para a sua integração com a API.
PUT - Atualizando um atributo
Para atualizar um determinado atributo que foi criado na API deverá ser realizada uma requisição com o método PUT, onde serão utilizados os headers padronizados e sinalizados acima no endpoint:
É possível atualizar apenas a label (título do atributo na API) e as opções do atributo, o name (código) é mantido.
Request body:
Example request:
Response esperado:
204 [Success] - No content
Atributo de produtos em pré-venda
É possível tratar através da API a criação de produtos em pré-venda, para isso teremos o atributo com a label "dataLancamento" no qual o value deve conter a informação da data seguindo o padrão "DD/MM/AAAA", conforme cURL de exemplo disponibilizado a seguir:
Last updated
