BuyList

A query buyList retorna informações referentes a uma lista de compras cadastrada no Admin da loja, no qual pode ser cadastrada uma lista de produtos para ser apresentada como uma página de produto, ou como um spot em outras páginas.

Requisição

Parâmetros

Parâmetro	Tipo	Obrigatório	Descrição
id	Long	Sim	ID da lista de compra a ser buscada
partnerAccessToken	String	Não	Token de parceiro, utilizado para filtrar os produtos exibidos ao parceiro

Campos

Campos	Descrição
buyListId	Identificador único da lista de compras
buyListProducts	Lista com os seguintes campos: productId e quantity
alias	Alias da lista de compras
images	Lista de imagens da lista de compras
informations	Lista de informações associadas a lista de compras
promotions	Informações de promoções e desconto associados a lista de compras
productName	Nome da lista de compras
prices	Informações do preço total dos produtos contabilizados na lista de compras.

Exemplo

Neste exemplo é solicitado informações de uma determinada lista de compras:

query {
  buyList(id: 46) {
    productName
    buyListId
    buyListProducts {
      productId
      quantity
    }
  }
}

Mostrar resposta

{
  "data": {
    "buyList": {
      "productName": "Crianças - Diversão e Criação",
      "buyListId": 46,
      "buyListProducts": [
        {
          "productId": 73202,
          "quantity": 1
        },
        {
          "productId": 72421,
          "quantity": 1
        },
        {
          "productId": 32,
          "quantity": 1
        },
        {
          "productId": 281,
          "quantity": 1
        },
        {
          "productId": 282,
          "quantity": 1
        },
        {
          "productId": 70149,
          "quantity": 1
        }
      ]
    }
  }
}

Retornando o campo aliasComplete relacionado ao produto

Abaixo temos um exemplo do retorno do campo aliasComplete, onde traz o alias relacionado ao produto e que leva em consideração a configuração Configuração de URL de Produto dentro do painel administrativo.

Lista de Compra

query {
  buyList(id: 46) {
    aliasComplete
    }
  }

Mostrar resposta

{
  "data": {
    "buyList": {
      "aliasComplete": "listacompra/kit-escolar-46"
    }
  }
}

query {
  buyList(id: 1046) {
    aliasComplete
    }
  }

Mostrar resposta

{
  "data": {
    "buyList": {
      "aliasComplete": "kit/teste-kit-produtos-1046"
    }
  }
}

Apresentando informação de kit na consulta

Abaixo temos um exemplo do retorno de kit na query.

query {
  buyList(id: 1046) {
    buyListId
    kit
    buyListProducts{
      price
      productId
      quantity
    }
    alias
    prices{
      listPrice
      price
    }
   }
 }

Mostrar resposta

{
  "data": {
    "buyList": {
      "buyListId": 1046,
      "kit": true,
      "buyListProducts":[
        {
          "price":200,
          "productId":70129,
          "quantity":1
        },
        {
          "price": 210,
          "productId": 130130,
          "quantity": 2
        }
      ],
      "alias": "kit/teste-kit-produtos-1046",
      "prices": {
        "listPrice": 620,
        "price": 620
      }
    }
  }
}

Apresentando informação ExibirParent para lista de compra e kit

Abaixo temos um exemplo do retorno do campo includeSameParent, na consulta da query, conforme setado no painel administrativo. Este campo reflete a flag Exibir Parent e Incluir parents que se encontra dentro do cadastro de lista de compra e kit no painel administrativo.

No retorno da API:

caso a flag esteja ativa no painel administrativo = true
caso a flag esteja desativada no painel administrativo = false

query{
  buyList(id: 1046){
    buyListProducts{
      includeSameParent
    }
  }
}

Mostrar resposta

{
  "data": {
    "buyList": {
      "buyListId": 1046,
      "kit": false,
      "alias": "listacompra/kit-escolar-46",
      "buyListProducts":[
        {
          "productId":70129,
          "quantity":1,
          "includeSameParent": false
        },
        {
          "productId": 130130,
          "quantity": 2,
          "includeSameParent": false
        }
      ]
    }
  }
}