Update the warehouse state of one or multiple shipments

Note: This endpoint is only available to eFulfillment clients who have shipments fulfilled at one of Easyship's integrated warehouses.

📘

Metadata sent with the Update Warehouse State endpoint

If the shipment already contains metadata, existing keys will be overwritten and new keys will be added.


Reference: Warehouse States

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:

  • 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

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.

Language
Authentication
Header
Click Try It! to start a request and see the response here!