Update Status

put

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

Hold - Put the shipments on hold for up to 28 days. Shipments on hold 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 manifests.

Cancel - Use to cancel/void one or more current shipments. This can only be used before a shipment has been confirmed by being manifested.

Release - Use to release shipments from hold and shipments cancelled for less than 24 hours. Once released, the shipment will be included in the next manifest.

Picked - Set the shipment to picked. This means this shipment will only be manifested if you choose to manifest 'Picked' shipments.

Body Params

Update Status Request

Status

string

enum

required

Update Status Type

Hold - Put the shipments on hold for up to 28 days. Shipments on hold 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 manifests.
Cancel - Use to cancel/void one or more current shipments. This can only be used before a shipment has been confirmed by being manifested.
Release - Use to release shipments from hold and shipments cancelled for less than 24 hours. Once released, the shipment will be included in the next manifest.
Picked - Set the shipment to picked. This means this shipment will only be manifested if you choose to manifest 'Picked' shipments.

Allowed:

Reason

string | null

Reason
The reason for this status update.

If the status you are updating to is 'Hold' the reason is required and must be 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', the reason is required and must be one of the following values:
Order Cancelled
Packed in Error
Repacked

ShipmentIds

array of strings

required

Shipment Ids
The shipments to apply the change to.
There must be at least 1 shipment and a maximum of 99.

The Shipment Id may be an id or a tracking/barcode number.
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

400Invalid request response.