Sign in
Shipments

Defer Shipments

Postpone the processing or delivery of specific shipments. With this endpoint, you can specify which shipments you would like to defer and provide new shipment dates, streamlining the logistics workflow when shipments cannot proceed as planned due to issues, such as delays, scheduling conflicts, or customer requests. <br /> <br />Before deferring a shipment, bear in mind the following: <br /> <br />• The shipment can be deferred by a maximum of 28 days from the date of the request. <br />• The shipment can only be deferred before it has been manifested. <br />• The maximum allowable defer requests per call is 99.

put/v4/shipments/defer

Request body

ShipmentIdstring required

A unique identifier for the shipment that is being deferred. This ID is necessary to specify which shipment the new deferred status applies to, ensuring precise handling of the request.

ShipmentDatestring date required

A new date assigned to the shipment indicating when it is now scheduled to be manifested and shipped (handed over to the carrier). This field allows users to adjust their shipping timelines and effectively manage their logistics according to updated requirements or circumstances. <br /> <br />Before entering the new shipment date, keep in mind the following: <br />• The date must be in the YYYY-MM-DD format. <br />• The date must not be in the past and cannot be more than 28 days in the future.

Example request

[
  {
    "ShipmentId": "AD123456783GB"
  }
]

Response

All shipments were deferred successfully.

Changes

No recorded changes to this endpoint across all 1 revision of this API.