GET /moves/:id

A GET to the /moves endpoint allows your application to fetch current information about a specific move or pair of moves (such as a concierge and loaner pair). Requests made to this endpoint require an authorization header using your authentication token:

Auth Header

curl --request GET \
  --url https://api.hopdrive.com/v1/moves/:id \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer <your token>' \
  --data '{ ... }'

When you successfully request a move, you will get back a move_id unique to that request. A GET request to the endpoint https://api.hopdrive.com/moves/<move_id> will return the same response as the original request for the associated move type.

Example Request

GET /v1/moves/10033

Example Response

200 /v1/moves/10033

{
  "ready_by_time_utc": "2022-03-24T14:00:00+00:00",
  "earliest_available_time": "2022-03-24T14:00:00+00:00",
  "move": {
    "id": 10033,
    "status": null,
    "rooftop": 42,
    "settled": true,
    "pickup_started": null,
    "pickup_arrived": null,
    "pickup_successful": null,
    "delivery_started": null,
    "delivery_arrived": null,
    "delivery_successful": null,
    "cancel_status": "not cancelled",
    "cancel_reason": null,
    "dealer_contact": "Jane Smith",
    "special_instructions": "Check in at service center",
    "reference_num": null,
    "move_details_url": "https://dealer.hopdrive.io/moves/10033",
    "tracking_link": null,
    "move_uri": "https://api.hopdrive.com/v1/moves/10033",
    "lane_uri": "https://api.hopdrive.com/v1/lanes/4990",
    "vehicle": {
      "stock": "BK0018",
      "vin": "5GAKRBED5BJ262438",
      "year": "2011",
      "make": "Buick",
      "model": "Enclave",
      "color": "white",
      "manual": false
    },
    "workflowset": 3,
    "pickup_workflow_data": {
      "damages": "",
      "odometer": "525",
      "signer-name": "Jane Smith",
      "driver-notes": "",
      "damages-note-1": "Damage note 1"
    },
    "delivery_workflow_data": {
      "additional_field": "Hello World!"
    }
  },
  "pickup_location": {
    "name": "Denny's Automobiles",
    "lat": 37.5050257,
    "lon": -77.6013313,
    "google_place_id": "ChIJkxCQwnBtsYkR1QqrxNduupo",
    "location_id": 2246,
    "full_address": "11161 Research Plaza Way, Richmond, VA 23236, USA"
  },
  "delivery_location": {
    "name": "Lot 4",
    "lat": 37.550209,
    "lon": -77.4494655,
    "google_place_id": "Eic4ODggVyBCcm9hZCBTdCwgUmljaG1vbmQsIFZBIDIzMjIwLCBVU0EiGxIZChQKEgkPDdZ3SBGxiRG2k4LRA4YLvxD4Bg",
    "location_id": 2141,
    "full_address": "888 W Broad St, Richmond, VA 23220, USA"
  },
  "pickup_photos": [
    {
      "id": "15a103eb-d44b-4e06-ba85-d2d6d7acbde3",
      "status": "done",
      "name": "rear-interior",
      "url": "https://s3.us-east-1.amazonaws.com/social-auto-new/prod/task_images/W1721660917077114-photoName.jpeg",
      "time": "2022-09-20T03:00:48.548211+00:00",
      "lat": 38.03299,
      "lon": -78.44548
    },
    {
      "id": "bac5cde3-48dc-4865-ba7e-85194ba0a673",
      "status": "done",
      "name": "instrument-cluster",
      "url": "https://s3.us-east-1.amazonaws.com/social-auto-new/prod/task_images/yq421660917160752-photoName.jpeg",
      "time": "2022-09-20T03:00:48.548211+00:00",
      "lat": 38.03299,
      "lon": -78.44548
    },
    {
      "id": "15a103eb-d44b-4e06-ba85-d2d6d7acbde3",
      "status": "pending",
      "name": "damages-1",
      "url": null,
      "time": "2022-09-20T03:00:48.548211+00:00",
      "lat": 38.03299,
      "lon": -78.44548
    }
  ],
  "delivery_photos": [
    {
      "id": "e8ca6a9f-5789-4700-84d2-e944ebf67d0d",
      "status": "done",
      "name": "front-interior",
      "url": "https://s3.us-east-1.amazonaws.com/social-auto-new/prod/task_images/a08o1660917066555-photoName.jpeg",
      "time": "2022-09-20T03:00:48.548211+00:00",
      "lat": 38.03299,
      "lon": -78.44548
    },
    {
      "id": "153884ef-8f6d-495d-bc19-99705b7bc5f7",
      "status": "pending",
      "name": "front-interior-1",
      "url": null,
      "time": "2022-09-20T03:00:48.548211+00:00",
      "lat": 38.03299,
      "lon": -78.44548
    }
  ]
}

If there are any damage notes associated with the vehicle, they can be found in pickup_workflow_data or delivery_workflow_data and can be mapped to the corresponding damage photo by name. In the sample response above, e.g., the photo named damages-1 in pickup_photos corresponds to damages-note-1 in pickup_workflow_data.

Additional Responses

If there is an associated charge on the move, the response will include the charge object. The charge object will include all the charge details associated with the move.

See the charge object documentation for more information about the response object.