patch https://api.easyship.com/shipment//shipments/update_warehouse_state
eFulfilment clients only
This endpoint is only available for shipments fulfilled at one of the Easyship integrated warehouses. Please contact us for more information.
| status | 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 |
creation_failed | The order creation was rejected for an internal reason by the WMS. This can happen for instance 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 error_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: if the shipment was created through a store integration, Easyship will mark the order as "shipped" on the store If the company has the email notification option turned on, Easyship will send an email notification to the receiver, with the tracking number and the tracking page URL * Easyship will start tracking the shipment, and update its status based on the courier's tracking events |
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. |
Status updated to "shipped"
Updating a shipment's
warehouse_stateto "shipped" will trigger:
- Easyship will start tracking the shipment in real time
- if the shipment was sync'ed from a store integration (e.g. Magento, Shopify...), Easyship will automatically push a status update to the store, including the tracking number and tracking page URL
- if you opted in for the email notifications to the receiver, Easyship will send a email to the receiver with the tracking page URL