Vehicles events
The feedback endpoint and auth method must be define in the customer subscription for a given principal.
We expect a feedback endpoint with a POST http method that will receive a JSON object with the following structure in success case:
API Contract
OutgoingVehicleServicesPivot schema
OutgoingVehicleServicesPivot.ts
{
"header": {
"message": string,
"message_date": string, // UTC date time format "YYYY-MM-DDTHH:MM:SSZ"
"app" : string // 'E4_4PL'
},
"outgoing_event": {
"issuer": {
"code": "string",
"name": "string"
},
"receiver": {
"code": "string",
"name": "string"
},
"event": {
"event_no": "string",
"type": "string", // 'receipt_execution', 'exit_execution'
"creation_datetime_utc": string, // UTC date time format "YYYY-MM-DDTHH:MM:SSZ"
"real_date": {
"date": "string", // Local date time format "YYYY-MM-DDTHH:MM:SS"
"utc_date": string, // UTC date time format "YYYY-MM-DDTHH:MM:SSZ"
},
"origin_software": "string", // 'E4_4PL'
"result_code": "string", // 'DONE' or error code
"result_message": "string"
},
"vehicle_account": {
"vehicle_account_no": "string",
"vin": "string",
"logistics_status": "string", // see logistics_status
"vehicle": {
"make": "string"
}
},
"operation": {
"operation_no": "string",
"platform": { // place of receipt or exit
"member_role": {
"place_name": "string",
"zip_code": "string",
"city": "string",
"country": "string", // ISO 3166-1 alpha-2 country code
"platform": {
"code": "string",
"name": "string"
}
}
}
}
}
}
Example of OutgoingVehicleServicesPivot Body
JSON
{
"header": {
"message": "OE-MOS-20251013-00014",
"message_date": "2024-06-20T12:00:00Z",
"app" : "E4_4PL"
},
"outgoing_event": {
"issuer": {
"code": "MOS",
"name": "Mosanada"
},
"receiver": {
"code": "your_code_in_our_system",
"name": "your_name_in_our_system"
},
"event": {
"event_no": "E-MOS-20251013-00149",
"type": "receipt_execution", // 'receipt_execution', 'exit_execution', 'transport_available', 'transport_unavailable'
"creation_datetime_utc": "2025-10-13T12:14:38.275Z",
"real_date": {
"date": "2025-10-10T15:15:00",
"utc_date": "2025-10-10T13:15:00.000Z"
},
"origin_software": "E4_4PL",
"result_code": "DONE",
"result_message": "Receipt executed successfully"
},
"vehicle_account": {
"vehicle_account_no": "VA-MOS-20251013-00001",
"vin": "WVWZZZ3CZWE000001",
"logistics_status": "mos_car_arrived",
"vehicle": {
"make": "Volkswagen"
}
},
"operation": {
"operation_no": "O-MOS-20251013-00014",
"platform": {
"member_role": {
"place_name": "Mosanada Warehouse",
"zip_code": "12345",
"city": "Mosanada City",
"country": "SA",
"platform": {
"code": "mos_code",
"name": "mos_name"
}
}
}
}
}
}
Example of error OutgoingVehicleServicesPivot Body
JSON
{
"header": {
"message": "OE-MOS-20251013-00014",
"message_date": "2024-06-20T12:00:00Z",
"app" : "E4_4PL"
},
"outgoing_event": {
"issuer": {
"code": "MOS",
"name": "Mosanada"
},
"receiver": {
"code": "your_code_in_our_system",
"name": "your_name_in_our_system"
},
"event": {
"event_no": "E-MOS-20251013-00149",
"family": "order_execution",
"type": "order_creation",
"creation_datetime_utc": "2025-10-13T12:14:38.275Z",
"real_date": {
"date": "2025-10-10T15:15:00",
"utc_date": "2025-10-10T13:15:00.000Z"
},
"origin_software": "E4_4PL",
"result_code": "VEHICLE_ACCOUNT_NOT_FOUND", // internal e4cars error coder
"result_message": "Vehicle account not found" // detailed error message
},
"vehicle_account": {
"vin": "WVWZZZ3CZWE000001"
}
}
}
| code | description |
|---|---|
mos_car_arrived |
Car arrived |
mos_car_left |
Car left |
mos_preparation_quality_check_cancelled |
Preparation quality check cancelled |
mos_preparation_quality_check_completed |
Preparation quality check completed |
mos_ready_for_delivery |
Ready for delivery |
mos_ready_for_delivery_cancelled |
Ready for delivery cancelled |
The feedback endpoint and auth method must be define in the customer subscription for a given principal.
We expect a feedback endpoint with a POST http method that will receive a JSON object with the following structure in success case:
API Contract
OutgoingVehicleServicesPivot schema
OutgoingVehicleServicesPivot.ts
{
"header": {
"message": string,
"message_date": string, // UTC date time format "YYYY-MM-DDTHH:MM:SSZ"
"app" : string // 'E4_4PL'
},
"outgoing_event": {
"issuer": {
"code": "string",
"name": "string"
},
"receiver": {
"code": "string",
"name": "string"
},
"event": {
"event_no": "string",
"type": "string", // 'service_started' | 'service_ended''
"creation_datetime_utc": string, // UTC date time format "YYYY-MM-DDTHH:MM:SSZ"
"real_date": {
"date": "string", // Local date time format "YYYY-MM-DDTHH:MM:SS"
"utc_date": string, // UTC date time format "YYYY-MM-DDTHH:MM:SSZ"
},
"origin_software": "string", // 'E4_4PL'
"result_code": "string", // 'DONE' or error code
"result_message": "string"
},
"vehicle_account": {
"vehicle_account_no": "string",
"vin": "string",
"logistics_status": "string", // see logistics_status
"vehicle": {
"make": "string"
}
},
"orders": [{
"order_no": "string",
"customer_order_no": "string",
"product": {
"code": "string",
"name": "string"
},
"product_family": "string", // 'on_demand_platform'
"steps"?: [{
"code": "string"
}]
}]
}
}
Example of OutgoingVehicleServicesPivot Body
JSON
{
"header": {
"message": "OE-MOS-20251013-00014",
"message_date": "2024-06-20T12:00:00Z",
"app" : "E4_4PL"
},
"outgoing_event": {
"issuer": {
"code": "MOS",
"name": "Mosanada"
},
"receiver": {
"code": "your_code_in_our_system",
"name": "your_name_in_our_system"
},
"event": {
"event_no": "E-MOS-20251013-00149",
"type": "service_started",
"creation_datetime_utc": "2025-10-13T12:14:38.275Z",
"real_date": {
"date": "2025-10-10T15:15:00",
"utc_date": "2025-10-10T13:15:00.000Z"
},
"origin_software": "E4_4PL",
"result_code": "DONE",
"result_message": "Service executed successfully"
},
"vehicle_account": {
"vehicle_account_no": "VA-MOS-20251013-00001",
"vin": "WVWZZZ3CZWE000001",
"logistics_status": "mos_preparation_quality_check_completed",
"vehicle": {
"make": "Volkswagen"
}
},
"orders": [{
"order_no": "O-MOS-20251013-00015",
"customer_order_no": "your_customer_order_no",
"product": {
"code": "product_code",
"name": "product_name"
},
"product_family": "on_demand_platform",
"steps": [{
"code": "WASHING"
},{
"code": "SPECIAL_ADD_STICKERS"
}]
}]
}
}
Example of error OutgoingVehicleServicesPivot Body
JSON
{
"header": {
"message": "OE-MOS-20251013-00014",
"message_date": "2024-06-20T12:00:00Z",
"app" : "E4_4PL"
},
"outgoing_event": {
"issuer": {
"code": "MOS",
"name": "Mosanada"
},
"receiver": {
"code": "your_code_in_our_system",
"name": "your_name_in_our_system"
},
"event": {
"event_no": "E-MOS-20251013-00149",
"family": "order_execution",
"type": "service_started",
"creation_datetime_utc": "2025-10-13T12:14:38.275Z",
"real_date": {
"date": "2025-10-10T15:15:00",
"utc_date": "2025-10-10T13:15:00.000Z"
},
"origin_software": "E4_4PL",
"result_code": "VEHICLE_ACCOUNT_NOT_FOUND", // internal e4cars error coder
"result_message": "Vehicle account not found" // detailed error message
},
"vehicle_account": {
"vin": "WVWZZZ3CZWE000001"
}
}
}
| code | description |
|---|---|
mos_car_arrived |
Car arrived |
mos_car_left |
Car left |
mos_preparation_quality_check_cancelled |
Preparation quality check cancelled |
mos_preparation_quality_check_completed |
Preparation quality check completed |
mos_ready_for_delivery |
Ready for delivery |
mos_ready_for_delivery_cancelled |
Ready for delivery cancelled |