Pular para o conteúdo principal

Entendendo a mudança de prazo

Quando uma remessa tem a data de entrega replanejada, o cliente ou integrador precisa saber o quanto antes: o que foi prometido mudou, e a comunicação com o destinatário precisa refletir a nova data. A consulta de novos prazos de entrega reúne os dados necessários para essa atualização em um único recurso.

O papel da consulta de novos prazos​

O endpoint principal dessa capacidade é:

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

A consulta retorna uma lista paginada das remessas com prazo atualizado. Cada registro apresenta:

  • o identificador da remessa (shipment_id);
  • o identificador do pacote (package_id);
  • o identificador do pedido relacionado (order_id);
  • a data de entrega original (old_delivery_date);
  • a nova data de entrega (new_delivery_date).

Quando usar​

Use a consulta de novos prazos quando o ERP, Hub ou sistema do cliente precisar:

  • atualizar a data de entrega exibida ao destinatário;
  • identificar as remessas afetadas por um replanejamento;
  • manter um histórico das mudanças de prazo para análise operacional.

A consulta pode ser orientada por período (created_at_gte e created_at_lte, formato ISO-8601) e paginada com _limit e _offset, além de ordenada com _sort (ex.: created_at:desc).

Para receber cada mudança no momento em que ela acontece, o tópico de webhook logistic_shipmentdeadline_updated notifica a atualização da data de entrega da remessa.

Os parâmetros, respostas, escopos e exemplos estão na página técnica de novos prazos de entrega.