Customers can connect to Border Express Web via the web API. Access to information available within this API is managed based on customer accounts. This API currently includes the following functionality:
\nBefore 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.
\nBorder Express only currently accepts/returns JSON as an input/output format.
\nOur API accepts requests over HTTPS for the following methods:
\nBorder Express has an API for development/testing and a production API for when you are ready to go live with your integration. Please do not utilise our production API for testing purposes.
\nBorder Express reserves the right to add fields/endpoints our API's at any time. It is the responsibility of the partner platform to ensure additions do not impact current implementation. If changes are required where an existing field requires a change/removal Border Express will version the endpoint and communicate the date the old version will be depreciated.
\nFor setup and testing purposes, please connect to our test API
\nhttps://integrationapi.borderexpress.com.au
\n.
\nAfter testing is complete and you are ready to deploy to live, please contact integrations@borderexpress.com.au and request the URL to our production API.
\nSecurity to the API is maintained by Border Express, all connections to our API are required to be over a HTTPS connection. Border Express utilises bearer tokens for authentication, the information inside these bearer tokens are for Border Express use only as they can change at any time. Tokens are only valid for 1 hour and Border Express reserve the right to revoke/disable a token priory to expiry.
\nFor additional support, please email integrations@borderexpress.com.au.
\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[{"content":"Getting Started","slug":"getting-started"},{"content":"Environments","slug":"environments"},{"content":"Security","slug":"security"},{"content":"Support","slug":"support"}],"owner":"11708031","collectionId":"4da6a79b-8bd3-4d81-bcc6-feb3a306c689","publishedId":"SzzhdySi","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"},"publishDate":"2024-12-02T05:16:29.000Z"},"item":[{"name":"Authentication","item":[{"name":"auth","id":"02718259-c52b-43af-86ce-9d371cad63e6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"url":"{{baseUrl}}/token","urlObject":{"path":["token"],"host":["{{baseUrl}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"02718259-c52b-43af-86ce-9d371cad63e6"}],"id":"ef39854d-db88-4c8c-b303-54592ff43197","description":"Border Express uses OAuth 2.0 authorisation. Tokens are issued for a period of time and enable you to interact with our API.
\nThis section explains how to retrieve a token as well as how to use the token to authenticate.
\nBefore you can authenticate with the Border Express API, you will need to provide an email address that Border Express can use to set up your account.
\nAfter your account is set up, Border Express will provide you with a client ID and secret that you can use to retrieve an API token.
\nTo retrieve an API token:\nMake a POST request to https://integrationapi.borderexpress.com.au/token with a \"Content-Type\" of: \"Content-Type: application/x-www-form-urlencoded\".
\nThe entered request body should contain your credentials in the format of:
\ngrant_type=client_credentials&client_id={clientId}&client_secret={clientSecret}\nIf successful, a result will be returned in JSON. Below is an example of what this will look like.
\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}\nWhen a token is first retrieved, it is valid for an hour.
\nIn the request header, add the below values:
\nTokens must be renewed once expired. If a token has been revoked by Border Express you will receive a 401 status code and will be required to re-authenticate.
\n","event":[{"listen":"prerequest","script":{"id":"772cb755-2e6f-4cd6-a5f4-b46d19c888b1","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"b285a81b-78dd-43cd-9d39-d5c338c5a214","type":"text/javascript","exec":[""]}}],"_postman_id":"ef39854d-db88-4c8c-b303-54592ff43197"},{"name":"Consignments","item":[{"name":"Create Consignment","item":[{"name":"Create a consignment for goods travelling with Border Express on a specified service.","id":"dc10c4e4-bacd-43a4-a4da-b21a9613922d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"AuthorityToLeave\": \"A consignment will include details of pickup and receiver locations, item information and any special instructions or delivery requirements.
\n","urlObject":{"path":["api","v2","consignments"],"host":["{{baseUrl}}"],"query":[{"disabled":true,"description":{"content":"If the full label detail should be returned, this includes a base64 encoding of the pdf file
\n","type":"text/plain"},"key":"includeLabelDetail","value":"Specify how many copies of the labels should be generated
\n","type":"text/plain"},"key":"labelCopies","value":"1"},{"disabled":true,"description":{"content":"Specify the size of the labels generated
\n","type":"text/plain"},"key":"labelSize","value":"A6"}],"variable":[]}},"response":[{"id":"2df12310-e04c-4e9e-afee-c5ef21366481","name":"Success","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"AuthorityToLeave\": \"false\",\n \"DespatchDate\": \"2020-07-01\",\n \"LoadItems\": [\n {\n \"ChargeUnit\": \"kilogram\",\n \"Description\": \"box\",\n \"HasFoodstuffs\": \"Returns the labels (barcodes) for a consignment.
\n","urlObject":{"path":["api","v2","consignments",":consignmentNumber","labels"],"host":["{{baseUrl}}"],"query":[{"description":{"content":"Specify the size of the labels generated
\n","type":"text/plain"},"key":"size","value":"A6"},{"description":{"content":"Specify how many copies of the labels should be generated
\n","type":"text/plain"},"key":"copies","value":"1"}],"variable":[{"id":"93f72917-259e-4ee3-b00b-432cc293a089","description":{"content":"(Required) The consignment to generate labels for
\n","type":"text/plain"},"type":"string","value":"| Field | \nDescription | \nMax Size | \n Req. | \nComments | \n
|---|---|---|---|---|
| consignmentNumberPrefix | \nString | \n5 | \nNo | \nThe alpha or numeric characters used to prefix a consignment number. | \n
| despatchDate | \nDatetime | \n\n | Yes | \nDate format: YYYY-MM-DD. Date must be >= today. | \n
| payingAccountCode | \nString | \n50 | \nYes | \nBorder Express account code associated with the customer paying for the service. Must be a valid active account with trading terms. | \n
| serviceCode | \nString | \n5 | \nYes | \nBLK- Bulk palletised freight. PAR- Parcel or carton freight. ECM - B2C individual items only MEC - B2C multiple items. | \n
| receiverToCollect | \nBoolean | \n\n | Yes | \nFalse – Border Express to deliver the freight. True – Receiving customer will collect freight from a Border Express branch. The default value is False. | \n
| specialInstructions | \nString | \n500 | \nNo | \nNote: This does not display on the label but will be displayed on driver's devices. | \n
| authorityToLeave | \nBoolean | \n\n | Yes | \nIndicates if the driver has the authority to leave goods in a safe place. True - The customer has given the authority to leave the goods. False - No authority to leave goods has been given. | \n
| barcodes | \nArray(String) | \n\n | No | \nRequired if the customer is providing their own freight labels (and do not require Border Express to generate labels). Max individual barcode length is 50 characters. | \n
| Dangerous Goods Contact | \n||||
| dangerousGoodsContact.Name | \nString | \n50 | \n\n | Name of the contact person for the DGs. Required if the consignment includes dangerous goods. | \n
| dangerousGoodsContact.Phone | \nString | \n15 | \n\n | Must be a valid phone number with numbers between 0-9 and can only include () characters. Required if the consignment includes dangerous goods. | \n
| Sender Details | \n||||
| sender.code | \nString | \n50 | \nNo | \nBorder Express account code associated with the customer sending the freight. | \n
| sender.name | \nString | \n50 | \nYes | \nName of the company sending the freight. | \n
| sender.addressLine1 | \nString | \n150 | \nYes | \nAddress the freight is being sent from. | \n
| sender.addressLine2 | \nString | \n150 | \nNo | \n\n |
| sender.suburb | \nString | \n50 | \nYes | \nMust be a valid Australia Post suburb. | \n
| sender.state | \nString | \n3 | \nYes | \nShort code for the state which the freight is being sent from e.g. NSW, VIC. | \n
| sender.postcode | \nString | \n4 | \nYes | \nMust be a valid Australia Post postcode. | \n
| sender.contactName | \nString | \n30 | \nNo | \nName of the contact person sending the freight. | \n
| sender.contactPhone | \nString | \n15 | \nNo | \nMust be a valid phone number with numbers between 0-9 and can only include () characters. | \n
| sender.contactEmail | \nString | \n200 | \nNo | \nMust be a valid email. | \n
| sender.reference | \nString | \n50 | \nNo | \n\n |
| Receiver Details | \n||||
| receiver.code | \nString | \n50 | \nNo | \nBorder Express account code associated with the customer receiving the freight. | \n
| receiver.name | \nString | \n50 | \nYes | \nName of the customer receiving the freight. | \n
| receiver.addressLine1 | \nString | \n150 | \nYes | \nAddress the freight is being delivered to. | \n
| receiver.addressLine2 | \nString | \n150 | \nNo | \n\n |
| receiver.suburb | \nString | \n50 | \nYes | \nMust be a valid Australia Post delivery location. | \n
| receiver.state | \nString | \n3 | \nYes | \nShort name for the state which the freight is being delivered into e.g. NSW, VIC. | \n
| receiver.postcode | \nString | \n4 | \nYes | \nMust be a valid Australia Post delivery location. | \n
| receiver.contactName | \nString | \n30 | \nNo | \nThe name of the contact person who will receive the delivery. | \n
| receiver.contactPhone | \nString | \n15 | \nYes | \nMust be a valid phone number with numbers between 0-9 and can only include () characters. | \n
| receiver.contactEmail | \nString | \n200 | \nYes | \nMust be a valid email. | \n
| receiver.reference | \nString | \n50 | \nNo | \n\n |
| Load Item Details - Required A consignment must have at least one load item. | \n ||||
| loadItems.customerReference | \nString | \n50 | \nNo | \n\n |
| loadItems.quantity | \nInteger | \n\n | Yes | \nMust have quantity > 0. | \n
| loadItems.description | \nString | \n50 | \nYes | \nA description of the item (Examples: box, pallet, carton, skid etc.). If the Unit Description = ‘Pallet’, then Length and Width will be auto-converted to 1.2m | \n
| loadItems.length | \nDouble | \n\n | \n | Measured in meters. Required if the service type is bulk (palletised freight).Must be > 0. | \n
| loadItems.width | \nDouble | \n\n | \n | Measured in meters. Required if the service type is bulk (palletised freight). Must be > 0. | \n
| loadItems.height | \nDouble | \n\n | \n | Measured in meters. Required if the service type is bulk (palletised freight). Must be > 0. | \n
| loadItems.weight | \nDouble | \n\n | Yes | \nMeasured in kilograms. | \n
| loadItems.chargeUnit | \nString | \n50 | \nYes | \nFor the parcel, bulk and multi item eCommerce (MEC) service the charge unit is normally “Kilogram”. For the single eCommerce service (ECM) the charge unit is normally “Piece Rate”. | \n
| loadItems.hasFoodstuffs | \nBoolean | \n\n | Yes | \nFalse - The freight does not contain food products. True - This is a food product. Default value is false. | \n
| Load Item Dangerous Goods Required if the consignment has dangerous goods. | \n ||||
| loadItems.dGs.unNumber | \nString | \n4 | \nYes | \nMust be 4 characters in length. Must contain valid numbers between 0 – 9. Must be allowed to travel with Border Express. | \n
| loadItems.dGs.packingGroup | \nString | \n3 | \nNo | \nValues must be I, II or III if provided. | \n
| loadItems.dGs.packageType | \nString | \n30 | \nYes | \nMust be a valid DG package type e.g. bag, drum, carton, bottle, tube. | \n
| loadItems.dGs.quantity | \nInteger | \n\n | Yes | \nMust be a number > 0. | \n
| loadItems.dGs.aggregateQuantity | \nInteger | \n\n | Yes | \nMust be a number > 0. | \n
| loadItems.dGs.shippingName | \nString | \n500 | \nYes | \nProper shipping name | \n
| loadItems.dGs.class | \nString | \n10 | \nYes | \nDG class | \n
| loadItems.dGs.subRisk | \nString | \n25 | \nNo | \nSub risk category of the DG (must be provided if one exists) | \n
| Time Sensitive Details Only required if customer has a timeslot or delivery window agreement. | \n ||||
| timeslot.dateTime | \nDatetime | \n\n | No | \nA specific booking time for freight to be delivered. Receiver local time YYYY-MM-DD HH:mm. | \n
| timeslot.reference | \nString | \n50 | \nNo | \nRequired if a timeslot date time is provided. | \n
| deliveryWindow.startDate | \nDatetime | \n\n | No | \nThe earliest date which a delivery can occur in. Note: the start date must be after the consignment despatch date. Date format: YYYY-MM-DD. | \n
| deliveryWindow.endDate | \nDatetime | \n\n | No | \nThe latest date which a delivery can occur in. Required if there is a delivery window start date. Date format: YYYY-MM-DD | \n
| deliveryWindow.startTime | \nString | \n\n | No | \nThe earliest time which a delivery can occur in, on any one day within the delivery window. Receiver local time. Time format: HH:mm | \n
| deliveryWindow.endTime | \nString | \n\n | No | \nThe latest time which a delivery can occur in, on any one day within the delivery window. Receiver local time. Time format: HH:mm | \n
| Alerts (Optional) | \n||||
| alerts.contactName | \nString | \n50 | \nNo | \nThe name of the person who will be receiving the notification. | \n
| alerts.emailAddress | \nString | \n200 | \nNo | \nMust be a valid email address. | \n
| alerts.alertType | \nString | \n30 | \nNo | \nCurrent alert types include: DESPATCHED – Freight has been despatched from sender. DELIVERY_STATUS – Freight has passed through a delivery checkpoint. DELIVERED – Freight has been delivered. | \n
| CHEP Pallet Details Required for palletised freight only where CHEP pallets are utilised. | \n ||||
| pallets.chep.exchangeIn | \nInteger | \n\n | No | \nMust be a number >= 0. | \n
| pallets.chep.exchangeOut | \nInteger | \n\n | No | \nMust be a number >= 0. | \n
| pallets.chep.directTransferToRec | \nInteger | \n\n | No | \nMust be a number >= 0. | \n
| pallets.chep.transferOffBex | \nInteger | \n\n | No | \nMust be a number >= 0. | \n
| pallets.chep.docketNumber | \nString | \n50 | \nNo | \nIs required if CHEP exchange in and direct transfer to receiver > 0. | \n
| Loscam Pallet Details Required for palletised freight only where Loscam pallets are utilised. | \n ||||
| pallets.loscam.exchangeIn | \nInteger | \n\n | No | \nMust be a number >= 0. | \n
| pallets.loscam.exchangeOut | \nInteger | \n\n | No | \nMust be a number >= 0. | \n
| pallets.loscam.directTransferToRec | \nInteger | \n\n | No | \nMust be a number >= 0. | \n
| pallets.loscam.transferOffBex | \nInteger | \n\n | No | \nMust be a number >= 0. | \n
| pallets.loscam.docketNumber | \nString | \n50 | \nNo | \nRequired if Loscam transferOffBex or direct transfer to receiver > 0. | \n
Retrieve details about a particular consignment which has been shipped with Border Express for delivery.
\n","urlObject":{"path":["api","v1","consignments",":consignmentNumber"],"host":["{{baseUrl}}"],"query":[{"description":{"content":"If included children information is returned. Allowed values {\"all\",\"barcodes\",\"events\",\"loaditems\", \"label\",\"pods\",\"preconditions\"}
\n","type":"text/plain"},"key":"expand","value":"If enabled the response will be wrapped with an APIResponse object(obsolete)
\n","type":"text/plain"},"key":"wrap","value":"false"},{"description":{"content":"Specify how many copies of the labels should be generated
\n","type":"text/plain"},"key":"labelCopies","value":"1"},{"description":{"content":"Specify the size of the labels generated
\n","type":"text/plain"},"key":"labelSize","value":"A6"}],"variable":[{"id":"54b80242-f704-4a77-8e11-0d77ccbf55ba","description":{"content":"(Required) The number associated with the consignment.
\n","type":"text/plain"},"type":"string","value":"Retrieve details about the consignments which have been shipped with Border Express for delivery based on specific attributes.\n If called with no parameters, the despatch date range will be defaulted to 6 months from the current date.\n Despatch date is applied as a range and applied first, the comparison operator does not apply to the date range.
\n","urlObject":{"path":["api","v1","consignments"],"host":["{{baseUrl}}"],"query":[{"description":{"content":"Determine if the search should be an \"AND\" or an \"OR\" search, only required if more than one parameter is set.
\n","type":"text/plain"},"key":"comparison","value":"If included children information is returned. Allowed values {\"all\",\"barcodes\",\"events\",\"loaditems\",\"pods\",\"preconditions\"}
\n","type":"text/plain"},"key":"expand","value":"Search for a consignment number.
\n","type":"text/plain"},"key":"connoteNumber","value":"Search for a consignment via a barcode number
\n","type":"text/plain"},"key":"barcodeNumber","value":"Search for a consignment via a despatch date range (maximum of 6 months in a request)
\n","type":"text/plain"},"key":"despatchFromDate","value":"Search for a consignment via a despatch date range (maximum of 6 months in a request)
\n","type":"text/plain"},"key":"despatchToDate","value":"Search for a consignment via an ETA date range
\n","type":"text/plain"},"key":"etaFromDate","value":"Search for a consignment via an ETA date range
\n","type":"text/plain"},"key":"etaToDate","value":"Search for a consignment via a customer account
\n","type":"text/plain"},"key":"accountNumber","value":"Specify how large the result set should be
\n","type":"text/plain"},"key":"pageSize","value":"0"},{"description":{"content":"Specify what page of the search should be returned
\n","type":"text/plain"},"key":"pageNumber","value":"1"},{"description":{"content":"Specify how many copies of the labels should be generated
\n","type":"text/plain"},"key":"label_copies","value":"1"},{"description":{"content":"Specify the size of the labels generated
\n","type":"text/plain"},"key":"label_size","value":"A6"}],"variable":[]}},"response":[{"id":"2d9fe267-6620-47cb-a620-d0b4169c666c","name":"No search results found","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json","type":"text"}],"url":{"raw":"{{baseUrl}}/api/v1/consignments?comparison=OR&expand=all&connoteNumber=1123694&barcodeNumber=00069999","host":["{{baseUrl}}"],"path":["api","v1","consignments"],"query":[{"key":"comparison","value":"OR"},{"key":"expand","value":"all"},{"key":"connoteNumber","value":"1123694"},{"key":"barcodeNumber","value":"00069999"},{"key":"despatchFromDate","value":"Details for consignments can be obtained either by searching for a specific consignment (recommended) or by searching based on a list of predefined consignment attributes.
\n","_postman_id":"9e8ec2f8-b2d0-4b5a-85aa-38398f6f7c35"},{"name":"Tracking","item":[{"name":"Retrieve the status history for a given consignment.","id":"9da199fa-890e-4b81-95a2-9ad44c4d81da","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{baseUrl}}/api/v1/consignments/:consignmentNumber/Statuses","description":"Return a history of the status checkpoints a consignment has passed through in its lifecycle e.g. Despatched, In Transit, On Board, Delivered.
\n","urlObject":{"path":["api","v1","consignments",":consignmentNumber","Statuses"],"host":["{{baseUrl}}"],"query":[{"disabled":true,"key":"wrap","value":"false"}],"variable":[{"id":"13d4998c-6320-4f67-94c4-f6bebf629ce3","description":{"content":"(Required) The number for the consignment to get the status history for
\n","type":"text/plain"},"type":"string","value":"Returns scans for barcodes associated with the consignment.
\n","urlObject":{"path":["api","v1","consignments",":consignmentNumber","barcodes","scans"],"host":["{{baseUrl}}"],"query":[{"description":{"content":"The start of the date range to get barcode scans for
\n","type":"text/plain"},"key":"fromDate","value":"The end of the date range to get barcode scans for
\n","type":"text/plain"},"key":"toDate","value":"How many records to return
\n","type":"text/plain"},"key":"pageSize","value":"0"},{"description":{"content":"Determines the page to start on using the page size above
\n","type":"text/plain"},"key":"pageNumber","value":"0"}],"variable":[{"id":"00169cdd-86b0-4bdb-823b-a29d309aefe0","description":{"content":"(Required) The consignment to get barcode scans for
\n","type":"text/plain"},"type":"string","value":"Returns a public history of the status checkpoints a consignment has passed through in its lifecycle e.g. In Transit, On Board, Delivered etc.
\n","urlObject":{"path":["api","v2","consignments","{consignmentNumber}","publicStatuses"],"host":["{{baseUrl}}"],"query":[],"variable":[]}},"response":[{"id":"6fc2c043-adee-45c8-a450-054909ec987b","name":"Status history retrieved","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json","type":"text"}],"url":"{{baseUrl}}/api/v2/consignments/{consignmentNumber}/publicStatuses"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"ConsignmentNumber\": \"string\",\n \"DespatchedDate\": \"2023-05-25\",\n \"ETADate\": \"2023-05-25\",\n \"DeliveredDate\": \"2023-05-25T05:38:14.607Z\",\n \"CurrentStatus\": {\n \"DisplayName\": \"string\",\n \"IntegrationCode\": \"string\",\n \"LastModified\": \"2023-05-25T05:38:14.607Z\"\n },\n \"SenderLocation\": {\n \"Suburb\": \"string\",\n \"State\": \"string\",\n \"Postcode\": \"string\"\n },\n \"ReceiverLocation\": {\n \"Suburb\": \"string\",\n \"State\": \"string\",\n \"Postcode\": \"string\"\n },\n \"StatusHistory\": [\n {\n \"Order\": 0,\n \"Status\": \"string\",\n \"DateOccurred\": \"2023-05-25T05:38:14.607Z\",\n \"Suburb\": \"string\",\n \"State\": \"string\",\n \"Postcode\": \"string\",\n \"IntegrationCode\": \"string\",\n \"StatusEvents\": [\n {\n \"DateOccurred\": \"2023-05-25T05:38:14.607Z\",\n \"ItemBarcode\": \"string\",\n \"Suburb\": \"string\",\n \"State\": \"string\",\n \"Postcode\": \"string\"\n }\n ]\n }\n ],\n \"TotalItems\": 0\n}"}],"_postman_id":"2c5a4080-6326-415c-a88e-9c8feda72e73"}],"id":"62881a64-124e-4771-9ed1-bfd32143b722","description":"Currently Border Express support the following tracking statuses:
\nTracking for items (barcodes) based on available scan types is also provided for specific consignments. If you would like a list of available barcode scan types, please refer to the \"scan types\" section in this documentation.
\n","_postman_id":"62881a64-124e-4771-9ed1-bfd32143b722"},{"name":"PODs","item":[{"name":"Download the last proof of delivery document in a specified format.","id":"0be885b7-a59b-419a-8511-9312f8fa3910","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{baseUrl}}/api/v1/consignments/:consignmentNumber/pods/:fileFormat","urlObject":{"path":["api","v1","consignments",":consignmentNumber","pods",":fileFormat"],"host":["{{baseUrl}}"],"query":[{"disabled":true,"description":{"content":"If set as true, a Base64 encoded string of the image will be returned, if false the image will be sent as a byte array
\n","type":"text/plain"},"key":"base64","value":"false"},{"disabled":true,"description":{"content":"If enabled and base64 is enabled the response will be wrapped with an APIResponse object
\n","type":"text/plain"},"key":"wrap","value":"false"}],"variable":[{"description":{"content":"(Required) Specify which consignment a proof of delivery should be retrieve for
\n","type":"text/plain"},"type":"string","value":"(Required) The format the file is returned as. Supported file types (PDF, TIF)
\n","type":"text/plain"},"type":"string","value":"POD metadata consists of specific information about the delivery e.g. date POD was signed on.
\n","urlObject":{"path":["api","v1","consignments",":consignmentNumber","pods","Metadata"],"host":["{{baseUrl}}"],"query":[{"description":{"content":"If enabled the response will be wrapped with an APIResponse object
\n","type":"text/plain"},"key":"wrap","value":"false"}],"variable":[{"id":"4dd4be3c-18e9-4027-a2a5-633741e769d5","description":{"content":"(Required) The number for the consignment to get the PODs for
\n","type":"text/plain"},"type":"string","value":"You can retrieve a proof of delivery (POD) for your consignments either as an image or as a base64 string.
\n","_postman_id":"962bb391-96b2-4b33-b4bc-a6abdafe0758"},{"name":"Price Estimate","item":[{"name":"Get a price estimate based on the given criteria.","id":"a6cf8ab1-ad51-49b2-83b9-c58499bca23d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"\n{\n \"DepartDate\": \"Returns an estimated price.
\nAll pricing enquiries are estimations only and are subject to change. All services quoted or requested via the API fall under the Border Express Conditions of Carriage.
\n","_postman_id":"bcf9bd10-e56e-479e-83f7-fa0d0df6e87b"},{"name":"ETA","item":[{"name":"Get an arrival date estimate based on the given criteria.","id":"cb959916-221c-4cb7-9995-d95ba0fc6737","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{baseUrl}}/api/v1/consignments/arrivalEstimate?departDate=Returns an arrival date estimate.
\n","urlObject":{"path":["api","v1","consignments","arrivalEstimate"],"host":["{{baseUrl}}"],"query":[{"description":{"content":"The departure date
\n","type":"text/plain"},"key":"departDate","value":"The sender suburb
\n","type":"text/plain"},"key":"senderSuburb","value":"The sender postcode
\n","type":"text/plain"},"key":"senderPostcode","value":"The receiver suburb
\n","type":"text/plain"},"key":"receiverSuburb","value":"The receiver postcode
\n","type":"text/plain"},"key":"receiverPostcode","value":"Retrieve an estimated arrival date for delivery of goods based on a pickup and delivery location. Please note all dates are estimates only and are subject to change.
\n","_postman_id":"7f9d8d11-6ddc-41c0-a04a-4a980b5d4d8c"}],"id":"0a63387a-2f08-49ba-a218-7584616c4696","description":"Consignments contain details about the freight which is going to be travelling with Border Express.\nCustomers can perform the following consignment related functions:
\nReturns scans for barcodes.
\n","urlObject":{"path":["api","barcodes",":barcode","scans"],"host":["{{baseUrl}}"],"query":[{"description":{"content":"The start of the date range to get scans for
\n","type":"text/plain"},"key":"fromDate","value":"The end of the date range to get scans for
\n","type":"text/plain"},"key":"toDate","value":"How many records to return
\n","type":"text/plain"},"key":"pageSize","value":"0"},{"description":{"content":"Determines the page to start on using the page size above
\n","type":"text/plain"},"key":"pageNumber","value":"0"}],"variable":[{"id":"22985404-0d53-4e55-8d86-065788c6aad3","description":{"content":"(Required) The barcode to get scans for
\n","type":"text/plain"},"type":"string","value":"Returns types of scan events for barcodes.
\n","urlObject":{"path":["api","barcodes","scanTypes"],"host":["{{baseUrl}}"],"query":[],"variable":[]}},"response":[{"id":"3953274c-4853-4d19-8c9a-ef5358da652d","name":"Scan event types for barcodes","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json","type":"text"}],"url":"{{baseUrl}}/api/barcodes/scanTypes"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"ScanTypes\": [\n {\n \"Id\": \"-1\",\n \"Name\": \"Checkpoint\"\n },\n {\n \"Id\": \"1120\",\n \"Name\": \"Into Branch\"\n },\n {\n \"Id\": \"2030\",\n \"Name\": \"Load for Linehaul\"\n },\n {\n \"Id\": \"2031\",\n \"Name\": \"Removed from Linehaul\"\n },\n {\n \"Id\": \"2110\",\n \"Name\": \"Unload from Linehaul\"\n },\n {\n \"Id\": \"2910\",\n \"Name\": \"Held Freight\"\n },\n {\n \"Id\": \"3010\",\n \"Name\": \"Load for Delivery\"\n },\n {\n \"Id\": \"3011\",\n \"Name\": \"Removed from Delivery\"\n },\n {\n \"Id\": \"3020\",\n \"Name\": \"Load for Onforward\"\n },\n {\n \"Id\": \"3021\",\n \"Name\": \"Removed from Onforward\"\n },\n {\n \"Id\": \"3090\",\n \"Name\": \"Unload for Delivery\"\n },\n {\n \"Id\": \"3100\",\n \"Name\": \"Unload for Onforward\"\n }\n ]\n}"}],"_postman_id":"1cb9388d-479f-40e1-b054-83bded504048"}],"id":"6b0a6e78-e8d2-4987-adf6-b63297954da1","description":"Track individual item (barcodes) through scanning checkpoints in the Border Express network.
\n","_postman_id":"6b0a6e78-e8d2-4987-adf6-b63297954da1"}],"id":"dbf84e34-a606-43c3-9da0-e8e73e962081","description":"An item is an individual piece of freight (e.g carton, box) labeled with a unique barcode, which can travel through the Border Express network. A consignment can be made up of multiple items for delivery.
\n","_postman_id":"dbf84e34-a606-43c3-9da0-e8e73e962081"},{"name":"Suburbs","item":[{"name":"Retrieves a list of suburbs/route codes","id":"9317f33f-7da3-4b41-b842-18d1a91de40a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{baseUrl}}/api/v3/suburbs","description":"Retrieve a list of Suburbs with Route codes per Service Type
\n","urlObject":{"path":["api","v3","suburbs"],"host":["{{baseUrl}}"],"query":[{"disabled":true,"description":{"content":"The name of the Suburb
\n","type":"text/plain"},"key":"Suburb","value":"The State that the Suburb is in
\n","type":"text/plain"},"key":"State","value":"The Postcode for Suburb
\n","type":"text/plain"},"key":"Postcode","value":"The Routing Code
\n","type":"text/plain"},"key":"RoutingCode","value":"Keyword search for all fields
\n","type":"text/plain"},"key":"Keyword","value":"Returns a list of suburbs and route codes.
\n","_postman_id":"addfc73c-0954-422c-b2de-78f548889f14"},{"name":"Pickup Bookings","item":[{"name":"Create a pickup booking","id":"e53b92bc-f69b-4bf2-a304-c0868384e717","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"PickupDate\": \"2023-05-01\",\n \"ReadyTime\": \"13:00\",\n \"CloseTime\": \"16:00\",\n \"SenderCode\": \"TESTAPI\",\n \"BookingName\": \"Test Booking\",\n \"SenderName\": \"Test Sender \",\n \"AddressLine1\": \"123 Test St\",\n \"AddressLine2\": null,\n \"Suburb\": \"Melbourne\",\n \"State\": \"VIC\",\n \"Postcode\": \"3000\",\n \"ContactName\": \"John Smith\",\n \"ContactPhone\": \"0000 000 000\",\n \"ContactEmail\": \"test@test.com\",\n \"PayingAccountCode\": \"TESTAPI\",\n \"SpecialInstructions\": \"Please go to blue door\",\n \"DangerousGoodsContact\": {\n \"Name\": \"John Smith\",\n \"Phone\": \"0000 000 000\"\n },\n \"Pallets\": {\n \"Chep\": {\n \"Total\": 2\n },\n \"Loscam\": {\n \"Total\": 0\n }\n },\n \"Items\": [\n {\n \"Quantity\": 2,\n \"Description\": \"pallets\",\n \"Weight\": 250,\n \"PalletSpaces\": 2,\n \"HasFoodstuffs\": false,\n \"DGs\": [\n {\n \"UNNumber\": \"3480\",\n \"PackingGroup\": null,\n \"PackageType\": null,\n \"Quantity\": 1,\n \"AggregateQuantity\": 1\n }\n ],\n \"ReceivingSuburb\": {\n \"Suburb\": \"Sydney\",\n \"State\": \"NSW\",\n \"Postcode\": \"2000\"\n }\n }\n ]\n}"},"url":"{{baseUrl}}/api/v2/bookings","description":"A pickup booking will include details of the pickup location, the items being collected and any special instructions pertaining to the pickup. See below for a description of each field and its usage.
\n","urlObject":{"path":["api","v2","bookings"],"host":["{{baseUrl}}"],"query":[],"variable":[]}},"response":[{"id":"6d606427-3936-4a12-88ab-cc9db2157a90","name":"Success","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"PickupDate\": \"2023-05-01\",\r\n \"ReadyTime\": \"13:00\",\r\n \"CloseTime\": \"16:00\",\r\n \"SenderCode\": \"TESTAPI\",\r\n \"BookingName\": \"Test Booking\",\r\n \"SenderName\": \"Test Sender\",\r\n \"AddressLine1\": \"123 Test St\",\r\n \"AddressLine2\": null,\r\n \"Suburb\": \"Melbourne\",\r\n \"State\": \"VIC\",\r\n \"Postcode\": \"3000\",\r\n \"ContactName\": \"John Smith\",\r\n \"ContactPhone\": \"0000 000 000\",\r\n \"ContactEmail\": \"test@test.com\",\r\n \"PayingAccountCode\": \"TESTAPI\",\r\n \"SpecialInstructions\": \"Please go to blue door\",\r\n \"DangerousGoodsContact\": {\r\n \"Name\": \"John Smith\",\r\n \"Phone\": \"0000 000 000\"\r\n },\r\n \"Pallets\": {\r\n \"Chep\": {\r\n \"Total\": 2\r\n },\r\n \"Loscam\": {\r\n \"Total\": 0\r\n }\r\n },\r\n \"Items\": [\r\n {\r\n \"Quantity\": 2,\r\n \"Description\": \"pallets\",\r\n \"Weight\": 250,\r\n \"PalletSpaces\": 2,\r\n \"HasFoodstuffs\": false,\r\n \"DGs\": [\r\n {\r\n \"UNNumber\": \"3480\",\r\n \"PackingGroup\": null,\r\n \"PackageType\": null,\r\n \"Quantity\": 1,\r\n \"AggregateQuantity\": 1\r\n }\r\n ],\r\n \"ReceivingSuburb\": {\r\n \"Suburb\": \"Sydney\",\r\n \"State\": \"NSW\",\r\n \"Postcode\": \"2000\"\r\n }\r\n }\r\n ]\r\n}","options":{"raw":{"language":"json"}}},"url":"{{baseUrl}}/api/v2/bookings"},"status":"Created","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"BookingNumber\": \"5600443\",\n \"PickupDate\": \"2023-05-09\",\n \"LateBooking\": true\n}\n\n"}],"_postman_id":"e53b92bc-f69b-4bf2-a304-c0868384e717"}],"id":"e10eaacf-352f-4d9a-8e9a-42fa8030408d","description":"Pickup bookings allow you to request that freight be collected by Border Express.
\n","_postman_id":"e10eaacf-352f-4d9a-8e9a-42fa8030408d"}],"event":[{"listen":"prerequest","script":{"id":"72495890-637c-4798-b906-1bc4f62e097f","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"5332f4de-21fa-48ba-ae66-97a6fcebba70","type":"text/javascript","exec":[""]}}]}