Most of the fields are explained in our Swagger documentation but we would like to highlight some fields to make your development process easier.
section booking
| Field | Comment |
|---|---|
| customerBookingId | Your internal booking ID – must be unique In total you can have four different references on each booking – your internal booking id (customerBookingId) – loading reference (loadingReference) – unloading reference (unloadingReference) – invoice reference (invoiceReference) When the booking is created you will receive BEGOMAID that will be used as the reference in all communication between you and Begoma. |
| customerCardId | A value that you receive from us together with your credentials. |
section – locations
One location for each address.
| Field | Comment |
|---|---|
| locationType | 1 = loading 2 = unloading |
| countryCode | Two character country code from United Nations Economic Commission for Europe. UN/LOCODE Code List by Country and Territory | UNECE |
| zipcode | always together with country code and without any spaces ie. SE-20121 |
section Goods specifications
Either you add one row for the complete load, for instance if you have a complete load with the same material where each colli isn’t marked. Or you can add one row for each colli.
| Field | Comment |
|---|---|
| goodsMarks | description of goods or a specific package ID |
| goodsPhgType | Description of the package type. Could be boxes, cages, bars, palette etc. |
| goodsLength goodsWidth goodsHeight | dimensions of the goods, always in centimetres |
| goodsQty | number of packages |
| goodsCBM | how many cubic meters do the goods fill |
| goodsLDM | how many loading meters do the goods take |
| goodsWeight | how much do the goods weight, in kilograms |
{
"booking": {
"customerBookingId": "test 123",
"customerCardId": "3277E29E-F02F-4634-842E-0ADC7B134157",
"locations": [
{
"locationType": 1,
"locationName": "Test AB",
"streetAddress": "Street of testing No 1",
"city": "Stockholm",
"countryCode": "SE",
"zipcode": "SE-10000",
"planningDateUTC": "2021-10-30T09:37:18.360Z"
}
],
"goodsSpecifications": [
{
"goodsMarks": "Test equipment",
"goodsPhgType": "Boxes",
"goodsLength": 120,
"goodsWidth": 80,
"goodsHeight": 100,
"goodsQty": 1,
"goodsCBM": 0.1,
"goodsLDM": 0.4,
"goodsWeight": 500,
"goodsChgWeight": "string"
}
],
"references": {
"loadingReference": "Loading 1",
"unloadingReference": "Unloading 1",
"invoiceReference": "Invoice 1"
}
}
}
Response
{
"message": "Booking was successfully created!",
"begomaId": 575116
}
{
"message": "Booking with ID test 123 already exist"
}