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
"address1": "3575 Boul. Saint-Laurent"

The street address where the fulfillment event occurred.

city
"city": "Montreal"

The city where the fulfillment event occurred.

country
"country": "Canada"

The country where the fulfillment event occurred.

created_at
"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
"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
"fulfillment_id": 450789469

An ID for the fulfillment that's associated with the fulfillment event.

happened_at
"happened_at": "2012-03-13T16:09:54-04:00"

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

id
"id": 255858046

An ID for the fulfillment event.

latitude
"latitude": 45.5017

A geographic coordinate specifying the latitude of the fulfillment event.

longitude
"longitude": 73.5673

A geographic coordinate specifying the longitude of the fulfillment event.

message
"message": "IN_TRANSIT"

An arbitrary message describing the status. Can be provided by a shipping carrier.

order_id
"order_id": 3183479

The ID of the order that's associated with the fulfillment event.

province
"province": "QC"

The province where the fulfillment event occurred.

shop_id
"shop_id": 255858046

An ID for the shop that's associated with the fulfillment event.

status
"status": "in_transit"

The status of the fulfillment event. Valid values:

  • confirmed: The shipping carrier confirms that they have received the shipment request.
  • in_transit: The shipment has been received by the shipping carrier and it is on its way to its destination.
  • out_for_delivery: The shipment has been received at the facility that will deliver it.
  • delivered: The shipment has been scanned at the final delivery address.
  • failure: For whatever reason, the shipping carrier failed to deliver the shipment.
updated_at
"updated_at": "2012-03-15T16:09:54-04:00"

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

zip
"zip": "H2X 2R7"

The zip code of the location where the fulfillment event occurred.

Endpoints

GET /admin/orders/450789469/fulfillments/255858046/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/orders/#{order_id}/fulfillments/#{fulfillment_id}/events.json
View Response
HTTP/1.1 200 OK
{
  "fulfillment_events": [
    {
      "id": 944956399,
      "fulfillment_id": 255858046,
      "status": "in_transit",
      "message": null,
      "happened_at": "2018-11-14T16:28:39-05:00",
      "city": null,
      "province": null,
      "country": null,
      "zip": null,
      "address1": null,
      "latitude": null,
      "longitude": null,
      "shop_id": 690933842,
      "created_at": "2018-11-14T16:28:39-05:00",
      "updated_at": "2018-11-14T16:28:39-05:00",
      "estimated_delivery_at": null,
      "order_id": 450789469,
      "admin_graphql_api_id": "gid://shopify/FulfillmentEvent/944956399"
    }
  ]
}
GET /admin/orders/450789469/fulfillments/255858046/events/944956400.json
Retrieves a specific fulfillment event
event_id

The ID of the fulfillment event.

Retrieve a specific fulfillment event

GET /admin/orders/#{order_id}/fulfillments/#{fulfillment_id}/events/#{event_id}.json
View Response
HTTP/1.1 200 OK
{
  "fulfillment_event": {
    "id": 944956400,
    "fulfillment_id": 255858046,
    "status": "in_transit",
    "message": null,
    "happened_at": "2018-11-14T16:28:43-05:00",
    "city": null,
    "province": null,
    "country": null,
    "zip": null,
    "address1": null,
    "latitude": null,
    "longitude": null,
    "shop_id": 690933842,
    "created_at": "2018-11-14T16:28:43-05:00",
    "updated_at": "2018-11-14T16:28:43-05:00",
    "estimated_delivery_at": null,
    "order_id": 450789469,
    "admin_graphql_api_id": "gid://shopify/FulfillmentEvent/944956400"
  }
}
POST /admin/orders/450789469/fulfillments/255858046/events.json
Creates a fulfillment event

Create a fulfillment event

POST /admin/orders/#{order_id}/fulfillments/#{fulfillment_id}/events.json
{
  "event": {
    "status": "in_transit"
  }
}
View Response
HTTP/1.1 201 Created
{
  "fulfillment_event": {
    "id": 944956401,
    "fulfillment_id": 255858046,
    "status": "in_transit",
    "message": null,
    "happened_at": "2018-11-14T16:28:45-05:00",
    "city": null,
    "province": null,
    "country": null,
    "zip": null,
    "address1": null,
    "latitude": null,
    "longitude": null,
    "shop_id": 690933842,
    "created_at": "2018-11-14T16:28:45-05:00",
    "updated_at": "2018-11-14T16:28:45-05:00",
    "estimated_delivery_at": null,
    "order_id": 450789469,
    "admin_graphql_api_id": "gid://shopify/FulfillmentEvent/944956401"
  }
}
DELETE /admin/orders/450789469/fulfillments/255858046/events/944956402.json
Deletes a fulfillment event

Delete a fulfillment event

DELETE /admin/orders/#{order_id}/fulfillments/#{fulfillment_id}/events/#{event_id}.json
View Response
HTTP/1.1 200 OK
{
}

Sign up for a Partner account to get started.

Sign up