CalculatePrices

A query calculatePrices retorna informações sobre o preço e parcelamento de uma lista de produtos. Pode ser enviado um único produto ou uma lista, para calcular o parcelamento a partir do resultado total do valor da compra.

Requisição

Parâmetros

Parâmetro	Tipo	Obrigatório	Descrição
partnerAccessToken	String	Não	Token de parceiro. Informações como a tabela de preço são atreladas ao parceiro, caso não possua, o retorno será da tabela padrão.
products	[CalculatePricesProductInput]	Sim	Lista com os produtos a serem calculados

calculatePricesProductInput

Parâmetro	Tipo	Descrição
productVariantId	Long	ID do variante do produto
quantity	Int	Quantidade do produto

Campos

Campo	Descrição
bestInstallment	Seleção da melhor forma de parcelamento calculada
discountPercentage	Valor de 0,00 a 1,00 representando o total do desconto
discounted	Valor da soma dos produtos com desconto aplicado
installmentPlans	Traz todos os resultados possíveis de parcelamento
listPrice	Preço da lista (de)
price	Preço final (por)
multiplicationFactor	O fator de multiplicação, presente em itens que são vendidos por uma determinada quantidade
priceTables	Lista das diferentes tabelas de preços do produto. É retornado quando passado algum partnerAccessToken ou uma tabela de preço pública

Exemplo

Neste exemplo são pedidas informações dos 2 primeiros conteúdos cadastrados na loja:

Request body

query{
  calculatePrices(partnerAccessToken:"",products:[{productVariantId:4454, quantity:1}]){
    bestInstallment {
      displayName
      name
    }
    discountPercentage
    discounted
    installmentPlans {
      displayName
      name
      installments{
        discount
        fees
        number
        value
      }
    }
    listPrice
    multiplicationFactor
    price
  } 
}

Mostrar resposta

Request response

{
  "data": {
    "calculatePrices": {
      "bestInstallment": {
        "displayName": "Cartão Sem Desconto",
        "name": "Vindi - Cartão"
      },
      "discountPercentage": 0.29,
      "discounted": true,
      "installmentPlans": [
        {
          "displayName": "Cartão Sem Desconto",
          "name": "Vindi - Cartão",
          "installments": [
            {
              "discount": false,
              "fees": true,
              "number": 1,
              "value": 2799.39
            },
            {
              "discount": false,
              "fees": false,
              "number": 2,
              "value": 1272.45
            },
            {
              "discount": false,
              "fees": false,
              "number": 3,
              "value": 848.3
            },
            {
              "discount": false,
              "fees": false,
              "number": 4,
              "value": 636.22
            },
            {
              "discount": false,
              "fees": false,
              "number": 5,
              "value": 508.98
            },
            {
              "discount": false,
              "fees": true,
              "number": 6,
              "value": 434.75
            },
            {
              "discount": false,
              "fees": true,
              "number": 7,
              "value": 372.65
            },
            {
              "discount": false,
              "fees": true,
              "number": 8,
              "value": 326.07
            },
            {
              "discount": false,
              "fees": true,
              "number": 9,
              "value": 289.84
            },
            {
              "discount": false,
              "fees": true,
              "number": 10,
              "value": 260.85
            },
            {
              "discount": false,
              "fees": true,
              "number": 11,
              "value": 237.14
            },
            {
              "discount": false,
              "fees": true,
              "number": 12,
              "value": 217.38
            }
          ]
        }
      ],
      "listPrice": 3594,
      "multiplicationFactor": 0,
      "price": 2544.9
    }
  }
}