Update Status

put

https://api.intersoftsapient.net/v4/shipments/status

Modify the current status of one or more shipments in the system. With this endpoint, you can update the status of specified shipments, such as placing them on hold, cancelling them, releasing them for delivery, or marking them as picked.

Body Params

Update Status Request

Status

string

enum

required

A field indicating one of the following statuses to assign to the specified shipments.

Hold: Temporarily pauses the shipment, preventing it from proceeding until further action is taken. Before putting the shipment on hold, make sure of the following:
- You can only put the shipments on hold for up to 28 days.
- Shipments that are held for longer than 28 days will be cancelled.
- A shipment on hold will not be included in an closeouts/manifests, but instead will remain in its current state.
- You can only put shipments on hold that are in the LabelPrinted status, as only shipments with this status are included in the manifests.
Cancel: Marks the shipment as cancelled, indicating it will no longer be processed or delivered. This can only be used before a shipment has been confirmed by being manifested.
Release: Changes the shipment status to indicate it is cleared for delivery or further processing. Used to release shipments that were held for less than 24 hours. Once released, the shipment is included in the next manifest.
Picked: Indicates that the shipment has been picked up and is being prepared for delivery. This means this shipment will only be manifested if you choose to manifest the 'Picked' shipments.

Allowed:

Reason

string | null

A string providing the reason for the status update. Depending on the shipment's current status, specify why a shipment's status is being changed, adding context and aiding in future audits and management.

If the status you are updating to is Hold, then you must provide the reason using one of the following values:
• Awaiting Dispatch
• Awaiting Payment
• Awaiting Stock
• Awaiting Customer Response
• Held for Shipping Day
• Weight Consolidation
• Warehouse Processing

If the status you are updating to is Cancel, then you must provide the reason using one of the following values:
• Order Cancelled
• Packed in Error
• Repacked

ShipmentIds

array of strings

required

An array of unique identifiers for the shipments that are being updated. This field specifies to which shipments the new status will apply, allowing for batch processing of multiple shipments in a single request.

Note: There must be at least one shipment and a maximum of 99. This value can be an ID or a tracking/barcode number. However, for consignment shipments, only the consignment-level tracking/barcode number can be used.

ShipmentIds*

Responses

200

All shipments were updated successfully.

401

Unauthorized

403

Forbidden

500

Internal Server Error

Language

Credentials

OAuth2

Loading…

Response

Choose an example:

application/json

400Invalid request response.