Logo
Ecartapi.com Public API Documentation

Get fulfillment Events

GET https://api.ecartapi.com/api/v2/orders/{orderId}/fulfillments/{fulfillmentId}/events

Properties


city The city where the fulfillment event occurred.


country The country where the fulfillment event occurred.


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


estimatedDeliveryAt 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.'


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


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


state The province where the fulfillment event occurred.


status

The status of the fulfillment event. Valid values:

shipped: 1,
receivedatpostoffice: 2,
in
transit: 3,
outfordelivery: 4,
deliveryattemptfailed: 5,
delayed: 6,
pickupready: 7,
delivered: 8,
returned
to_sender: 9,
lost: 10,
failed: 11,
created: 12,
other: 13


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


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

 

Body PARAM

Key Datatype Required Description 



HEADERS

Key Datatype Required Description 
Authorization
string




RESPONSES

status OK

{ "success": true, "events": [ { "id": "22199720640681", "status": { "id": null, "status": "in_transit", "ecartapi": "in_transit", "ecartapiId": "3" }, "description": null, "location": { "postalCode": null, "city": null, "country": { "code": null, "name": null, "codeIso2": null, "codeIso3": null }, "state": { "code": null, "name": null, "codeIso2": null, "codeIso3": null } }, "dates": { "createdAt": "2023-08-15T17:07:15-06:00", "updatedAt": "2023-08-15T17:07:15-06:00", "estimatedDeliveryAt": null, "happenedAt": "2023-08-15T17:07:15-06:00" }, "latitude": null, "longitude": null }, { "id": "22200033640617", "status": { "id": null, "status": "in_transit", "ecartapi": "in_transit", "ecartapiId": "3" }, "description": "IN_TRANSIT", "location": { "postalCode": "H2X 2R7", "city": "Montreal", "country": { "code": "CA", "name": "Canada", "codeIso2": "CA", "codeIso3": "CAN" }, "state": { "code": "QC", "name": "Quebec", "codeIso2": null,
Curl
curl -X GET 'https://api.ecartapi.com/api/v2/orders/{orderId}/fulfillments/{fulfillmentId}/events' -H 'Authorization: access_token'

ENDPOINTS