Consultar Categorias
Nesta seção indicaremos como realizar a consulta na lista de categorias da Americanas.
Ao consultar a lista de Categorias, será possível consultar o ID de uma determinada e assim incluí-lo no JSON de produtos, também obrigatoriedade de atributos nelas.
GET - Consulta lista de categorias
https://api.skyhub.com.br/categoriesRequest headers:
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:
{
"total": 0,
"limit": 0,
"offset": "0",
"sort": "string",
"values": [
{
"id": "string",
"tenant": "string",
"operator": "string",
"createDate": "1970-01-01T00:00:00.000000",
"lastUpdate": "1970-01-01T00:00:00.000000",
"channel": "string",
"eanRequired": "boolean",
"account": null,
"lastEvent": null,
"categoryData": {
"tag": "string",
"id": "string",
"name": "string",
"id1": "string",
"name1": "string"
},
"attributes": [
{
"marketplace": "string",
"name": "string",
"nameId": "string",
"value": "string",
"valueId": "string",
"group": "string",
"grupId": "string",
"type": "string",
"typeId": "string",
"descriptionValue": "string",
"toSKU": "boolean",
"variant": "boolean",
"binary": "boolean",
"active": "boolean",
"required": "boolean"
}
]
}
]
}
Example request:
Response esperado:
200 [Success] - OK: Haverá um response body com a lista de categorias:
Filtros de consulta
Consultar categoria individualmente
Já tendo o id de uma categoria, é possível também consultá-la de forma individual conforme abaixo:
Request headers:
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:
Como consultar pelo nome
É possível realizar buscas por nome de uma determinada categoria.
Para realizar o filtro pelo nome da categoria, deverá ser informada a query ?categoryName= no endpoint /categories, referenciando a sequência de caracteres a ser consultada, conforme exemplo a seguir:
Example request:
Response esperado:
200 [Success] - OK: No retorno da consulta acima, retornará todas as categorias que possuírem a sequência 'limpeza' como vemos a seguir:
Utilizando o limit e o offset
Por padrão, a consulta acima trará somente os primeiros 5 resultados (limit=5), porém pode ser passado na consulta um valor de no máximo 100, trazendo assim essa quantidade de categorias na busca.
Caso ainda tenha uma próxima página, deve-se utilizar o parâmetro offset. Por exemplo, se na requisição houvesse ainda uma segunda página e desejasse passar pra ela, a consulta abaixo deve ser realizada:
Last updated