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:
- GET /admin/api/2020-01/orders/{order_id}/fulfillments/{fulfillment_id}/events.json Retrieves a list of fulfillment events for a specific fulfillment
- GET /admin/api/2020-01/orders/{order_id}/fulfillments/{fulfillment_id}/events/{event_id}.json Retrieves a specific fulfillment event
- POST /admin/api/2020-01/orders/{order_id}/fulfillments/{fulfillment_id}/events.json Creates a fulfillment event
- DELETE /admin/api/2020-01/orders/{order_id}/fulfillments/{fulfillment_id}/events/{event_id}.json Deletes a fulfillment event
FulfillmentEvent properties
address1 |
The street address where the fulfillment event occurred. |
city |
The city where the fulfillment event occurred. |
country |
The country where the fulfillment event occurred. |
created_at |
The date and time (ISO 8601 format) when the fulfillment event was created. |
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 |
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 |
An ID for the fulfillment event. |
latitude |
A geographic coordinate specifying the latitude of the fulfillment event. |
longitude |
A geographic coordinate specifying the longitude of the fulfillment event. |
message |
An arbitrary message describing the status. Can be provided by a shipping carrier. |
order_id |
The ID of the order that's associated with the fulfillment event. |
province |
The province where the fulfillment event occurred. |
shop_id |
An ID for the shop that's associated with the fulfillment event. |
status |
The status of the fulfillment event. Valid values:
|
updated_at |
The date and time (ISO 8601 format) when the fulfillment event was updated. |
zip |
The zip code of the location where the fulfillment event occurred. |
Endpoints
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/api/2020-01/orders/450789469/fulfillments/255858046/events.json
View Response
HTTP/1.1 200 OK
{
"fulfillment_events": [
{
"id": 944956391,
"fulfillment_id": 255858046,
"status": "in_transit",
"message": null,
"happened_at": "2021-01-01T14:36:19-05:00",
"city": null,
"province": null,
"country": null,
"zip": null,
"address1": null,
"latitude": null,
"longitude": null,
"shop_id": 690933842,
"created_at": "2021-01-01T14:36:19-05:00",
"updated_at": "2021-01-01T14:36:19-05:00",
"estimated_delivery_at": null,
"order_id": 450789469,
"admin_graphql_api_id": "gid://shopify/FulfillmentEvent/944956391"
}
]
}
event_id
|
The ID of the fulfillment event. |
Retrieve a specific fulfillment event
GET /admin/api/2020-01/orders/450789469/fulfillments/255858046/events/944956392.json
View Response
HTTP/1.1 200 OK
{
"fulfillment_event": {
"id": 944956392,
"fulfillment_id": 255858046,
"status": "in_transit",
"message": null,
"happened_at": "2021-01-01T14:36:20-05:00",
"city": null,
"province": null,
"country": null,
"zip": null,
"address1": null,
"latitude": null,
"longitude": null,
"shop_id": 690933842,
"created_at": "2021-01-01T14:36:20-05:00",
"updated_at": "2021-01-01T14:36:20-05:00",
"estimated_delivery_at": null,
"order_id": 450789469,
"admin_graphql_api_id": "gid://shopify/FulfillmentEvent/944956392"
}
}
Create a fulfillment event
POST /admin/api/2020-01/orders/450789469/fulfillments/255858046/events.json
{
"event": {
"status": "in_transit"
}
}
View Response
HTTP/1.1 201 Created
{
"fulfillment_event": {
"id": 944956393,
"fulfillment_id": 255858046,
"status": "in_transit",
"message": null,
"happened_at": "2021-01-01T14:36:21-05:00",
"city": null,
"province": null,
"country": null,
"zip": null,
"address1": null,
"latitude": null,
"longitude": null,
"shop_id": 690933842,
"created_at": "2021-01-01T14:36:21-05:00",
"updated_at": "2021-01-01T14:36:21-05:00",
"estimated_delivery_at": null,
"order_id": 450789469,
"admin_graphql_api_id": "gid://shopify/FulfillmentEvent/944956393"
}
}
Delete a fulfillment event
DELETE /admin/api/2020-01/orders/450789469/fulfillments/255858046/events/944956394.json
View Response
HTTP/1.1 200 OK
{
}
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:
- GET /admin/api/2020-04/orders/{order_id}/fulfillments/{fulfillment_id}/events.json Retrieves a list of fulfillment events for a specific fulfillment
- GET /admin/api/2020-04/orders/{order_id}/fulfillments/{fulfillment_id}/events/{event_id}.json Retrieves a specific fulfillment event
- POST /admin/api/2020-04/orders/{order_id}/fulfillments/{fulfillment_id}/events.json Creates a fulfillment event
- DELETE /admin/api/2020-04/orders/{order_id}/fulfillments/{fulfillment_id}/events/{event_id}.json Deletes a fulfillment event
FulfillmentEvent properties
address1 |
The street address where the fulfillment event occurred. |
city |
The city where the fulfillment event occurred. |
country |
The country where the fulfillment event occurred. |
created_at |
The date and time (ISO 8601 format) when the fulfillment event was created. |
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 |
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 |
An ID for the fulfillment event. |
latitude |
A geographic coordinate specifying the latitude of the fulfillment event. |
longitude |
A geographic coordinate specifying the longitude of the fulfillment event. |
message |
An arbitrary message describing the status. Can be provided by a shipping carrier. |
order_id |
The ID of the order that's associated with the fulfillment event. |
province |
The province where the fulfillment event occurred. |
shop_id |
An ID for the shop that's associated with the fulfillment event. |
status |
The status of the fulfillment event. Valid values:
|
updated_at |
The date and time (ISO 8601 format) when the fulfillment event was updated. |
zip |
The zip code of the location where the fulfillment event occurred. |
Endpoints
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/api/2020-04/orders/450789469/fulfillments/255858046/events.json
View Response
HTTP/1.1 200 OK
{
"fulfillment_events": [
{
"id": 944956391,
"fulfillment_id": 255858046,
"status": "in_transit",
"message": null,
"happened_at": "2021-01-01T14:36:19-05:00",
"city": null,
"province": null,
"country": null,
"zip": null,
"address1": null,
"latitude": null,
"longitude": null,
"shop_id": 690933842,
"created_at": "2021-01-01T14:36:19-05:00",
"updated_at": "2021-01-01T14:36:19-05:00",
"estimated_delivery_at": null,
"order_id": 450789469,
"admin_graphql_api_id": "gid://shopify/FulfillmentEvent/944956391"
}
]
}
event_id
|
The ID of the fulfillment event. |
Retrieve a specific fulfillment event
GET /admin/api/2020-04/orders/450789469/fulfillments/255858046/events/944956392.json
View Response
HTTP/1.1 200 OK
{
"fulfillment_event": {
"id": 944956392,
"fulfillment_id": 255858046,
"status": "in_transit",
"message": null,
"happened_at": "2021-01-01T14:36:20-05:00",
"city": null,
"province": null,
"country": null,
"zip": null,
"address1": null,
"latitude": null,
"longitude": null,
"shop_id": 690933842,
"created_at": "2021-01-01T14:36:20-05:00",
"updated_at": "2021-01-01T14:36:20-05:00",
"estimated_delivery_at": null,
"order_id": 450789469,
"admin_graphql_api_id": "gid://shopify/FulfillmentEvent/944956392"
}
}
Create a fulfillment event
POST /admin/api/2020-04/orders/450789469/fulfillments/255858046/events.json
{
"event": {
"status": "in_transit"
}
}
View Response
HTTP/1.1 201 Created
{
"fulfillment_event": {
"id": 944956393,
"fulfillment_id": 255858046,
"status": "in_transit",
"message": null,
"happened_at": "2021-01-01T14:36:21-05:00",
"city": null,
"province": null,
"country": null,
"zip": null,
"address1": null,
"latitude": null,
"longitude": null,
"shop_id": 690933842,
"created_at": "2021-01-01T14:36:21-05:00",
"updated_at": "2021-01-01T14:36:21-05:00",
"estimated_delivery_at": null,
"order_id": 450789469,
"admin_graphql_api_id": "gid://shopify/FulfillmentEvent/944956393"
}
}
Delete a fulfillment event
DELETE /admin/api/2020-04/orders/450789469/fulfillments/255858046/events/944956394.json
View Response
HTTP/1.1 200 OK
{
}
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:
- GET /admin/api/2020-07/orders/{order_id}/fulfillments/{fulfillment_id}/events.json Retrieves a list of fulfillment events for a specific fulfillment
- GET /admin/api/2020-07/orders/{order_id}/fulfillments/{fulfillment_id}/events/{event_id}.json Retrieves a specific fulfillment event
- POST /admin/api/2020-07/orders/{order_id}/fulfillments/{fulfillment_id}/events.json Creates a fulfillment event
- DELETE /admin/api/2020-07/orders/{order_id}/fulfillments/{fulfillment_id}/events/{event_id}.json Deletes a fulfillment event
FulfillmentEvent properties
address1 |
The street address where the fulfillment event occurred. |
city |
The city where the fulfillment event occurred. |
country |
The country where the fulfillment event occurred. |
created_at |
The date and time (ISO 8601 format) when the fulfillment event was created. |
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 |
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 |
An ID for the fulfillment event. |
latitude |
A geographic coordinate specifying the latitude of the fulfillment event. |
longitude |
A geographic coordinate specifying the longitude of the fulfillment event. |
message |
An arbitrary message describing the status. Can be provided by a shipping carrier. |
order_id |
The ID of the order that's associated with the fulfillment event. |
province |
The province where the fulfillment event occurred. |
shop_id |
An ID for the shop that's associated with the fulfillment event. |
status |
The status of the fulfillment event. Valid values:
|
updated_at |
The date and time (ISO 8601 format) when the fulfillment event was updated. |
zip |
The zip code of the location where the fulfillment event occurred. |
Endpoints
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/api/2020-07/orders/450789469/fulfillments/255858046/events.json
View Response
HTTP/1.1 200 OK
{
"fulfillment_events": [
{
"id": 944956391,
"fulfillment_id": 255858046,
"status": "in_transit",
"message": null,
"happened_at": "2021-01-01T14:36:19-05:00",
"city": null,
"province": null,
"country": null,
"zip": null,
"address1": null,
"latitude": null,
"longitude": null,
"shop_id": 690933842,
"created_at": "2021-01-01T14:36:19-05:00",
"updated_at": "2021-01-01T14:36:19-05:00",
"estimated_delivery_at": null,
"order_id": 450789469,
"admin_graphql_api_id": "gid://shopify/FulfillmentEvent/944956391"
}
]
}
event_id
|
The ID of the fulfillment event. |
Retrieve a specific fulfillment event
GET /admin/api/2020-07/orders/450789469/fulfillments/255858046/events/944956392.json
View Response
HTTP/1.1 200 OK
{
"fulfillment_event": {
"id": 944956392,
"fulfillment_id": 255858046,
"status": "in_transit",
"message": null,
"happened_at": "2021-01-01T14:36:20-05:00",
"city": null,
"province": null,
"country": null,
"zip": null,
"address1": null,
"latitude": null,
"longitude": null,
"shop_id": 690933842,
"created_at": "2021-01-01T14:36:20-05:00",
"updated_at": "2021-01-01T14:36:20-05:00",
"estimated_delivery_at": null,
"order_id": 450789469,
"admin_graphql_api_id": "gid://shopify/FulfillmentEvent/944956392"
}
}
Create a fulfillment event
POST /admin/api/2020-07/orders/450789469/fulfillments/255858046/events.json
{
"event": {
"status": "in_transit"
}
}
View Response
HTTP/1.1 201 Created
{
"fulfillment_event": {
"id": 944956393,
"fulfillment_id": 255858046,
"status": "in_transit",
"message": null,
"happened_at": "2021-01-01T14:36:21-05:00",
"city": null,
"province": null,
"country": null,
"zip": null,
"address1": null,
"latitude": null,
"longitude": null,
"shop_id": 690933842,
"created_at": "2021-01-01T14:36:21-05:00",
"updated_at": "2021-01-01T14:36:21-05:00",
"estimated_delivery_at": null,
"order_id": 450789469,
"admin_graphql_api_id": "gid://shopify/FulfillmentEvent/944956393"
}
}
Delete a fulfillment event
DELETE /admin/api/2020-07/orders/450789469/fulfillments/255858046/events/944956394.json
View Response
HTTP/1.1 200 OK
{
}
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:
- GET /admin/api/2020-10/orders/{order_id}/fulfillments/{fulfillment_id}/events.json Retrieves a list of fulfillment events for a specific fulfillment
- GET /admin/api/2020-10/orders/{order_id}/fulfillments/{fulfillment_id}/events/{event_id}.json Retrieves a specific fulfillment event
- POST /admin/api/2020-10/orders/{order_id}/fulfillments/{fulfillment_id}/events.json Creates a fulfillment event
- DELETE /admin/api/2020-10/orders/{order_id}/fulfillments/{fulfillment_id}/events/{event_id}.json Deletes a fulfillment event
FulfillmentEvent properties
address1 |
The street address where the fulfillment event occurred. |
city |
The city where the fulfillment event occurred. |
country |
The country where the fulfillment event occurred. |
created_at |
The date and time (ISO 8601 format) when the fulfillment event was created. |
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 |
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 |
An ID for the fulfillment event. |
latitude |
A geographic coordinate specifying the latitude of the fulfillment event. |
longitude |
A geographic coordinate specifying the longitude of the fulfillment event. |
message |
An arbitrary message describing the status. Can be provided by a shipping carrier. |
order_id |
The ID of the order that's associated with the fulfillment event. |
province |
The province where the fulfillment event occurred. |
shop_id |
An ID for the shop that's associated with the fulfillment event. |
status |
The status of the fulfillment event. Valid values:
|
updated_at |
The date and time (ISO 8601 format) when the fulfillment event was updated. |
zip |
The zip code of the location where the fulfillment event occurred. |
Endpoints
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/api/2020-10/orders/450789469/fulfillments/255858046/events.json
View Response
HTTP/1.1 200 OK
{
"fulfillment_events": [
{
"id": 944956391,
"fulfillment_id": 255858046,
"status": "in_transit",
"message": null,
"happened_at": "2021-01-01T14:36:19-05:00",
"city": null,
"province": null,
"country": null,
"zip": null,
"address1": null,
"latitude": null,
"longitude": null,
"shop_id": 690933842,
"created_at": "2021-01-01T14:36:19-05:00",
"updated_at": "2021-01-01T14:36:19-05:00",
"estimated_delivery_at": null,
"order_id": 450789469,
"admin_graphql_api_id": "gid://shopify/FulfillmentEvent/944956391"
}
]
}
event_id
|
The ID of the fulfillment event. |
Retrieve a specific fulfillment event
GET /admin/api/2020-10/orders/450789469/fulfillments/255858046/events/944956392.json
View Response
HTTP/1.1 200 OK
{
"fulfillment_event": {
"id": 944956392,
"fulfillment_id": 255858046,
"status": "in_transit",
"message": null,
"happened_at": "2021-01-01T14:36:20-05:00",
"city": null,
"province": null,
"country": null,
"zip": null,
"address1": null,
"latitude": null,
"longitude": null,
"shop_id": 690933842,
"created_at": "2021-01-01T14:36:20-05:00",
"updated_at": "2021-01-01T14:36:20-05:00",
"estimated_delivery_at": null,
"order_id": 450789469,
"admin_graphql_api_id": "gid://shopify/FulfillmentEvent/944956392"
}
}
Create a fulfillment event
POST /admin/api/2020-10/orders/450789469/fulfillments/255858046/events.json
{
"event": {
"status": "in_transit"
}
}
View Response
HTTP/1.1 201 Created
{
"fulfillment_event": {
"id": 944956393,
"fulfillment_id": 255858046,
"status": "in_transit",
"message": null,
"happened_at": "2021-01-01T14:36:21-05:00",
"city": null,
"province": null,
"country": null,
"zip": null,
"address1": null,
"latitude": null,
"longitude": null,
"shop_id": 690933842,
"created_at": "2021-01-01T14:36:21-05:00",
"updated_at": "2021-01-01T14:36:21-05:00",
"estimated_delivery_at": null,
"order_id": 450789469,
"admin_graphql_api_id": "gid://shopify/FulfillmentEvent/944956393"
}
}
Delete a fulfillment event
DELETE /admin/api/2020-10/orders/450789469/fulfillments/255858046/events/944956394.json
View Response
HTTP/1.1 200 OK
{
}
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:
- GET /admin/api/2021-01/orders/{order_id}/fulfillments/{fulfillment_id}/events.json Retrieves a list of fulfillment events for a specific fulfillment
- GET /admin/api/2021-01/orders/{order_id}/fulfillments/{fulfillment_id}/events/{event_id}.json Retrieves a specific fulfillment event
- POST /admin/api/2021-01/orders/{order_id}/fulfillments/{fulfillment_id}/events.json Creates a fulfillment event
- DELETE /admin/api/2021-01/orders/{order_id}/fulfillments/{fulfillment_id}/events/{event_id}.json Deletes a fulfillment event
FulfillmentEvent properties
address1 |
The street address where the fulfillment event occurred. |
city |
The city where the fulfillment event occurred. |
country |
The country where the fulfillment event occurred. |
created_at |
The date and time (ISO 8601 format) when the fulfillment event was created. |
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 |
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 |
An ID for the fulfillment event. |
latitude |
A geographic coordinate specifying the latitude of the fulfillment event. |
longitude |
A geographic coordinate specifying the longitude of the fulfillment event. |
message |
An arbitrary message describing the status. Can be provided by a shipping carrier. |
order_id |
The ID of the order that's associated with the fulfillment event. |
province |
The province where the fulfillment event occurred. |
shop_id |
An ID for the shop that's associated with the fulfillment event. |
status |
The status of the fulfillment event. Valid values:
|
updated_at |
The date and time (ISO 8601 format) when the fulfillment event was updated. |
zip |
The zip code of the location where the fulfillment event occurred. |
Endpoints
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/api/2021-01/orders/450789469/fulfillments/255858046/events.json
View Response
HTTP/1.1 200 OK
{
"fulfillment_events": [
{
"id": 944956391,
"fulfillment_id": 255858046,
"status": "in_transit",
"message": null,
"happened_at": "2021-01-01T14:36:19-05:00",
"city": null,
"province": null,
"country": null,
"zip": null,
"address1": null,
"latitude": null,
"longitude": null,
"shop_id": 690933842,
"created_at": "2021-01-01T14:36:19-05:00",
"updated_at": "2021-01-01T14:36:19-05:00",
"estimated_delivery_at": null,
"order_id": 450789469,
"admin_graphql_api_id": "gid://shopify/FulfillmentEvent/944956391"
}
]
}
event_id
|
The ID of the fulfillment event. |
Retrieve a specific fulfillment event
GET /admin/api/2021-01/orders/450789469/fulfillments/255858046/events/944956392.json
View Response
HTTP/1.1 200 OK
{
"fulfillment_event": {
"id": 944956392,
"fulfillment_id": 255858046,
"status": "in_transit",
"message": null,
"happened_at": "2021-01-01T14:36:20-05:00",
"city": null,
"province": null,
"country": null,
"zip": null,
"address1": null,
"latitude": null,
"longitude": null,
"shop_id": 690933842,
"created_at": "2021-01-01T14:36:20-05:00",
"updated_at": "2021-01-01T14:36:20-05:00",
"estimated_delivery_at": null,
"order_id": 450789469,
"admin_graphql_api_id": "gid://shopify/FulfillmentEvent/944956392"
}
}
Create a fulfillment event
POST /admin/api/2021-01/orders/450789469/fulfillments/255858046/events.json
{
"event": {
"status": "in_transit"
}
}
View Response
HTTP/1.1 201 Created
{
"fulfillment_event": {
"id": 944956393,
"fulfillment_id": 255858046,
"status": "in_transit",
"message": null,
"happened_at": "2021-01-01T14:36:21-05:00",
"city": null,
"province": null,
"country": null,
"zip": null,
"address1": null,
"latitude": null,
"longitude": null,
"shop_id": 690933842,
"created_at": "2021-01-01T14:36:21-05:00",
"updated_at": "2021-01-01T14:36:21-05:00",
"estimated_delivery_at": null,
"order_id": 450789469,
"admin_graphql_api_id": "gid://shopify/FulfillmentEvent/944956393"
}
}
Delete a fulfillment event
DELETE /admin/api/2021-01/orders/450789469/fulfillments/255858046/events/944956394.json
View Response
HTTP/1.1 200 OK
{
}
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:
- GET /admin/api/2021-04/orders/{order_id}/fulfillments/{fulfillment_id}/events.json Retrieves a list of fulfillment events for a specific fulfillment
- GET /admin/api/2021-04/orders/{order_id}/fulfillments/{fulfillment_id}/events/{event_id}.json Retrieves a specific fulfillment event
- POST /admin/api/2021-04/orders/{order_id}/fulfillments/{fulfillment_id}/events.json Creates a fulfillment event
- DELETE /admin/api/2021-04/orders/{order_id}/fulfillments/{fulfillment_id}/events/{event_id}.json Deletes a fulfillment event
FulfillmentEvent properties
address1 |
The street address where the fulfillment event occurred. |
city |
The city where the fulfillment event occurred. |
country |
The country where the fulfillment event occurred. |
created_at |
The date and time (ISO 8601 format) when the fulfillment event was created. |
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 |
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 |
An ID for the fulfillment event. |
latitude |
A geographic coordinate specifying the latitude of the fulfillment event. |
longitude |
A geographic coordinate specifying the longitude of the fulfillment event. |
message |
An arbitrary message describing the status. Can be provided by a shipping carrier. |
order_id |
The ID of the order that's associated with the fulfillment event. |
province |
The province where the fulfillment event occurred. |
shop_id |
An ID for the shop that's associated with the fulfillment event. |
status |
The status of the fulfillment event. Valid values:
|
updated_at |
The date and time (ISO 8601 format) when the fulfillment event was updated. |
zip |
The zip code of the location where the fulfillment event occurred. |
Endpoints
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/api/2021-04/orders/450789469/fulfillments/255858046/events.json
View Response
HTTP/1.1 200 OK
{
"fulfillment_events": [
{
"id": 944956391,
"fulfillment_id": 255858046,
"status": "in_transit",
"message": null,
"happened_at": "2021-01-01T14:36:19-05:00",
"city": null,
"province": null,
"country": null,
"zip": null,
"address1": null,
"latitude": null,
"longitude": null,
"shop_id": 690933842,
"created_at": "2021-01-01T14:36:19-05:00",
"updated_at": "2021-01-01T14:36:19-05:00",
"estimated_delivery_at": null,
"order_id": 450789469,
"admin_graphql_api_id": "gid://shopify/FulfillmentEvent/944956391"
}
]
}
event_id
|
The ID of the fulfillment event. |
Retrieve a specific fulfillment event
GET /admin/api/2021-04/orders/450789469/fulfillments/255858046/events/944956392.json
View Response
HTTP/1.1 200 OK
{
"fulfillment_event": {
"id": 944956392,
"fulfillment_id": 255858046,
"status": "in_transit",
"message": null,
"happened_at": "2021-01-01T14:36:20-05:00",
"city": null,
"province": null,
"country": null,
"zip": null,
"address1": null,
"latitude": null,
"longitude": null,
"shop_id": 690933842,
"created_at": "2021-01-01T14:36:20-05:00",
"updated_at": "2021-01-01T14:36:20-05:00",
"estimated_delivery_at": null,
"order_id": 450789469,
"admin_graphql_api_id": "gid://shopify/FulfillmentEvent/944956392"
}
}
Create a fulfillment event
POST /admin/api/2021-04/orders/450789469/fulfillments/255858046/events.json
{
"event": {
"status": "in_transit"
}
}
View Response
HTTP/1.1 201 Created
{
"fulfillment_event": {
"id": 944956393,
"fulfillment_id": 255858046,
"status": "in_transit",
"message": null,
"happened_at": "2021-01-01T14:36:21-05:00",
"city": null,
"province": null,
"country": null,
"zip": null,
"address1": null,
"latitude": null,
"longitude": null,
"shop_id": 690933842,
"created_at": "2021-01-01T14:36:21-05:00",
"updated_at": "2021-01-01T14:36:21-05:00",
"estimated_delivery_at": null,
"order_id": 450789469,
"admin_graphql_api_id": "gid://shopify/FulfillmentEvent/944956393"
}
}
Delete a fulfillment event
DELETE /admin/api/2021-04/orders/450789469/fulfillments/255858046/events/944956394.json
View Response
HTTP/1.1 200 OK
{
}
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:
- GET /admin/api/unstable/orders/{order_id}/fulfillments/{fulfillment_id}/events.json Retrieves a list of fulfillment events for a specific fulfillment
- GET /admin/api/unstable/orders/{order_id}/fulfillments/{fulfillment_id}/events/{event_id}.json Retrieves a specific fulfillment event
- POST /admin/api/unstable/orders/{order_id}/fulfillments/{fulfillment_id}/events.json Creates a fulfillment event
- DELETE /admin/api/unstable/orders/{order_id}/fulfillments/{fulfillment_id}/events/{event_id}.json Deletes a fulfillment event
FulfillmentEvent properties
address1 |
The street address where the fulfillment event occurred. |
city |
The city where the fulfillment event occurred. |
country |
The country where the fulfillment event occurred. |
created_at |
The date and time (ISO 8601 format) when the fulfillment event was created. |
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 |
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 |
An ID for the fulfillment event. |
latitude |
A geographic coordinate specifying the latitude of the fulfillment event. |
longitude |
A geographic coordinate specifying the longitude of the fulfillment event. |
message |
An arbitrary message describing the status. Can be provided by a shipping carrier. |
order_id |
The ID of the order that's associated with the fulfillment event. |
province |
The province where the fulfillment event occurred. |
shop_id |
An ID for the shop that's associated with the fulfillment event. |
status |
The status of the fulfillment event. Valid values:
|
updated_at |
The date and time (ISO 8601 format) when the fulfillment event was updated. |
zip |
The zip code of the location where the fulfillment event occurred. |
Endpoints
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/api/unstable/orders/450789469/fulfillments/255858046/events.json
View Response
HTTP/1.1 200 OK
{
"fulfillment_events": [
{
"id": 944956391,
"fulfillment_id": 255858046,
"status": "in_transit",
"message": null,
"happened_at": "2021-01-01T14:36:19-05:00",
"city": null,
"province": null,
"country": null,
"zip": null,
"address1": null,
"latitude": null,
"longitude": null,
"shop_id": 690933842,
"created_at": "2021-01-01T14:36:19-05:00",
"updated_at": "2021-01-01T14:36:19-05:00",
"estimated_delivery_at": null,
"order_id": 450789469,
"admin_graphql_api_id": "gid://shopify/FulfillmentEvent/944956391"
}
]
}
event_id
|
The ID of the fulfillment event. |
Retrieve a specific fulfillment event
GET /admin/api/unstable/orders/450789469/fulfillments/255858046/events/944956392.json
View Response
HTTP/1.1 200 OK
{
"fulfillment_event": {
"id": 944956392,
"fulfillment_id": 255858046,
"status": "in_transit",
"message": null,
"happened_at": "2021-01-01T14:36:20-05:00",
"city": null,
"province": null,
"country": null,
"zip": null,
"address1": null,
"latitude": null,
"longitude": null,
"shop_id": 690933842,
"created_at": "2021-01-01T14:36:20-05:00",
"updated_at": "2021-01-01T14:36:20-05:00",
"estimated_delivery_at": null,
"order_id": 450789469,
"admin_graphql_api_id": "gid://shopify/FulfillmentEvent/944956392"
}
}
Create a fulfillment event
POST /admin/api/unstable/orders/450789469/fulfillments/255858046/events.json
{
"event": {
"status": "in_transit"
}
}
View Response
HTTP/1.1 201 Created
{
"fulfillment_event": {
"id": 944956393,
"fulfillment_id": 255858046,
"status": "in_transit",
"message": null,
"happened_at": "2021-01-01T14:36:21-05:00",
"city": null,
"province": null,
"country": null,
"zip": null,
"address1": null,
"latitude": null,
"longitude": null,
"shop_id": 690933842,
"created_at": "2021-01-01T14:36:21-05:00",
"updated_at": "2021-01-01T14:36:21-05:00",
"estimated_delivery_at": null,
"order_id": 450789469,
"admin_graphql_api_id": "gid://shopify/FulfillmentEvent/944956393"
}
}
Delete a fulfillment event
DELETE /admin/api/unstable/orders/450789469/fulfillments/255858046/events/944956394.json
View Response
HTTP/1.1 200 OK
{
}