{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"info":{"_postman_id":"eba01557-0d30-4cb4-a289-de9a872ef9f1","name":"Drivin API Documentation","description":"![](https://s3.amazonaws.com/envprod001/API+DEVELOPER++DOCUMENTATION.png)\n\nWelcome to Drivin's API documentation.  \nHere, you'll find everything you need to know in order to integrate Drivin with your systems.\n\nBefore you start, it's important to know that the services you'll find available in this documentation will allow you to create, search, modify and delete information through a RESTful API.\n\nNow that you know our protocol, we advise you to review the documentation so you can then define the integration flow between Drivin and your systems (what information will be necessary).\n\nAny questions you might have regarding our services, or you can't find the correct APIs, please contact us at [support@driv.in](mailto:soporte@driv.in).\n\n# Drivin Main Definitions:\n\n**\\- Organization:**  \nBasically, your account. Here you'll be able to operate Drivin (Each organization has its own api_key).\n\n**\\- Crew:**  \nDrivins' crew corresponds to \"Driver\" or \"Assistant\" user type. These users will be able to make use of the mobile application to manage the route in real-time.\n\n**\\- Warehouse:**  \nA warehouse is a Distribution Center or a physical place from where routes start and/or end. You can set one or several warehouses up.\n\n**\\- Schema:** A schema is where all the constraints and parameters that are evaluated when planning routes are defined.\n\nIn Drivin, we can support several types of operations within the same warehouse.\n\n**\\- Order:**  \nAn order corresponds to a visit to a specific address. It can be a delivery, pickup, service, etc.\n\n**\\- Scenario (Plan):**  \nUsed to create routes based off an operation date, a scheme, vehicles and orders.\n\n**\\- Route:**  \nA route is made up of one or more trips that, in turn, has visits, a vehicle, and crew associated to it.\n\n**\\- Trip:**  \nA trip is made up of one or more orders.\n\n# Types of Planning:\n\n**1\\. Normal planning:**  \nNormal optimization aims to minimize the fleet and km traveled to be used in a scenario in order to manage all the orders.\n\n**2\\. Planning with allocation:**  \nIn optimization with allocation, you, as the client, tell us in which vehicle each order goes, so Drivin can optimize the delivery sequence of each vehicle in order to comply with the existing time windows and travel the least amount of kilometers.\n\n**3\\. Balanced planning:**  \nBalanced optimization allows you to evenly distribute the workload. The scenario will be optimized by assigning the same amount of addresses per vehicle.\n\n**4\\. Entire fleet planning:**  \nWhole fleet optimization will consider all vehicles and won't necessarily distribute the number of addresses per vehicle evenly.\n\n# Settings and Initial Tests:\n\nOnce you've reviewed the documentation and would like to perform the initial tests, please contact us at [support@driv.in](mailto:soporte@driv.in) to create your organization in a *test environment*. You'll also receive your `api_key`, which will allow your authentication in Drivin.\n\nOnce you have your api_key, please set up the following Headers:\n\n**1\\. X-API-KEY**\n\n**2\\. Content-Type: application/json**\n\n*(*You'll receive a *`HTTP 200 OK`** to confirm Headers are properly set up)*\n\n*The set up url corresponds to the production env url. The QA env URL is:* [*https://app2-qa.driv.in/*](https://app2-qa.driv.in/Questions,)\n\n# Questions, comments or suggestions:\n\nIf you have any questions, comments or suggestions, feel free to email us at [support@driv.in](mailto:soporte@driv.in).","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":false,"owner":"3830854","team":112137,"collectionId":"eba01557-0d30-4cb4-a289-de9a872ef9f1","publishedId":"UzkTXwfG","public":true,"publicUrl":"https://apidocs-en.driv.in","privateUrl":"https://go.postman.co/documentation/3830854-eba01557-0d30-4cb4-a289-de9a872ef9f1","customColor":{"top-bar":"101828","right-sidebar":"101828","highlight":"EF5B25"},"documentationLayout":"classic-double-column","customisation":null,"version":"8.10.1","publishDate":"2022-08-02T19:54:48.000Z","activeVersionTag":"latest","documentationTheme":"light","metaTags":{},"logos":{}},"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/238a62363bf994d20c966a0356c65e22d0838a9de08014fa239a906ed27b7ade","favicon":"https://res.cloudinary.com/postman/image/upload/v1660797293/team/wfjckxbqneyyqdfrpzls.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://apidocs-en.driv.in/view/metadata/UzkTXwfG"}