With this API you will get the current status of your booking. Begoma have nine different status. For some of our statuses we have a corresponding United Nations Economic Commission for Europe status code:
https://service.unece.org/trade/untdid/d98a/uncl/uncl9011.htm
| Status | Meaning | UNTDID |
|---|---|---|
| 1 | Registered: Order created, Begoma ID received | 6 Booked |
| 2 | Confirmed: Begoma have confirmed the order. The transport will be executed. | |
| 3 | Booked: Begoma has planned your order. | |
| 4 | Load carrier assigned: A load carrier has been assigned to the order. | |
| 5 | At loading place: We are at the loading place and ready to start loading | 1 Arrived |
| 6 | Loading confirmed: Your order is loaded on the load carrier | 48 Loaded |
| 7 | On track: Your order is on its way to the unloading place and delivery will be according to plan. ETA and current location are available. | 31 En route |
| 8 | Delayed: Your order is on its way to the unloading place, but unfortunatly we are delayed according to the plan. ETA and current location are available. | 20 Delayed |
| 9 | At unloading place: We are at the unloading place and ready to be unloaded. | 1 Arrived |
| 10 | Unloading confirmed: We have unloaded your order. | 22 Delivery completed |
Request
| Field | Comment |
|---|---|
| CustomerCardId | Mandatory. Your unique CustomerCardId |
| At least one of below | |
| CustomerBookingId | Your internal booking ID |
| BegomaId | Begomas unique booking ID |
| LoadingReference | Loading reference |
| UnloadingReference | Unloading reference |
| InvoiceReference | Invoice reference |
{
"booking": {
"customerBookingId": "string",
"customerCardId": "string",
"loadingReference": "string",
"unloadingReference": "string",
"invoiceReference": "string"
}
}Response
{
"booking": {
"customerBookingId": "string",
"begomaId": 0,
"customerCardId": "string",
"status": "string",
"untdid": "string",
"locations": [
{
"locationType": 1,
"locationName": "string",
"streetAddress": "string",
"city": "string",
"countryCode": "string",
"zipcode": "string",
"planningDateUTC": "string",
"etaDateUTC": "string",
"actualDateUTC": "string",
"deliveryStatus": "string"
}
],
"references": {
"loadingReference": "string",
"unloadingReference": "string",
"invoiceReference": "string"
},
"vehiclePosition": {
"timestamp": "2021-11-06T08:44:31.762Z",
"truckNumber": "string",
"position": {
"lat": 0,
"lng": 0
},
"speed": 0,
"heading": 0
}
}
}