FulfillmentEvent

A FulfillmentEvent represents a tracking event belonging 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 can you 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

created_at
{ "created_at" : "2012-03-13T16:09:54-04:00" }

The date and time when the fulfillment event was created. The API returns this value in ISO 8601 format.

updated_at
{ "updated_at" : "2012-03-15T16:09:54-04:00" }

The date and time when the fulfillment event was updated. The API returns this value in ISO 8601 format.

id
{ "id" : 255858046 }

A numeric unique identifier for the fulfillment event.

shop_id
{ "id" : 255858046 }

A numeric unique identifier for the shop to which the fulfillment event belongs.

order_id
{ "order_id  " : 3183479 }

The id of the order the fulfillment event belongs to

fulfillment_id
{ "fulfillment_id" : 450789469 }

A numeric unique identifier for the fulfillment to which the fulfillment event belongs.

status
{ "status" : "in_transit" }

The status of the fulfillment event. Valid values are:

  • 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 which will deliver the mailpiece.
  • delivered: The shipment has been scanned at the final delivery address.
  • failure: For whatever reason, the shipping carrier failed to deliver the shipment.

happened_at
{ "happened_at" : 450789469 }

The date and time when the fulfillment event occurred.

message
{ "message" : "IN_TRANSIT" }

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

city
{ "city" : "Montreal" }

The city in which the fulfillment event occurred.

province
{ "province" : "QC" }

The province in which the fulfillment event occurred.

zip
{ "zip" : "H2X 2R7" }

The zip code in the location in which the fulfillment event occurred.

country
{ "country" : "Canada" }

The country in which the fulfillment event occurred.

address1
{ "address1" : "3575 Boul. Saint-Laurent" }

The fulfillment event's street address.

latitude
{ "latitude" : 45.5017 }

Geographic coordinate specifying the north/south location of a fulfillment event.

longitude
{ "longitude" : 73.5673 }

Geographic coordinate specifying the east/west location of a fulfillment event.

Endpoints

GET/admin/orders/450789469/fulfillments/255858046/events.json
fulfillment_id

ID of the fulfillment to which the fulfillment event belongs.

order_id

ID of the order to which the fulfillment belongs.

Get a list of all fulfillment events for a fulfillment

GET /admin/orders/#{id}/fulfillments/#{id}/events.json
View Response
HTTP/1.1 200 OK
{
  "fulfillment_events": [
    {
      "id": 887533084,
      "fulfillment_id": 255858046,
      "status": "in_transit",
      "message": null,
      "happened_at": "2016-07-28T17:26:47-04:00",
      "city": null,
      "province": null,
      "country": null,
      "zip": null,
      "address1": null,
      "latitude": null,
      "longitude": null,
      "shop_id": 690933842,
      "created_at": "2016-07-28T17:26:47-04:00",
      "updated_at": "2016-07-28T17:26:47-04:00",
      "estimated_delivery_at": null,
      "order_id": 450789469
    }
  ]
}
GET/admin/orders/450789469/fulfillments/255858046/events/887533085.json

Fetch a fulfillment event.

GET /admin/orders/#{id}/fulfillments/#{id}/events/#{id}.json
View Response
HTTP/1.1 200 OK
{
  "fulfillment_event": {
    "id": 887533085,
    "fulfillment_id": 255858046,
    "status": "in_transit",
    "message": null,
    "happened_at": "2016-07-28T17:26:47-04:00",
    "city": null,
    "province": null,
    "country": null,
    "zip": null,
    "address1": null,
    "latitude": null,
    "longitude": null,
    "shop_id": 690933842,
    "created_at": "2016-07-28T17:26:47-04:00",
    "updated_at": "2016-07-28T17:26:47-04:00",
    "estimated_delivery_at": null,
    "order_id": 450789469
  }
}
POST/admin/orders/450789469/fulfillments/255858046/events.json

Create a fulfillment event.

POST /admin/orders/#{id}/fulfillments/#{id}/events.json
{
  "event": {
    "status": "in_transit"
  }
}
View Response
HTTP/1.1 201 Created
{
  "fulfillment_event": {
    "id": 887533083,
    "fulfillment_id": 255858046,
    "status": "in_transit",
    "message": null,
    "happened_at": "2016-07-28T17:26:46-04:00",
    "city": null,
    "province": null,
    "country": null,
    "zip": null,
    "address1": null,
    "latitude": null,
    "longitude": null,
    "shop_id": 690933842,
    "created_at": "2016-07-28T17:26:46-04:00",
    "updated_at": "2016-07-28T17:26:46-04:00",
    "estimated_delivery_at": null,
    "order_id": 450789469
  }
}
DELETE/admin/orders/450789469/fulfillments/255858046/events/887533082.json

Delete a fulfillment event.

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