Skip to main content

Response

A successful POST to a moves endpoint will return a modified request object, including additional information about the move or pair of moves.

For unsuccessful requests, please refer to Error Handling and Error Codes.

Additional Fields#

For each individual move, the following new fields are included in the response:

  • move_uri - A URI string referencing the /moves resource for the associated move created

  • lane_uri - A URI string referencing the /lanes resource for the lane (pickup and delivery location pair) associated with the move created

  • status - The current status of the move

  • cancel_status - If a cancellation has been requested, the current status will be reflected here

  • pickup_started - Timestamp for when the pickup portion of the move was started

  • pickup_arrived - Timestamp for when the driver arrived at the pickup location

  • pickup_successful - Timestamp for when the pickup portion of the move was completed

  • delivery_started - Timestamp for when the delivery portion of the move was started

  • delivery_arrived - Timestamp for when the driver arrived at the delivery location

  • delivery_successful - Timestamp for when the delivery portion of the move was completed

  • tracking_link - URL to a live tracking map of the move

When a request is sent, the individual location fields are parsed, combined, and sent through Google's Places API in order to cleanse and retrieve a known, standardized location. For each location object within a move, the following new fields are included in the response for comparison:

  • lat - The latitude associated with the found location
  • lon - The longitude associated with the found location
  • google_place_id - The ID used by Google to identify the found location
  • location_id - The ID assigned to the location by HopDrive that can be used to retrieve information through the /locations resource
  • full_address - The full address as returned by the Google Places API, this can be compared to the fields on the request object to ensure accuracy