Estimativa de frete
Estimativa rápida de preço e prazo de frete para um CEP, para a página do produto e o carrinho.
Use na página do produto e no carrinho, para o cliente ver preço e prazo sem montar o carrinho inteiro. O limite de corpo é 1 MB.
/api/v1/storefront/shipping/estimatePúblicaEstimativa rápida de frete por CEP
A estimativa rápida do botão "Calcular frete" da página do produto e do carrinho. Devolve as opções por CEP, com preço e uma data de chegada pronta para exibir, na ordem de posição que o administrador definiu.
Corpo da requisição
postal_codestringobrigatórioCEP do destino, 8 dígitos, com ou sem hífen. Letras e sentinelas (
00000000, 99999999) são recusadas.itemsobject[]obrigatórioItens, de 1 a 100.
items[].product_iduuidobrigatórioProduto.
items[].quantityintegerpadrão: 1Quantidade, maior que zero.
items[].weightintegerPeso em gramas. Vale o que você enviar; se omitir, vem do catálogo.
items[].widthintegerLargura em cm. Mesma regra.
items[].heightintegerAltura em cm. Mesma regra.
items[].lengthintegerComprimento em cm. Mesma regra.
items[].vendor_iduuidSeller. Se omitir, vem do catálogo.
items[].priceintegerPreço unitário em centavos. Se omitir, vem do catálogo.
items[].free_shippingbooleanProduto com frete grátis. Se omitir, vem do catálogo.
subtotalintegerSubtotal do carrinho em centavos, usado em regras de frete grátis e faixas por valor.
Exemplo de requisição
Resposta
200Opções de frete
Campos da resposta
postal_codestringO CEP no formato
00000-000.ratesobject[]Opções, na ordem de posição dos métodos (a rota não reordena por preço).
rates[].method_iduuidId do método.
rates[].method_namestringNome.
rates[].method_codestringCódigo do método. Ausente se vazio.
rates[].priceintegerPreço em centavos.
0 é grátis.rates[].delivery_days_minintegerMenor prazo em dias úteis.
rates[].delivery_days_maxintegerMaior prazo em dias úteis.
rates[].delivery_estimatestringTexto pronto: uma data (
qui., 15 de out.) ou uma faixa (3-5 dias úteis), conforme o formato configurado pela loja na Janela de Entrega.rates[].iconstringEmoji de apoio.
rates[].free_shippingbooleanFrete grátis.
rates[].is_pickupbooleanRetirada em loja.
free_shipping_thresholdintegerValor, em centavos, a partir do qual o frete é grátis para toda a loja.
0 quando não há.unavailableobject[]Métodos que não puderam ser cotados, com
code e message. Ausente se nada foi excluído. Mesmo formato de Cotar frete.Erros
| Status | Quando | Corpo |
|---|---|---|
| 400 | Corpo que não é JSON. | {"error":"invalid request body","detail":"..."} |
| 400 | CEP malformado ou sentinela. | {"error":"invalid_postal_code","detail":"invalid CEP: expected 8 digits (e.g. 01310-100)"} |
| 400 | Sem itens. | {"error":"at least one item is required"} |
| 400 | Mais de 100 itens. | {"error":"too many items: maximum 100 allowed"} |
| 400 | Quantidade menor que 1. | {"error":"invalid_quantity","detail":"quantity must be a positive whole number"} |
| 500 | product_id que não é UUID, ou falha interna. | {"error":"failed to calculate shipping rates","detail":"..."} |