Categories

A query de categories retorna informações de categorias cadastradas na loja.

Requisição

Parâmetros

Parâmetro	Tipo	Obrigatório	Descrição
Parâmetros de paginação		Sim	Parâmetros utilizados na paginação por cursor
categoryIds	[Long]	Não	Filtro de categorias por IDs
sortDirection	Enum SortDirection	Não	Direção de ordenação. Por padrão é ASC
sortKey	Enum CategorySortKeys	Não	Chave de ordenação. Por padrão é ID

Campos

Campo	Descrição
categoryId	ID de cadastro da categoria
children	Lista de categorias filhas
description	Descrição da categoria
displayMenu	Se a categoria deve ser exibida no menu do site
hotsiteAlias	Alias do hotsite da categoria
hotsiteUrl	URL do hotsite da categoria
imageUrl	URL da imagem associada à categoria
imageUrlLink	Link de acesso à imagem da categoria
name	Nome da categoria
parent	Categoria pai, se existente
parentCategoryId	ID da categoria pai
position	Ordem na qual a categoria será exibida
products	Lista de produtos pertencentes à categoria. São paginados por cursor
urlLink	URL relacionada à categoria

Exemplo

Neste exemplo são pedidas informações das 2 primeiras categorias da loja:

query {
  categories(first:2) {
    edges {
      cursor
      node {
        categoryId
        name
      }
    }
  }
}

Mostrar resposta

{
  "data": {
    "categories": {
      "edges": [
        {
          "cursor": "eyJJZCI6MSwiVmFsdWUiOiIxIn0=",
          "node": {
            "categoryId": 1,
            "name": "TIPOS CABELOS"
          }
        },
        {
          "cursor": "eyJJZCI6MiwiVmFsdWUiOiIyIn0=",
          "node": {
            "categoryId": 2,
            "name": "TINTURA E COLORAÇÃO"
          }
        }
      ]
    }
  }
}

Novo filtro URLs para obter a categoria

Abaixo temos um exemplo, que será possível obter a categoria a partir da URL consultada:

query {
  categories(urls: "country/haras-e-fazenda", first: 50) {
    nodes {
      categoryId
      name
      hotsiteUrl
      children {
        categoryId
        name
        hotsiteUrl
      }
    }
  }
}

Mostrar resposta

{
  "data": {
    "categories": {
      "nodes": [
        {
          "categoryId": 68,
          "name": "Haras e Fazenda",
          "hotsiteUrl": "country/haras-e-fazenda",
          "children": [
            {
              "categoryId": 80,
              "name": "Capas e Outros",
              "hotsiteUrl": "country/haras-e-fazenda/capas-e-outros"
            }
          ]
        }
      ]
    }
  }
}