Order Fulfillment API - Support for Shipment Status
January 27th, 2025
Feature Release
We added support for status
at the shipment-level in the Order Fulfillment API. This enables the abilty to send delivery confirmation emails at the shipment-level.
What's New?
- You can now pass
status
when creating/updating shipments. View documentation here. - Shipment-level shipping confirmation email will be sent upon setting a shipment as
shipped
. - Shipment-level delivery confirmation email will be sent upon setting a shipment as
delivered
. - If
status
is not sent, legacy logic applies:- Shipping confirmation email sent upon shipment creation.
- Delivery confirmation email sent upon setting a fulfillment as
delivered
.
Deprecation Notice
The legacy email logic will be deprecated at a later time, after the full adoption of shipment status
. For now, it remains in place to allow for a smooth transition.
Cutover Recommendations
- Start using
status
on new orders. Updating existing shipments may result in duplicate emails. - When sending
status
, please ensure that it's sent for all shipments within the order to avoid duplicate emails being sent.