# 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.

## Resource Properties ### FulfillmentEvent * address1: The street address where the fulfillment event occurred. * Type: x-string * Example: "3575 Boul. Saint-Laurent" * city: The city where the fulfillment event occurred. * Type: x-string * Example: "Montreal" * country: The country where the fulfillment event occurred. * Type: x-string * Example: "Canada" * created_at: The date and time (ISO 8601 format) when the fulfillment event was created. * Type: x-string * Example: "2012-03-13T16:09:54-04:00" * 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.' * Type: x-string * Example: "2014-04-13T16:09:54-04:00" * fulfillment_id: An ID for the fulfillment that's associated with the fulfillment event. * Type: x-string * Example: 450789469 * happened_at: The date and time (ISO 8601 format) when the fulfillment event occurred. * Type: x-string * Example: "2012-03-13T16:09:54-04:00" * id: An ID for the fulfillment event. * Type: x-string * Example: 255858046 * latitude: A geographic coordinate specifying the latitude of the fulfillment event. * Type: x-string * Example: 45.5017 * longitude: A geographic coordinate specifying the longitude of the fulfillment event. * Type: x-string * Example: 73.5673 * message: An arbitrary message describing the status. Can be provided by a shipping carrier. * Type: x-string * Example: "IN_TRANSIT" * order_id: The ID of the order that's associated with the fulfillment event. * Type: x-string * Example: 3183479 * province: The province where the fulfillment event occurred. * Type: x-string * Example: "QC" * shop_id: An ID for the shop that's associated with the fulfillment event. * Type: x-string * Example: 255858046 * status:

The status of the fulfillment event. Valid values:

* Type: x-string * Example: "in_transit" * updated_at: The date and time (ISO 8601 format) when the fulfillment event was updated. * Type: x-string * Example: "2012-03-15T16:09:54-04:00" * zip: The zip code of the location where the fulfillment event occurred. * Type: x-string * Example: "H2X 2R7" ## Retrieves a list of fulfillment events for a specific fulfillment Retrieves a list of fulfillment events for a specific fulfillment ### Endpoint /admin/api/#{api_version}/orders/{order_id}/fulfillments/{fulfillment_id}/events.json (GET) ### Parameters * api_version (required): * fulfillment_id (required): * order_id (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. ### Responses #### 200 Retrieves a list of fulfillment events for a specific fulfillment Examples: ##### Retrieve a list of all the fulfillment events that are associated with a specific fulfillment Request: ``` GET /admin/api/unstable/orders/450789469/fulfillments/255858046/events.json ``` Response: ``` HTTP/1.1 200 OK {"fulfillment_events":[{"id":944956392,"fulfillment_id":255858046,"status":"in_transit","message":null,"happened_at":"2025-01-02T11:39:28-05:00","city":null,"province":null,"country":null,"zip":null,"address1":null,"latitude":null,"longitude":null,"shop_id":548380009,"created_at":"2025-01-02T11:39:28-05:00","updated_at":"2025-01-02T11:39:28-05:00","estimated_delivery_at":null,"order_id":450789469,"admin_graphql_api_id":"gid://shopify/FulfillmentEvent/944956392"}]} ``` ## Creates a fulfillment event Creates a fulfillment event ### Endpoint /admin/api/#{api_version}/orders/{order_id}/fulfillments/{fulfillment_id}/events.json (POST) ### Parameters * api_version (required): * fulfillment_id (required): * order_id (required): ### Responses #### 201 Creates a fulfillment event Examples: ##### Create a fulfillment event Request: ``` POST /admin/api/unstable/orders/450789469/fulfillments/255858046/events.json {"event":{"status":"in_transit"}} ``` Response: ``` HTTP/1.1 201 Created {"fulfillment_event":{"id":944956394,"fulfillment_id":255858046,"status":"in_transit","message":null,"happened_at":"2025-01-02T11:39:30-05:00","city":null,"province":null,"country":null,"zip":null,"address1":null,"latitude":null,"longitude":null,"shop_id":548380009,"created_at":"2025-01-02T11:39:30-05:00","updated_at":"2025-01-02T11:39:30-05:00","estimated_delivery_at":null,"order_id":450789469,"admin_graphql_api_id":"gid://shopify/FulfillmentEvent/944956394"}} ``` ## Retrieves a specific fulfillment event Retrieves a specific fulfillment event ### Endpoint /admin/api/#{api_version}/orders/{order_id}/fulfillments/{fulfillment_id}/events/{event_id}.json (GET) ### Parameters * api_version (required): * event_id (required): * fulfillment_id (required): * order_id (required): * event_id: The ID of the fulfillment event. ### Responses #### 200 Retrieves a specific fulfillment event Examples: ##### Retrieve a specific fulfillment event Request: ``` GET /admin/api/unstable/orders/450789469/fulfillments/255858046/events/944956391.json ``` Response: ``` HTTP/1.1 200 OK {"fulfillment_event":{"id":944956391,"fulfillment_id":255858046,"status":"in_transit","message":null,"happened_at":"2025-01-02T11:39:28-05:00","city":null,"province":null,"country":null,"zip":null,"address1":null,"latitude":null,"longitude":null,"shop_id":548380009,"created_at":"2025-01-02T11:39:28-05:00","updated_at":"2025-01-02T11:39:28-05:00","estimated_delivery_at":null,"order_id":450789469,"admin_graphql_api_id":"gid://shopify/FulfillmentEvent/944956391"}} ``` ## Deletes a fulfillment event Deletes a fulfillment event ### Endpoint /admin/api/#{api_version}/orders/{order_id}/fulfillments/{fulfillment_id}/events/{event_id}.json (DELETE) ### Parameters * api_version (required): * event_id (required): * fulfillment_id (required): * order_id (required): ### Responses #### 200 Deletes a fulfillment event Examples: ##### Delete a fulfillment event Request: ``` DELETE /admin/api/unstable/orders/450789469/fulfillments/255858046/events/944956393.json ``` Response: ``` HTTP/1.1 200 OK {} ```