Sign in

v1

latestOpenAPI 3.1.02026-07-134488210.8 KB
Orders

Update Fulfillment Status

Post a shipment status update or trigger an automation event for a fulfillment.

The status field accepts two types of values:

Statuses (e.g., in_transit, delivered): Real carrier tracking statuses that update the shipment's current status. When you send these, the fulfillment's current status is updated to reflect the new state. Triggers any configured automations for that status.

Events (e.g., stalled_in_transit, delayed, arriving_early): Special event types that trigger automations without changing the current shipment status. The status field remains unchanged, but you can still update estimated delivery date and add tracking history entries. Use these to trigger event-based automations.

Both statuses and events can update other fields like estimated delivery date and tracking history.

Requires the orders_write scope.

post/stores/{storeId}/orders/{orderId}/fulfillments/{fulfillmentId}/shipment-status

Request body

status'pre_transit' | 'in_transit' | 'out_for_delivery' | 'available_for_pickup' | 'delivered' | 'return_to_sender' | 'failure' | 'cancelled' | 'error' | 'stalled_in_transit' | 'delayed' | 'arriving_early' required

Shipment status or automation event.

Statuses update the current shipment status and trigger automations: pre_transit, in_transit, out_for_delivery, available_for_pickup, delivered, return_to_sender, failure, cancelled, error.

Events trigger automations without changing the current status: stalled_in_transit, delayed, arriving_early.

estimatedDeliveryDatestring date-time nullable

Estimated delivery date in ISO 8601 format.

messagestring nullable

Tracking event message (e.g., "Departed shipping partner facility").

datetimestring date-time nullable

Timestamp of the tracking event in ISO 8601 format.

Response

Success

successtrue required