{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"info":{"_postman_id":"dbc855b9-58b7-4b36-b741-0bcc2ad6e6d5","name":"Cargofive Public API","description":"## INTRODUCTION.\n\nThis **article** will hopefully help you understand our **Cargofive Public API** and how to interact with its various components.\n\n---\n\nLet's begin with some main concepts.\n\nWhen you search for different rates provided by several carriers that Cargofive is connected to, you are going to interact with two general components: the **Rates** and the **Offers.**\n\nThe main difference between rates and offers is foundational to the freight forwarding process.\n\nRates are the _buying rates_ or the costs that you, as a freight forwarder, will pay to providers.\n\nOffers, on the other hand, are the _selling rates_ based on those costs. These are the rates you will charge your customers. Offers take into account the buying rates and add a margin or profit.\n\nGenerally speaking, this is a two-step process:\n\n### **First step: searching rates**\n\nThe **Rate** is the first step of the CargoFive Process.\n\nWhen you need to know how many options we have available for one route, you are going to send a `GET` request to /**rates** and we will return _n_ rates. Each rate is an option for that search.\n\nAll these rate options will be grouped into a single Offer.\n\nEach rate will have information about the route, the costs, the carrier, dates, terms&conditions and penalty fees.\n\nThe params required in your request are the following:\n\n- `origin` and `destination` ([Get Ports And Locations](https://go.postman.co/workspace/Proj-Fenix~b4094e8d-35f7-4b24-b658-a8108392f154/documentation/33120643-dbc855b9-58b7-4b36-b741-0bcc2ad6e6d5?entity=request-0680ce0e-c6e9-4cd9-b529-169476c8b967))\n    \n- the `type` of search ( LCL or FCL)\n    \n- Validity `date` of the rate.\n    \n- Other values depend on what `type` of search you are going to perform (Container info for FCL and packages options for LCL)\n    \n- And optional values such as [client information](https://cargofive.postman.co/workspace/Proj-Fenix~b4094e8d-35f7-4b24-b658-a8108392f154/folder/33120643-b8668b09-a098-4d2f-98fe-a5d97ed73eba?action=share&source=copy-link&creator=33120643&ctx=documentation), [price level,](https://cargofive.postman.co/workspace/b4094e8d-35f7-4b24-b658-a8108392f154/request/33120643-e4dcbe58-89e2-4cac-ac66-fb585f1c6c6a?ctx=documentation) commodity, kind of cargo, incoterm or internal ids.\n    \n\nWith the returned rates you are going to select the ones that satisfy your clients' needs and send them to us (using their `rate_uuid`) via a **`POST`** request to **/offers**, converting those rates to a single proposal to your client.\n\n---\n\n### **Second step: generating offers**\n\nAn Offer is the second part of the process.\n\nAs it was mentioned above, one offer could contain _n_ rates.\n\nThe offer is the proposal that you are going to send to your client.\n\nYou can add, group or edit charges and sales values, add remarks or surcharges included, add profit groups, inland, change currency convertion and add internal reference codes.\n\n---\n\nTo simplify the process, the JSON response structure of both the offer and the rate are the same.\n\n_To better understand the process, we suggest you perform a_ `GET` _to_ _**/rates**_ _requesting an FCL rate._","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":false,"owner":"33120643","team":1430713,"collectionId":"dbc855b9-58b7-4b36-b741-0bcc2ad6e6d5","publishedId":"2sA3JGeiqz","public":true,"publicUrl":"https://developers.cargofive.com","privateUrl":"https://go.postman.co/documentation/33120643-dbc855b9-58b7-4b36-b741-0bcc2ad6e6d5","customColor":{"top-bar":"060A2E","right-sidebar":"303030","highlight":"031B4E"},"documentationLayout":"classic-double-column","customisation":{"metaTags":[{"name":"description","value":""},{"name":"title","value":"CargoFive Dev Site"}],"appearance":{"default":"light","themes":[{"name":"dark","logo":"https://content.pstmn.io/cfdd6598-b51f-4eea-b404-bded2e89f315/Q2FyZ29maXZlIExvZ28ucG5n","colors":{"top-bar":"060A2E","right-sidebar":"303030","highlight":"031B4E"}},{"name":"light","logo":"https://content.pstmn.io/cfdd6598-b51f-4eea-b404-bded2e89f315/Q2FyZ29maXZlIExvZ28ucG5n","colors":{"top-bar":"060A2E","right-sidebar":"303030","highlight":"031B4E"}}]}},"version":"8.10.0","publishDate":"2024-06-24T20:42:17.000Z","activeVersionTag":"latest","documentationTheme":"light","metaTags":{"title":"CargoFive Dev Site","description":""},"logos":{"logoLight":"https://content.pstmn.io/cfdd6598-b51f-4eea-b404-bded2e89f315/Q2FyZ29maXZlIExvZ28ucG5n","logoDark":"https://content.pstmn.io/cfdd6598-b51f-4eea-b404-bded2e89f315/Q2FyZ29maXZlIExvZ28ucG5n"}},"statusCode":200},"environments":[],"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/1ec0af3bff03760a162b4e74a8956001f233ad5729f1dd1e3ad06778f482b2eb","favicon":"https://cargofive.com/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"}],"canonicalUrl":"https://developers.cargofive.com/view/metadata/2sA3JGeiqz"}