go back Home

MovementService

This service provides methods for retrieving movements, flipping them between brokerage and asset types, sending load confirmations and managing extra pay on the movement.

Operations

name description
GET /movements Retrieves a List of movements having a full or partial match of the ID to the given argument.
GET /movements/customTemplates Retrieves a list of custom document designer templates. Used in conjunction with sending rate confirmations.
GET /movements/search Searches the database for movements matching the given request parameters.
GET /movements/userSavedSearch Retrieves a List of RowMovement objects based on an existing saved search.
GET /movements/{id} Retrieves the Movement specified by the ID.
GET /movements/{id}/confirmationDefaults Retrieves the default values for the carrier contact to receive the rate confirmation.
GET /movements/{id}/otherPay Returns a list of Driver Extra Pay records for a given movement
GET /movements/{id}/otherPay/{otherPayId} Returns the requested driver extra pay record.
GET /movements/{id}/route Retrieves the step by step route information from the connected mileage software. Based on EntryMovement.showRoute();
GET /movements/{id}/routeForMap Retrieves the step by step route information from the connected mileage software. Based on EntryMovement.showRoute(); DEFUNCT and deprecated until we manage to get PCMiler to work with us on maps.
POST /movements/{id}/setBrokerageFlag
POST /movements/{id}/updateOperationalStatus Updates the operational status field on the movement. Movements must be of LTL type.
PUT /movements/{id}/otherPay Creates other pay records tied to the movement record.
PUT /movements/{id}/sendConfirmation Sends a confirmation to the the carrier, via return PDF, email, and fax.