The service contains endpoints for dispatch functions on brokerage moves.
| name | description |
|---|---|
| GET /carrierDispatch/logisticsTender/getNextTenderInfo/{movementId} | This method checks to see if a payee is setup to receive EDI, and if so, return basic info about the tender to be sent. |
| POST /carrierDispatch/addPendingLock/{movementId} | Adds a pending lock on the movement. |
| POST /carrierDispatch/assign/{movementId} | This method allows assignment of a carrier to a movement. |
| POST /carrierDispatch/cancel/{movementId} | This method cancels an in-progress or delivered move. |
| POST /carrierDispatch/clearCarrier/{movementId} | This method clears the assigned carrier from the movement. |
| POST /carrierDispatch/clearNextStop/{movementId} | This method clears the next available stop for the given movement. |
| POST /carrierDispatch/clearStop/{stopId} | This method clears the specified stop using the parameters given. |
| POST /carrierDispatch/deliver/{movementId} | This method delivers out the specified movement with the current date/time as the stop arrival and departure times. |
| POST /carrierDispatch/lockMovement/{movementId} | Request a lock to be placed on the specified move. If successful, a lock will be placed on the movement for the time period specified in the dispatch control file field "lock_clock_minutes". |
| POST /carrierDispatch/logisticsTender/sendCancelTender/{movementId} | This method generates an EDI cancel load tender for the movement. |
| POST /carrierDispatch/logisticsTender/sendNonCancelTender/{movementId} | This method generates an EDI original or change load tender for the movement. |
| POST /carrierDispatch/setPay/{movementId} | Sets the carrier pay for a given movement. |
| POST /carrierDispatch/unlock/{movementId} | This will attempt to unlock a locked move. An exception will be thrown if the move is not locked, the locked user is different than the one making the unlock request, or the requesting user does not have permission to unlock a movement. |