The REST Admin API is a legacy API as of October 1, 2024. All apps and integrations should be built with the GraphQL Admin API. For details and migration steps, visit our migration guide.
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?
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.
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.'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
->id
An ID for the fulfillment event.
latitude
->latitude
A geographic coordinate specifying the latitude of the fulfillment event.
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?
Creates a fulfillment event
api_version
string
required
fulfillment_id
string
required
order_id
string
required
Was this section helpful?
Was this section helpful?
Retrieves a list of fulfillment events for a specific fulfillment
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?
Was this section helpful?
Retrieves a specific fulfillment event
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?
Was this section helpful?
Deletes a fulfillment event
api_version
string
required
event_id
string
required
fulfillment_id
string
required
order_id
string
required
Was this section helpful?
Was this section helpful?