POST https://api.ecartapi.com/api/v2/orders/{orderId}/fulfillments/{fulfillmentId}/events
Allowed values for status and meaning:
Ecartapi status
E-commerce status
E-commerce Description
pickup_ready
readyforpickup
The shipment is ready for pickup at a shipping depot.
created
confirmed
The carrier is aware of the shipment, but hasn't received it yet.
deliveryattemptfailed
attempted_delivery
Delivery of the shipment was attempted, but unable to be completed.
delivered
delivered
The shipment was successfully delivered.
failed
failure
Something went wrong when pulling tracking information for the shipment, such as the tracking number was invalid or the shipment was canceled.
in_transit
in_transit
The shipment is being transported between shipping facilities on the way to its destination.
outfordelivery
outfordelivery
The shipment is being delivered to its final destination.
other
picked_up
The fulfillment was successfully picked up.
Body
PARAM
Key | Datatype | Required | Description |
HEADERS
Key | Datatype | Required | Description |
Authorization
|
string |
RESPONSES
status OK
{
"success": true,
"event": {
"id": "22953803481257",
"status": {
"id": null,
"status": "in_transit",
"ecartapi": "in_transit",
"ecartapiId": "3"
},
"description": "IN_TRANSIT",
"location": {
"address1": null,
"country": {
"code": "MX",
"name": "Mexico",
"codeIso2": "MX",
"codeIso3": "MEX"
},
"state": {
"code": "AG",
"name": "Aguascalientes",
"codeIso2": null,
"codeIso3": null
},
"city": "Calvillo",
"postalCode": "20800"
},
"dates": {
"createdAt": "2023-11-14T16:11:14-06:00",
"updatedAt": "2023-11-14T16:11:14-06:00",
"estimatedDeliveryAt": "2023-11-15T17:46:49-06:00",
"happenedAt": "2023-11-13T18:00:00-06:00"
},
"latitude": "45.5017",
"longitude": "73.5673"
}
} |
ENDPOINTS