FulfillmentEvent

The FulfillmentEvent resource represents tracking events that belong to a fulfillment of one or more items in an order. Fulfillment events are displayed on the order status page to update customers on the status of their shipment.

What you can do with FulfillmentEvent

The Shopify API lets you do the following with the FulfillmentEvent resource. More detailed versions of these general actions may be available:

FulfillmentEvent properties

address1 plain "address1": "3575 Boul. Saint-Laurent" The street address where the fulfillment event occurred.
city plain "city": "Montreal" The city where the fulfillment event occurred.
country plain "country": "Canada" The country where the fulfillment event occurred.
created_at plain "created_at": "2012-03-13T16:09:54-04:00" The date and time (ISO 8601 format) when the fulfillment event was created.
estimated_delivery_at plain "estimated_delivery_at": "2014-04-13T16:09:54-04:00" The estimated delivery date based on the fulfillment’s tracking number, as long as it’s provided by one of the following carriers: USPS, FedEx, UPS, or Canada Post (Canada only). Value is null if no tracking number is available or if the tracking number is from an unsupported carrier. This property is available only when carrier calculated rates are in use.’
fulfillment_id plain "fulfillment_id": 450789469 An ID for the fulfillment that’s associated with the fulfillment event.
happened_at plain "happened_at": "2012-03-13T16:09:54-04:00" The date and time (ISO 8601 format) when the fulfillment event occurred.
id plain "id": 255858046 An ID for the fulfillment event.
latitude plain "latitude": 45.5017 A geographic coordinate specifying the latitude of the fulfillment event.
longitude plain "longitude": 73.5673 A geographic coordinate specifying the longitude of the fulfillment event.
message plain "message": "IN_TRANSIT" An arbitrary message describing the status. Can be provided by a shipping carrier.
order_id plain "order_id": 3183479 The ID of the order that’s associated with the fulfillment event.
province plain "province": "QC" The province where the fulfillment event occurred.
shop_id plain "shop_id": 255858046 An ID for the shop that’s associated with the fulfillment event.
status plain "status": "in_transit" The status of the fulfillment event. Valid values:
+ label_printed: A label for the shipment was purchased and printed.
+ label_purchased: A label for the shipment was purchased, but not printed.
+ attempted_delivery: Delivery of the shipment was attempted, but unable to be completed.
+ ready_for_pickup: The shipment is ready for pickup at a shipping depot.
+ picked_up: The fulfillment was successfully picked up.
+ confirmed: The carrier is aware of the shipment, but hasn’t received it yet.
+ in_transit: The shipment is being transported between shipping facilities on the way to its destination.
+ out_for_delivery: The shipment is being delivered to its final destination.
+ delivered: The shipment was successfully delivered.
+ failure: Something went wrong when pulling tracking information for the shipment, such as the tracking number was invalid or the shipment was canceled.
updated_at plain "updated_at": "2012-03-15T16:09:54-04:00" The date and time (ISO 8601 format) when the fulfillment event was updated.
zip plain "zip": "H2X 2R7" The zip code of the location where the fulfillment event occurred.

Endpoints

GET/admin/api/2021-01/orders/{order_id}/fulfillments/{fulfillment_id}/events.json Retrieves a list of fulfillment events for a specific fulfillment
fulfillment_id The ID of the fulfillment that’s associated with the fulfillment event.
order_id The ID of the order that’s associated with the fulfillment event.

Retrieve a list of all the fulfillment events that are associated with a specific fulfillment

GET /admin/api/2021-01/orders/450789469/fulfillments/255858046/events.json

View Response

GET/admin/api/2021-01/orders/{order_id}/fulfillments/{fulfillment_id}/events/{event_id}.json Retrieves a specific fulfillment event
event_id The ID of the fulfillment event.

Retrieve a specific fulfillment event

GET /admin/api/2021-01/orders/450789469/fulfillments/255858046/events/944956392.json

View Response

POST/admin/api/2021-01/orders/{order_id}/fulfillments/{fulfillment_id}/events.json Creates a fulfillment event

Create a fulfillment event

POST /admin/api/2021-01/orders/450789469/fulfillments/255858046/events.json

{

“event”: {

  1. "status": "in_transit"

}

}

View Response

DELETE/admin/api/2021-01/orders/{order_id}/fulfillments/{fulfillment_id}/events/{event_id}.json Deletes a fulfillment event

Delete a fulfillment event

DELETE /admin/api/2021-01/orders/450789469/fulfillments/255858046/events/944956394.json

View Response