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âmetro | O que é | Obrigatório | Exemplo |
|---|---|---|---|
created_at_gte | Data inicial inclusiva do período (ISO-8601) | Sim | 2026-03-01T00:00:00Z |
created_at_lte | Data final inclusiva do período (ISO-8601) | Sim | 2026-01-01T23:59:59Z |
_sort | Campo e direção de ordenação dos resultados (ex.: created_at:desc) | Não | created_at:desc |
_limit | Quantidade máxima de registros por página (1 a 200) | Não | 10 |
_offset | Offset para paginação | Não | 0 |
| Header | O que é | Obrigatório |
|---|---|---|
x-correlation-id | Identificador de correlação para rastreio da chamada | Nã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:
| Valor | Descrição |
|---|---|
open:logistic-shipmentdeadline-shipper:read | Permite a leitura de remessas com uma nova data de entrega. |