Need Support? phone 1300 803 873 or email [email protected]

Facility Attachments Integration Guide

This support post explains how to integrate your internal system with the electronic document management function within Inbound Connect

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.

 
The integration flow is as follows:
  1. Generate an API key for a user (or create a generic integration user first) within your facility account.
  2. Construct a payload based on the payload format tab and send it in to our API endpoint.
  3. 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.  

  1. Once logged in as the user in question.
  2. Go to the My Settings menu in the top right of the screen.
  3. Select the API Keys tab and click New API Key.
  4. 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.
  5. To all HTTP requests to the Inbound Connect endpoint ensure you have the following HTTP Header added.
    1. Inbound-API-Key: <emailaddress>:<apikey>
    2. Where email address is the email address of the user within your facility account
    3. And apikey is the value copied from step 4 above.
This particular Inbound Connect endpoint accepts a JSON payload in the body of a POST message to the API endpoint.
 
 

Field Descriptions

FieldDescriptionComments
bookingNumberThe booking number you want to link this attachment to.Provided by Inbound
attachmentTypeCodeThe attachment type you want to associate with the uploaded electronic document.Refer to reference data for valid values
fileNameThe name of the file you are attaching to the booking.Include extension.  Eg:  deliveryorder.pdf
base64FileBytesThe binary data of the file converted into a base64 string 

Example

{
	"bookingNumber": "INBFAC202309001",
	"attachmentTypeCode": "DO",
	"fileName": "DeliveryOrder.pdf",
	"base64FileBytes": "JVBERi0xLjQKJcOkw7zDtsOfCjIgMCBvYmoKPDwvTGVuZ3RoIDMgMCBSL0ZpbHRlci9GbGF........"
}
Each facility has the ability to define their own attachment types. Please ensure you only send in codes that match the facility you are targeting. If the facility is not listed then use the base attachment types.
Facility Name
Base Attachment Types
NameDescription
OTHEROther
Shipping Note (SN)Shipping Note (SN)
PHOTOPhoto
Pallet Transfer DocketPallet Transfer Docket
Hazardous/DG DocumentsHaz Docs including MO41 or MSDS
DOImport Delivery Order
Export Receival Advice (ERA)Export Receival Advice (ERA)
Export Cargo ReceiptExport Cargo Receipt
Gate PassGate Pass
Customs (ICS) StatusCustoms (ICS) Status
AQISQuarantine Direction
MAWBAir Waybill
SIGNEDSigned Document
IRInterim Receipt
SLIShippers Letter of Instruction (SLI)
Proof of Delivery (POD)Proof of Delivery (POD)
Tasman Logistics Brooklyn
NameDescription
SIGNEDSigned Document
DOImport Delivery Order
IRInterim Receipt
SLIShippers Letter of Instruction (SLI)
Customs (ICS) StatusCustoms (ICS) Status
Gate PassGate Pass
AQISQuarantine Direction
Hazardous/DG DocumentsHaz Docs including MO41 or MSDS
Pallet Transfer DocketPallet Transfer Docket
PHOTOPhoto
CWT Globelink
NameDescription
DOImport Delivery Order
Shipping OrderShipping Order
Secon Freight Logistics – Niton Drive Gate 1 – LCL
NameDescription
DOImport Delivery Order
IRInterim Receipt
AQISQuarantine Direction
Customs (ICS) StatusCustoms (ICS) Status
SIGNEDSigned Document
Gate PassGate Pass
Export Cargo ReceiptExport Cargo Receipt
OTHEROther
WBDWashbay Docket
The Cargo Warehouse 557 Mt Derrimut Rd Derrimut
NameDescription
OTHEROther
Proof of Delivery (POD)Proof of Delivery (POD)
DOImport Delivery Order
IRInterim Receipt
AQISQuarantine Direction
Customs (ICS) StatusCustoms (ICS) Status
Gate PassGate Pass
Export Cargo ReceiptExport Cargo Receipt
Hazardous/DG DocumentsHaz Docs including MO41 or MSDS
SDOSub Delivery Order
SIGNEDSigned Document
Arrow Transport & Quarantine Services Chullora
NameDescription
DOImport Delivery Order
AQISQuarantine Direction
Hazardous/DG DocumentsHaz Docs including MO41 or MSDS
Shipping Note (SN)Shipping Note (SN)
OTHEROther
LOSCAM Truganina
NameDescription
Pallet Transfer DocketPallet Transfer Docket
OTHEROther
Hup Soon Cheong Services
NameDescription
Shipping OrderShipping Order
DOImport Delivery Order
Qantas Freight Sydney Airport
NameDescription
AQISQuarantine Direction
Pallet Transfer DocketPallet Transfer Docket
Hazardous/DG DocumentsHaz Docs including MO41 or MSDS
MAWBAir Waybill
SLIShippers Letter of Instruction (SLI)
DOImport Delivery Order
Share the Post:

Ready to take your logsitics business to the next level?

Reach out and request a demo today.