{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"info":{"_postman_id":"232a72cc-72a1-4209-aa77-b481fb377e4f","name":"Load Posting","description":"API to put loads onto the 5F tours platform.\n\n## Getting Started\n\nAccess the 5F Tour Broker Portal to generate an api key to begin using the api.\n\nYou can use the token by setting an Authorization header with the value \"Token {yourToken}\"  \n`Authorization: Token abc123`\n\n## Webhooks\n\nTo help with keep data recent as possible there's two configurable webhooks.\n\n*   **Load Booked Event** - When a load is booked in our system an event is triggered\n*   **Load Availability Check** - Endpoint for the 5F platform to check if a load is still available. This make it so we can better focus on offering loads that need to be covered\n    \n\nThese can be configured in the 5F Tours Broker Portal\n\n## Environments\n\nThey API is exposed in two environments, staging and production.\n\nStaging URL example: `https://stage.api.lohi.ai/v1/external/loads`\n\nProduction URL example: `https://api.lohi.ai/v1/external/loads`\n\n## Sample error message\n\nAll error messages are in the following format.\n\n``` json\n{\n    \"error\": {\n        \"code\": \"lapi-007\",\n        \"message\": \"Load ID not formatted correctly\"\n    }\n}\n\n```\n\n## Load Object Fields\n\n*   `id`\n    *   Identifier in 5F system\n*   `externalIdentifier`\n    *   Optional\n    *   Identifier in source system\n*   `status`\n    *   Status of the load in the system\n        *   `listed` - default status of a load ready to be assigned\n        *   `needs_rate_con` - driver is interested in the load but is waiting on rate con\n        *   `booked` - driver has accepted the load and has a rate con for it\n*   `breakevenRateCents`\n    *   How much the load is being charged to the shipper for\n*   `targetMarginRate`\n    *   The percentage in decimal form of how much of breakeven is made\n*   `shipper`\n    *   Name of shipper\n*   `shippingComments`\n    *   Comments from the shipper about the load\n*   `shipperExternalIdentifier`\n    *   Optional - The identifier of the shipper in the source system can be used for grouping and filtering\n*   `shipperType`\n    *   Type of shipper\n    *   Valid Values\n        *   `spot`\n        *   `dedicated`\n*   `cargoValueCents`\n    *   The value of the cargo used to help find drivers with required coverage\n*   `weightPounds`\n    *   Weight of cargo in pounds\n*   `tempFahrenheit`\n    *   Optional\n    *   Temperature requirement if applicable\n*   `brokerStatusUpdateEmails`\n    *   Array of emails that load updates should be sent to\n*   `brokerBillingEmails`\n    *   Array of emails that should receive load updates related to billing\n*   `brokerDetentionNotificationMinutes`\n    *   At how many minutes should a notification be sent for detention to `brokerStatusUpdateEmails`\n*   `createdAt`\n    *   When the load was created in the 5F system\n*   `updatedAt`\n    *   When the load was lasted updated in the 5F system\n*   `listingInvalidAt`\n    *   Loads will automatically stop being considered when this time passes\n*   `equipment.type`\n    *   Type of equipment that can be used for the load\n    *   Currently accepted values\n        *   `dry_van`\n        *   `flatbed`\n        *   `reefer`\n*   `stops.stopType`\n    *   `pickup`\n    *   `dropoff`\n*   `stops.sequence`\n    *   Order of stops, starts at 1\n*   `stops.coordinates`\n*   `stops.address`\n*   `stops.arrivalWindowType`\n*   `stops.arrivalWindowStartsAt`\n    *   Beginning of the window that the driver can arrive at\n*   `stops.arrivalWindowEndsAt`\n    *   End of the window that the driver can arrive at the facility at\n*   `stops.details`\n    *   Additional details needed to complete the load\n*   `stops.commodity`\n    *   What is being picked up or dropped off at the stop\n*   `stops.quantity`\n    *   How much is being picked up or dropped off\n*   `stops.unit`\n    *   Accepted values\n        *   `kg` - kilograms\n        *   `lbs` - pounds\n        *   `tons` - tons\n        *   `boxes` - boxes\n        *   `gal` - gallons\n        *   `l` - liters\n        *   `bbls` - barrels\n        *   `ea` - each\n        *   `MSCF` - MSCF\n        *   `pl` - pallets\n        *   `pc` - pieces\n*   `stops.referenceNumber`\n*   `stops.appointmentTrackingNumber`\n*   `stops.facilityName`\n    *   Name of facility shown to driver\n*   `stops.facilityContact`\n    *   Contract information for the facility\n*   `stops.detentionHourlyRateCents`\n    *   Rate of detention per hour in cents\n*   `stops.detentionFreeMinutes`\n    *   How many minutes of detention are free before detention is paid out\n*   `stops.arrivalWindowType`\n    *   Rules for the arrival window of the facility\n    *   Accepted values\n        *   `fixed`\n        *   `first_come_first_serve`\n*   `restrictions`\n    *   Special restrictions that made limit what drivers can do the load\n    *   Accepted Values\n        *   `hazmat`\n        *   `twic_card_required`\n*   `driverAgreedRateCents`\n    *   How much the carrier has agreed to do the load for\n*   `carrier`\n    *   Carrier that has agreed to do the load\n*   `carrier.name`\n    *   Name of carrier that has agreed to to the load\n*   `carrier.mcNumber`\n    *   MC Number of carrier that has agreed to do the load","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":false,"owner":"12723268","collectionId":"232a72cc-72a1-4209-aa77-b481fb377e4f","publishedId":"UVXqEsyu","public":true,"publicUrl":"https://docs.broker.5f.app","privateUrl":"https://go.postman.co/documentation/12723268-232a72cc-72a1-4209-aa77-b481fb377e4f","customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"EF5B25"},"documentationLayout":"classic-single-column","customisation":null,"version":"8.10.0","publishDate":"2022-02-01T00:55:03.000Z","activeVersionTag":"latest","documentationTheme":"light","metaTags":{},"logos":{}},"statusCode":200},"environments":[{"name":"Load API - Production","id":"f81f368a-d550-46c6-90ba-9269a8c800d5","owner":"12723268","values":[{"key":"baseURL","value":"https://api.lohi.ai/v1/external","enabled":true,"type":"default"},{"key":"apiKey","value":"Tokens can be generated from integration dashboard","enabled":true,"type":"secret"}],"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/1d65b666d26f13ea6c1b44f53108bc5a0e9e2caf15c7086118df51793989cfb4","favicon":"https://res.cloudinary.com/postman/image/upload/v1589219053/team/e50hynutz7fhpqmcqw6h.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":"Load API - Production","value":"12723268-f81f368a-d550-46c6-90ba-9269a8c800d5"}],"canonicalUrl":"https://docs.broker.5f.app/view/metadata/UVXqEsyu"}