The purpose of this document is to provide technical information to Border Express’ partners regarding the
export and import of transportation data. Border Express currently exports data via XML and provides a
REST API for data import (POD’s, additional services, barcode and consignment events).
<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<Manifest>\n<ManifestNumber>2671533</ManifestNumber>\n<ManifestDate>31/08/2018</ManifestDate>\n<ManifestType>Onforward</ManifestType>\n<NumberOfConsignments>1</NumberOfConsignments>\n<ManifestFrom>Wagga Wagga</ManifestFrom>\n<ManifestTo>Wagga Wagga</ManifestTo>\n<DepartureDate>31/08/2018</DepartureDate>\n<DepartureTime>10:36:06 PM</DepartureTime>\n<ArrivalDate />\n<ArrivalTime />\n<Subcontractor>{Legal Name}</Subcontractor>\n<SubcontractorName>{Trading Name}</SubcontractorName>\n<SubcontractorAddress>123 Test Street</SubcontractorAddress>\n<SubcontractorSuburb>Wagga Wagga</SubcontractorSuburb>\n<SubcontractorState>NSW</SubcontractorState>\n<SubcontractorPostcode>2650</SubcontractorPostcode>\n<SubcontractorUserID>1234</SubcontractorUserID>\n<SubcontractorBranchID>3</SubcontractorBranchID>\n<Consignment>\n<ConsignmentNumber>5529184</ConsignmentNumber>\n<ConsignmentDate>30/08/2018</ConsignmentDate>\n<SenderName>Test Group</SenderName>\n<SenderStreetAddress>6 Bonville Ave</SenderStreetAddress>\n<SenderStreetAddress1/>\n<SenderSuburb>Thornton</SenderSuburb>\n<SenderState>NSW</SenderState>\n<SenderPostcode>2322</SenderPostcode>\n<ReceiverName>Test Rec </ReceiverName>\n<ReceiverStreetAddress>Test Depot</ReceiverStreetAddress>\n<ReceiverStreetAddress1>3 William Street</ReceiverStreetAddress1>\n<ReceiverSuburb>Urana</ReceiverSuburb>\n<ReceiverState>NSW</ReceiverState>\n<ReceiverPostcode>2645</ReceiverPostcode>\n<ReceiverPhone />\n<ReceiverContact />\n<ReceiverReference />\n<Mode>Express</Mode>\n<FreightPayableBy>Test10</FreightPayableBy>\n<PalletType>N/A</PalletType>\n<SenderChepIn>0</SenderChepIn>\n<SenderChepOut>0</SenderChepOut>\n<ReceiverChepIn>0</ReceiverChepIn>\n<ReceiverChepOut>0</ReceiverChepOut>\n<SenderLoscamIn>0</SenderLoscamIn>\n<SenderLoscamOut>0</SenderLoscamOut>\n<ReceiverLoscamIn>0</ReceiverLoscamIn>\n<ReceiverLoscamOut>0</ReceiverLoscamOut>\n<PalletsTransferredDirect>No</PalletsTransferredDirect>\n<DeliveryChepTransferDocket />\n<DangerousGoods>No</DangerousGoods>\n<SpecialInstructions>ATL</SpecialInstructions>\n<PreferredSender>No</PreferredSender>\n<PreferredReceiver>Yes</PreferredReceiver>\n<LoadDetails>\n<ItemReference>N/A</ItemReference>\n<NumberOfUnits>1</NumberOfUnits>\n<UnitDescription>Pallet</UnitDescription>\n<Weight>600</Weight>\n<CubicUnits>1</CubicUnits>\n<Length>1.4</Length>\n<Width>1.2</Width>\n<Height>1.2</Height>\n<Cubic>2.016</Cubic>\n<CubicConverted>504</CubicConverted>\n</LoadDetails>\n<LoadDetails>\n<ItemReference>N/A</ItemReference>\n<NumberOfUnits>1</NumberOfUnits>\n<UnitDescription>Pallet</UnitDescription>\n<Weight>676</Weight>\n<CubicUnits>1</CubicUnits>\n<Length>1.4</Length>\n<Width>1.2</Width>\n<Height>1.2</Height>\n<Cubic>2.016</Cubic>\n<CubicConverted>504</CubicConverted>\n</LoadDetails>\n<CostOnforwardDetails>\n<ItemReference>N/A</ItemReference>\n<NumberOfUnits>1</NumberOfUnits>\n<UnitDescription>Pallet</UnitDescription>\n<Weight>600</Weight>\n<CubicUnits>1</CubicUnits>\n<Length>1.4</Length>\n<Width>1.2</Width>\n<Height>1.2</Height>\n<Cubic>2.016</Cubic>\n<CubicConverted>504</CubicConverted>\n</CostOnforwardDetails>\n<CostOnforwardDetails>\n<ItemReference>N/A</ItemReference>\n<NumberOfUnits>1</NumberOfUnits>\n<UnitDescription>Pallet</UnitDescription>\n<Weight>676</Weight>\n<CubicUnits>1</CubicUnits>\n<Length>1.4</Length>\n<Width>1.2</Width>\n<Height>1.2</Height>\n<Cubic>2.016</Cubic>\n<CubicConverted>504</CubicConverted>\n</CostOnforwardDetails>\n<LogisticUnitDetails>\n<Barcode>00093477800039666440</Barcode>\n</LogisticUnitDetails>\n<LogisticUnitDetails>\n<Barcode>00093477800039666457</Barcode>\n</LogisticUnitDetails>\n<DangerousGoodsDetails>\n<UNNumber />\n<Class />\n<ShippingName />\n<SubRisk />\n<PackagingGroup />\n<TypeOfPackage />\n<NumberOfPackages />\n<AggregateQuantity />\n<ContactName />\n<ContactPhoneNumber />\n</DangerousGoodsDetails>\n</Consignment>\n</Manifest>\n<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<Manifest>\n<ManifestType>Onforward</ManifestType>\n<NumberOfConsignments>1</NumberOfConsignments>\n<Subcontractor>{Legal Name}</Subcontractor>\n<SubcontractorName>{Trading Name}</SubcontractorName>\n<SubcontractorAddress>123 Test Street</SubcontractorAddress>\n<SubcontractorSuburb>Wagga Wagga</SubcontractorSuburb>\n<SubcontractorState>NSW</SubcontractorState>\n<SubcontractorPostcode>2650</SubcontractorPostcode>\n<SubcontractorUserID>1234</SubcontractorUserID>\n<SubcontractorBranchID>3</SubcontractorBranchID>\n<Consignment>\n<ConsignmentNumber>5529184</ConsignmentNumber>\n<ConsignmentDate>30/08/2018</ConsignmentDate>\n<SenderName>Test Group</SenderName>\n<SenderStreetAddress>6 Test Ave</SenderStreetAddress>\n<SenderSuburb>Thornton</SenderSuburb>\n<SenderState>NSW</SenderState>\n<SenderPostcode>2322</SenderPostcode>\n<ReceiverName>Test Rec </ReceiverName>\n<ReceiverStreetAddress>Test Depot</ReceiverStreetAddress>\n<ReceiverStreetAddress1>3 William Street</ReceiverStreetAddress1>\n<ReceiverSuburb>Urana</ReceiverSuburb>\n<ReceiverState>NSW</ReceiverState>\n<ReceiverPostcode>2645</ReceiverPostcode>\n<ReceiverPhone />\n<ReceiverContact />\n<ReceiverReference />\n<Mode>Express</Mode>\n<FreightPayableBy>TEST10</FreightPayableBy>\n<PalletType>N/A</PalletType>\n<SenderChepIn>0</SenderChepIn>\n<SenderChepOut>0</SenderChepOut>\n<ReceiverChepIn>0</ReceiverChepIn>\n<ReceiverChepOut>0</ReceiverChepOut>\n<SenderLoscamIn>0</SenderLoscamIn>\n<SenderLoscamOut>0</SenderLoscamOut>\n<ReceiverLoscamIn>0</ReceiverLoscamIn>\n<ReceiverLoscamOut>0</ReceiverLoscamOut>\n<PalletsTransferredDirect>No</PalletsTransferredDirect>\n<DeliveryChepTransferDocket />\n<DangerousGoods>No</DangerousGoods>\n<LoadDetails>\n<ItemReference>N/A</ItemReference>\n<NumberOfUnits>1</NumberOfUnits>\n<UnitDescription>Pallet</UnitDescription>\n<Weight>600</Weight>\n<CubicUnits>1</CubicUnits>\n<Length>1.4</Length>\n<Width>1.2</Width>\n<Height>1.2</Height>\n<Cubic>2.016</Cubic>\n<CubicConverted>504</CubicConverted>\n</LoadDetails>\n<LoadDetails>\n<ItemReference>N/A</ItemReference>\n<NumberOfUnits>1</NumberOfUnits>\n<UnitDescription>Pallet</UnitDescription>\n<Weight>676</Weight>\n<CubicUnits>1</CubicUnits>\n<Length>1.4</Length>\n<Width>1.2</Width>\n<Height>1.2</Height>\n<Cubic>2.016</Cubic>\n<CubicConverted>504</CubicConverted>\n</LoadDetails>\n<CostOnforwardDetails>\n<ItemReference>N/A</ItemReference>\n<NumberOfUnits>1</NumberOfUnits>\n<UnitDescription>Pallet</UnitDescription>\n<Weight>600</Weight>\n<CubicUnits>1</CubicUnits>\n<Length>1.4</Length>\n<Width>1.2</Width>\n<Height>1.2</Height>\n<Cubic>2.016</Cubic>\n<CubicConverted>504</CubicConverted>\n</CostOnforwardDetails>\n<CostOnforwardDetails>\n<ItemReference>N/A</ItemReference>\n<NumberOfUnits>1</NumberOfUnits>\n<UnitDescription>Pallet</UnitDescription>\n<Weight>676</Weight>\n<CubicUnits>1</CubicUnits>\n<Length>1.4</Length>\n<Width>1.2</Width>\n<Height>1.2</Height>\n<Cubic>2.016</Cubic>\n<CubicConverted>504</CubicConverted>\n</CostOnforwardDetails>\n<LogisticUnitDetails>\n<Barcode>00093477800039666440</Barcode>\n</LogisticUnitDetails>\n<LogisticUnitDetails>\n<Barcode>00093477800039666457</Barcode>\n</LogisticUnitDetails>\n<DangerousGoodsDetails>\n<UNNumber />\n<Class />\n<ShippingName />\n<SubRisk />\n<PackagingGroup />\n<TypeOfPackage />\n<NumberOfPackages />\n<AggregateQuantity />\n<ContactName />\n<ContactPhoneNumber />\n</DangerousGoodsDetails>\n</Consignment>\n</Manifest>\nThere are two different export schedules running during the day, producing three different XML files. The XML structures should be the same, though not all nodes will be populated for all exports.
\nThe first export is scheduled to occur every 30 minutes. It will export any con notes that have been added to a manifest for an export enabled agent, providing that the manifest is considered finalised for data entry.
Con notes that are added to the manifest after the initial export will be exported in additional files.
This export will generate the file MANIFEST_{Manifest Number}_{Datestamp}.XML
The second export is scheduled to occur every morning at 2:40am. It will export any con notes dated to either of the previous two working days, provided the agent is the preferred agent for the sender suburb (pickup) or receiver suburb (delivery) on the con note.
Any con notes exported in this way will only be exported once to the same agent for pickup, and once for delivery.
This export will generate the files MANIFEST_{Manifest Number}_{Datestamp}.XML for con notes that are on a manifest, and NOMANIFEST_{Agent ID}_{Datestamp}.XML for con notes that are not on a manifest.
Agents or their technical partners will provide Border Express with an SFTP location, username and password and export files will be pushed to this location.
\n","_postman_id":"aee4fa28-eb5f-4c0e-a07d-bf0005a0eade"},{"name":"Imports","item":[{"name":"POD (full image)","id":"10e987ec-fecc-43eb-8d1e-d914cc2559e1","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"ManifestNumber\": \"string\",\r\n \"ConnoteNumber\": \"string\",\r\n \"DateSigned\": \"2023-07-24T04:01:11.498Z\",\r\n \"SignedBy\": \"string\",\r\n \"CollectedByUserId\": 0,\r\n \"Image\": {\r\n \"FileContents\": \"string\",\r\n \"FileName\": \"string\",\r\n \"ContentType\": \"string\"\r\n },\r\n \"ImageBase64\": \"string\"\r\n}","options":{"raw":{"language":"json"}}},"url":"{{baseUrl}}/api/pods","description":"Allows the creation of a POD from a provided image. A POD is usually created on job completion. Only one of the image properties are required (Image or ImageBase64). Use Image if submitting multipart/formdata, otherwise use ImageBase64.
\n{\nManifestNumber (string, optional): The manifest number the POD is associated with,\nConnoteNumber (string): The consignment number the POD is associated with,\nDateSigned (string): The date and time that the signature was signed,\nSignedBy (string): The name of the person who signed the proof,\nCollectedByUserId (integer, optional): The Id of the user that collected the proof,\nImage (HttpPostedFileMultipartModel, optional): The image contents,\nImageBase64 (string, optional): The image content encoded as base64\n}\n{\nFileContents (string, optional),\nFileName (string, optional),\nContentType (string, optional)\n}\nAllows the creation of a Border Express POD from a provided signature. A POD is usually created on job completion. Only one of the signature properties are required (Signature or SignatureBase64). Use Signature if submitting multipart/formdata otherwise use SignatureBase64.
\n{\nManifestNumber (string, optional): The manifest number the POD signature is associated with,\nConnoteNumber (string): The consignment number the POD signature is associated with,\nBarcodes (Array[PODSignatureCreateBarcodeViewModel], optional): The barcodes from the freight that was delivered,\nDateSigned (string): The date and time that the signature was signed,\nSignedBy (string): The name of the person who signed the signature,\nCollectedByUserId (integer, optional): The Id of the user that collected the signature,\nSignature (HttpPostedFileMultipartModel, optional): The signature image,\nSignatureBase64 (string, optional): The signature image encoded as base64\n}\n\n{\nBarcodeNumber (string)\n}\n\n{\nFileContents (string, optional),\nFileName (string, optional),\nContentType (string, optional)\n}\n\nWhen an item barcode is scanned, a scan may need to be created in order to provide visibility on the item.
UserId and BranchId are only required when passing in a location type of 1.
{\nScanTypeId (integer),\nBarcode (string): The value of the barcode scanned,\nUserId (integer, optional): The identity of the user that scanned the item,\nScanDate (string): The date and time the scan occurred,\nLocationType (integer): Where the item was scanned ( -1 - Sender, -2 - Receiver, 1 - Branch ),\nBranchId (integer, optional): The identity of the branch where the item was scanned,\nMethodId (integer, optional): The identity of the method used to perform the scan ( 1 - Physical (Scanned by a hardware \nscanner), 3 - Implied (Scan generated by software)),\nApplicationId (integer, optional): The identity of the application that performed the scan,\nAreaId (integer, optional): The identity of the area the item was scanned in,\nPosition (GeometryPointViewModel, optional): The latitude and longitude where the item was scanned\n}\n\n{\nLat (double),\nLon (double)\n}\n\nWe currently allow the following item level scans to be submitted:
\n","urlObject":{"path":["api","barcodes",":barcode","scans"],"host":["{{baseUrl}}"],"query":[],"variable":[{"description":{"content":"The barcode number that was scanned
\n","type":"text/plain"},"type":"any","value":"Enables the creation of additional service notifications for a consignment.
These are used to notify Border Express of any additional services performed for a customer at the point of
pickup/delivery.
{\nManifestNumber (string, optional): The manifest the additional service is related too,\nConnoteNumber (string): The consignment the additional service is related too, if provided in the URL the URL \nvalue will override the Body value,\nAdditionalServices (Array[AdditionalServiceNotificationViewModel]): A list of additional services performed\n}\n\n{\nUserId (integer),\nReasonId (integer),\nQty (integer)\n}\n\n#Available additional services
We currently allow the following additional services to be submitted:
The consignment the additional service relates to
\n","type":"text/plain"},"type":"any","value":"Allows the submission of events against a consignment.
\n[\n{\nBranchId (integer): The Branch Id where the event occurred,\nUserId (integer): The User Id that performed the action,\nDateOccurred (string): The date and time that the event occurred, Supports ISO8601 formatted date/time,\nCode (integer): The unique event code,\nComment (string, optional): Any additional information regarding the event\n}]\nBorder Express currently allows the following events to be submitted:
\n","urlObject":{"path":["api","consignments",":consignmentNumber","Events"],"host":["{{baseUrl}}"],"query":[],"variable":[{"description":{"content":"The number for the consignment to submit the event for.
\n","type":"text/plain"},"type":"any","value":"Enables the details of a consignment on an agent manifest to be modified. Currently, only the \"replace\" PATCH specification operation is supported. Requires the consignments to be on a manifest.
\nA list of instructions that specify what fields to change and the value to set.
\n{\nOperations (Array[PatchDocumentModel], optional)\n}\nPatchDocumentModel\n{\nOP (string, optional),\nPath (string, optional),\nValue (object, optional)\n}\nWe currently allow the following paths to be updated:
\nNote: modifiedbyuserid and modifiedatbranchid are specific to Agent
\nPlease note that the rejected status is also used for deliveries that do not require a sign-on-glass.\nWe currently allow the following rejected statuses to be submitted:
\n","urlObject":{"path":["api","agentManifests",":manifestNumber","consignments",":consignmentNumber"],"host":["{{baseUrl}}"],"query":[],"variable":[{"description":{"content":"The number of the agent runsheet the job is on.
\n","type":"text/plain"},"type":"any","value":"The consignment number of the job.
\n","type":"text/plain"},"type":"any","value":"Border Express import data from all third parties using the Border Express REST API. Data is required to be pushed to the Border Express API from agents (Border Express does not pull data from 3rd party APIs).
\n\n\nFor setup and testing purposes please connect to our test API
\n
https://integrationapi.borderexpress.com.au.
Full Border Express API documentation can be found at https://apidocumentation.borderexpress.com.au/. This API should only be used after testing has been confirmed.
\nThe following API endpoints are available:
\n• POD (full image): Allows the creation of a POD from a provided image. A POD is usually created on job completion.
\n• POD (signature): Allows the creation of a Border Express POD from a provided signature. A POD is usually created on job completion.
\n• Barcode scan events: When an item barcode is scanned, a scan event may need to be
created in order to provide visibility on the item.
• Additional charges: Enables the creation of additional service notifications for a consignment.
\nThese are used to notify Border Express of any additional services performed for a customer at the point of pickup or delivery.
\n• Consignment events: Allows the submission of events against a consignment.
\n• Consignment status updates: Enables the details of a consignment on an agent manifest to be modified.
\n\n\nIn order to request access to our API please email integrations@borderexpress.com.au and
\n
provide an email address to link your API account to.
Border Express uses OAuth 2.0 authorisation. Before you can start utilising the API you will need to contact Border Express by emailing integrations@borderexpress.com.au. Please provide an email address to link to your API account. After your account is set up, Border Express will send you a link to generate your client credentials, these will be used to retrieve an API bearer token.
\nTo retrieve an API Token:
\n• Make a POST request to https://integrationapi.borderexpress.com.au/token with a header of:
\nContent-Type: application/x-www-form-urlencoded.
The entered request body should contain your URL encoded credentials in the format of:
\ngrant_type=client_credentials&client_id={clientId}&client_secret={clientSecret}
If successful a result will be returned in JSON:
\n{\n \"access_token\":\"****\",\n \"token_type\":\"bearer\",\n \"expires_in\":3599,\n \"scope\":\"bex.webapi.basic\",\n \"userName\":\"username@borderexpress.com.au\",\n \".issued\":\"Tue, 29 Aug 2017 05:45:16 GMT\",\n \".expires\":\"Tue, 29 Aug 2017 06:45:16 GMT\"\n}\n\nTo utilise your token, you must add the access token into the request header. When a token is first retrieved, it is valid for an hour.
\nIn the request header, add the below values:
\nContent-Type: application/json
Authorization: bearer {access_token_value}
Tokens must be renewed once expired. If at token has been revoked by Border Express you will receive a
401 status code and will be required to re-authenticate.