Brands

A query de brands retorna informações de fabricantes cadastrados 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
brandInput	BrandInput	Não	Objeto de filtro de fabricantes
sortDirection	Enum SortDirection	Não	Direção de ordenação. Por padrão é ASC
sortKey	Enum BrandSortKeys	Não	Chave de ordenação. Por padrão é ID

brandInput

Parâmetro	Tipo	Descrição
brandIds	[Long]	Filtro por lista de IDs de fabricantes
name	[String]	Filtro por nomes de fabricantes
groupIds	[Long]	Filtro por IDs dos carrosséis de marca de acordo com painel administrativo da loja
groupNames	[String]	Filtro por Nomes dos carrosséis de marca de acordo com painel administrativo da loja

Campos

Campo	Descrição
active	Se o fabricante está ativo
alias	Alias para o hotsite do fabricante
brandId	ID de cadastro do fabricante
createdAt	Data de cadastro do fabricante
name	Nome do fabricante
products	Lista de produtos pertencentes ao fabricante. São paginados por cursor
updatedAt	Data da última atualização no fabricante
urlCarrossel	URL de redirecionamento
urlLink	URL relacionada ao fabricante
urlLogo	URL da imagem da logo do fabricante

Exemplos

Exemplo 1

Neste exemplo são pedidas informações dos 2 primeiros fabricantes da loja:

Request body

query {
  brands(first: 2) {
    edges {
      cursor
      node {
        id
        brandId
        name
      }
    }
  }
}

Mostrar resposta

Request response

{
  "data": {
    "brands": {
      "edges": [
        {
          "cursor": "eyJJZCI6MSwiVmFsdWUiOm51bGx9",
          "node": {
            "id": "eyJFbnRpdHkiOiJCcmFuZCIsIklkIjoxfQ==",
            "brandId": 1,
            "name": "Maxton "
          }
        },
        {
          "cursor": "eyJJZCI6MiwiVmFsdWUiOm51bGx9",
          "node": {
            "id": "eyJFbnRpdHkiOiJCcmFuZCIsIklkIjoyfQ==",
            "brandId": 2,
            "name": "Vans"
          }
        }
      ]
    }
  }
}

Exemplo 2

Neste exemplo é utilizada a paginação por cursor para pedir os próximos 2 fabricantes:

Request body

{
  brands(first: 2, after: "eyJJZCI6MiwiVmFsdWUiOm51bGx9") {
    edges {
      cursor
      node {
        id
        brandId
        name
      }
    }
  }
}

Mostrar resposta

Request response

{
  "data": {
    "brands": {
      "edges": [
        {
          "cursor": "eyJJZCI6MywiVmFsdWUiOm51bGx9",
          "node": {
            "id": "eyJFbnRpdHkiOiJCcmFuZCIsIklkIjozfQ==",
            "brandId": 3,
            "name": "Melissa"
          }
        },
        {
          "cursor": "eyJJZCI6NCwiVmFsdWUiOm51bGx9",
          "node": {
            "id": "eyJFbnRpdHkiOiJCcmFuZCIsIklkIjo0fQ==",
            "brandId": 4,
            "name": "Rodeo West"
          }
        }
      ]
    }
  }
}

Exemplo 3

Exemplo com ordenação decrescente pela chave NAME:

Request body

{
  brands(first: 2, sortKey:NAME, sortDirection:DESC) {
    edges {
      cursor
      node {
        id
        brandId
        name
      }
    }
  }
}

Mostrar resposta

Request response

{
  "data": {
    "brands": {
      "edges": [
        {
          "cursor": "eyJJZCI6MzksIlZhbHVlIjoiWnVua3kifQ==",
          "node": {
            "id": "eyJFbnRpdHkiOiJCcmFuZCIsIklkIjozOX0=",
            "brandId": 39,
            "name": "Zunky"
          }
        },
        {
          "cursor": "eyJJZCI6ODcxLCJWYWx1ZSI6IldlZyJ9",
          "node": {
            "id": "eyJFbnRpdHkiOiJCcmFuZCIsIklkIjo4NzF9",
            "brandId": 871,
            "name": "Weg"
          }
        }
      ]
    }
  }
}

Exemplo 4

Retornando informações de um fabricante especificado por nome e 2 de seus produtos:

Request body

{
  brands(first: 1, brandInput:{names:["Maxton"]}) {
    edges {
      cursor
      node {
        id
        brandId
        name
        products(first: 2) {
          edges {
            cursor
            node {
              id
              productId
              sku
              productName
            }
          }
        }
      }
    }
  }
}

Mostrar resposta

Request response

{
  "data": {
    "brands": {
      "edges": [
        {
          "cursor": "eyJJZCI6MSwiVmFsdWUiOm51bGx9",
          "node": {
            "id": "eyJFbnRpdHkiOiJCcmFuZCIsIklkIjoxfQ==",
            "brandId": 1,
            "name": "Maxton ",
            "products": {
              "edges": [
                {
                  "cursor": "WzEsImtpdCBwcmF0aWNvIG1heHRvbiBjYXN0YW5obyBlc2N1cm8gMy4wIiwyXQ==",
                  "node": {
                    "id": "eyJFbnRpdHkiOiJQcm9kdWN0IiwiSWQiOjJ9",
                    "productId": 28,
                    "sku": "112868",
                    "productName": "Kit Prático Maxton Castanho Escuro 3.0"
                  }
                },
                {
                  "cursor": "WzEsImtpdCBwcmF0aWNvIG1heHRvbiBjYXN0YW5obyBuYXR1cmFsIDQuMCIsNV0=",
                  "node": {
                    "id": "eyJFbnRpdHkiOiJQcm9kdWN0IiwiSWQiOjV9",
                    "productId": 25,
                    "sku": "112870",
                    "productName": "Kit Prático Maxton Castanho Natural 4.0"
                  }
                }
              ]
            }
          }
        }
      ]
    }
  }
}

Exemplo 5

Retornando as marcas de acordo com as configurações de carrossel de marca do painel administrativo da loja:

Request body

query{
  brands (first: 2, brandInput: {groupIds: [18, 19], groupNames: ["Carrossel", "Marcas TOP"]}){
    nodes {
      id
      brandId
      active
      urlLogo
      alias
      fullUrlLogo(width:270)
      name
    }
  }
}

Mostrar resposta

Request response

{
  "data": {
    "brands": {
      "nodes": [
        {
          "id": "eyJFbnRpdHkiOiJCcmFuZCIsIklkIjozfQ==",
          "brandId": 3,
          "active": true,
          "urlLogo": "3.jpg",
          "alias": "fabricante/melissa",
          "fullUrlLogo": "https://lojacss.fbitsstatic.net/img/fb/3.jpg?v=no-value&w=270",
          "name": "Melissa"
        },
        {
          "id": "eyJFbnRpdHkiOiJCcmFuZCIsIklkIjo1fQ==",
          "brandId": 5,
          "active": true,
          "urlLogo": "5.jpg",
          "alias": "fabricante/montblanc",
          "fullUrlLogo": "https://lojacss.fbitsstatic.net/img/fb/5.jpg?v=no-value&w=270",
          "name": "MontBlanc"
        }
      ]
    }
  }
}