post https://api.easyship.com/2023-01/shipments/warehouse_state_updates
Update the warehouse state of one or multiple shipments.
Required authorization scope: Shipment
This endpoint is only available to eFulfillment clients with shipments fulfilled at one of Easyship's integrated warehouses.
If a shipment contains the
metadata
object, it will persist unless you change existing keys or create new ones: in this case, corresponding keys will be updated or added.
The warehouse_state
field has the following possible statuses:
warehouse_state | Description |
---|---|
created
|
An order has been created in the warehouse management system and is ready to be fulfilled. Note: This update is not needed if a success response is sent when Easyship sends the label callback. |
failed
|
The order creation was rejected for an internal reason by the WMS. This can happen if the order information doesn't meet the WMS' requirements, or a product SKU is not defined in your WMS. A message can be added using the message parameter. This will allow the client and Easyship to understand the reason for rejection. |
packed
|
The order has been processed and packed and is waiting to be handed over to the courier |
shipped
|
The order has been handed over to the courier and has left the warehouse. Note: This status update will trigger the following:
|
cancellation_requested
|
A cancellation request has been sent to the warehouse management system. It is awaiting confirmation by the warehouse. Note: This status is set by clients requesting a cancellation through the dashboard. It should not be set by a warehouse. |
cancelled
|
The order has been cancelled in the warehouse management system. Note: This status update will trigger Easyship to cancel the shipment. |
cancelled_no_stock
|
The order has been cancelled in the warehouse management system because the products are out of stock. Note: This status update will trigger Easyship to cancel the shipment. |
backorder_no_stock
|
The order is set as backorder because of the products are out of stock. It may be packed and shipped at a later date. |
returned
|
The package was returned by the courier or by the receiver, and received at the warehouse. |