There are many situations where your internal operational systems (terminal operating system, warehouse management system etc), generates documents which you wish to link to the associated Inbound Connect booking. These could be Gate Pass documents or other operational documents you want visible with the booking.
This feature allows you to send the details of documents electronically to Inbound Connect and have them automatically associated as an attachment to the Inbound Connect booking. From there the attachment will be visible to all operations staff, including available on the Inbound Connect mobile applications to forklift operators and other staff.
- Generate an API key for a user (or create a generic integration user first) within your facility account.
- Construct a payload based on the payload format tab and send it in to our API endpoint.
- The system will automatically attach the electronic document to the booking you have specified.
Endpoint
The facility attachment API URL will be provided by your Inbound Connect account or support team member. Please contact them to get the URL.
Security
To authenticate to the Inbound Connect API, you first need to generate an API token for a user with permissions to edit bookings. You can either create a generic user with just this permission, or use an existing user.
- Once logged in as the user in question.
- Go to the My Settings menu in the top right of the screen.
- Select the API Keys tab and click New API Key.
- Copy down the API key as once the window is closed you won’t be able to retrieve it again and you will be required to generate a new key.
- To all HTTP requests to the Inbound Connect endpoint ensure you have the following HTTP Header added.
- Inbound-API-Key: <emailaddress>:<apikey>
- Where email address is the email address of the user within your facility account
- And apikey is the value generated from step 4 above.
Field Descriptions
| Field | Description | Comments |
|---|---|---|
| bookingNumber | The booking number you want to link this attachment to. | Provided by Inbound |
| attachmentTypeCode | The attachment type you want to associate with the uploaded electronic document. | Refer to reference data for valid values |
| fileName | The name of the file you are attaching to the booking. | Include extension. Eg: deliveryorder.pdf |
| base64FileBytes | The binary data of the file converted into a base64 string |
Example
{
"bookingNumber": "INBFAC202309001",
"attachmentTypeCode": "DO",
"fileName": "DeliveryOrder.pdf",
"base64FileBytes": "JVBERi0xLjQKJcOkw7zDtsOfCjIgMCBvYmoKPDwvTGVuZ3RoIDMgMCBSL0ZpbHRlci9GbGF........"
}
| Attachment Type Code | Description |
|---|---|
| DO | Import Delivery Order |
| OTHER | Other |
| IR | Interim Receipt |
| SLI | Shippers Letter of Instruction (SLI) |
| Proof of Delivery (POD) | Proof of Delivery (POD) |
| MAWB | Air Waybill |
| AQIS | Quarantine Direction |
| Customs (ICS) Status | Customs (ICS) Status |
| SIGNED | Signed Document |
| Gate Pass | Gate Pass |
| Export Cargo Receipt | Export Cargo Receipt |
| Export Receival Advice (ERA) | Export Receival Advice (ERA) |