{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"info":{"_postman_id":"a92c785c-355f-4f06-98bc-1f6367204dd2","name":"FreightExchange API","description":"# **Welcome to the FreightExchange API!**\n\nOur APIs provide seamless connectivity between your systems and FreightExchange, enabling you to perform various functions. We are continuously working on expanding our API offerings, and this page will be updated regularly to keep you informed about the latest additions. We value your feedback and suggestions on the interfaces that would benefit you and any improvements we can make to enhance the usability of our APIs.\n\nStay tuned for updates, and please don't hesitate to reach out with your ideas and thoughts on how we can better serve you through our APIs. Your input is invaluable to us as we strive to provide a more efficient and user-friendly experience.\n\nThank you for choosing FreightExchange!\n\n# Getting Started\n\nTo begin using the FreightExchange API, there are a few steps you need to follow:\n\n1. **FreightExchange Account**: If you don't already have one, you'll need to [sign up for a FreightExchange account](https://portal.freightexchange.com.au/signup). This will provide you with access to the API key and allow you to subscribe to the APIs.\n    \n2. **FreightExchange API Key**: To authenticate your requests to the API, you'll require an API key. To obtain the API key, you need to reach out to our team and request it. You can create a ticket by clicking [here](https://freightexchange.freshdesk.com/support/tickets/new), and our team will generate the API key for you.\n    \n\nPlease make sure to keep your API key secure, as it serves as the authentication token for making requests to the FreightExchange API.\n\nIf you have any questions or need assistance during this process, feel free to reach out to our team. We're here to help you get started and make the most out of the FreightExchange API.\n\n# What do the FreightExchange APIs do?\n\nThe FreightExchange APIs provide seamless integration between your systems and FreightExchange, offering several key functionalities:\n\n1. **Create Quotes**: With the API, you can retrieve quotes from various carriers to compare and select the service that best fits your requirements. This allows you to make informed decisions based on pricing, transit times, and other relevant factors.\n    \n2. **Get Labels**: You can use the API to retrieve labels and other shipping documents for each shipment. This feature allows you to generate labels for your shipments, facilitating smooth logistics operations.\n    \n3. **Book Pickups**: The API allows you to book pickups for your selected shipments and carriers. You can schedule pickups individually or in batches, streamlining the process of arranging carrier pickups for your shipments.\n    \n4. **Track Shipments**: With the API, you can retrieve tracking events for all your shipments. This functionality provides real-time visibility into the movement and status of your shipments, enabling proactive monitoring and efficient supply chain management.\n    \n\n# Workflows\n\nOur systems are designed to provide the flexibility to integrate with numerous carriers in a way that suits your businesses' specific workflows. Workflows can be tailored to interface with the FreightExchange web app or to process shipments entirely via your systems.\n\nBelow are common workflows for different user scenarios.\n\n#### Scenario 1: Push Orders to FreightExchange via API and Use the FreightExchange Interface to select the carrier, book pickups and print labels\n\n<img src=\"https://content.pstmn.io/82503f8b-dac0-4096-aca9-862b5771eb1c/TGFiZWxzIGFuZCBUcmFja2luZyBudW1iZXIgKDIpLnBuZw==\">\n\n(a) Push orders to FreightExchange via [Create Quote](#39f2464e-00e7-45d0-91b6-b8bd793ab8bc):\n\n1. Integrated platform sends a request to the FreightExchange API [Create Quote](#39f2464e-00e7-45d0-91b6-b8bd793ab8bc) endpoint, including the necessary shipment details.\n    \n2. The API processes the request and creates a quote based on the provided information.\n    \n3. Upon successful creation, the API returns the quote details, including any relevant information such as carrier service, pricing, and transit time.\n    \n4. Your system receives the quote response and can further process and display the information as needed.\n    \n\n(b) Fulfill orders via the FreightExchange interface:\n\n1. Using the FreightExchange interface, you can access the created quotes and review the available carrier services.\n    \n2. Provide the necessary shipment details, such as package dimensions, weight, and any additional requirements.\n    \n3. Select the desired carrier service for each order and proceed to confirm the quote within the interface.\n    \n\n(c) Manifest and dispatch shipments using the FreightExchange interface:\n\n1. Generate shipping labels and required documentation through the FreightExchange interface.\n    \n2. Once the shipments are ready for dispatch, use the interface to manifest and schedule pickups with the selected carriers.\n    \n\n(d) Fetch tracking details via the [Get Tracking](#452064e6-8da3-4ac1-8c48-836e1734f696) endpoint:\n\n1. Use the FreightExchange API [Get Tracking](#452064e6-8da3-4ac1-8c48-836e1734f696) endpoint to retrieve tracking details for specific orders or shipments.\n    \n2. Include the relevant identifiers, such as FE tracking number and destination post code, in the API request.\n    \n3. The API will return the tracking events and updates associated with the provided identifiers.\n    \n4. Your system can process and display the tracking information to keep users informed about the status and progress of their shipments.\n    \n\n#### Scenario 2: Use the FreightExchange API to book the shipment with the cheapest carrier, then generate labels and book the pickup\n\nYou can follow the below workflow:\n\n<img src=\"https://content.pstmn.io/c4995dfe-9aff-4806-9ad4-e1c5eacbe808/SW50ZWdyYXRlZCBQbGF0Zm9ybSAoNikucG5n\">\n\n(a) Push orders into FreightExchange via [Create Quote](#39f2464e-00e7-45d0-91b6-b8bd793ab8bc) with confirmOrder = true:\n\n1. From your eCommerce, inventory, warehouse management, or other platform, send a [Create Quote](#39f2464e-00e7-45d0-91b6-b8bd793ab8bc) request to the FreightExchange API, including the necessary shipment details and setting the `confirmOrder` parameter to `true`.\n    \n2. If the [Create Quote ](#39f2464e-00e7-45d0-91b6-b8bd793ab8bc) API returns any combination of key and message in the errors array in the response then please don't call the Buy Quote API without fixing those errors.\n    \n3. The API processes the request, creates a quote, and automatically confirms the order.\n    \n4. You will receive a response from the API containing the created quote details, including the Quote ID.\n    \n\n(b) Use the Quote ID to generate the tracking number and labels via [Buy Quote](#98afbab0-c05d-493a-bb0f-87e091d9af63):\n\n1. Use the Quote ID obtained from the previous step and make a [Buy Quote](#98afbab0-c05d-493a-bb0f-87e091d9af63) request to the FreightExchange API.\n    \n2. The API processes the request and generates a tracking number and labels for the shipment associated with the specified Quote ID.\n    \n\n(c) Get the labels via the [Get Document](#ddbc53c0-e61a-4ab2-b872-7b4e4de46030) endpoint:\n\n1. Use the FreightExchange API's [Get Document](#ddbc53c0-e61a-4ab2-b872-7b4e4de46030) endpoint, providing the necessary identifiers (such as Quote ID or tracking number) to retrieve the labels.\n    \n2. The API will return the label file(s) in PDF format, which you can process and use for printing or digital distribution.\n    \n\n(d) Send the manifest to the carrier and book the pickup via [Confirm Booking](#824ed1ef-7ee1-42e0-9003-111c2c67b25a) endpoint:\n\n1. Once you have the necessary shipment details and labels, send the manifest and book the pickup with the selected carrier.\n    \n2. Use the [Confirm Booking](#824ed1ef-7ee1-42e0-9003-111c2c67b25a) endpoint in the FreightExchange API, providing the required information for the carrier and pickup request.\n    \n3. The API will process the request and confirm the booking with the carrier.\n    \n\n(e) Get the tracking details of the shipment via the Get Tracking endpoint:\n\n1. Use the [Get Tracking](#452064e6-8da3-4ac1-8c48-836e1734f696) endpoint in the FreightExchange API to fetch the tracking details for the shipment.\n    \n2. Include the relevant identifiers, such as tracking number or Quote ID, in the API request.\n    \n3. The API will return the tracking events and updates associated with the provided identifiers, allowing you to keep track of the shipment's progress.\n    \n\n<img src=\"https://content.pstmn.io/48f362ca-0f84-4702-92bc-1b8a3258a3b9/Q2hlYXBlc3QgUHJpY2UtRmxvdy5wbmc=\" alt=\"Cheapest%20Carrier%20Flow\">\n\n**NOTE**: _If the response object contains any error for the key \"errors\" as mentioned in Appendix A then the subsequent calls will not work as there is an error. Before proceeding with Buy Quote endpoint the errors needs to be fixed._\n\n_If you are using any ecommerce platform or wms system to push the orders then you need to read the errors on that system, fix them. There are 2 ways to push the updates to FE:__a. Delete the previous quote via_ [<i>Delete quote</i>](#dc2ea8ed-d406-403d-af93-7019bdd01de7) _and send the_ [<i>Create quote</i>](#39f2464e-00e7-45d0-91b6-b8bd793ab8bc) _request again, or_  \nb. Call the [<i>Update quote</i>](#02829425-4211-4ffb-9651-23907b09a3a8) _API with the updated payload. Update quote will either return the same id or will generate a new id based on the values which are updated._\n\n#### Scenario 3: Use the FreightExchange API to book the shipment, create labels and book the pickup with a specific carrier and/or carrier service\n\nThe workflow to book a shipment with a specific carrier and service is illustrated below.\n\n<img src=\"https://content.pstmn.io/71807626-244e-4616-8fb5-49bbefdd1cc6/SW50ZWdyYXRlZCBQbGF0Zm9ybSAoNikucG5n\">\n\n(a) Push orders into FreightExchange via [Create Quote](#39f2464e-00e7-45d0-91b6-b8bd793ab8bc) with confirmOrder = true:\n\n1. From your eCommerce, inventory, warehouse management, or other platform, send a [Create Quote](#39f2464e-00e7-45d0-91b6-b8bd793ab8bc) request to the FreightExchange API, including the necessary shipment details and setting the `confirmOrder` parameter to `true`, and entering the required list of carriers and/or services in the `selectionCriteria` . If the carrier or service cannot accept the shipment the `selectionCriteria` will allocate to the next carrier or service specified in the `selectionCriteria`. If none of the carrier/service from selectionCriteria accept the shipment then it will fallback to the cheapest carrier.\n    \n2. The API processes the request, creates a quote, and automatically confirms the order.\n    \n3. You will receive a response from the API containing the created quote details, including the Quote ID.\n    \n\n(b) Use the Quote ID to generate the tracking number and labels via [Buy Quote](#98afbab0-c05d-493a-bb0f-87e091d9af63):\n\n1. Use the Quote ID obtained from the previous step and make a [Buy Quote](#98afbab0-c05d-493a-bb0f-87e091d9af63) request to the FreightExchange API.\n    \n2. The API processes the request and generates a tracking number and labels for the shipment associated with the specified Quote ID.\n    \n\n(c) Get the labels via the [Get Document](#ddbc53c0-e61a-4ab2-b872-7b4e4de46030) endpoint:\n\n1. Use the FreightExchange API's [Get Document](#ddbc53c0-e61a-4ab2-b872-7b4e4de46030) endpoint, providing the necessary identifiers (such as Quote ID, tracking number or Item ID) to retrieve the labels.\n    \n2. The API will return the label file(s) in PDF format, which you can process and use for printing or digital distribution.\n    \n\n(d) Send the manifest to the carrier and book the pickup via [Confirm Booking](#824ed1ef-7ee1-42e0-9003-111c2c67b25a) endpoint:\n\n1. Once you have the necessary shipment details and labels, send the manifest and book the pickup with the selected carrier.\n    \n2. Use the [Confirm Booking](#824ed1ef-7ee1-42e0-9003-111c2c67b25a) endpoint in the FreightExchange API, providing the required information for the carrier and pickup request.\n    \n3. The API will process the request and confirm the booking with the carrier.\n    \n\n(e) Get the tracking details of the shipment via the Get Tracking endpoint:\n\n1. Use the [Get Tracking](#452064e6-8da3-4ac1-8c48-836e1734f696) endpoint in the FreightExchange API to fetch the tracking details for the shipment.\n    \n2. Include the relevant identifiers, such as tracking number or Quote ID, in the API request.\n    \n3. The API will return the tracking events and updates associated with the provided identifiers, allowing you to keep track of the shipment's progress.\n    \n\n<img src=\"https://content.pstmn.io/223ff551-9e04-4882-96c4-93a2ba7b4d42/U2VsZWN0ZWQgQ2FycmllciBGbG93LnBuZw==\" alt=\"Selected%20Carrier%20Flow\">\n\n**NOTE**: _If the response object contains any error for the key \"errors\" as mentioned in Appendix A then the subsequent calls will not work as there is an error. Before proceeding with Buy Quote endpoint the errors needs to be fixed._\n\n_If you are using any ecommerce platform or wms system to push the orders then you need to read the errors on that system, fix them. There are 2 ways to push the updates to FE:__a. Delete the previous quote via_ [<i>Delete quote</i>](#dc2ea8ed-d406-403d-af93-7019bdd01de7) _and send the_ [<i>Create quote</i>](#39f2464e-00e7-45d0-91b6-b8bd793ab8bc) _request again, or__b. Call the_ [<i>Update quote</i>](#02829425-4211-4ffb-9651-23907b09a3a8) _API with the updated payload. Update quote will either return the same id or will generate a new id based on the values which are updated._\n\n#### Scenario 4: Use the FreightExchange API to get all available quotes and then book the shipment, create labels and book the pickup with the carrier/service of your choice\n\n<img src=\"https://content.pstmn.io/54b91714-c33e-4c47-b80a-f17bdce4907e/SW50ZWdyYXRlZCBQbGF0Zm9ybSAoNykucG5n\">\n\n(a) Push orders into FreightExchange via [Create Quote](#39f2464e-00e7-45d0-91b6-b8bd793ab8bc) with confirmOrder = false:\n\n1. From your eCommerce, inventory, warehouse management, or other platform, send a [Create Quote](#39f2464e-00e7-45d0-91b6-b8bd793ab8bc) request to the FreightExchange API, including the necessary shipment details and setting the `confirmOrder` parameter to `false`.\n    \n2. The API processes the request and creates a quote without confirming the order.\n    \n3. You will receive a response from the API containing the created quote details, including the Quote ID and price options.\n    \n\n(b) Confirm the quote with the price ID from the response of Step (a):\n\n1. Review the price options available in the API response from Step (a) and select the desired price for the preferred carrier.\n    \n2. Use the FreightExchange API's [Confirm Quote with desired rate](#5aedad9c-9420-433f-b055-8e56dc733471) endpoint, including the Quote ID and the selected price ID from the quote response, to confirm the quote and proceed with the booking.\n    \n\n(c) Use the Quote ID to generate the tracking number and labels via [Buy Quote](#98afbab0-c05d-493a-bb0f-87e091d9af63):\n\n1. Use the Quote ID obtained from the previous step and make a [Buy Quote](#98afbab0-c05d-493a-bb0f-87e091d9af63) request to the FreightExchange API.\n    \n2. The API processes the request and generates a tracking number and labels for the shipment associated with the specified Quote ID.\n    \n\n(d) Get the labels via the [Get Document](#ddbc53c0-e61a-4ab2-b872-7b4e4de46030) endpoint:\n\n1. Use the FreightExchange API's [Get Document](#ddbc53c0-e61a-4ab2-b872-7b4e4de46030) endpoint, providing the necessary identifiers (such as Quote ID or tracking number) to retrieve the labels.\n    \n2. The API will return the label file(s) in PDF format, which you can process and use for printing or digital distribution.\n    \n\n(e) Send the manifest to the carrier and book the pickup via [Confirm Booking](#824ed1ef-7ee1-42e0-9003-111c2c67b25a) endpoint:\n\n1. Once you have the necessary shipment details and labels, send the manifest and book the pickup with the selected carrier.\n    \n2. Use the [Confirm Booking](#824ed1ef-7ee1-42e0-9003-111c2c67b25a) endpoint in the FreightExchange API, providing the required information for the carrier and pickup request.\n    \n3. The API will process the request and confirm the booking with the carrier.\n    \n\n(f) Get the tracking details of the shipment via the Get Tracking endpoint:\n\n1. Use the [Get Tracking](#452064e6-8da3-4ac1-8c48-836e1734f696) endpoint in the FreightExchange API to fetch the tracking details for the shipment.\n    \n2. Include the relevant identifiers, such as tracking number or Quote ID, in the API request.\n    \n3. The API will return the tracking events and updates associated with the provided identifiers, allowing you to keep track of the shipment's progress.\n    \n\n<img src=\"https://content.pstmn.io/293b9bc7-729e-46ad-ad66-1d8214b9d715/U2VsZWN0ZSBhIHByaWNlLnBuZw==\" alt=\"Select%20the%20preferred%20price\">\n\n#### Scenario 5: Use the FreightExchange API to get all available quotes and then consolidate the shipments, create incremental labels and book the pickup with the carrier/service of your choice\n\n<img src=\"https://lh7-us.googleusercontent.com/docsz/AD_4nXf6BSQvoRTnM9yLd5QY7Qip3WjZeK97zws1K8DHtYAStcaJRLQ4KTgqQ3p2xn_L0D7JZWKsVLaRrTRbGN1EGNwciWqcQkyokgIot3ZQLtQS7-_0Lrlb-vRuwZhd5_eLIonXreYixDiGHxIJrV2QoHHjZmI5?key=TB3Icp0kYEB9axbN-uTdHw\">\n\n(a) Push orders into FreightExchange via [Create Quote](https://apidocs.freightexchange.com.au/#39f2464e-00e7-45d0-91b6-b8bd793ab8bc) with confirmOrder = true and customFields.labelDeliveryWebhook = :\n\n1. From your eCommerce, inventory, warehouse management, or other platform, send a [Create Quote](https://apidocs.freightexchange.com.au/#39f2464e-00e7-45d0-91b6-b8bd793ab8bc) request to the FreightExchange API, including the necessary shipment details and setting the confirmOrder parameter to true.\n    \n2. If the [Create Quote ](https://apidocs.freightexchange.com.au/#39f2464e-00e7-45d0-91b6-b8bd793ab8bc) API returns any combination of key and message in the errors array in the response then please don't call the Buy Quote API without fixing those errors.\n    \n3. You will receive a response from the API containing the created quote details, including the FE Tracking Number and the Quote ID .\n    \n\n(b) Use the FE Tracking Number to generate the tracking number and labels via [Buy Quote](https://apidocs.freightexchange.com.au/#98afbab0-c05d-493a-bb0f-87e091d9af63):\n\n1. Use the FE Tracking Number obtained from the previous step and make a [Buy Quote](https://apidocs.freightexchange.com.au/#98afbab0-c05d-493a-bb0f-87e091d9af63) request to the FreightExchange API.\n    \n2. The API processes the request and generates a tracking number and labels for the shipment associated with the specified FE Tracking Number.\n    \n\n(c) Get the labels via on the webhook:\n\n1. Once the labels are generated in Step(b), if the Create Quote request in Step(a) contains the customFields.labelDeliveryWebhook, then the label payload will be sent to the webhook.\n    \n\n(d) Send the manifest to the carrier and book the pickup via [Confirm Booking](https://apidocs.freightexchange.com.au/#824ed1ef-7ee1-42e0-9003-111c2c67b25a) endpoint:\n\n1. Once you have the necessary shipment details and labels, send the manifest and book the pickup with the selected carrier.\n    \n2. Use the FreightExchange UI to send the shipments to the carrier.\n    \n\n(e) Get the tracking details of the shipment via webhook:\n\n1. Whenever an event will be received for a shipment from the carrier, if the tracking webhook URL is set, then the tracking events payload will be pushed to the webhook configured.\n    \n\n#### Scenario 6: Use the FreightExchange API to get all available quotes available for Delivery on/by a specific date\n\n<img src=\"https://content.pstmn.io/d5bd52d1-8d99-4bf0-b726-f45b1c013da1/SW50ZWdyYXRlZCBQbGF0Zm9ybSAoMTQpLnBuZw==\">\n\n(a) Push orders into FreightExchange via [Create Quote](https://apidocs.freightexchange.com.au/#39f2464e-00e7-45d0-91b6-b8bd793ab8bc) with confirmOrder = true, delvery_date and delivery_type. Our APIs supports two options for delivery_type, i.e. DELIVER_BY and DELIVER_ON.\n\n1. From your eCommerce, inventory, warehouse management, or other platform, send a [Create Quote](https://apidocs.freightexchange.com.au/#39f2464e-00e7-45d0-91b6-b8bd793ab8bc) request to the FreightExchange API, including the necessary shipment details and setting the confirmOrder parameter to true.\n    \n2. If you want the delivery to be done on a specific date or by a specific date then set the delivery_type and delivery_date parameters in the Create Quote request. If these fields are set then we will response will only contain the carriers which supports delivery date.\n    \n3. If the [Create Quote ](https://apidocs.freightexchange.com.au/#39f2464e-00e7-45d0-91b6-b8bd793ab8bc) API returns any combination of key and message in the errors array in the response then please don't call the Buy Quote API without fixing those errors.\n    \n4. You will receive a response from the API containing the created quote details, including the FE Tracking Number and the Quote ID .\n    \n\n(b) Use the FE Tracking Number to generate the tracking number and labels via [Buy Quote](https://apidocs.freightexchange.com.au/#98afbab0-c05d-493a-bb0f-87e091d9af63):\n\n1. Use the FE Tracking Number obtained from the previous step and make a [Buy Quote](https://apidocs.freightexchange.com.au/#98afbab0-c05d-493a-bb0f-87e091d9af63) request to the FreightExchange API.\n    \n2. The API processes the request and generates a tracking number and labels for the shipment associated with the specified FE Tracking Number.\n    \n\n(c) Get the labels via on the webhook:\n\n1. Once the labels are generated in Step(b), if the Create Quote request in Step(a) contains the customFields.labelDeliveryWebhook, then the label payload will be sent to the webhook.\n    \n\n(d) Manifest will be sent to the carrier closer to the delivery date\n\n1. Once the shipment is on Book page, you don't have to dispatch it. Automated job in backend will create the manifest closer to the delivery date and will send it to the carrier as per the timeframe of the carrier.\n    \n\n(e) Get the tracking details of the shipment via webhook:\n\n1. Whenever an event will be received for a shipment from the carrier, if the tracking webhook URL is set, then the tracking events payload will be pushed to the webhook configured.\n    \n\n**NOTE**: _If the response object contains any error for the key \"errors\" as mentioned in Appendix A then the subsequent calls will not work as there is an error. Before proceeding with Buy Quote endpoint the errors needs to be fixed._\n\n_If you are using any ecommerce platform or wms system to push the orders then you need to read the errors on that system, fix them. There are 2 ways to push the updates to FE:__a. Delete the previous quote via_ [<i>Delete quote</i>](#dc2ea8ed-d406-403d-af93-7019bdd01de7) _and send the_ [<i>Create quote</i>](#39f2464e-00e7-45d0-91b6-b8bd793ab8bc) _request again, or__b. Call the_ [<i>Update quote</i>](#02829425-4211-4ffb-9651-23907b09a3a8) _API with the updated payload. Update quote will either return the same id or will generate a new id based on the values which are updated._\n\n# API Reference\n\n## **URLs**\n\n**Staging Enviornment:** [https://apidemo.freightexchange.com.au/](https://apidemo.freightexchange.com.au/)  \n**Production Enviornment:** [https://api.freightexchange.com.au/](https://api.freightexchange.com.au/)\n\n## Authentication\n\nWe will issue you with a token which identifies your organisation.\n\nPlease ensure that you replace `{{securityToken}}` with the actual security token issued to your organization. This token serves as a unique identifier for your organization and must be included in the header of each API request to authenticate your calls.\n\nIt's important to note that separate tokens will be provided for the development and live environments. You can request the respective API tokens from our team. By utilizing the appropriate token based on the environment, you can ensure the correct authentication for your API requests.","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":false,"owner":"16313073","team":425335,"collectionId":"a92c785c-355f-4f06-98bc-1f6367204dd2","publishedId":"2s93JqRjif","public":true,"publicUrl":"https://apidocs.freightexchange.com.au","privateUrl":"https://go.postman.co/documentation/16313073-a92c785c-355f-4f06-98bc-1f6367204dd2","customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"},"documentationLayout":"classic-double-column","customisation":{"metaTags":[{"name":"description","value":"This document contains all the APIs required to integrate with FreightExchange platform."},{"name":"title","value":""}],"appearance":{"default":"light","themes":[{"name":"dark","logo":null,"colors":{"top-bar":"212121","right-sidebar":"303030","highlight":"FF6C37"}},{"name":"light","logo":null,"colors":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"}}]}},"version":"8.10.1","publishDate":"2024-07-24T11:25:03.000Z","activeVersionTag":"latest","documentationTheme":"light","metaTags":{"title":"","description":"This document contains all the APIs required to integrate with FreightExchange platform."},"logos":{"logoLight":null,"logoDark":null}},"statusCode":200},"environments":[{"name":"Live","id":"2fe5d47a-9a1b-44ea-98bd-89fdb351b09c","owner":"16313073","values":[{"key":"URL","value":"https://api.freightexchange.com.au","enabled":true,"type":"default"},{"key":"apiKey","value":"xxxxxxxxxxxxxxxxxxxx","enabled":true,"type":"default"},{"key":"docURL","value":"https://api.freightexchange.com.au/portal/api/documents","enabled":true,"type":"default"}],"published":true}],"user":{"authenticated":false,"permissions":{"publish":false}},"run":{"button":{"js":"https://run.pstmn.io/button.js","css":"https://run.pstmn.io/button.css"}},"web":"https://www.getpostman.com/","team":{"logo":"https://res.cloudinary.com/postman/image/upload/t_team_logo_pubdoc/v1/team/77ba00e55ec8206555387a8fc112e59e76552660bf986a043e0d19f4565dc30b","favicon":"https://freightexchange.com.au/favicon.ico"},"isEnvFetchError":false,"languages":"[{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"HttpClient\"},{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"RestSharp\"},{\"key\":\"curl\",\"label\":\"cURL\",\"variant\":\"cURL\"},{\"key\":\"dart\",\"label\":\"Dart\",\"variant\":\"http\"},{\"key\":\"go\",\"label\":\"Go\",\"variant\":\"Native\"},{\"key\":\"http\",\"label\":\"HTTP\",\"variant\":\"HTTP\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"OkHttp\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"Unirest\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"Fetch\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"jQuery\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"XHR\"},{\"key\":\"c\",\"label\":\"C\",\"variant\":\"libcurl\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Axios\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Native\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Request\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Unirest\"},{\"key\":\"objective-c\",\"label\":\"Objective-C\",\"variant\":\"NSURLSession\"},{\"key\":\"ocaml\",\"label\":\"OCaml\",\"variant\":\"Cohttp\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"cURL\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"Guzzle\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"HTTP_Request2\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"pecl_http\"},{\"key\":\"powershell\",\"label\":\"PowerShell\",\"variant\":\"RestMethod\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"http.client\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"Requests\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"httr\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"RCurl\"},{\"key\":\"ruby\",\"label\":\"Ruby\",\"variant\":\"Net::HTTP\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"Httpie\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"wget\"},{\"key\":\"swift\",\"label\":\"Swift\",\"variant\":\"URLSession\"}]","languageSettings":[{"key":"csharp","label":"C#","variant":"HttpClient"},{"key":"csharp","label":"C#","variant":"RestSharp"},{"key":"curl","label":"cURL","variant":"cURL"},{"key":"dart","label":"Dart","variant":"http"},{"key":"go","label":"Go","variant":"Native"},{"key":"http","label":"HTTP","variant":"HTTP"},{"key":"java","label":"Java","variant":"OkHttp"},{"key":"java","label":"Java","variant":"Unirest"},{"key":"javascript","label":"JavaScript","variant":"Fetch"},{"key":"javascript","label":"JavaScript","variant":"jQuery"},{"key":"javascript","label":"JavaScript","variant":"XHR"},{"key":"c","label":"C","variant":"libcurl"},{"key":"nodejs","label":"NodeJs","variant":"Axios"},{"key":"nodejs","label":"NodeJs","variant":"Native"},{"key":"nodejs","label":"NodeJs","variant":"Request"},{"key":"nodejs","label":"NodeJs","variant":"Unirest"},{"key":"objective-c","label":"Objective-C","variant":"NSURLSession"},{"key":"ocaml","label":"OCaml","variant":"Cohttp"},{"key":"php","label":"PHP","variant":"cURL"},{"key":"php","label":"PHP","variant":"Guzzle"},{"key":"php","label":"PHP","variant":"HTTP_Request2"},{"key":"php","label":"PHP","variant":"pecl_http"},{"key":"powershell","label":"PowerShell","variant":"RestMethod"},{"key":"python","label":"Python","variant":"http.client"},{"key":"python","label":"Python","variant":"Requests"},{"key":"r","label":"R","variant":"httr"},{"key":"r","label":"R","variant":"RCurl"},{"key":"ruby","label":"Ruby","variant":"Net::HTTP"},{"key":"shell","label":"Shell","variant":"Httpie"},{"key":"shell","label":"Shell","variant":"wget"},{"key":"swift","label":"Swift","variant":"URLSession"}],"languageOptions":[{"label":"C# - HttpClient","value":"csharp - HttpClient - C#"},{"label":"C# - RestSharp","value":"csharp - RestSharp - C#"},{"label":"cURL - cURL","value":"curl - cURL - cURL"},{"label":"Dart - http","value":"dart - http - Dart"},{"label":"Go - Native","value":"go - Native - Go"},{"label":"HTTP - HTTP","value":"http - HTTP - HTTP"},{"label":"Java - OkHttp","value":"java - OkHttp - Java"},{"label":"Java - Unirest","value":"java - Unirest - Java"},{"label":"JavaScript - Fetch","value":"javascript - Fetch - JavaScript"},{"label":"JavaScript - jQuery","value":"javascript - jQuery - JavaScript"},{"label":"JavaScript - XHR","value":"javascript - XHR - JavaScript"},{"label":"C - libcurl","value":"c - libcurl - C"},{"label":"NodeJs - Axios","value":"nodejs - Axios - NodeJs"},{"label":"NodeJs - Native","value":"nodejs - Native - NodeJs"},{"label":"NodeJs - Request","value":"nodejs - Request - NodeJs"},{"label":"NodeJs - Unirest","value":"nodejs - Unirest - NodeJs"},{"label":"Objective-C - NSURLSession","value":"objective-c - NSURLSession - Objective-C"},{"label":"OCaml - Cohttp","value":"ocaml - Cohttp - OCaml"},{"label":"PHP - cURL","value":"php - cURL - PHP"},{"label":"PHP - Guzzle","value":"php - Guzzle - PHP"},{"label":"PHP - HTTP_Request2","value":"php - HTTP_Request2 - PHP"},{"label":"PHP - pecl_http","value":"php - pecl_http - PHP"},{"label":"PowerShell - RestMethod","value":"powershell - RestMethod - PowerShell"},{"label":"Python - http.client","value":"python - http.client - Python"},{"label":"Python - Requests","value":"python - Requests - Python"},{"label":"R - httr","value":"r - httr - R"},{"label":"R - RCurl","value":"r - RCurl - R"},{"label":"Ruby - Net::HTTP","value":"ruby - Net::HTTP - Ruby"},{"label":"Shell - Httpie","value":"shell - Httpie - Shell"},{"label":"Shell - wget","value":"shell - wget - Shell"},{"label":"Swift - URLSession","value":"swift - URLSession - Swift"}],"layoutOptions":[{"value":"classic-single-column","label":"Single Column"},{"value":"classic-double-column","label":"Double Column"}],"versionOptions":[],"environmentOptions":[{"value":"0","label":"No Environment"},{"label":"Live","value":"16313073-2fe5d47a-9a1b-44ea-98bd-89fdb351b09c"}],"canonicalUrl":"https://apidocs.freightexchange.com.au/view/metadata/2s93JqRjif"}