VenddorDocumentação API
API atualAPI legada
Guia rápidoReferência completa
Carregando índice…
API atual/Referência completa/Janela de entrega

Simular a data de entrega

Calcula a data de entrega que a loja prometeria agora para um produto, um método de envio e um CEP, sem gravar nada.

Use esta rota para conferir uma configuração antes de publicá-la, ou para depurar uma promessa que parece errada. Ela roda exatamente o mesmo cálculo da página do produto, com a hora atual, e devolve as datas e o texto que o cliente veria. Nada é gravado.

Simular

POST/api/v1/admin/delivery-window/previewAdmin

Simula a data de entrega

Exige o privilégio manage_shipping (também para ler) e o módulo delivery-window ligado.

Corpo da requisição

product_iduuid
Produto. Se informado e o produto tem processing_days maior que zero, ele substitui o preparo padrão. Opcional.
shipping_method_iduuid
Método de envio, para obter os dias de transporte. Sem ele (ou desativado), o transporte conta zero dia.
postal_codestring
CEP de destino, para escolher o prazo da área do endereço.

Exemplo de requisição

bash
curl -X POST "$BASE_URL/api/v1/admin/delivery-window/preview" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "product_id": "d8a6c5e7-8e44-4055-a0e2-49014f5d17f6",
    "shipping_method_id": "50000000-0000-0000-0000-000000000001",
    "postal_code": "01310-100"
  }'

Resposta

200Estimativa
json
{
  "earliest_date": "2026-10-15",
  "latest_date": "2026-10-16",
  "business_days": 2,
  "business_days_min": 2,
  "display_text": "qui., 15 de out.",
  "display_format": "date_range"
}

Campos da resposta

earliest_datestring
Data mais cedo, AAAA-MM-DD.
latest_datestring
Data mais tarde, AAAA-MM-DD.
business_daysinteger
Dias úteis totais até a data mais tarde (preparo + transporte máximo).
business_days_mininteger
Dias úteis totais até a data mais cedo.
display_textstring
Texto pronto para mostrar, no formato de display_format, em português.
display_formatstring
date_rangebusiness_dayshidden
Formato de exibição da loja.
buy_by_datestring
Só em entrega de dia fixo: último dia para comprar e pegar o próximo fechamento.
fixed_windowboolean
Presente e verdadeiro quando a data veio de uma regra de dia fixo, não do calendário comum.

Erros

StatusQuandoCorpo
401Sem token, token inválido ou expirado{"error":"invalid or expired token"}
403Sem o privilégio manage_shipping{"error":"insufficient privileges","privilege_required_any":["manage_shipping"]}
403Módulo delivery-window desligado{"error":"module_disabled","module":"delivery-window"}
400Corpo que não é JSON{"error":"invalid request body","detail":"..."}
500shipping_method_id ou product_id que não é UUID, ou método inexistente{"error":"failed to calculate delivery estimate","detail":"..."}
Teste o corte

A simulação usa a hora de agora. Para ver o efeito do horário de corte, rode a simulação antes e depois dele, ou ajuste cutoff_time para alguns minutos adiante, simule e volte ao valor real.

Cotação do checkout pode diferir

Se o método de envio tem os dias vindos de uma cotação de transportadora em tempo real, a promessa do checkout usa esses dias e não soma o preparo da loja de novo. A simulação usa os dias configurados no método e na área.

Veja também

  • Configuração
  • Áreas do método
Anterior
Feriados da entrega
Próxima
Monitoramento de entregas
Nesta página
  • Simular
  • Exemplo de requisição
  • Resposta
  • Erros
  • Veja também