Pular para o conteúdo principal

Novos Prazos de Entrega

Acompanhe os casos em que um prazo de entrega combinado no embarque precisou ser replanejado: qual remessa foi afetada, qual era a data prevista e qual é a nova data de entrega.

Para que serve​

Os novos prazos de entrega representam uma mudança no que foi prometido ao destinatário no momento do embarque. Esta capacidade permite acompanhar essas alterações de forma programática, para que a sua operação e o atendimento ao cliente estejam sempre com a data certa na mão.

Consultar novos prazos de entrega​

GET /logistics/shipments/v1/delivery-date-changes

Retorna uma lista paginada com os novos prazos de entrega atualizados das remessas do embarcador. Cada registro informa a remessa, o pacote, o pedido relacionado e a mudança de data: o prazo original (old_delivery_date) e o replanejado (new_delivery_date).

Os parâmetros created_at_gte e created_at_lte são obrigatórios e delimitam o período da consulta (formato ISO-8601).

ParâmetroO que éObrigatórioExemplo
created_at_gteData inicial inclusiva do período (ISO-8601)Sim2026-03-01T00:00:00Z
created_at_lteData final inclusiva do período (ISO-8601)Sim2026-01-01T23:59:59Z
_sortCampo e direção de ordenação dos resultados (ex.: created_at:desc)Nãocreated_at:desc
_limitQuantidade máxima de registros por página (1 a 200)Não10
_offsetOffset para paginaçãoNão0
HeaderO que éObrigatório
x-correlation-idIdentificador de correlação para rastreio da chamadaNão

Referência completa — Consultar novos prazos de entrega

Mudanças de prazo por webhook​

Além da consulta, é possível receber a mudança de prazo de forma reativa por webhook: o tópico logistic_shipmentdeadline_updated notifica quando uma remessa tem a data de entrega atualizada.

Escopos necessários​

Para a utilização das APIs os seguintes escopos poderão ser necessários:

ValorDescrição
open:logistic-shipmentdeadline-shipper:readPermite a leitura de remessas com uma nova data de entrega.