Move Object

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

• rooftop - The rooftop the move was created for

• settled - A move will be marked as settled 7 days after being completed. This means that the move's charge (see charge object) has been finalized and the move is ready to be invoiced.

• 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

• workflowset - The workflow set used to define pickup and delivery workflows to use on the move

• earliest_available_time - The earliest time the move can be started based on the location's availability (Business hours, holidays, etc.)

• message - If the earliest_available_time is affected by a holiday or other closure, a description of the closure will be included here

• driver_name - The name of the driver assigned to the move, if one has been assigned

• usecase_key - The use-case key describing the type of workflow this move is part of. See Usecase Keys below for possible values.

• scenario_key - The scenario key from the dispatch scenario associated with this move. See Scenario Types below for possible values.

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

---

Usecase Keys

The usecase_key field indicates the type of workflow the move is part of.

Key	Description
round-trip	Round Trip
one-way	One way
concierge-pu	Concierge Pickup
concierge-ret	Concierge Return
concierge-loaner-pu	Concierge + Loaner pickup
concierge-loaner-ret	Concierge + Loaner return
one-way-hangtag	One way with hangtag staged indicator
concierge-hangtag	One way concierge with hangtag return ready indicator
concierge-loaner-hangtag	Concierge + loaner with hangtag return ready indicator
one-way-shuttle	One way move with a customer provided shuttle
one-way-hangtag-shuttle	One Way Shuttle with hangtag staged indicator

---

Scenario Types

The scenario_key field indicates the dispatch scenario associated with the move.

Scenario	Description
Stranded with ride after	Stranded with ride after
Shuttle driver providing rides	Shuttle driver providing rides
Stranded with Shuttle After	Stranded with Shuttle After
Concierge with Vehicle at Consumer	Concierge with Vehicle at Consumer
Concierge with Vehicle at Dealership	Concierge with Vehicle at Dealership
Concierge+Loaner with vehicle at Consumer	Concierge+Loaner with vehicle at Consumer
Concierge+Loaner with Vehicle at Dealership	Concierge+Loaner with Vehicle at Dealership
Ride before Stranded	Ride before Stranded
Round Trip with Flexible Sequencing	Round Trip with Flexible Sequencing
Round Trip without Flexible Sequencing	Round Trip without Flexible Sequencing
Shuttle Linker	Shuttle Linker
Stranded with ride on both sides	Stranded with ride on both sides
Base	A single drive move that links with its previous and next move
Round Trip Flex with Ride After	A pair of drive moves with a ride after (has flexible sequencing)
Round Trip Flex with Ride Before	A pair of drive moves with a ride before (has flexible sequencing)
Round Trip Flex with Ride on Both Sides	A pair of drive moves with a ride before and after (has flexible sequencing)
Round Trip with Ride After	A pair of drive moves with a ride after
Round Trip with Ride Before	A pair of drive moves with a ride before
Round Trip with Ride on Both Sides	A pair of drive moves with a ride before and after
Stranded with No Rides	A single drive move with no rides
Triangle	Drive move with two rides; the customer pays the full cost of both attached rides
Shuttle Run	A shuttle driver executing a multi-stop passenger route
Mobile Service Run	A mobile service technician executing a multi-stop service route
Parts Delivery Route	A delivery driver executing a multi-stop parts delivery route