# Consultar Categorias 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/categories ``` {% hint style="info" %} A consulta trará 5 categorias, mas é possível utilizar o **limit** para trazer mais conforme necessidade (Máx. 100). Também é possível aplicar a paginação através do parâmetro ***offset**.* {% endhint %} #### Request headers:
KeyValue
X-User-Emailemail_de_usuario
X-Api-Keytoken_de_integracao de sua conta SkyHub
X-Accountmanager-keytoken_account único de cada Plataforma/ERP
Acceptapplication/json
Content-Typeapplication/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:** ``` curl --location -g --request GET 'https://api.skyhub.com.br/categories?limit=100&offset=2' \ --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:** {% hint style="success" %} 200 \[Success] - OK: Haverá um response body com a lista de categorias: {% endhint %} 
{
  "total": 1000,
  "limit": 10,
  "offset": 2,
  "values": [
    {
      "tenant": "TALD00776574000660",
      "operator": "TALD00776574000660",
      "account": null,
      "createDate": "2025-01-01T08:42:00.627000",
      "lastUpdate": "2025-01-01T08:42:41.454000",
      "lastEvent": null,
      "id": "3",
      "channel": "TALD00776574000660",
      "eanRequired": false,
      "categoryData": {
        "tag": "x-x-x",
        "id": "x",
        "name": "Nome",
        "id1": "x",
        "name1": "Nome 1",
        "id2": "x",
        "name2": "Nome 2",
        "id3": "x",
        "name3": "Nome 3"
      },
      "attributes": [
        {
          "marketplace": "TALD00776574000660",
          "name": "x",
          "nameId": "x",
          "value": "",
          "valueId": "",
          "group": "Grupo",
          "grupId": "x",
          "type": "Texto",
          "typeId": "1",
          "descriptionValue": "",
          "toSKU": false,
          "variant": false,
          "binary": false,
          "active": true,
          "required": false
        }
      ]
    }
  ]
}
## Filtros de consulta ### Consultar categoria individualmente Já tendo o **id** de uma categoria, é possível também consultá-la de forma individual conforme abaixo: ``` https://api.skyhub.com.br/categories/{id} ``` #### Request headers:
keyvalue
X-User-Emailemail_de_usuario
X-Api-Keytoken_de_integracao de sua conta SkyHub
X-Accountmanager-keytoken_account único de cada Plataforma/ERP
Acceptapplication/json
Content-Typeapplication/json
#### Estrutura de resposta: ``` { "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" }, "attributesData": [ { "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" } ] } ``` ### Como consultar pelo nome É possível realizar buscas por nome de uma determinada categoria. {% hint style="info" %} A busca retornará todas as categorias que possuírem a sequência de caracteres declarada no filtro. {% endhint %} 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: ``` https://api.skyhub.com.br/categories?categoryName={nome_da_categoria} ``` #### Example request: ``` curl --location -g --request GET 'https://api.skyhub.com.br/categories?categoryName=limpeza' \ --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: {% hint style="success" %} 200 \[Success] - OK: No retorno da consulta acima, retornará todas as categorias que possuírem a sequência 'limpeza' como vemos a seguir: {% endhint %} ``` { "total": 74, "limit": 1, "offset": 0, "values": [ { "tenant": "TALD00776574000660", "operator": "TALD00776574000660", "account": null, "createDate": "2025-06-24T20:11:13.589000", "lastUpdate": "2025-06-24T20:12:24.258000", "lastEvent": null, "id": "106", "channel": "TALD00776574000660", "eanRequired": false, "categoryData": { "tag": "1-86-106", "id": "106", "name": "Equipamentos e acessórios para limpeza e coleta seletiva", "id1": "1", "name1": "Agro, indústria e comércio", "id2": "86", "name2": "Equipamentos de segurança e sinalização", "id3": "106", "name3": "Equipamentos e acessórios para limpeza e coleta seletiva" }, "attributes": [ { "marketplace": "TALD00776574000660", "name": "Capacidade em volume", "nameId": "473", "value": "", "valueId": "", "group": "Especificações - Equipamentos e acessórios para limpeza e coleta seletiva", "grupId": "112", "type": "Texto", "typeId": "1", "descriptionValue": "", "toSKU": false, "variant": false, "binary": false, "active": true, "required": false } } ] } ] } ``` #### **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. ``` https://api.skyhub.com.br/categories?categoryName=limpeza&limit=100 ``` 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: ``` https://api.skyhub.com.br/categories?categoryName=limpeza&limit=10&offset=10 ```
--- # Agent Instructions: Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter: ``` GET https://desenvolvedores.skyhub.com.br/produtos/categorizacao/consultar-categorias.md?ask= ``` The question should be specific, self-contained, and written in natural language. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.