Descartes MacroPoint provides multiple options to create a functional and robust integration maximizing scalability and value. These integrations power the Descartes MacroPoint Capacity product. Documentation for the API and Flat File integrations can be found on the left side under the designated folder.
\nOne Year Delivered Loads File
\nComplete Carrier List - Sent on 24 hour frequency
\nOpen Loads - Sent on 15 minute frequency
\nBooked Loads- Sent on 15 minute frequency
\nDelivered Loads - Sent on 15 minute frequency
\n*Please Note: Only send changes for each load type. Not a complete list on each post.
\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[{"content":"Data Requirements:","slug":"data-requirements"}],"owner":"6789800","collectionId":"9c060b55-32c3-4a77-93ba-e59d8bbcd764","publishedId":"SzmfXGu5","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"00AAFF"},"publishDate":"2020-12-03T16:33:51.000Z"},"item":[{"name":"APIs","item":[{"name":"Import API","item":[{"name":"Carrier Import","id":"19a5773f-a70c-4e89-a28b-1a623c73c2f5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{\n \"ExecutionTime\": \"00:00:03.7734000\",\n \"Request\": {\n \"LspCarriers\": [],\n \"SessionId\": \"\",\n \"RequestId\": \"\",\n \"UserAuthenticatedId\": null,\n \"TrackTelemetry\": true,\n \"Method\": \"API\"\n },\n \"Result\": {\n \"UnableToLocateDOTorMCNumberLspCarriers\": []\n },\n \"Success\": true,\n \"ErrorCodes\": [],\n \"ErrorMessages\": [],\n \"WarningCodes\": [],\n \"WarningMessages\": [],\n \"InformationalMessages\": [\n \"Saving 1 Carriers to Database.\"\n ]\n}\n\nLoad Types: Open, Booked, & Delivered
The more information supplied the better the user experience
{\n \"ExecutionTime\": \"00:00:00.1028778\",\n \"Request\": {\n \"LspId\": \"123456\",\n \"LspName\": \"Customer Name\",\n \"ReceivedDateTimeUtc\": \"2023-06-21T17:34:26.2923641Z\",\n \"Loads\": [],\n \"SessionId\": \"\",\n \"RequestId\": \"\",\n \"UserAuthenticatedId\": null,\n \"TrackTelemetry\": true,\n \"Method\": \"API\",\n \"FileName\": null,\n \"Provider\": null,\n \"Message\": null,\n \"Status\": null\n },\n \"Result\": null,\n \"Success\": true,\n \"ErrorCodes\": [],\n \"ErrorMessages\": [],\n \"WarningCodes\": [],\n \"WarningMessages\": [],\n \"InformationalMessages\": [\n \"Original Message Batch Size: 1\"\n ]\n}\n\nThe Import APIs allow you to post carrier and load data to Capacity so Descartes MacroPoint and your system are always in sync. The Import APIs are RESTful with calls being made to the base domain:
\nProduction: https://import-capacity.macropoint.com/api/v2/
\nThe Find Power API allows for companies to receive a listing of top carriers ranked based on the lane and projected open capacity of the shipment. Additional parameters can be sent on the call allowing to factor in expanded radiuses, extended history, sub equipment, and expanded hours around appointment times to open the search to a wider carrier pool.
\nProduction: https://dw-export-capacity.macropoint.com/api/v3/LSPFindPowerExportV3
\nIndivual Carrier Details included in Response Schema
\n{\n \"executionTime\": \"00:00:00.0017900\",\n \"request\": {\n \"lspId\": \"123456\",\n \"loadId\": \"Test123\",\n \"includeCapacityCoOpTrucks\": true,\n \"includeCapacityCoOpHistory\": true,\n \"origin\": {\n \"c\": \"City\",\n \"s\": \"State\",\n \"zip\": \"Zip Code\",\n \"lat\": xx.xxxxxxxx,\n \"lng\": -xx.xxxxxxxx,\n \"date\": \"YYY-MM-DDTHH:MM:SS+UTC Offset\",\n \"time\": \"HH:MM:SS\"\n },\n \"originMilesRadiusWindow\": 50,\n \"destination\": {\n \"c\": \"City\",\n \"s\": \"State\",\n \"zip\": \"Zip Code\",\n \"lat\": xx.xxxxxxxx,\n \"lng\": -xx.xxxxxxxx,\n \"date\": \"YYY-MM-DDTHH:MM:SS+UTC Offset\",\n \"time\": \"HH:MM:SS\"\n },\n \"destinationMilesRadiusWindow\": 50,\n \"equipmentTypes\": [\n \"DryVan\"\n ],\n \"timeWindowBeforeOriginAppointment\": \"12:00:00\",\n \"timeWindowAfterOriginAppointment\": \"00:00:00\",\n \"dayWindowForHistoricalData\": 180\n },\n \"result\": {\n \"avgRatePerMile\": 0.0,\n \"carriers\": [\n {\n \"status\": \"Active\",\n \"dot\": \"DOT Number\",\n \"mc\": \"MC Number\",\n \"name\": \"Carrier Name\",\n \"r\": 1,\n \"laneScore\": 0.0\n },\n\n*Required - The Load ID sent to Capacity looking to find power
\n","type":"text/plain"},"key":"request.loadId","value":"Load ID"},{"description":{"content":"*Required - The equipment type of the load. Must be: DryVan, FlatBed, or Reefer
\n","type":"text/plain"},"key":"request.equipmentTypes","value":"Equipment Type"},{"description":{"content":"*Required - A second equipment type if desired: Must be: DryVan, FlatBed, or Reefer. This can be the same as Equipment Type if an alternate is not acceptable
\n","type":"text/plain"},"key":"request.equipmentTypes","value":"Alternate Equipment Type"},{"description":{"content":"*Required - Number of miles away from the load's origin to consider a \"hit\" when matching with history/live trucks. Default is 50.
\n","type":"text/plain"},"key":"request.originMilesRadiusWindow","value":"Origin Mile Radius"},{"description":{"content":"*Required - Number of miles away from the load's destination to consider a \"hit\" when matching with history/live trucks. Default is 50.
\n","type":"text/plain"},"key":"request.destinationMilesRadiusWindow","value":"Destination Mile Radius"},{"description":{"content":"Number of hours before the load's origin pickup date and time to consider trucks in the area as a \"hit\". Default is 12. Format: 00:00:00
\n","type":"text/plain"},"key":"request.timeWindowBeforeOriginAppointment","value":"Hours Before Pick Time"},{"description":{"content":"Number of hours after the load's origin pickup date and time to consider trucks in the area as a \"hit\". Default is 0. Format: 00:00:00
\n","type":"text/plain"},"key":"request.timeWindowAfterOriginAppointment","value":"Hours After Pick Time"},{"description":{"content":"*Required - Number of months of history to search over. Must be: Twelve, Six, Three, One. Default is Six.
\n","type":"text/plain"},"key":"request.monthWindowForHistoricalData","value":"Months History"}],"variable":[]}},"response":[],"_postman_id":"82482dc4-3163-4232-820c-3ac3c2929f65"},{"name":"Single Carrier Statistics","event":[{"listen":"test","script":{"id":"12771883-1e3e-4bb8-abdd-a8e7883489f3","exec":["pm.test(\"Status code is 200\", function () { pm.response.to.have.status(200); });","pm.test(\"Expected success\", function () {"," var jsonData = pm.response.json();"," pm.expect(jsonData.success).to.eq(true);","});","pm.test(\"Includes original request\", function () {"," var jsonData = pm.response.json();"," pm.expect(jsonData.request.lspId).to.eq(\"Demo\");"," pm.expect(jsonData.request.loadId).to.eq(\"1008\");","});","","pm.test(\"Expected carrier count\", function () {"," var jsonData = pm.response.json();"," pm.expect(jsonData.result.carriers.length).to.eq(1);","});","","pm.test(\"Expected top carrier\", function () {"," var jsonData = pm.response.json();"," pm.expect(jsonData.result.carriers[0].status).to.eq(\"Active\");"," pm.expect(jsonData.result.carriers[0].dot).to.eq(\"10000018\");"," pm.expect(jsonData.result.carriers[0].mc).to.eq(\"\");"," pm.expect(jsonData.result.carriers[0].name).to.eq(\"Gotham City Tansport\");"," pm.expect(jsonData.result.carriers[0].r).to.eq(1);"," pm.expect(jsonData.result.carriers[0]).to.have.property('laneScore');"," pm.expect(jsonData.result.carriers[0]).to.have.property('s');"," pm.expect(jsonData.result.carriers[0]).to.have.property('carrierContact');"," pm.expect(jsonData.result.carriers[0]).to.have.property('carrierRating');"," pm.expect(jsonData.result.carriers[0]).to.have.property('trucks');","});"],"type":"text/javascript","packages":{}}}],"id":"ee42c656-17ad-4a2a-834b-082eb94be62c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"Single Carrier Information API allows customers to receive detailed information around a specific carrier including contact information, carrier lane history, forward looking capacity, deadhead averages, and carrier safety ratings.
\nAvgRatePerMile: The average rate per mile (excluding fuel) across all carriers in the Find Power results
\nPercentOfHistoryFromCoOp: Percent of customer's historical lane results coming from Capacity CoOp
\nCarriers: A list of carriers ranked in order of best match for the open load (100 or less will be returned)
\nPer Carrier
\nstatus: Carrier status in customer's network, active or inactive
\ndot: DOT Number for this carrier
\nmc: MC number for this carrier
\nname: Carrier's Name
\nr: Rank for this carrier
\nlaneScore: Lane Score for this carrier
\ns: Statistics related to this carrier, as follows:
\ncarrierContact: Includes contact information for all carriers (name, email, phone number)
\ncarrierRating: If the request contained a carrierDotNumber, the carrier rating information will be returned for just that carrier.
\nownerName: The person at your LSP that owns this carrier (may be empty/missing)
\ntrucks: This includes current GPS locations (latitude/longitude) of the relevant trucks (may be empty/missing)
\n*Required - The Load ID sent to Capacity looking to find power
\n","type":"text/plain"},"key":"request.loadId","value":"Load ID"},{"description":{"content":"*Required - The equipment type of the load. Must be: DryVan, FlatBed, or Reefer
\n","type":"text/plain"},"key":"request.equipmentTypes","value":"Equipment Type"},{"description":{"content":"A second equipment type if desired: Must be: DryVan, FlatBed, or Reefer
\n","type":"text/plain"},"key":"request.equipmentTypes","value":"Alternate Equipment Type"},{"description":{"content":"*Required - Number of miles away from the load's origin to consider a \"hit\" when matching with history/live trucks. Default is 50.
\n","type":"text/plain"},"key":"request.originMilesRadiusWindow","value":"Origin Mile Radius"},{"description":{"content":"*Required - Number of miles away from the load's destination to consider a \"hit\" when matching with history/live trucks. Default is 50.
\n","type":"text/plain"},"key":"request.destinationMilesRadiusWindow","value":"Destination Mile Radius"},{"description":{"content":"Number of hours before the load's origin pickup date and time to consider trucks in the area as a \"hit\". Default is 12. Format: 00:00:00
\n","type":"text/plain"},"key":"request.timeWindowBeforeOriginAppointment","value":"Hours Before Pick Time"},{"description":{"content":"Number of hours after the load's origin pickup date and time to consider trucks in the area as a \"hit\". Default is 0. Format: 00:00:00
\n","type":"text/plain"},"key":"request.timeWindowAfterOriginAppointment","value":"Hours After Pick Time"},{"description":{"content":"*Required - Number of months of history to search over. Must be: Twelve, Six, Three, One. Default is Six.
\n","type":"text/plain"},"key":"request.monthWindowForHistoricalData","value":"Months of Data"},{"description":{"content":"*Required - Specifically request additional information about a carrier in the find power results (contact information, rating, detailed statistics, etc)
\n","type":"text/plain"},"key":"request.carrierDotNumber","value":"Carrier DOT"}],"variable":[]}},"response":[],"_postman_id":"ee42c656-17ad-4a2a-834b-082eb94be62c"}],"id":"866f2ea0-e55f-4d5f-852b-4a7dea62c855","description":"The Export APIs allows customers receive ranked carrier matches on specific loads, detailed carrier lane statistics, and carrier contact information.
\nThe Export Search History request allows customers to request historical detailed statistics on a specified lane.
\nProduction: https://dw-export-capacity.macropoint.com/api/v3/LSPHistoryExportV3
\nThe response includes the below
\nRequest - your original request to HistoryExport
\nResult:
\nAvgRatePerMile - the average rate per mile (excluding fuel) across all carriers in the Find Power results
\nCarriers - the list of carriers ranked in order of best match for the open load (100 or less will be returned)
\nstatus
\nActive means you actively work with this carrier, but another LSP may also actively work with the carrier as well
\nInactive means another LSP actively works with this carrier and the data comes from capacity coop
\ndot
\nmc
\nname
\nr
\nlaneScore
\ns
\nFLC: Number of Trucks (Forward Looking Capacity) this carrier has that are near your open load's pickup
\nT: Number of total historical trips related in some way to this open load (either the pickup location or destination location)
\nDH: Average deadhead miles for the FLC for this carrier (i.e. average number of miles from the truck locations to the origin's pickup)
\nL: Number of Lane Matches in this carrier's history (i.e. number of times this carrier ran the same Origin to Destination route)
\nD: Number of times this carrier has stopped in this destination
\nRL: Number of Reverse Lane Matches in this carrier's history (i.e. number of this times this carrier ran a Destination to Origin route)
\nO: Number of times this carrier has started in this origin
\nR: The average rate per mile (excluding fuel) charged for this lane, if it has lane matches
\nadditionalContacts
\nsharedContact
\nownerContact
\ncarrierContact
\nOrigin City and State, or Origin Postal is required
\n","type":"text/plain"},"key":"request.origin.city","value":"Origin City"},{"description":{"content":"Origin City and State, or Origin Postal is required
\n","type":"text/plain"},"key":"request.origin.state","value":"Origin State"},{"description":{"content":"Origin City and State, or Origin Postal is required
\n","type":"text/plain"},"key":"request.origin.postal","value":"Origin Postal Code"},{"description":{"content":"Destination City and State, or Destination Postal is required
\n","type":"text/plain"},"key":"request.destination.city","value":"Destination City"},{"description":{"content":"Destination City and State, or Destination Postal is required
\n","type":"text/plain"},"key":"request.destination.state","value":"Destination State"},{"description":{"content":"Destination City and State, or Destination Postal is required
\n","type":"text/plain"},"key":"request.destination.postal","value":"Destination Postal Code"},{"description":{"content":"Required equipment type you want to search for (DryVan, FlatBed, or/and Reefer)
\n","type":"text/plain"},"key":"request.equipmentTypes","value":"Equipment Type"},{"description":{"content":"Miles away from the origin to look for historical trips. Default is 50.
\n","type":"text/plain"},"key":"request.originmilesradiuswindow","value":"Miles from Origin"},{"description":{"content":"Miles away from the destination to look for historical trips. Default is 50.
\n","type":"text/plain"},"key":"request.destinationmilesradiuswindow","value":"Miles from Destination"},{"description":{"content":"One, Three, Six, Nine, Twelve - number of months of history to search. Default is six.
\n","type":"text/plain"},"key":"request.MonthWindowForHistoricalData","value":"Months of Data"},{"description":{"content":"Number of history results to return (default 100, max 100)
\n","type":"text/plain"},"key":"request.NumberOfCarriersReturned","value":"Number of Results to Return"}],"variable":[]}},"response":[],"_postman_id":"0017a0cb-ebc5-4085-90ff-6a746ed3c0f8"},{"name":"Lane History Search - Single Carrier Detailed Statistics","event":[{"listen":"test","script":{"id":"7e402996-3f3e-4a80-b43e-c52abd3dd561","exec":["pm.test(\"Status code is 200\", function () { pm.response.to.have.status(200); });","pm.test(\"Expected success\", function () {"," var jsonData = pm.response.json();"," pm.expect(jsonData.success).to.eq(true);","});","pm.test(\"Includes original request\", function () {"," var jsonData = pm.response.json();"," "," pm.expect(jsonData.request.lspId).to.eq(\"Demo\");"," pm.expect(jsonData.request.origin.zip).to.eq(\"44212\");"," pm.expect(jsonData.request.destination.zip).to.eq(\"30301\");","});","","pm.test(\"Expected carrier count\", function () {"," var jsonData = pm.response.json();"," pm.expect(jsonData.result.carriers.length).to.eq(1);","});","","","pm.test(\"Expected top carrier\", function () {"," var jsonData = pm.response.json();"," pm.expect(jsonData.result.carriers[0].status).to.eq(\"Active\");"," pm.expect(jsonData.result.carriers[0].dot).to.eq(\"10000019\");"," pm.expect(jsonData.result.carriers[0].mc).to.eq(\"\");"," pm.expect(jsonData.result.carriers[0].name).to.eq(\"King's Landing Cargo\");"," pm.expect(jsonData.result.carriers[0].r).to.eq(1); ","});","","","pm.test(\"Contains historical statistics for carrier\", function () {"," var jsonData = pm.response.json();"," pm.expect(jsonData.result.carriers[0].tripSheets.length).to.eq(6);"," ","});",""],"type":"text/javascript","packages":{}}}],"id":"c66dc02a-03a3-4319-80e9-08fe177a068c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"The Export Search History - Single Carrier Statistics request allows customers to request historical detailed statistics on a specified lane for a specified carrier
\nProduction: https://dw-export-capacity.macropoint.com/api/v3/LSPHistoryExportV3
\nIf you make a second call to ask for detailed results about one of the carriers, your result will have:
\nAvgRatePerMile - the average rate per mile (excluding fuel) across all carriers in the Find Power results
\nPercentOfHistoryFromCoOp - percent of your historical lane results coming from Capacity CoOp
\nCarriers - the list of carriers ranked in order of best match for the open load (100 or less will be returned)
\nStatus
\nActive means you actively work with this carrier, but another LSP may also actively work with the carrier as well
\nInactive means another LSP actively works with this carrier and the data comes from capacity coop
\ndot
\nmc
\nname
\nr
\nlaneScore
\ns
\nFLC: Number of Trucks (Forward Looking Capacity) this carrier has that are near your open load's pickup
\nT: Number of total historical trips related in some way to this open load (either the pickup location or destination location)
\nDH: Average deadhead miles for the FLC for this carrier (i.e. average number of miles from the truck locations to the origin's pickup)
\nL: Number of Lane Matches in this carrier's history (i.e. number of times this carrier ran the same Origin to Destination route)
\nD: Number of times this carrier has stopped in this destination
\nRL: Number of Reverse Lane Matches in this carrier's history (i.e. number of this times this carrier ran a Destination to Origin route)
\nO: Number of times this carrier has started in this origin
\nR: The average rate per mile (excluding fuel) charged for this lane, if it has lane matches
\nadditionalContacts
\nsharedContact
\nownerContact
\ncarrierContact
\ncarrierRating
\nownerName
\ntripSheets
\norigin
\ndestination
\nequipmentType
\nstatistics
\ntoD
\ntoO
\nfromO
\nfromD
\nlanes
\nOrigin City and State, or Origin Postal is required
\n","type":"text/plain"},"key":"request.origin.city","value":"Cleveland"},{"disabled":true,"description":{"content":"Origin City and State, or Origin Postal is required
\n","type":"text/plain"},"key":"request.origin.state","value":"OH"},{"description":{"content":"Origin City and State, or Origin Postal is required
\n","type":"text/plain"},"key":"request.origin.postal","value":"44212"},{"disabled":true,"description":{"content":"Destination City and State, or Destination Postal is required
\n","type":"text/plain"},"key":"request.destination.city","value":"Atlanta"},{"disabled":true,"description":{"content":"Destination City and State, or Destination Postal is required
\n","type":"text/plain"},"key":"request.destination.state","value":"GA"},{"description":{"content":"Destination City and State, or Destination Postal is required
\n","type":"text/plain"},"key":"request.destination.postal","value":"30301"},{"description":{"content":"Required equipment type you want to search for (DryVan, FlatBed, or/and Reefer)
\n","type":"text/plain"},"key":"request.equipmentTypes","value":"DryVan"},{"disabled":true,"description":{"content":"Miles away from the origin to look for historical trips. Default is 50.
\n","type":"text/plain"},"key":"request.originmilesradiuswindow","value":"65"},{"disabled":true,"description":{"content":"Miles away from the destination to look for historical trips. Default is 50.
\n","type":"text/plain"},"key":"request.destinationmilesradiuswindow","value":"70"},{"disabled":true,"description":{"content":"One, Three, Six, Nine, Twelve - number of months of history to search. Default is six.
\n","type":"text/plain"},"key":"request.MonthWindowForHistoricalData","value":"three"},{"description":{"content":"DOTNumber of the carrier you want to get specific historical statistics on
\n","type":"text/plain"},"key":"request.carrierDotNumber","value":"10000019"},{"disabled":true,"description":{"content":"Number of history results to return (default 100, max 100)
\n","type":"text/plain"},"key":"request.NumberOfCarriersReturned","value":"5"}],"variable":[]}},"response":[],"_postman_id":"c66dc02a-03a3-4319-80e9-08fe177a068c"}],"id":"143a524c-dc94-4cac-b12c-48b0902b32b8","description":"The Search API allows you to search a specified lane based on a defined Origin, Destination, and Equipment Type and return historical carrier matches up to 12 months back
\nNote: This is a billable feature. If this is not currently included in your contract and your company needs access to it, please contact your sales rep.
\n","_postman_id":"143a524c-dc94-4cac-b12c-48b0902b32b8"},{"name":"Offer API","item":[{"name":"3rd Party TMS Integration","item":[{"name":"Add an Offer","id":"4cb472b8-b551-4969-a3fa-95ae465043ac","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"Requirements:
\nRequest Structure
\nRequest Schema:
\nResponse Schema:
\nResponse Codes:
\n","urlObject":{"protocol":"https","path":["api","v1","lspoffer"],"host":["capacity-offer-api","macropoint","com"],"query":[],"variable":[]}},"response":[{"id":"1fe624da-efb8-43d4-940e-b904af8e823f","name":"Offer created","originalRequest":{"method":"PUT","header":[{"key":"Authorization","value":"BasicRequirements:
\nThe Load must be open in the MacroPoint Capacity Product
\nAn original offer must be created either via the Broker or Carrier.
\nThe LSP is required in the GET Request
\nRequest Structure
\nRequest Example:
\nhttps://capacity-offer-api.macropoint.com/api/v1/lspoffer/tms/123456/12345678
\nResponse Schema:
\nResponse Codes:
\n","urlObject":{"protocol":"https","path":["api","v1","lspoffer","tms",":lspId",":offerId"],"host":["capacity-offer-api","macropoint","com"],"query":[],"variable":[{"type":"any","value":null,"key":"lspId"},{"description":{"content":"(Required) OfferId of offer to get.
\n","type":"text/plain"},"type":"any","value":"33","key":"offerId"}]}},"response":[{"id":"4188289d-cf2b-4514-856f-081b311d79e5","name":"Details about an offer - needs updated","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"BasicRequirements:
\nThe Load must be open in the MacroPoint Capacity Product
\nAn original offer must be created either via the Broker or Carrier.
\nThe LSP is required in the GET Request
\nRequest Structure
\nRequest Example:
\nhttps://capacity-offer-api.macropoint.com/api/v1/lspoffer/tms/123456/123.4452
\nResponse Schema:
\nResponse Codes:
\n","urlObject":{"protocol":"https","path":["api","v1","lspoffer","tms","{lspId}"],"host":["capacity-offer-api","macropoint","com"],"query":[],"variable":[]}},"response":[{"id":"837e434a-521d-4c7e-bc21-89135cf615c0","name":"Details about offers","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"BasicRequirements:
\nThe Load must be open in the MacroPoint Capacity Product
\nAn original offer must be created either via the Broker or Carrier
\nThe LSP and OfferID are required in the GET Request
\nOnce the load has been sent to the Descartes MacroPoint Capacity product as accepted, the customer should follow their normal booking process within their TMS to secure the carrier on the load.
\nRequest Structure
\nRequest Example:
\nhttps://capacity-offer-api.macropoint.com/api/v1/lspoffer/tms/123456/accept/123.4452
\nResponse Schema:
\nResponse Codes:
\n","urlObject":{"protocol":"https","path":["api","v1","lspoffer","tms","{lspId}","accept","{offerId}"],"host":["capacity-offer-api","macropoint","com"],"query":[],"variable":[]}},"response":[{"id":"a6e9e7f4-67bf-4201-a5cc-266d3850b7f6","name":"Acceptance successfully submitted","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"BasicRequirements:
\nThe Load must be open in the MacroPoint Capacity Product
\nAn original offer must be created either via the Broker or Carrier
\nThe OfferID is required in the DEL request
\nRequest Structure
\nRequest Example:
\nhttps://capacity-offer-api.macropoint.com/api/v1/lspoffer/
\nResponse Codes:
\n","urlObject":{"protocol":"https","path":["api","v1","lspoffer","{offerId}"],"host":["capacity-offer-api","macropoint","com"],"query":[],"variable":[]}},"response":[{"id":"0897fdcd-3f4c-4e4f-bbee-ba1d17501783","name":"Rescind Offer","originalRequest":{"method":"DELETE","header":[{"key":"Authorization","value":"BasicThe 3rd Party TMS Integration allows a TMS to integrate with the Capacity Offer API at a venue level.
\nVenue access allows a 3rd Party TMS to scale the integration efficiently across multiple customers.
\nVenue login credentials provide one username per 3rd Party TMS. Passwords are customer specific and are provided by Descartes MacroPoint.
\n","_postman_id":"e615ab3f-a169-4974-93cc-641cdf383486"},{"name":"Custom Integration","item":[{"name":"Add an Offer","id":"a03ae8aa-e8b5-4061-a023-0f7ea18d5b7e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"Requirements:
\nRequest Structure
\nRequest Schema:
\nResponse Schema:
\nResponse Codes:
\n","urlObject":{"protocol":"https","path":["api","v1","lspoffer"],"host":["capacity-offer-api","macropoint","com"],"query":[],"variable":[]}},"response":[{"id":"05a44a3f-0773-4f77-a325-1bee48035d8a","name":"Offer created","originalRequest":{"method":"PUT","header":[{"key":"Authorization","value":"BasicRequirements:
\nThe Load must be open in the MacroPoint Capacity Product
\nAn original offer must be created either via the Broker or Carrier
\nThe OfferID is required in the GET Request
\nOnce the load has been sent to the Descartes MacroPoint Capacity product as accepted, the customer should follow their normal booking process within their TMS to secure the carrier on the load.
\nRequest Structure
\nRequest Example:
\nhttps://capacity-offer-api.macropoint.com/api/v1/lspoffer/accept/12345678
\nResponse Schema:
\nResponse Codes:
\n","urlObject":{"protocol":"https","path":["api","v1","lspoffer","accept","{offerId}"],"host":["capacity-offer-api","macropoint","com"],"query":[],"variable":[]}},"response":[{"id":"64796357-2a50-444c-a363-2c7d84e16e80","name":"Acceptance successfully submitted.","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"BasicRequirements:
\nThe Load must be open in the MacroPoint Capacity Product
\nAn original offer must be created either via the Broker or Carrier.
\nThe Offer ID is required in the GET Request
\nRequest Structure
\nRequest Example:
\nhttps://capacity-offer-api.macropoint.com/api/v1/lspoffer/12345678
\nResponse Schema:
\nResponse Codes:
\n","urlObject":{"protocol":"https","path":["api","v1","lspoffer","{offerId}"],"host":["capacity-offer-api","macropoint","com"],"query":[],"variable":[]}},"response":[{"id":"4618beaa-6692-41d5-9974-63b64f00caee","name":"Details about an offer","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"BasicRequirements:
\nThe Load must be open in the MacroPoint Capacity Product
\nAn original offer must be created either via the Broker or Carrier
\nThe OfferID is required in the DEL request
\nRequest Structure
\nRequest Example:
\nhttps://capacity-offer-api.macropoint.com/api/v1/lspoffer/123456
\nResponse Codes:
\n","urlObject":{"protocol":"https","path":["api","v1","lspoffer","{offerId}"],"host":["capacity-offer-api","macropoint","com"],"query":[],"variable":[]}},"response":[{"id":"d2b3cd1d-0629-4ae3-9664-5ce38bb01c10","name":"Rescind Offer","originalRequest":{"method":"DELETE","header":[{"key":"Authorization","value":"Basic{\n \"originalOfferId\": null,\n \"offerId\": 10800877,\n \"lspId\": \"7890456\",\n \"carrierDot\": \"123456\",\n \"dateCreatedUtc\": \"2024-08-07T20:10:03.1344836\",\n \"rate\": 0,\n \"limitRate\": 0,\n \"loadId\": \"276930\",\n \"expire\": \"2024-08-14T04:00:00Z\",\n \"fromCarrier\": true,\n \"status\": \"Accepted\",\n \"childCompany\": null,\n \"note\": null,\n \"additionalNotes\": null\n}\n\nThe Descartes MacroPoint Capacity Offer API provides customers and 3rd Party TMSs the ability to offer open loads to carriers, accept offers from carriers, and counter offers.
\n","_postman_id":"fc4d738e-65d9-4072-b13c-3516f28fcf89"}],"id":"fbc2743d-d01f-45e4-bf3a-4bc5a9c018c6","description":"Descartes MacroPoint Capacity APIs are the premier form of integration and power the Descartes MacroPoint Capacity product. Below you will find documentation for integrating inbound data (Import API) to MacroPoint Capacity as well as how to receive carrier matches back to your system (Export API).
\n","event":[{"listen":"prerequest","script":{"id":"07564bfc-3f6b-4d0e-9e0f-d7f4321aaab4","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"45e3f810-a09a-4ae2-b9f8-185b7117f081","type":"text/javascript","exec":[""]}}],"_postman_id":"fbc2743d-d01f-45e4-bf3a-4bc5a9c018c6"},{"name":"Flat File","item":[{"name":"Carrier Upload","id":"bf516441-7ad1-4e82-9fd7-f801448fc440","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"url":"","description":"Carrier Upload Flat File allows customers to post complete carrier lists
\nDescartes MacroPoint offers customers the ability to upload the following updates via the Descartes MacroPoint FTP:
\nNote: All column headers must be included for both Carriers and Loads files. If data is missing or unknown leave cell blank. Column header order does not matter.
\nAll files should be uploaded to the FTP URL:
\nDescartes MacroPoint will provide you:
\n