Please note this content is now maintained in the Inbound Connect Knowledge Base.
This is accessible after logging in, clicking on your name in the top right corner and selecting knowledge base.
e-Bookings are a feature of the Inbound Connect platform, that allows a user to integrate the booking process into their transport management operating system, or other internal logistics platform.
The feature allows you to send the details of the bookings you require electronically to the platform and have e-Bookings created for you, ready for allocation of timeslots only.
The integration flow is as follows:
- External system sends a correctly formatted e-Bookings file (and any associated attachments) to [email protected].
- Inbound Connect will validate the file to ensure it is correctly formatted and that the bookings are valid.
- If the file is correctly validated, then the e-Bookings will be automatically populated into your account.
- The user of Inbound Connect then only needs to select an e-Booking from the e-Bookings menu option and right click on the booking to convert it to a confirmed booking.
- The process of conversion requires you only allocate a timeslot to the booking to complete the process.
- You have the option when converting the booking to make any edits or adjustments to the data as required.
The name of the file attached to the email MUST be ebookings.json
The file is formatted in JSON format and has the following details:
Field Descriptions
| Field | Description | Comments |
|---|---|---|
| transporterCode | Your transporter code | Provided by Inbound |
| apiKey | A security key to validate you are the authorised sender of the file. | You may generate an API key by navigating to “My Settings” under user’s profile. |
| apiUser | The email address of the API key owner. | |
| bookingDetails.facilityCode | Code to specify the facility for the e-Booking | Refer to reference data |
| bookingDetails.facilityServiceCode | Code to specify the service at the facility | Refer to reference data |
| bookingDetails.externalReferenceId | A unique ID to represent this booking, used for updates | |
| bookingDetails.estimatedBookingDate | A date to show the user to estimate when the date a timeslot should be allocated to the booking | Format should be yyyy-mm-dd. |
| bookingDetails.secondaryCapacityQuantity | If this service supports secondary capacity you can indicate the quantity here | Number |
| bookingDetails.fields.name | Name of the field to populate on the booking | Refer to reference data |
| bookingDetails.fields.value | Your string value to assign to the booking field | |
| bookingDetails.attachments.fileName | The full filename of the attachment you wish to attach to this e-Booking | Must be attached to the same email as the json payload |
| bookingDetails.attachments.fileTypeCode | The type of file attachment | Refer to reference data |
Example
{
"transporterCode": "ExampleTransporter",
"apiUser": "NotProvided",
"apiKey": "NotProvided",
"bookingDetails": [
{
"facilityCode": "INBFAC",
"facilityServiceCode": "FAKPICK",
"estimatedBookingDate": "2023-12-01",
"secondaryCapacityQuantity": 5,
"fields": [
{
"name": "Your Ref",
"value": "My Reference Number"
},
{
"name": "Vehicle Rego",
"value": "YND341"
},
{
"name": "Container No.",
"value": "MSKU1234565"
},
{
"name": "AIMS Number",
"value": "AIM123"
},
{
"name": "House BL",
"value": "HBL999333"
},
{
"name": "Special Instructions",
"value": "FRAGILE"
},
{
"name": "UOM",
"value": "CBM"
},
{
"name": "Vessel",
"value": "9307023 - OOCL DUBAI"
},
{
"name": "No. of Units",
"value": "2.5"
}
],
"attachments": [
{
"fileName": "Test01.pdf",
"fileTypeCode": "POP"
},
{
"fileName": "Test02.pdf",
"fileTypeCode": "POP"
}
]
},
{
"facilityCode": "INBFAC",
"facilityServiceCode": "FAKDROP",
"fields": [
{
"name": "Your Ref",
"value": "DEMO"
},
{
"name": "Vehicle Rego",
"value": "YND341"
},
{
"name": "Container No.",
"value": "MSCU88735551"
},
{
"name": "AIMS Number",
"value": ""
},
{
"name": "House BL",
"value": "HBL999333"
},
{
"name": "Special Instructions",
"value": "FRAGILE"
},
{
"name": "UOM",
"value": "CBM"
},
{
"name": "Vessel",
"value": "9307023 - OOCL DUBAI"
},
{
"name": "No. of Units",
"value": "2.5"
}
],
"attachments": [
{
"fileName": "Test01.pdf",
"fileTypeCode": "POP"
},
{
"fileName": "Test02.pdf",
"fileTypeCode": "POP"
}
]
}
]
}
[jsoncontentimporter url="https://api.inboundconnect.com/api/services/app/Public/GetDraftBookingReferenceDetails" basenode=result]
[/jsoncontentimporter]
Facilities
| Facility Code | Facility Name | Facility Service Code | Field Name | Mandatory |
|---|---|---|---|---|
| {facilities.facilityCode} | {facilities.facilityName} | {facilities.services.facilityServiceCode} | {facilities.services.mandatoryFields.name} | Yes | {/subloop-array:facilities.services.mandatoryFields} {subloop-array:facilities.services.optionalFields:-1}
| {facilities.facilityCode} | {facilities.facilityName} | {facilities.services.facilityServiceCode} | {facilities.services.optionalFields.name} | No | {/subloop-array:facilities.services.optionalFields}