ShippingQuotes

A query shippingQuotes retorna informações de cotações de frete de produtos diretamente ou associados a um carrinho.

Requisição

Parâmetros

Parâmetro	Tipo	Obrigatório	Descrição
cep	CEP	Sim	CEP usado para a cotação de frete (apenas números)
checkoutId	Uuid	Não	ID do carrinho, usado em casos de cotação de frete de todos produtos de um carrinho
productVariantId	Long	Não	ID do produto variante, usado em caso de cotação de frete de um único produto
quantity	Int	Não	Quantidade do produto a ser cotado.

Campos

Campo	Descrição
deadline	Prazo de entrega dos produtos
name	Nome da opção de frete
products	Lista com o ID e valor dos produtos cotados
shippingQuoteId	ID de cadastro da opção de frete
type	Tipo de frete
value	Valor do frete

Exemplos

Exemplo 1

Neste exemplo são pedidas informações de cotações frete de um único produto:

Request body

query{
  shippingQuotes(cep:"80420120", productVariantId:446){
    name
    type
    value
    deadline
  }
}

Mostrar resposta

Request response

{
  "data": {
    "shippingQuotes": [
      {
        "name": "Entrega virtual",
        "type": "Tabela",
        "value": 0,
        "deadline": 2
      },
      {
        "name": "PAC Varejo",
        "type": "Correios",
        "value": 43.98,
        "deadline": 29
      },
      {
        "name": "Correios PAC 2",
        "type": "Intelipost",
        "value": 51.79,
        "deadline": 9
      },
      {
        "name": "SEDEX Varejo",
        "type": "Correios",
        "value": 89.48,
        "deadline": 23
      },
      {
        "name": "SEDEX sem contrato(Taxas de Balcão)",
        "type": "Correios",
        "value": 111.2,
        "deadline": 23
      },
      {
        "name": "Correios Sedex 23123",
        "type": "Intelipost",
        "value": 143.65,
        "deadline": 3
      }
    ]
  }
}

Exemplo 2

Neste exemplo são pedidas informações de cotações frete para vários produtos:

Request body

query {
  shippingQuotes(cep:"80420120", productVariantId:446, quantity:3) {
    name
    type
    value
    deadline
    products {
      productVariantId
      value
    }
  }
}

Mostrar resposta

Response body

{
  "data": {
    "shippingQuotes": [
      {
        "name": "SEDEX sem contrato(Taxas de Balcão)*",
        "type": "Correios",
        "value": 116.8,
        "deadline": 22,
        "products": [
          {
            "productVariantId": 446,
            "value": 38.93
          },
          {
            "productVariantId": 446,
            "value": 38.94
          },
          {
            "productVariantId": 446,
            "value": 38.93
          }
        ]
      }
    ]
  }
}

Cotação de frete com o endereço selecionado

Segue abaixo um exemplo:

Shipping Quotes

query ($checkoutId: Uuid!) {
	shippingQuotes(checkoutId: $checkoutId, useSelectedAddress: true) {
		shippingQuoteId
		deadline
		id
		name
		type
		value
	}
}

Cotação com agendamento

Segue abaixo um exemplo:

Request

query ($checkoutId: Uuid!) {
	shippingQuotes(checkoutId: $checkoutId, useSelectedAddress: true) {
		deadline
		deliverySchedules {
			date
			periods {
				end
				id
				start
			}
		}
		name
		shippingQuoteId
		type
		value
	}
}

Mostrar resposta

Response

{
	"data": {
		"shippingQuotes": [
			{
				"deadline": 2,
				"deliverySchedules": [
					{
						"date": "2023-04-28T05:00:00.000-03:00",
						"periods": [
							{
								"end": "19:00:00",
								"id": 34,
								"start": "11:00:00"
							}
						]
					},
					// ...
				],
				"name": "Teste",
				"shippingQuoteId": "0663cbab-2258-463e-912c-5beaf1930087",
				"type": "Tabela",
				"value": 21.9
			}
		]
	}
}

Cotação de frete com mais de um produto variante com matriz de atributos e suas quantidades

Segue abaixo um exemplo de cotação de frete com vários produtos variantes com matriz de atributos e suas respectivas quantidades:

Request body

query {
  shippingQuotes(
    cep: "80420120"
    products: [
      { productVariantId: 179, quantity: 1 }
      { productVariantId: 180, quantity: 1 }
    ]
  ) {
    name
    type
    value
    deadline
    products {
      productVariantId
      value
    }
  }
}

Mostrar resposta

Response body

{
  "data": {
    "shippingQuotes": [
      {
        "name": "Teste Cadastro",
        "type": "Retirada",
        "value": 0,
        "deadline": 1,
        "products": [
          {
            "productVariantId": 179,
            "value": 0
          },
          {
            "productVariantId": 180,
            "value": 0
          }
        ]
      },
      {
        "name": "Correios PAC 2",
        "type": "Intelipost",
        "value": 57.4,
        "deadline": 6,
        "products": [
          {
            "productVariantId": 179,
            "value": 28.7
          },
          {
            "productVariantId": 180,
            "value": 28.7
          }
        ]
      },
      {
        "name": "Correios Sedex 23123",
        "type": "Intelipost",
        "value": 157.49,
        "deadline": 2,
        "products": [
          {
            "productVariantId": 179,
            "value": 78.75
          },
          {
            "productVariantId": 180,
            "value": 78.74
          }
        ]
      },
      {
        "name": "SEDEX Varejo",
        "type": "Correios",
        "value": 552.02,
        "deadline": 22,
        "products": [
          {
            "productVariantId": 179,
            "value": 276.01
          },
          {
            "productVariantId": 180,
            "value": 276.01
          }
        ]
      }
    ]
  }
}