Skip to main content

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.

FulfillmentEvent

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

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.

created_at
->
createdAt

The date and time (ISO 8601 format) when the fulfillment event was created.

estimated_delivery_at
->
estimatedDeliveryAt

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
->
happenedAt

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
->
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 event
post
Creates a fulfillment event

fulfillmentEventCreate

Creates a fulfillment event

Anchor to Parameters of Creates a fulfillment eventParameters

api_version
string
required
fulfillment_id
string
required
order_id
string
required
Was this section helpful?

Anchor to post-orders-order-id-fulfillments-fulfillment-id-events-examplesExamples

Create a fulfillment event

Was this section helpful?
post

/admin/api/2025-07/orders/450789469/fulfillments/255858046/events.json

curl -d '{"event":{"status":"in_transit"}}' \
-X POST "https://your-development-store.myshopify.com/admin/api/2025-07/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-07-01T14:04:33-04:00",
"city": null,
"province": null,
"country": null,
"zip": null,
"address1": null,
"latitude": null,
"longitude": null,
"shop_id": 548380009,
"created_at": "2025-07-01T14:04:33-04:00",
"updated_at": "2025-07-01T14:04:33-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 fulfillment
get
Retrieves a list of fulfillment events for a specific fulfillment

fulfillment

Retrieves a list of fulfillment events for a specific fulfillment

Anchor to Parameters of Retrieves a list of fulfillment events for a specific fulfillmentParameters

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?

Anchor to get-orders-order-id-fulfillments-fulfillment-id-events-examplesExamples

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

Was this section helpful?
get

/admin/api/2025-07/orders/450789469/fulfillments/255858046/events.json

curl -X GET "https://your-development-store.myshopify.com/admin/api/2025-07/orders/450789469/fulfillments/255858046/events.json" \
-H "X-Shopify-Access-Token: {access_token}"

{}

Response

JSON
HTTP/1.1 200 OK
{
"fulfillment_events": [
{
"id": 944956391,
"fulfillment_id": 255858046,
"status": "in_transit",
"message": null,
"happened_at": "2025-07-01T14:04:32-04:00",
"city": null,
"province": null,
"country": null,
"zip": null,
"address1": null,
"latitude": null,
"longitude": null,
"shop_id": 548380009,
"created_at": "2025-07-01T14:04:32-04:00",
"updated_at": "2025-07-01T14:04:32-04:00",
"estimated_delivery_at": null,
"order_id": 450789469,
"admin_graphql_api_id": "gid://shopify/FulfillmentEvent/944956391"
}
]
}

Anchor to GET request, Retrieves a specific fulfillment event
get
Retrieves a specific fulfillment event
deprecated

Retrieves a specific fulfillment event

Anchor to Parameters of Retrieves a specific fulfillment eventParameters

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?

Anchor to get-orders-order-id-fulfillments-fulfillment-id-events-event-id-examplesExamples

Retrieve a specific fulfillment event

Was this section helpful?
get

/admin/api/2025-07/orders/450789469/fulfillments/255858046/events/944956394.json

curl -X GET "https://your-development-store.myshopify.com/admin/api/2025-07/orders/450789469/fulfillments/255858046/events/944956394.json" \
-H "X-Shopify-Access-Token: {access_token}"

{}

Response

JSON
HTTP/1.1 200 OK
{
"fulfillment_event": {
"id": 944956394,
"fulfillment_id": 255858046,
"status": "in_transit",
"message": null,
"happened_at": "2025-07-01T14:04:35-04:00",
"city": null,
"province": null,
"country": null,
"zip": null,
"address1": null,
"latitude": null,
"longitude": null,
"shop_id": 548380009,
"created_at": "2025-07-01T14:04:35-04:00",
"updated_at": "2025-07-01T14:04:35-04:00",
"estimated_delivery_at": null,
"order_id": 450789469,
"admin_graphql_api_id": "gid://shopify/FulfillmentEvent/944956394"
}
}

Anchor to DELETE request, Deletes a fulfillment event
del
Deletes a fulfillment event
deprecated

Deletes a fulfillment event

Anchor to Parameters of Deletes a fulfillment eventParameters

api_version
string
required
event_id
string
required
fulfillment_id
string
required
order_id
string
required
Was this section helpful?

Anchor to delete-orders-order-id-fulfillments-fulfillment-id-events-event-id-examplesExamples

Delete a fulfillment event

Was this section helpful?
del

/admin/api/2025-07/orders/450789469/fulfillments/255858046/events/944956393.json

curl -X DELETE "https://your-development-store.myshopify.com/admin/api/2025-07/orders/450789469/fulfillments/255858046/events/944956393.json" \
-H "X-Shopify-Access-Token: {access_token}"

{}

Response

JSON
HTTP/1.1 200 OK
{}