The REST Admin API is a legacy API as of October 1, 2024. Starting April 1, 2025, all new public apps must be built exclusively with the GraphQL Admin API. For details and migration steps, visit our migration guide.
Fulfillment
Requires
orders access scope.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.
Was this section helpful?
#
Endpoints
- post/admin/api/latest/orders/{order_
id}/fulfillments/{fulfillment_ id}/events. json Creates a fulfillment event - get/admin/api/latest/orders/{order_
id}/fulfillments/{fulfillment_ id}/events. json Retrieves a list of fulfillment events for a specific fulfillment - get/admin/api/latest/orders/{order_
id}/fulfillments/{fulfillment_ id}/events/{event_ id}. json Retrieves a specific fulfillment eventdeprecated - del/admin/api/latest/orders/{order_
id}/fulfillments/{fulfillment_ id}/events/{event_ id}. json Deletes a fulfillment eventdeprecated
Anchor to
The FulfillmentEvent resource
Anchor to
Properties
address1
->
address1
The street address where the fulfillment event occurred.
city
->
city
The city where the fulfillment event occurred.
country
->
country
The country where the fulfillment event occurred.
estimated_delivery_at
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
An ID for the fulfillment that's associated with the fulfillment event.
happened_at
The date and time (ISO 8601 format) when the fulfillment event occurred.
id
->
id
An ID for the fulfillment event.
latitude
->
latitude
A geographic coordinate specifying the latitude of the fulfillment event.
longitude
A geographic coordinate specifying the longitude of the fulfillment event.
message
->
message
An arbitrary message describing the status. Can be provided by a shipping carrier.
order_id
deprecated
The ID of the order that's associated with the fulfillment event.
Was this section helpful?
{}
The FulfillmentEvent resource
{
"address1": "3575 Boul. Saint-Laurent",
"city": "Montreal",
"country": "Canada",
"created_at": "2012-03-13T16:09:54-04:00",
"estimated_delivery_at": "2014-04-13T16:09:54-04:00",
"fulfillment_id": 450789469,
"happened_at": "2012-03-13T16:09:54-04:00",
"id": 255858046,
"latitude": 45.5017,
"longitude": 73.5673,
"message": "IN_TRANSIT",
"order_id": 3183479,
"province": "QC",
"shop_id": 255858046,
"status": "in_transit",
"updated_at": "2012-03-15T16:09:54-04:00",
"zip": "H2X 2R7"
}
Anchor to POST request, Creates a fulfillment eventpostCreates a fulfillment event
post
Creates a fulfillment event
Creates a fulfillment event
api_version
string
required
fulfillment_id
string
required
order_id
string
required
Was this section helpful?
Create a fulfillment event
Create a fulfillment event
Was this section helpful?
post
/admin/api/2025-10/orders/450789469/fulfillments/255858046/events.
curl -d '{"event":{"status":"in_transit"}}' \
-X POST "https://your-development-store.myshopify.com/admin/api/2025-10/orders/450789469/fulfillments/255858046/events.json" \
-H "X-Shopify-Access-Token: {access_token}" \
-H "Content-Type: application/json"
{}
Response
JSON
HTTP/1.1 201 Created
{
"fulfillment_event": {
"id": 944956392,
"fulfillment_id": 255858046,
"status": "in_transit",
"message": null,
"happened_at": "2025-10-01T15:06:01-04:00",
"city": null,
"province": null,
"country": null,
"zip": null,
"address1": null,
"latitude": null,
"longitude": null,
"shop_id": 548380009,
"created_at": "2025-10-01T15:06:01-04:00",
"updated_at": "2025-10-01T15:06:01-04:00",
"estimated_delivery_at": null,
"order_id": 450789469,
"admin_graphql_api_id": "gid://shopify/FulfillmentEvent/944956392"
}
}
examples
Create a fulfillment event
curl -d '{"event":{"status":"in_transit"}}' \ -X POST "https://your-development-store.myshopify.com/admin/api/2025-10/orders/450789469/fulfillments/255858046/events.json" \ -H "X-Shopify-Access-Token: {access_token}" \ -H "Content-Type: application/json"const { admin, session } = await authenticate.admin(request); const fulfillment_event = new admin.rest.resources.FulfillmentEvent({session: session}); fulfillment_event.order_id = 450789469; fulfillment_event.fulfillment_id = 255858046; fulfillment_event.status = "in_transit"; await fulfillment_event.save({ update: true, });# Session is activated via Authentication test_session = ShopifyAPI::Context.active_session fulfillment_event = ShopifyAPI::FulfillmentEvent.new(session: test_session) fulfillment_event.order_id = 450789469 fulfillment_event.fulfillment_id = 255858046 fulfillment_event.status = "in_transit" fulfillment_event.save!// Session is built by the OAuth process const fulfillment_event = new shopify.rest.FulfillmentEvent({session: session}); fulfillment_event.order_id = 450789469; fulfillment_event.fulfillment_id = 255858046; fulfillment_event.status = "in_transit"; await fulfillment_event.save({ update: true, });response
HTTP/1.1 201 Created{"fulfillment_event":{"id":944956392,"fulfillment_id":255858046,"status":"in_transit","message":null,"happened_at":"2025-10-01T15:06:01-04:00","city":null,"province":null,"country":null,"zip":null,"address1":null,"latitude":null,"longitude":null,"shop_id":548380009,"created_at":"2025-10-01T15:06:01-04:00","updated_at":"2025-10-01T15:06:01-04:00","estimated_delivery_at":null,"order_id":450789469,"admin_graphql_api_id":"gid://shopify/FulfillmentEvent/944956392"}}
Anchor to GET request, Retrieves a list of fulfillment events for a specific fulfillmentgetRetrieves a list of fulfillment events for a specific fulfillment
get
Retrieves a list of fulfillment events for a specific fulfillment
Retrieves a list of fulfillment events for a specific fulfillment
api_version
string
required
fulfillment_id
string
required
order_id
string
required
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.
Was this section helpful?
Retrieve a list of all the fulfillment events that are associated with a specific fulfillment
Retrieve a list of all the fulfillment events that are associated with a specific fulfillment
Was this section helpful?
get
/admin/api/2025-10/orders/450789469/fulfillments/255858046/events.
curl -X GET "https://your-development-store.myshopify.com/admin/api/2025-10/orders/450789469/fulfillments/255858046/events.json" \
-H "X-Shopify-Access-Token: {access_token}"
{}
Response
JSON
HTTP/1.1 200 OK
{
"fulfillment_events": [
{
"id": 944956394,
"fulfillment_id": 255858046,
"status": "in_transit",
"message": null,
"happened_at": "2025-10-01T15:06:02-04:00",
"city": null,
"province": null,
"country": null,
"zip": null,
"address1": null,
"latitude": null,
"longitude": null,
"shop_id": 548380009,
"created_at": "2025-10-01T15:06:02-04:00",
"updated_at": "2025-10-01T15:06:02-04:00",
"estimated_delivery_at": null,
"order_id": 450789469,
"admin_graphql_api_id": "gid://shopify/FulfillmentEvent/944956394"
}
]
}
examples
Retrieve a list of all the fulfillment events that are associated with a specific fulfillment
curl -X GET "https://your-development-store.myshopify.com/admin/api/2025-10/orders/450789469/fulfillments/255858046/events.json" \ -H "X-Shopify-Access-Token: {access_token}"await admin.rest.resources.FulfillmentEvent.all({ session: session, order_id: 450789469, fulfillment_id: 255858046, });# Session is activated via Authentication test_session = ShopifyAPI::Context.active_session ShopifyAPI::FulfillmentEvent.all( session: test_session, order_id: 450789469, fulfillment_id: 255858046, )// Session is built by the OAuth process await shopify.rest.FulfillmentEvent.all({ session: session, order_id: 450789469, fulfillment_id: 255858046, });response
HTTP/1.1 200 OK{"fulfillment_events":[{"id":944956394,"fulfillment_id":255858046,"status":"in_transit","message":null,"happened_at":"2025-10-01T15:06:02-04:00","city":null,"province":null,"country":null,"zip":null,"address1":null,"latitude":null,"longitude":null,"shop_id":548380009,"created_at":"2025-10-01T15:06:02-04:00","updated_at":"2025-10-01T15:06:02-04:00","estimated_delivery_at":null,"order_id":450789469,"admin_graphql_api_id":"gid://shopify/FulfillmentEvent/944956394"}]}
Anchor to GET request, Retrieves a specific fulfillment eventgetRetrieves a specific fulfillment event deprecated
get
Retrieves a specific fulfillment event
deprecated
Retrieves a specific fulfillment event
api_version
string
required
event_id
string
required
fulfillment_id
string
required
order_id
string
required
event_id
The ID of the fulfillment event.
Was this section helpful?
Retrieve a specific fulfillment event
Retrieve a specific fulfillment event
Was this section helpful?
get
/admin/api/2025-10/orders/450789469/fulfillments/255858046/events/944956393.
curl -X GET "https://your-development-store.myshopify.com/admin/api/2025-10/orders/450789469/fulfillments/255858046/events/944956393.json" \
-H "X-Shopify-Access-Token: {access_token}"
{}
Response
JSON
HTTP/1.1 200 OK
{
"fulfillment_event": {
"id": 944956393,
"fulfillment_id": 255858046,
"status": "in_transit",
"message": null,
"happened_at": "2025-10-01T15:06:01-04:00",
"city": null,
"province": null,
"country": null,
"zip": null,
"address1": null,
"latitude": null,
"longitude": null,
"shop_id": 548380009,
"created_at": "2025-10-01T15:06:01-04:00",
"updated_at": "2025-10-01T15:06:01-04:00",
"estimated_delivery_at": null,
"order_id": 450789469,
"admin_graphql_api_id": "gid://shopify/FulfillmentEvent/944956393"
}
}
examples
Retrieve a specific fulfillment event
curl -X GET "https://your-development-store.myshopify.com/admin/api/2025-10/orders/450789469/fulfillments/255858046/events/944956393.json" \ -H "X-Shopify-Access-Token: {access_token}"await admin.rest.resources.FulfillmentEvent.find({ session: session, order_id: 450789469, fulfillment_id: 255858046, id: 944956393, });# Session is activated via Authentication test_session = ShopifyAPI::Context.active_session ShopifyAPI::FulfillmentEvent.find( session: test_session, order_id: 450789469, fulfillment_id: 255858046, id: 944956393, )// Session is built by the OAuth process await shopify.rest.FulfillmentEvent.find({ session: session, order_id: 450789469, fulfillment_id: 255858046, id: 944956393, });response
HTTP/1.1 200 OK{"fulfillment_event":{"id":944956393,"fulfillment_id":255858046,"status":"in_transit","message":null,"happened_at":"2025-10-01T15:06:01-04:00","city":null,"province":null,"country":null,"zip":null,"address1":null,"latitude":null,"longitude":null,"shop_id":548380009,"created_at":"2025-10-01T15:06:01-04:00","updated_at":"2025-10-01T15:06:01-04:00","estimated_delivery_at":null,"order_id":450789469,"admin_graphql_api_id":"gid://shopify/FulfillmentEvent/944956393"}}
Anchor to DELETE request, Deletes a fulfillment eventdelDeletes a fulfillment event deprecated
del
Deletes a fulfillment event
deprecated
Deletes a fulfillment event
api_version
string
required
event_id
string
required
fulfillment_id
string
required
order_id
string
required
Was this section helpful?
Delete a fulfillment event
Delete a fulfillment event
Was this section helpful?
del
/admin/api/2025-10/orders/450789469/fulfillments/255858046/events/944956391.
curl -X DELETE "https://your-development-store.myshopify.com/admin/api/2025-10/orders/450789469/fulfillments/255858046/events/944956391.json" \
-H "X-Shopify-Access-Token: {access_token}"
{}
Response
JSON
HTTP/1.1 200 OK
{}
examples
Delete a fulfillment event
curl -X DELETE "https://your-development-store.myshopify.com/admin/api/2025-10/orders/450789469/fulfillments/255858046/events/944956391.json" \ -H "X-Shopify-Access-Token: {access_token}"await admin.rest.resources.FulfillmentEvent.delete({ session: session, order_id: 450789469, fulfillment_id: 255858046, id: 944956391, });# Session is activated via Authentication test_session = ShopifyAPI::Context.active_session ShopifyAPI::FulfillmentEvent.delete( session: test_session, order_id: 450789469, fulfillment_id: 255858046, id: 944956391, )// Session is built by the OAuth process await shopify.rest.FulfillmentEvent.delete({ session: session, order_id: 450789469, fulfillment_id: 255858046, id: 944956391, });response
HTTP/1.1 200 OK{}