Create Order API request allows customers to Create Tracking Sessions or Tracking Requests
\nRequest Structure
\nCreate Order Elements
\nTrackVia Tags
\nTrackVia International Mobile Number Tag
\nA Country Code is required for tracking any mobile phone that is not a United States number. Country code can be supplied in either the numerical or aplha code.
\nIf the numerical country code is provided, the '+' must be provided in front of the country code. IE: +525555555555.
\nAcceptable Country Codes are listed under the the folder 'Descartes MacroPoint Best Practice Procedures' - 'Country Codes'
\nNote: In compliance with GDPR regulations, customers must receive consent from drivers to submit European phone numbers for tracking
\nExample Format:
\n <Number Type=\"Mobile\">+525555555555</Number>\n\nExample Format:
\n <Number Type=\"Mobile\">MEX525555555555</Number>\n\nTrackVia VehicleID Specify Telematics Provider Tag
\nThe VehicleID should be provided in the TrackVia tags (VehicleID or TrailerID) only if a carrier has multiple telematic providers connected in Descartes MacroPoint for their fleet.
\nThe Provider name must match the provider in MacroPoint.
\nPlease work with your assigned Implmentation Engineer if this feature is needed.
\nExample Format:
\n <TrackVia>\n <Number Type='VehicleId' Provider=\"Samsara\">123</Number>\n <Number Type='TrailerID' Provider=\"Geotab\">9874</Number>\n </TrackVia>\n\nTrackStartDateTime Tags
\nReference Information Tags
\nThe reference information tags can be used on FTL shipments to retrieve additional customs data points if the shipment is moving cross-border into the US.
\nNote: Either the Ocean Bill of Lading Number or the Carrier Booking Number and Carrier SCAC are required to track Ocean Shipments
\nNotifications Tags
\nCold Chain Tags
\nCarrier Tags
\nVehicle Tags
\nTripSheet Tags
\nTripSheet Stop Nodes
\nTripSheet Stop Address Nodes
\nPolygon Geofence Nodes
\n*If Polygon Geofences are sent on a stop, the Format and Data tags are requires
\n<GeoFence>\n <Format>OGC_WKT</Format>\n <Data>POLYGON((-88.1046760 41.8895166, -88.1042588 41.8894996, -88.1039705 41.8894629, -88.1039591 41.8897509,-88.1046760 41.8895166))</Data>\n</GeoFence>\n\nHideTripSheet Tag
\nCustomer Tag
\nMode Tag
\nCustomer Account Number Tag
\nScheduleAlerts Tag
\nEmailCopiesOfUpdatesTo Tag
\nNotes Tag
\nCreate Order Responses
\nCreate Order Errors
\nResponse Example:
\nResponse 201
\n Success\n FB93D3FE546749F5A3385D1E2961A12B\n A04EE941BEC446419749D8433885C654\n\nChange Order API Request allows customers to edit certain fields on tracking sessions
\nWhen posting a Change Order, either the OrderID or TrackingRequestID provided by Descartes MacroPoint on the original Create Order success message must be used in the URL of the Change Order request
\nThe OrderID or TrackingRequestID can be used interchangeably to make Change Order requests
\nA complete XML must be submitted on the order, partial calls are not accepted. Tags that are not supported still need to be passed with populated data from the Create Order request
\nRequest Structure
\nChange Order Elements that can be updated in the Change Order request
\nUnacceptable Changes Overview
\nChange Order Responses
\nChange Order Errors
\n","urlObject":{"protocol":"https","path":["api","1.0","orders","changeorder","{OrderID","TrackingRequestID}"],"host":["macropoint-lite","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"d933e4d9-7d78-4052-9968-de1c39978e3e"},{"name":"Stop Order","id":"c08d1f61-2a88-4d27-8e14-faa833eb5616","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"Stop Order API Request allows customers to Cancel Orders or Tracking Requests
\nTracking Requests that have been created but are not yet assigned will be removed from Descartes MacroPoint's website if a Stop Order request is sent
\nTracking Sessions =that have been created will be moved to 'Stopped By Creator' status
\nRequest Structure
\nRequires either the OrderID or TrackingRequestID received from the successful Create Order request to be provided in the Endpoint URL
\nExample:
\nhttps://macropoint-lite.com/api/1.0/orders/stoporder/FB93D3FE546749F5A3385D1E2961A12B
\nThe Stop Order response does not provide any data, only a '200 OK' status will be returned
\n\n
If the OrderID or Tracking RequestID is unable to be provided from the successful Create Order request the tracking session can be stopped with the LoadID:
\nURL: https://macropoint-lite.com/api/1.0/orders/stoporder
\nRequest Structure
\n<Order xmlns=\"http://macropoint-lite.com/xml/1.0\" >\n<IDNumber>TESTSTOPORDER</IDNumber> \n</Order>\n\nStop Order Response for requests using the LoadID
\n","urlObject":{"protocol":"https","path":["api","1.0","orders","stoporder","{OrderID","TrackingrequestID}"],"host":["macropoint-lite","com"],"query":[],"variable":[]}},"response":[{"id":"efdb2f29-0d41-4876-b8f1-7f6c65961533","name":"Stop Order Request using OrderID or TrackingRequestID","originalRequest":{"method":"POST","header":[{"key":"Content-Type","type":"text","value":"application/xml"}],"body":{"mode":"raw","raw":""},"url":"https://macropoint-lite.com/api/1.0/orders/stoporder/7C915EA32EA349FCBDBCB3E2F0506D9"},"status":"Stop Order Response - 200 OK","_postman_previewlanguage":"plain","header":[{"key":"Date","value":"Wed, 04 Mar 2020 16:17:56 GMT"},{"key":"Content-Length","value":"0"},{"key":"Connection","value":"keep-alive"},{"key":"Server","value":"Microsoft-IIS/10.0"},{"key":"X-Powered-By","value":"ASP.NET"}],"cookie":[],"responseTime":null,"body":null},{"id":"ff19a35c-4045-4762-9032-98a3d6d6363b","name":"Stop Order Request using LoadID","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"Create Order API request for Ocean Tracking
\nRequest Structure
\nCreate Order Elements
\nTrackVia Tags
\nTrackStartDateTime Tags
\nReference Information Tags
\nNote: Either the Ocean Bill of Lading Number or the Carrier Booking Number and Carrier SCAC are required to track Ocean Shipments
\nNotifications Tags
\nTripSheet Tag
\nTripSheet Stop Nodes
\nStartFragment
\nCustomer Tag
\nMode Tag
\nEndFragment
\nEmailCopiesOfUpdatesTo Tag
\nNotes Tag
\nCreate Order Responses
\nResponse Example:
\nResponse 201
\n Success\n FB93D3FE546749F5A3385D1E2961A12B\n\nCreate Order API request for Air Tracking
\nRequest Structure
\nCreate Order Elements
\nTrackVia Tags
\nTrackStartDateTime Tags
\nNotifications Tags
\nCustomer Tag
\nMode Tag
\nEmailCopiesOfUpdatesTo Tag
\nNotes Tag
\nCreate Order Responses
\nResponse Example:
\nResponse 201
\n Success\n FB93D3FE546749F5A3385D1E2961A12B\n\nCreate Order API request for Rail Tracking
\nRequest Structure
\nCreate Order Elements
\nTrackVia Tags
\nTrackStartDateTime Tags
\nNotifications Tags
\nTripSheet Tags
\nTripSheet Stop Nodes
\nTripSheet Stop Address Nodes
\nCustomer Tag
\nMode Tag
\nEmailCopiesOfUpdatesTo Tag
\nNotes Tag
\nCreate Order Responses
\nResponse Example:
\nResponse 201
\n Success\n FB93D3FE546749F5A3385D1E2961A12B\n A04EE941BEC446419749D8433885C654\n\nThe load visibility endpoints enable customers to create, update, and stop orders directly from their TMS or ERP system, ensuring those loads are seamlessly tracked within Descartes MacroPoint.
\n","event":[{"listen":"prerequest","script":{"id":"8d892f3f-be54-44e7-870c-e06c6f797c15","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"5b083565-d5d9-4f9e-91e4-d8d5c6deb7bd","type":"text/javascript","exec":[""]}}],"_postman_id":"5503da4c-74aa-4027-91ad-8ab3b0f9c503"},{"name":"Load Visibility Data Retrieval","item":[{"name":"Location Updates","id":"495fe0fd-9686-4255-ab0c-b3d87e315f67","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://CustomerSpecifiedURL?MPOrderID={1}&ID={2}&Latitude={3}&Longitude={4}&Uncertainty={5}&Street1={6}&Street2={7}&Neighborhood={8}&City={9}&State={10}&Postal={11}&Country={12}&LocationDateTimeUTC={13}&ApproxLocationDateTimeInLocalTime={14}&DataSource={15}&MPTrackingRequestID={16}&Locator={17}","description":"The Location Updates Callback will push the location updates received on an order to a URL endpoint that is established by the customer.
\nIndividual Location Updates can be retrieved from the URL via a GET Request.
\nLocation updates are provided in real time as they are received on a live tracking session
\nThe DataSource value in the URL return will differ based on the tracking session method. Below are the variation options:
\nSample URL:
\nhttps://CustomerSpecifiedURL?MPOrderID=1234567&ID=Load-123&Latitude=39.842180&Longitude=-82.917530&Uncertainty=0&Street1=6050+Oak+Tree+Blvd&Street2=Suite+190&Neighborhood=&City=Independence&State=OH&Postal=44131&Country=USA&LocationDateTimeUTC=2020-01-01T12:00:00Z&ApproxLocationDateTimeInLocalTime=2020-01-01T12:00:00Z&DataSource=Ping&MPTrackingRequestID=A04EE941BEC446419749D8433885C654&locator=2167894270\n\nThe Trip Events Callback will push the arrival and departure trip events on a specified order to a URL endpoint that is established by the customer.
\nIndividual Event Updates can be retrieved from the URL via a GET Request.
\nTrip Events are provided in real time as they are received on a live tracking session.
\n| Parameter | Description |
|---|---|
MPOrderID | Unique Descartes MacroPoint ID |
MPTrackingRequestID | Unique Descartes MacroPoint generated ID for the order if a Tracking Request was sent to a partnered Descartes MacroPoint Carrier at the time of order creation. If no Tracking Request was sent to a MacroPoint Partnered Carrier this parameter will not contain any value Note: The MPTrackingRequestID will be provided for all LTL trip event updates. |
ID | Customer specific order ID |
Stop | Name of the stop |
StopID | Customer internal reference ID for stop |
Event | Event is the “code” that goes with the event. E.g., X1 for Arrived at delivery location, X3 for arrived at pick-up location |
EventDateTime | Time in ISO8601 and in UTC |
ApproxLocationDateTimeIn LocalTime | The date and time that this event occurred in the local time zone |
Latitude | The latitude in decimal degrees |
Longitude | The longitude in decimal degrees |
Street1 | The street address if available |
Street2 | The second street address line if available |
Neighborhood | The name of the neighborhood if available |
City | The city name if available |
State | The state name if available |
Postal | The postal code if available |
Country | The country if available Ex: US, USA, United States |
UpdatedBy | Method event was captured. Values include: Customer (via API or Control Tower), Carrier (via integration), Driver (via mobile app), MacroPoint (via geofence) |
UnLocode | Code for Associated Terminal. Ocean Tracking Only. |
Locator | TMS ID, Truck Number, Trailer Number, or Mobile Cell Phone Number |
BOL | For ocean shipments only the Master BOL used to track the shipment |
ConfirmationStatus | Used to determine if an OpsForce AI agent calls the driver to confirm an event. Will be blank on initial event. |
The ConfirmationStatus value in the URL return will differ based on the OpsForce AI Agent's response from the driver regarding the relevant event. Below are the variation options:
\nStandard FTL Event Codes:
\nStandard Ocean Event Codes:
\nSample URL:
\nhttps://CustomerSpecifiedURL?MPOrderID=1234567&MPTrackingRequestID=632F3D84198B4E32BD70259C12A9BE25&ID=Load-123&Stop=stop1&Event=x1&EventDateTime=2022-06-21T14:25:08Z&StopID=123&ApproxLocationDateTimeInLocalTime=2022-06-21T10:25:08&Latitude=41.39690000&Longitude=-81.66249100&Street1=6050+Oak+Tree+Blvd&Street2=Suite+190&Neighborhood=Meadow+Lakes&City=Independence&State=OH&Postal=44131&Country=US&UpdatedBy=Driver&UnLocode=CNZUH&Locator=&BOL=\n\nOcean Tracking Only
\n","type":"text/plain"},"key":"UnLocode","value":"{19}"},{"key":"Locator","value":"{20}"},{"key":"BOL","value":"{21}"},{"key":"ConfirmationStatus","value":"{22}"}],"variable":[]}},"response":[],"_postman_id":"629d6b9a-fc55-445a-94df-e3e2fa58c556"},{"name":"Order Status","id":"09cfe9d1-0473-4692-9a11-442bfe81487a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://CustomerSpecifiedURL?MPOrderID={1}&MPTrackingRequestID={2}&ID={3}&Code={4}&Message={5}","description":"The Order Status Callback will push the order status changes on a specified order to a URL endpoint that is established by the Customer.
\nIndividual Order Status Updates can be retrieved from the URL via a GET Request.
\nOrder Status updates are provided in real time as they are received on a live tracking session.
\nOrder Status
\nSample URL:
\nhttps://CustomerSpecifiedURL?MPOrderID=1234567&MPTrackingRequestID=89123456&ID=Load-123&Code=1020&Message=Ready+To+Track\n\nThe Schedule Alerts Callback will push all ETAs and schedule alerts on a specified order to a URL endpoint that is established by the customer.
\nIndividual Schedule Alert Updates can be retrieved from the URL via a GET Request.
\nDescartes MacroPoint will recalculate and return a new schedule alert with each corresponding location update received on the order
\nSchedule Alerts can be throttled by Customer within Descartes MacroPoint if desired
\nScheduled Alert Codes:
\nSample URL:
\nhttps://CustomerSpecifiedURL?MPOrderID=1234567&ID=Load-123&StopType=Pickup&StopID=123&StopName=Stop1&AddressLine1=6050+Oak+Tree+Blvd&City=Independence&State=OH&PostalCode=44131&ScheduleAlertCode=1&ScheduledStartTimeInLocalTimeForStop=20200101120000&ScheduledEndTImeInLocalTimeForStop=20200101120000&ScheduleAlertText=OnTime&DistanceToStopInMiles=20&EtaToStop=2020-01-01T11:55\n:00Z&ETALocalTimeZoneOffset=04:00&MPTrackingRequestID=3531B52998C34E85ADF91BF976E9F0F1\n\nThe Enhanced Shipment Status Callback will push all relevant status messages by mode received on a specified order to a URL endpoint that is established by the customer.
\nIndividual Shipment Status Updates can be retrieved from the URL via a GET Request.
\nEnhanced Shipment Status updates are provided in real time as they are received on a live tracking session.
\nThe following fields are passed directly from the Carrier and can vary by Carrier:
\n- \n
StatusCode
\n \nStatusMessage
\n \nStatusDate
\n \nStatusLocationCity
\n \nStatusLocationState
\n \nStatusLocationCountry
\n \nEventETADateTimeInLocalTime
\n \nEventETADateTimeUTC
\n \n
LTL and Parcel MacroPoint Shipment Status Message Codes:
\nOcean StatusCode and StatusMessage examples (please note additional statues may be received from carriers):
\nRail Status Codes
\nAir Status Codes
\nSample URL:
\nhttps://CustomerSpecifiedURL?MPOrderID=93213131093F4D01A0465997A8AFBEB4&ID=Test.LTL.Provider.3&StatusCode=At+Phoenix+on+06/21/21&StatusMessage=At+Phoenix+on+06/21/21&StatusDate=2022-06-21T14:25:08Z&StatusLocationCity=Phoenix&StatusLocationState=AZ&StatusLocationCountry=US&EventETADateTimeInLocalTime=2022-06-21T10:25:08&EventETADateTimeUTC=2021-07-05T18:00:00Z&UnLocode=USLGB&MacroPointShipmentStatus=10&Locator=&BOL=\n\nOcean Tracking Only
\n","type":"text/plain"},"key":"UnLocode","value":"{11}"},{"description":{"content":"LTL and Parcel Tracking Only
\n","type":"text/plain"},"key":"MacroPointStatusCode","value":"{12}"},{"key":"Locator","value":"{13}"},{"key":"BOL","value":"{14}"}],"variable":[]}},"response":[],"_postman_id":"3b3d13f0-9051-4e32-a6b7-645daf6ecaa3"},{"name":"Location and Temperature Updates","id":"fec042ae-761d-4b7f-9302-41686ecacabf","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://CustomerSpecifiedURL?MPOrderID={1}&MPTrackingRequestID={2}&ID={3}&Latitude={4}&Longitude={5}&Uncertainty={6}&LocationDateTimeUTC={7}&Street1={8}&Street2={9}&Neighborhood={10}&City={11}&State={12}&Postal={13}&Country={14}&ApproxLocationDateTimeInLocalTime={15}&DataSource={16}&Locator={17}&ReadingDateTimeUtc={18}&Temptype={19}&Reading={20}&TempAlertCode={21}&TempAlertText={22}","description":"The Location and Temperature Update Callback will push the location and temperature updates received on an order to a URL endpoint that is established by the customer.
\nIndividual Location and Temperature Updates can be retrieved from the URL via a GET Request.
\nLocation and Temperature updates are provided in real time as they are received on a live tracking session
\nCold Chain Must be included in the Customers Contract in order to receive temperature updates and the Carrier's must support providing temperature updates via their Telematics or TMS connection
\nThe DataSource value in the URL return will differ based on the tracking session method. Below are the variation options:
\nTemperature Alert Codes:
\nSample URL:
\nhttps://CustomerSpecifiedURL?MPOrderID=1234567&ID=Load-123&MPTrackingRequestID=A04EE941BEC446419749D8433885C654&Latitude=39.842180&Longitude=-82.917530&Uncertainty=0&Street1=6050+Oak+Tree+Blvd&Street2=Suite+190&Neighborhood=&City=Independence&State=OH&Postal=44131&Country=USA&LocationDateTimeUTC=2024-01-01T12:00:00Z&ApproxLocationDateTimeInLocalTime=2024-01-01T12:00:00Z&DataSource=Ping&locator=2167894270&ReadingDateTimeUtc=2024-04-11T19:04:12.1270000&TempType=Fahrenheit&Reading-99240=65.408&Reading=49.1&TempAlertCode=2&TempAlertText=Above Temp Threshold\n\nThe Cold Chain Temperature Alert Callback will push all temperature data on a specified order to a URL endpoint that is established by the customer.
\nIndividual Cold Chain Temperature Alert Updates can be retrieved from the URL via a GET Request.
\nTemperature data are either pulled directly from telematics units or received directly from carriers via API.
\nNote: This is a billable feature. if you are interested in enabling, please contact your sales rep.
\nTemperature Alert Codes:
\nSample URL:
\nhttps://CustomerSpecifiedURL?MPOrderID=AA98A3D422654FB3A25698D691DBF780&ID=Test1234&ReadingDateTimeUtc=2024-04-11T19:04:12.1270000&TempType=Fahrenheit&reading-99240=65.408&Reading=49.1&MPTrackingRequestID=&TempAlertCode=2&TempAlertText=Above Temp Threshold\n\nThe Load Visibility Data Retrieval webhook endpoints enable customers to receive real-time updates for specific orders. All endpoints support either Basic Authentication or OAuth.
\n","event":[{"listen":"prerequest","script":{"id":"4fc4106d-1f60-44f6-8031-88e030ba07a4","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"681bad97-e3bf-44e9-97ed-b8b9d1b64d19","type":"text/javascript","exec":[""]}}],"_postman_id":"a66824ef-f45f-4147-8c2a-de67c30bc823"}],"id":"cadfabca-c8d5-4a6b-93a0-31df1cd5a9b1","description":"Available Customer to Descartes MacroPoint APIs:
\nAvailable Descartes MacroPoint to Customer APIs:
\n","_postman_id":"cadfabca-c8d5-4a6b-93a0-31df1cd5a9b1"},{"name":"Load Visibility Additional Features","item":[{"name":"Load Visibility URL and Data Export Retrieval","item":[{"name":"Order Hyperlink","id":"7f5321f9-65cb-4e9d-8088-455b34750289","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"The Order Hyperlink allows customers to receive a URL to view tracking details for a specified shipment
\nThe URL received in the response can be embedded in the customers TMS/ERP by spawning off a new browser
\nData accessible via the URL with or without a direct login to Descartes MacroPoint-Lite. Permissions are configurable on the account settings
\nRequest Structure
\nOrder Hyperlink Tags
\nNote: For manual testing, please remove the 'amp;' from the URL string
\nExampe:
\n\n","urlObject":{"protocol":"https","path":["api","1.0","tms","data","tmsgateway"],"host":["macropoint-lite","com"],"query":[],"variable":[]}},"response":[{"id":"4f4c8718-afe7-4867-b7de-14c5e1e7116c","name":"Order Hyperlink Example","originalRequest":{"method":"POST","header":[{"key":"Content-Type","type":"text","value":"application/xml"}],"body":{"mode":"raw","raw":"The Stop Specific Order Hyperlink allows customers to receive a URL to view tracking details for a specified stop on a specified shipment
\nThe URL received in the response can be embedded in the customers TMS/ERP by spawning off a new browser
\nData accessible via the URL with or without a direct login to Descartes MacroPoint-Lite. Permissions are configurable on the account settings
\nRequest Structure
\nOrder Hyperlink Tags
\nNote: For manual testing, please remove the 'amp;' from the URL string
\nExampe:
\n\n","urlObject":{"protocol":"https","path":["api","1.0","tms","data","tmsgateway"],"host":["macropoint-lite","com"],"query":[],"variable":[]}},"response":[{"id":"640d147c-8238-4b26-915d-8c366cc88c36","name":"Stop Specific Order Hyperlink Example","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/xml","type":"text"}],"body":{"mode":"raw","raw":"The Load Start Follow Along callback will push our full order hyperlink URL to a URL endpoint that is established by the customer.
\nIndividual Load Start Follow Along URL's can be retrieved from the URL via a GET Request.
\nLoad Start Follow Along updates are provided in real time once a live tracking session is created.
\nSample URL:
\nhttps://CustomerSpecifiedURL?MPOrderID=A27DC6A5952440A5AE877C7F92668F7C&MPTrackingRequestID=DED999FF96834A26B1BF871454B2E2B2&ID=TEST_12345678&FullUrl=https://visibility.macropoint.com/shipments?l=LNKd9b5b60ea5234c1fa1ff6f982ce3c69d\n\nThe Notifcation Center Alerts callback will push data based on rules created in the notification center to a URL endpoint that is established by the customer.
\nThe endpoint must also be enabled within the MacroPoint notification center interface where the rule is created.
\nNotification canter updates are provided in real time based on the alert frequency of the rule.
\n","urlObject":{"protocol":"https","host":["CustomerSpecifiedURL"],"query":[],"variable":[]}},"response":[],"_postman_id":"cd99e6e6-30e0-404c-b1fc-859f96a47a93"}],"id":"ee4d6912-25a4-4fca-b74a-982ed6e268e5","_postman_id":"ee4d6912-25a4-4fca-b74a-982ed6e268e5","description":""},{"name":"Carrier Data Connection and Communication","item":[{"name":"Carrier Wishlist","id":"3a2b6fe3-4cec-41e3-a723-476886385eeb","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"The Carrier Wishlist API allows customers to send in their active carrier list via API bulk file import once per 24 hour time period
\nUpon successful upload of the customers active carrier list in it's entirety, only changes or additions to carriers should be sent. Desired cadence can be determined by the customer but should not exceed once per 24 hour time period.
\nRequired Data to successfully import desired carriers.
\nNote: Data is comma separted
\nCarrier Wishlist API Responses
\n","urlObject":{"protocol":"https","path":["api","1.0","carrier","carrierwishlist"],"host":["macropoint-lite","com"],"query":[],"variable":[]}},"response":[{"id":"c35c598c-4f31-4488-baed-0fed67d62c26","name":"Carrier Wishlist","originalRequest":{"method":"GET","header":[],"body":{"mode":"raw","raw":"The Mapped Carrier callback will push mapped carrier details to a URL endpoint that is established by the customer.
\nThis process is completed nightly and individual mapped carrier details can be retrieved from the URL via a GET Request.
\nMapped Carrier Updates are provided in real time once a carrier is added to a customer account.
\nSample URL:
\nhttps://CustomerSpecifiedURL?CarrierName=TestCarrier&MappingCodes=TC1&DOTNumber=12345&ConnectionMethods=Telematics&TelematicsProviders=Motive&TelematicsTrackingTypes=VehicleID\n\nThe Partner Status request is used to provide associated carrier details for the specified customer or carrier details for a specified DOT.
\nUse of the Partner Status API can only be leveraged if the Carrier Wishlish is implemented
\nRequest Structure
\nCarrier ID Request Structure and Results:
\nA successful response whne a Carrier ID is passed in the GET Request URL will only be provided if the carrier is correctly partnered to the Customer in Descartes MacroPoint-Lite
\nExample Request using Carrier ID:
\nhttps://macropoint-lite.com/api/1.0/carrier/requestpartnerstatus/Test1
\nDOT Request Structure and Results:
\nA successful response when a DOT is passed in the GET Request URL will provide the specified Carrier details and if they are partnered to the customers account.
\nURL is appended to included 'DOT/{DOT #}'
\nExample Request using DOT:
\nhttps://macropoint-lite.com/api/1.0/carrier/requestpartnerstatus/DOT/2960430
\n\n
A successful response will include the following:
\nStatus Element:
\nPartnerStatus Element Tags:
\nConnectionMethods Tags:
\n","urlObject":{"protocol":"https","path":["api","1.0","carrier","requestpartnerstatus","test123"],"host":["macropoint-lite","com"],"query":[],"variable":[]}},"response":[{"id":"e820dcd1-31ff-4e06-b5e8-69fd9fd01d66","name":"Partner Status Example using Carrier ID","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/xml","type":"text"}],"body":{"mode":"raw","raw":""},"url":"https://macropoint-lite.com/api/1.0/carrier/requestpartnerstatus/{PartnerCode}"},"status":"OK","code":200,"_postman_previewlanguage":"xml","header":[{"key":"Date","value":"Wed, 04 Mar 2020 15:33:14 GMT"},{"key":"Content-Type","value":"application/xml; charset=utf-8"},{"key":"Content-Length","value":"720"},{"key":"Connection","value":"keep-alive"},{"key":"Server","value":"Microsoft-IIS/10.0"},{"key":"X-Powered-By","value":"ASP.NET"}],"cookie":[],"responseTime":null,"body":"\nTest1\n Test1\n The Good Truck API is an add on to our existing Partner Status API
\nA successful response will only be provided if the Good Truck API is enabled to your MacroPoint account and the carrier is correctly partnered to the Customer in Descartes MacroPoint-Lite which includes the CarrierID code being present
\nRequest Structure
\nExample Request:
\nhttps://macropoint-lite.com/api/1.0/carrier/requestpartnerstatus/ABC
\n\n
A successful response will include the following:
\nStatus Element:
\nPartnerStatus Element Tags:
\nConnectionMethods Tags:
\n","urlObject":{"protocol":"https","path":["api","1.0","carrier","requestpartnerstatus","{CarrierID}"],"host":["macropoint-lite","com"],"query":[],"variable":[]}},"response":[{"id":"14e8b332-d904-46c2-9b06-8629a95a03a5","name":"Good Truck API Example","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/xml","type":"text"}],"body":{"mode":"raw","raw":""},"url":"https://macropoint-lite.com/api/1.0/carrier/requestpartnerstatus/{PartnerCode}"},"status":"OK","code":200,"_postman_previewlanguage":"xml","header":[{"key":"Date","value":"Wed, 04 Mar 2020 15:33:14 GMT"},{"key":"Content-Type","value":"application/xml; charset=utf-8"},{"key":"Content-Length","value":"720"},{"key":"Connection","value":"keep-alive"},{"key":"Server","value":"Microsoft-IIS/10.0"},{"key":"X-Powered-By","value":"ASP.NET"}],"cookie":[],"responseTime":null,"body":"\nABCD\n The Send Message allows customers to send a message to a driver for a specified shipment
\nLoad must be tracking via the MacroPoint for Truckers App and customer account configured for order messaging in order to leverage this functionality
\nThe message will appear in the MacroPoint for Truckers App under the associated tracking session
\nRequest Structure
\nSend Message Tags
\nSend Message Responses
\nSend Message Errors
\n","urlObject":{"protocol":"https","path":["api","1.0","orders","SendMessage"],"host":["macropoint-lite","com"],"query":[],"variable":[]}},"response":[{"id":"da5bd7d7-9b40-48d1-85e5-56cb65d5a98c","name":"Send Message Example","originalRequest":{"method":"POST","header":[{"key":"Content-Type","type":"text","value":"application/xml"}],"body":{"mode":"raw","raw":"The Order Messaging Callback will push all driver messages on a specified order to a URL endpoint that is established by the Customer.
\nIndividual Order Messages can be retrieved from the URL via a GET Request.
\nOrder Messages are provided in real time as they are received on a live tracking session.
\nSample URL:
\nhttps://CustomerSpecifiedURL?OrderID=FB93D3FE546749F5A3385D1E2961A12B&Message=Will do&TrackingRequestID=3D3FE546749F5A3385D1E2961A12B&ID=Load123\n\nThe Form Submits Callback allows customers to receive form details and/or images for a specified shipment
\nForm Submits and Images (IE: POD's) are provided in real time as they are received on a live tracking session.
\nThe Form Details are customizable fields displayed to drivers in the MacroPoint for Truckers app to fill out when tracking your shipment. These are configured per the customers requirements
\nThis is a billable feature that must be included in the customers contract in order to access.
\nRequest Structure
\nFormItems Element
\nFormItem Attributes
\n**Data that has been customized by the company integrating with MacroPoint.
\nFormItem Element
\nFormItem Element Tags
\n**Data that has been customized by the company integrating with MacroPoint.
\n","urlObject":{"protocol":"https","path":["formsubmits"],"host":["CustomerSpecifiedURL"],"query":[],"variable":[]}},"response":[{"id":"b27f4bc6-29e0-422a-abdc-34d666cb2bd1","name":"Form Submits","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/xml","type":"text"}],"body":{"mode":"raw","raw":"\r\nThe FraudGuard API allows customers to receive additional statistics for a specified carrier, driver, or shipment to proactively indicate fraudulent behavior
\nThis feature requires additional account configuration to access. Please contact Descartes Service Desk or work with your implementation rep directly if you are interested.
\nRequest Structure
\nFraudGuard DOT Request Structure
\nFraudGuard DOT Response Structure
\nTop-Level Structure
\ndata.carrier.information
\ndata.carrier.connection_methods
\ndata.carrier.recent_shipments
\nReturns data from the 10 most recently completed loads
\ndata.carrier.performance
\n_meta (Metadata)
\nFraudGuard Errors
\n","urlObject":{"protocol":"https","path":["api","1.0","fraudguard"],"host":["macropoint-lite","com"],"query":[],"variable":[]}},"response":[{"id":"e5ba3359-31a9-4a07-87a5-21b99672277e","name":"FraudGuard DOT Example","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"dot_number\" : \"1234567\"\r\n}\r\n"},"url":"https://macropoint-lite.com/api/1.0/fraudguard"},"status":"Order Hyderlink Successful Response - 201","_postman_previewlanguage":"xml","header":[{"key":"Date","value":"Wed, 04 Mar 2020 16:09:09 GMT"},{"key":"Content-Type","value":"application/xml; charset=utf-8"},{"key":"Content-Length","value":"469"},{"key":"Connection","value":"keep-alive"},{"key":"Server","value":"Microsoft-IIS/10.0"},{"key":"X-Powered-By","value":"ASP.NET"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"carrier\": {\n \"information\": {\n \"dot_number\": \"1234567\",\n \"docket_number\": \"MC123456\",\n \"legal_name\": \"Test Customer Name\",\n \"address\": \"717 ATANDO AVE SUITE E\",\n \"city\": \"CHARLOTTE\",\n \"state\": \"NC\",\n \"zip_code\": \"28206\",\n \"phone\": \"999-999-9999\",\n \"mpid\": \"1234567\",\n \"total_power\": 77\n },\n \"connection_methods\": [\n \"Telematics\"\n ],\n \"recent_shipments\": [\n {\n \"track_via\": \"Telematics\",\n \"origin\": \"CHARLOTTE, NC\",\n \"destination\": \"SUMTER, SC\",\n \"tracking_status\": \"TrackingCompletedSuccessfully\",\n \"expired_date_time\": \"2025-11-12T21:12:58.0000000Z\"\n },\n {\n \"track_via\": \"Mobile\",\n \"origin\": \"HICKORY, NC\",\n \"destination\": \"THOMASVILLE, NC\",\n \"tracking_status\": \"TrackingCompletedSuccessfully\",\n \"expired_date_time\": \"2025-11-12T20:56:13.0000000Z\"\n },\n {\n \"track_via\": \"Mobile\",\n \"origin\": \"HICKORY, NC\",\n \"destination\": \"THOMASVILLE, NC\",\n \"tracking_status\": \"ExpiredWithDriverPhoneUnresponsive\",\n \"expired_date_time\": \"2025-11-12T19:01:56.0000000Z\"\n },\n {\n \"track_via\": \"Mobile\",\n \"origin\": \"Catawba, SC\",\n \"destination\": \"High Point, NC\",\n \"tracking_status\": \"TrackingCompletedSuccessfully\",\n \"expired_date_time\": \"2025-11-10T15:13:41.0000000Z\"\n },\n {\n \"track_via\": \"Mobile\",\n \"origin\": \"Catawba, SC\",\n \"destination\": \"Landis, NC\",\n \"tracking_status\": \"TrackingCompletedSuccessfully\",\n \"expired_date_time\": \"2025-11-07T20:38:50.0000000Z\"\n },\n {\n \"track_via\": \"Mobile\",\n \"origin\": \"Catawba, SC\",\n \"destination\": \"Landis, NC\",\n \"tracking_status\": \"ExpiredWithoutInstallation\",\n \"expired_date_time\": \"2025-11-07T17:45:09.0000000Z\"\n },\n {\n \"track_via\": \"Mobile\",\n \"origin\": \"Asheboro, NC\",\n \"destination\": \"Gastonia, NC\",\n \"tracking_status\": \"TrackingCompletedSuccessfully\",\n \"expired_date_time\": \"2025-11-06T21:09:49.0000000Z\"\n },\n {\n \"track_via\": \"Mobile\",\n \"origin\": \"Winston Salem, NC\",\n \"destination\": \"Gastonia, NC\",\n \"tracking_status\": \"TrackingCompletedSuccessfully\",\n \"expired_date_time\": \"2025-11-06T21:09:07.0000000Z\"\n },\n {\n \"track_via\": \"Mobile\",\n \"origin\": \"Benson, NC\",\n \"destination\": \"Yadkinville, NC\",\n \"tracking_status\": \"ExpiredWithoutLocation\",\n \"expired_date_time\": \"2025-11-04T21:30:09.0000000Z\"\n },\n {\n \"track_via\": \"Mobile\",\n \"origin\": \"MOORESVILLE, NC\",\n \"destination\": \"Charlotte, NC\",\n \"tracking_status\": \"TrackingCompletedSuccessfully\",\n \"expired_date_time\": \"2025-11-04T18:26:27.0000000Z\"\n }\n ],\n \"performance\": {\n \"total_orders\": 1172,\n \"carrier_since\": \"2024-05-31T12:27:07.0000000Z\",\n \"connection_method\": \"Telematics\",\n \"tracked_orders\": 597,\n \"tracking_percent\": 50.94,\n \"tracked_by_customers\": 30,\n \"spoofed_order_count\": 0,\n \"total_orders_currently_assigned\": 0,\n \"has_picked_up_in_state\": false,\n \"has_delivered_to_state\": false\n }\n }\n },\n \"severity\": \"none\",\n \"messages\": [],\n \"max_message_index\": -1,\n \"_meta\": {\n \"max_message_index\": -1,\n \"messages\": [],\n \"api_status\": 200,\n \"timestamp\": \"2025-11-12T22:30:10.3428644+00:00\",\n \"response_id\": \"3f9db786d2cd054210a2309654ae3820\"\n }\n}"}],"_postman_id":"b2d23793-c9ec-4512-8e09-e2faef5488e7"},{"name":"FraudGuard Phone Number","id":"bb6ef886-1211-4479-bb72-42b8f3672193","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"The FraudGuard API allows customers to receive additional statistics for a specified carrier, driver, or shipment to proactively indicate fraudulent behavior
\nThis feature requires additional account configuration to access. Please contact Descartes Service Desk or work with your implementation rep directly if you are interested.
\nRequest Structure
\nFraudGuard Phone Number Request Structure
\nFraudGuard Phone Number Response Structure
\nTop-Level Structure
\ndata.driver.recent_shipments
\nReturns data from the 10 most recently completed loads
\ndata.carrier.performance
\n_meta (Metadata)
\nFraudGuard Errors
\n","urlObject":{"protocol":"https","path":["api","1.0","fraudguard"],"host":["macropoint-lite","com"],"query":[],"variable":[]}},"response":[{"id":"c57edc31-3845-48b1-921a-44652c3bb52c","name":"FraudGuard Phone Number Example","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"phone_number\" : \"1234567890\"\r\n}\r\n"},"url":"https://macropoint-lite.com/api/1.0/fraudguard"},"status":"Order Hyderlink Successful Response - 201","_postman_previewlanguage":"xml","header":[{"key":"Date","value":"Wed, 04 Mar 2020 16:09:09 GMT"},{"key":"Content-Type","value":"application/xml; charset=utf-8"},{"key":"Content-Length","value":"469"},{"key":"Connection","value":"keep-alive"},{"key":"Server","value":"Microsoft-IIS/10.0"},{"key":"X-Powered-By","value":"ASP.NET"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"carrier\": {\n \"information\": {\n \"dot_number\": \"1234567\",\n \"docket_number\": \"MC123456\",\n \"legal_name\": \"Test Customer Name\",\n \"address\": \"717 ATANDO AVE SUITE E\",\n \"city\": \"CHARLOTTE\",\n \"state\": \"NC\",\n \"zip_code\": \"28206\",\n \"phone\": \"999-999-9999\",\n \"mpid\": \"1234567\",\n \"total_power\": 77\n },\n \"connection_methods\": [\n \"Telematics\"\n ],\n \"recent_shipments\": [\n {\n \"track_via\": \"Telematics\",\n \"origin\": \"CHARLOTTE, NC\",\n \"destination\": \"SUMTER, SC\",\n \"tracking_status\": \"TrackingCompletedSuccessfully\",\n \"expired_date_time\": \"2025-11-12T21:12:58.0000000Z\"\n },\n {\n \"track_via\": \"Mobile\",\n \"origin\": \"HICKORY, NC\",\n \"destination\": \"THOMASVILLE, NC\",\n \"tracking_status\": \"TrackingCompletedSuccessfully\",\n \"expired_date_time\": \"2025-11-12T20:56:13.0000000Z\"\n },\n {\n \"track_via\": \"Mobile\",\n \"origin\": \"HICKORY, NC\",\n \"destination\": \"THOMASVILLE, NC\",\n \"tracking_status\": \"ExpiredWithDriverPhoneUnresponsive\",\n \"expired_date_time\": \"2025-11-12T19:01:56.0000000Z\"\n },\n {\n \"track_via\": \"Mobile\",\n \"origin\": \"Catawba, SC\",\n \"destination\": \"High Point, NC\",\n \"tracking_status\": \"TrackingCompletedSuccessfully\",\n \"expired_date_time\": \"2025-11-10T15:13:41.0000000Z\"\n },\n {\n \"track_via\": \"Mobile\",\n \"origin\": \"Catawba, SC\",\n \"destination\": \"Landis, NC\",\n \"tracking_status\": \"TrackingCompletedSuccessfully\",\n \"expired_date_time\": \"2025-11-07T20:38:50.0000000Z\"\n },\n {\n \"track_via\": \"Mobile\",\n \"origin\": \"Catawba, SC\",\n \"destination\": \"Landis, NC\",\n \"tracking_status\": \"ExpiredWithoutInstallation\",\n \"expired_date_time\": \"2025-11-07T17:45:09.0000000Z\"\n },\n {\n \"track_via\": \"Mobile\",\n \"origin\": \"Asheboro, NC\",\n \"destination\": \"Gastonia, NC\",\n \"tracking_status\": \"TrackingCompletedSuccessfully\",\n \"expired_date_time\": \"2025-11-06T21:09:49.0000000Z\"\n },\n {\n \"track_via\": \"Mobile\",\n \"origin\": \"Winston Salem, NC\",\n \"destination\": \"Gastonia, NC\",\n \"tracking_status\": \"TrackingCompletedSuccessfully\",\n \"expired_date_time\": \"2025-11-06T21:09:07.0000000Z\"\n },\n {\n \"track_via\": \"Mobile\",\n \"origin\": \"Benson, NC\",\n \"destination\": \"Yadkinville, NC\",\n \"tracking_status\": \"ExpiredWithoutLocation\",\n \"expired_date_time\": \"2025-11-04T21:30:09.0000000Z\"\n },\n {\n \"track_via\": \"Mobile\",\n \"origin\": \"MOORESVILLE, NC\",\n \"destination\": \"Charlotte, NC\",\n \"tracking_status\": \"TrackingCompletedSuccessfully\",\n \"expired_date_time\": \"2025-11-04T18:26:27.0000000Z\"\n }\n ],\n \"performance\": {\n \"total_orders\": 1172,\n \"carrier_since\": \"2024-05-31T12:27:07.0000000Z\",\n \"connection_method\": \"Telematics\",\n \"tracked_orders\": 597,\n \"tracking_percent\": 50.94,\n \"tracked_by_customers\": 30,\n \"spoofed_order_count\": 0,\n \"total_orders_currently_assigned\": 0,\n \"has_picked_up_in_state\": false,\n \"has_delivered_to_state\": false\n }\n }\n },\n \"severity\": \"none\",\n \"messages\": [],\n \"max_message_index\": -1,\n \"_meta\": {\n \"max_message_index\": -1,\n \"messages\": [],\n \"api_status\": 200,\n \"timestamp\": \"2025-11-12T22:30:10.3428644+00:00\",\n \"response_id\": \"3f9db786d2cd054210a2309654ae3820\"\n }\n}"}],"_postman_id":"bb6ef886-1211-4479-bb72-42b8f3672193"},{"name":"FraudGuard Load Number","id":"a92dfbc7-b72a-4b9e-911b-131b5a93cd7b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"The FraudGuard API allows customers to receive additional statistics for a specified carrier, driver, or shipment to proactively indicate fraudulent behavior
\nThis feature requires additional account configuration to access. Please contact Descartes Service Desk or work with your implementation rep directly if you are interested.
\nRequest Structure
\nFraudGuard DOT Request Structure
\nFraudGuard DOT Response Structure
\nTop-Level Structure
\ndata.carrier.information
\ndata.carrier.connection_methods
\ndata.carrier.recent_shipments
\nReturns data from the 10 most recently completed loads
\ndata.carrier.performance
\n_meta (Metadata)
\nFraudGuard Errors
\n","urlObject":{"protocol":"https","path":["api","1.0","fraudguard"],"host":["macropoint-lite","com"],"query":[],"variable":[]}},"response":[{"id":"77173bf1-a329-4cc2-960a-7cb4a11872de","name":"FraudGuard DOT Example","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"identifier\": \"64817821\"\r\n}\r\n\r\n"},"url":"https://macropoint-lite.com/api/1.0/fraudguard"},"status":"Order Hyderlink Successful Response - 201","_postman_previewlanguage":"xml","header":[{"key":"Date","value":"Wed, 04 Mar 2020 16:09:09 GMT"},{"key":"Content-Type","value":"application/xml; charset=utf-8"},{"key":"Content-Length","value":"469"},{"key":"Connection","value":"keep-alive"},{"key":"Server","value":"Microsoft-IIS/10.0"},{"key":"X-Powered-By","value":"ASP.NET"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"carrier\": {\n \"information\": {\n \"mpid\": \"\"\n },\n \"connection_methods\": [],\n \"performance\": {\n \"total_orders\": 1843,\n \"carrier_since\": \"2024-06-04T15:01:15.0000000Z\",\n \"connection_method\": \"Tms, Telematics\",\n \"tracked_orders\": 1332,\n \"tracking_percent\": 72.27,\n \"tracked_by_customers\": 78,\n \"spoofed_order_count\": 0,\n \"total_orders_currently_assigned\": 18,\n \"has_picked_up_in_state\": true,\n \"has_delivered_to_state\": true\n }\n },\n \"driver\": {\n \"performance\": {\n \"total_orders\": 1,\n \"driver_since\": \"2025-10-29T18:25:42.7798359Z\",\n \"current_status\": \"OptIn\",\n \"tracked_orders\": 1,\n \"tracking_percent\": 100.0,\n \"tracked_by_customers\": 1,\n \"connected_by_carriers\": 1,\n \"spoofed_order_count\": 0,\n \"total_orders_currently_assigned\": 0,\n \"has_picked_up_in_state\": false,\n \"has_delivered_to_state\": true\n }\n }\n },\n \"severity\": \"none\",\n \"messages\": [],\n \"max_message_index\": -1,\n \"_meta\": {\n \"max_message_index\": -1,\n \"messages\": [],\n \"api_status\": 200,\n \"timestamp\": \"2025-11-13T17:58:43.0729478+00:00\",\n \"response_id\": \"ff07988611b6becdfb544a36da2a2b0a\"\n }\n}"}],"_postman_id":"a92dfbc7-b72a-4b9e-911b-131b5a93cd7b"}],"id":"4df61eba-e2e3-4ae0-a29d-a0a5bb76f1d3","_postman_id":"4df61eba-e2e3-4ae0-a29d-a0a5bb76f1d3","description":""}],"id":"e391673c-f564-4555-8597-0d348eda15a0","description":"The platform provides a set of supplemental endpoints/webhook options that allow customers to supply and retrieve additional shipment-related data beyond standard load visibility. These endpoints offer access to shipment tracking links, carrier details, and other supporting information that can be used to enrich internal systems or improve downstream workflows.
\n","_postman_id":"e391673c-f564-4555-8597-0d348eda15a0"},{"name":"Flat File Integration","item":[{"name":"Customer to Descartes MacroPoint FTP Uploads","item":[{"name":"Order Creation","id":"25084ad0-08d4-42bf-8f49-ba60a5db0005","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"url":"ftp.macropoint-lite.com/MPID","description":"Order Creation files allow customers to create, update, and stop tracking sessions within MacroPoint.
\nUpload Directory: \\Inbound
\nTotal number of columns: 18 (A-R)
\nTo successfully create a tracking session the following criteria must be met:
\nFile Format
\n","urlObject":{"path":["MPID"],"host":["ftp","macropoint-lite","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"25084ad0-08d4-42bf-8f49-ba60a5db0005"},{"name":"Change Order","id":"4093d018-6dcb-4bf7-b5aa-96409540eaf2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"url":"ftp.macropoint-lite.com/MPID","description":"Change Order files allow customers to make alterations to order details such as a carrier ID, address information, and appointment times. These data points can be updated by resubmitting a file with a matching Load ID.
\nUpload Directory: \\Inbound
Total number of columns: 18 (A-R)
To successfully update a tracking session the following criteria must be met:
\nChange Order Elements That Can Be Updated
\nUnacceptable Changes Overview
\n","urlObject":{"path":["MPID"],"host":["ftp","macropoint-lite","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"4093d018-6dcb-4bf7-b5aa-96409540eaf2"},{"name":"Stop Order","id":"bfe61d5e-bbf2-4ebf-beed-249ab4739953","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"url":"ftp.macropoint-lite.com/MPID","description":"Stop Order files allow customers to cancel orders or tracking requests.
\nUpload Directory: \\Inbound
\nOrders that have been created but are not yet tracking will be removed from Descartes MacroPoint's website if a Stop Order request is sent
Orders that have been created and are tracking will be moved to 'Stopped By Creator' status
Total number of columns: 18 (A-R)
\nTo successfully stop a tracking session the following criteria must be met:
Stop Order Elements that will Cancel the Order or Tracking Request
\n","urlObject":{"path":["MPID"],"host":["ftp","macropoint-lite","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"bfe61d5e-bbf2-4ebf-beed-249ab4739953"},{"name":"Carrier Wishlist","id":"2a4fa372-95d3-48f0-9104-1accb0fbe6a9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"url":"ftp.macropoint-lite.com/MPID","description":"Carrier Wishlist allows customers the ability to automatically import their current carrier list.
\nFile Upload & Authentication
All files should be uploaded to the FTPS or SFTP URL: ftp.macropoint-lite.com/{MPID}
Descartes MacroPoint will provide you:
\n- \n
- MPID \n
- FTPS/SFTP User ID \n
- FTPS/SFTP Password \n
Carrier Automation Downloadable Template
\nThe Carrier Automation file allows customers to import their current carrier list to MacroPoint.
\nUpload Directory: \\Partner
\nTotal number of columns: 10 (A-J)
\nTo successfully create a carrier list import file, the following criteria must be met:
\nFile Format
\n","urlObject":{"path":["MPID"],"host":["ftp","macropoint-lite","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"2a4fa372-95d3-48f0-9104-1accb0fbe6a9"}],"id":"ff0ef643-98da-429b-b930-5fa840eeb417","description":"File Upload & Authentication
All files should be uploaded to the FTPS or SFTP URL: ftp.macropoint-lite.com/{MPID}
Descartes MacroPoint will provide you:
\n- \n
MPID
\n \nFTPS/SFTP User ID
\n \nFTPS/SFTP Password
\n \n
Each type of file listed below must be uploaded to the Inbound directory:
\n- \n
- Create Orders, Change Orders, and Stop Orders: /Inbound \n
The Location Updates Callback will post all location updates received on an order to the Descartes SFTP/FTPS server
\nLocation updates are provided in real time as they are received on a live tracking session
\n","urlObject":{"path":["MPID"],"host":["ftp","macropoint-lite","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"9da2aaeb-2e67-4429-8e96-2c91cc562d23"},{"name":"Trip Event","id":"68bf0f9f-88eb-4686-9f5c-af9b8c197a5a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"url":"ftp.macropoint-lite.com/MPID","description":"The Trip Events Callback will post all arrival and departure trip events on a specified order to the Descartes MacroPoint SFTP/FTPS server
\nTrip Events are provided in real time as they are received on a live tracking session.
\nEvents are associated to the individual stop on the tracking session.
\nEvent Code Descriptions
\n","urlObject":{"path":["MPID"],"host":["ftp","macropoint-lite","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"68bf0f9f-88eb-4686-9f5c-af9b8c197a5a"},{"name":"Order Status","id":"8f5b7014-acce-48fe-a3b3-e2d4592e0a73","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"url":"ftp.macropoint-lite.com/MPID","description":"The Order Status Callback will post all order status changes on a specified order to the Descartes MacroPoint SFTP/FTPS server
\nOrder Status updates are provided in real time as they are received on a live tracking session.
\nOrder Status
\n","urlObject":{"path":["MPID"],"host":["ftp","macropoint-lite","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"8f5b7014-acce-48fe-a3b3-e2d4592e0a73"},{"name":"Schedule Alerts","id":"f1dcfd07-177f-44f1-adfc-527659b95d05","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"url":"ftp.macropoint-lite.com/MPID","description":"The Schedule Alerts Callback will post all ETA updates received on an order to the Descartes SFTP/FTPS server
\nDescartes MacroPoint will recalculate and return a new schedule alert with each corresponding location update received on the order
\nScheduled Alert Codes:
\n","urlObject":{"path":["MPID"],"host":["ftp","macropoint-lite","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"f1dcfd07-177f-44f1-adfc-527659b95d05"}],"id":"5b18408f-f7e8-4f79-8319-305b98628c25","description":"Descartes MacroPoint allows a customer to obtain updates via text files for a specific order including Location Updates & Trip Events from a Descartes FTP server.
\nAll files can be picked up by connecting to the FTPS or SFTP URL: ftp.macropoint-lite.com/{MPID}
\nDescartes MacroPoint will provide you:
\n- \n
- MPID \n
- FTPS/SFTP User ID \n
- FTPS/SFTP Password \n
All files will be posted to the root folder, not a specified directory.
\nFiles will be named YYYYMMDD-HHMI-UID-Event as defined below:
\n- \n
- YYYY four digit year \n
- MM zero filled, two digit month \n
- DD zero filled, two digit day \n
- HH zero filled, hour, 24 hour format (so 1:00 pm is represented by 13) \n
- MI zero filled, minute \n
- UID zero filled, 32 character unique identifier \n
- Event one of the following: AR, LD, UL, DP, LC \n
An example location update file name would be 20130711-2258-FABEA8BDE8B84DA8A37196A39056D5C1-LC.txt
\nEvent Code Descriptions
\n","_postman_id":"5b18408f-f7e8-4f79-8319-305b98628c25"}],"id":"3a2f0a88-d0ba-448d-a871-417daf230500","description":"Descartes MacroPoint offers Customers the ability to Create Orders, Change Orders, and Stop Orders via the Descartes MacroPoint secure FTP.
\nThe MacroPoint FTP server uses the same TLS certificates as https://visibility.macropoint.com. To obtain these manually you may use a web browser (example with Firefox):
\n1 - Navigate to https://visibility.macropoint.com and log in. Make sure you are logged in and not attempting to use the certificates from the Descates unified login page.
\n2 - Click the image of the padlock on the address bar
\n3 - Click connection secure
\n4 - Click more information
\n5 - Click view certificate
\n6 - You will be presented with three headings for each of the certificates
\n7 - For each heading you will scroll down to the \"Miscellaneous\" block where you will be given the option to download the cert
\nIP Addresses that should be whitelisted by the Customer when consuming API Callbacks
\n- \n
- 52.141.169.150 \n
- 52.141.169.192/28 \n
- 52.152.27.96/28 \n
- 52.237.140.174 \n
IP Addresses that should be whitelisted by the Customer when consuming FTP Callbacks
\n- \n
- 52.141.172.92 \n
- 52.237.177.208/28 \n
- 52.252.168.41 \n
- 52.252.211.86 \n
Acceptable Time Zones
\n","event":[{"listen":"prerequest","script":{"id":"61de9016-c35f-4c5f-853f-5a4c152de931","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"b92b7cff-c783-4522-8592-a9d3a2c511b7","type":"text/javascript","exec":[""]}}],"_postman_id":"1deb6921-3fa0-4616-abb5-334490569bdf"},{"name":"Country Codes","item":[],"id":"5b9476f9-577e-4e58-a45f-68c2e47e7976","description":"Acceptable Country Codes:
\nNote: In compliance with GDPR regulations, customers must receive consent from drivers to submit European phone numbers for tracking
\nFor numerical country codes, the '+' must be supplied in with the phone number. Example: +525555555555
\n","_postman_id":"5b9476f9-577e-4e58-a45f-68c2e47e7976"},{"name":"Ocean SCAC Codes","item":[],"id":"39e7ed40-3644-4b59-ac0c-d8f536a240b7","description":"SCAC Codes for Ocean Tracking:
\n","_postman_id":"39e7ed40-3644-4b59-ac0c-d8f536a240b7"},{"name":"Airline Prefix Codes","item":[],"id":"d84cdc00-757f-4e67-a79a-7d2cbe8827f8","description":"Airline Prefix Codes for Air Tracking:
\n","_postman_id":"d84cdc00-757f-4e67-a79a-7d2cbe8827f8"}],"id":"9900734e-840d-4451-948a-1ab63b40f8ca","description":"Descartes MacroPoint recomends the following best practice procedures for obtaining the highest level of successfully created orders tracking:
\n- \n
Best Practies:
\n- \n
Send all values (Mobile, VehicleID, and TrailerID) as often as possible
\n- \n
Descartes MacroPoint pulls optimal tracking value based on carrier’s integration
\n \nDescartes MacroPoint utilizes mobile failover when the VehicleID or TrailerID are invalid or do not pull valid data after two hours of attempting to track
\n \n
\nIf you get back a HTTP 400 - Number Value is required for Number Type 'Mobile', display in your system the driver cell is required for this shipment
\n \nIf you get back a HTTP 201 with a TrackingRequestID only and no OrderID in the XML response then use below logic for display to user
\n- \n
In the partner status call we pass back a field called “ConnectionMethod\" per carrier if you can store that then use logic below
\n- \n
If telematics, then display “Truck and Trailer # Needed”
\n \nIf TMS, then no additional info needed
\n \nIf no connection method, “Driver Cell Needed”
\n \n
\n
\nIf you get back a HTTP 201 with a OrderID only filled in then all set – no additional info needed
\n \nIf you get back a HTTP 201 with a OrderID and TrackingRequestID filled in then all set – no additional info needed
\n \nSend a Change Order when any driver values are added/Changed (Truck, Mobile, Trailer) or anytime carrier is re-saved
\n \n
\nMacroPoint OrderID vs TrackingRequestID clarification:
\n- \n
They can be used interchangeably for Change/Stop Order calls
\n \nOnly TrackingRequestID is returned when an order is sent with a mapped carrier code and not enough information to enable tracking. Order is still waiting on more details before it is able to track.
\n \nOnly OrderID is returned when an order is created with a cell phone number and non-mapped carrier ID
\n \nTrackingRequestID and OrderID are returned when the an order is sent with a mapped carrier code and enough information to enable tracking
\n \n
\nKeep TMS/ERP and Descartes MacroPoint in sync as the driver information is populated in TMS/ERP
\n \nUtilize Change Order in real time to immediately update the order in Descartes MacroPoint. Examples:
\n- \n
Appointment time changes
\n \nAddress changes
\n \nDriver information
\n \n
\nUtilize when TMS/ERP is updated with arrival/departure captured
\n \nStop Order for new CarrierID and new Create Order request
\n \nTo override default geofence location send lat/long coordinates for each stop along with addresses
\n \nConsume and display Descartes MacroPoint tracking status in internal system
\n \nImplement Order Hyperlink API and embed Descartes MacroPoint URL in TMS/ERP to allow ops users to function out of a single system
\n \nImplement Partner Status API and display carrier integration method in TMS carrier profile screen so operations users understand how a carrier is integrated with Descartes MacroPoint
\n \nIn CreateOrder, TrackStartDateTime is when MacroPoint will begin attepting to track the load. The recommendation is to set this value to 2-4 hours prior to the first pickup time.
\n \nIn CreateOrder, TrackDurationInHours is how long MacoPoint will attempt to track the load for and should be determined based on transit time. The recommentation would be to add 24-28 hours of additional time to account for delays.
\n \nIn CreateOrder, MaxiumumAllowableDrivingHoursPerDay is used for ETA and ahead/behind schedule alerting. If it is a team driver load, the recommentation is to set this to 24.
\n \nTrip Sheet Address should mirror address provided to carrier
\n \nUtilizing User Defined Fields provides users increased value when interfacting with MacroPoint's Control Tower. They display on the load detail view giving users visibilty to important shipment information. They also give users the ability to search for loads relevant to them. Examples: Rep Name, PO #, BOL #, Customer Name
\n \n