Skip to main content

One-way

Move a single vehicle from one location to another.

Example Request#

POST /v1/one-way-moves
{
"ready_by_time_utc": "2022-03-25T14:00:00Z",
"move": {
"dealer_contact": "Jane Smith",
"special_instructions": "Check in at service center",
"vehicle": {
"stock": "BK0018",
"vin": "5GAKRBED5BJ262438",
"year": "2011",
"make": "Buick",
"model": "Enclave",
"color": "white",
"manual": false
},
"pickup_location": {
"name": "Denny's Automobiles",
"address_one": "11161 Research Plaza Way",
"city": "Richmond",
"state": "VA",
"zip": "23236"
},
"delivery_location": {
"name": "Lot 4",
"address_one": "888 Broad St",
"city": "Richmond",
"state": "VA",
"zip": "23220"
}
}
}

Body Params#

FieldTypeRequired?Description
ready_by_time_utcStringRequiredThe date and time in YYYY-MM-DD hh:mm:ss format, using UTC/Zulu time. Reference
dealer_contactStringOptionalPoint of contact for our driver when arriving at the pickup location
special_instructionsStringOptionalAdditional information such as where to park or a number to call upon arrival
reference_idStringOptionalInternal reference number number such as a repair order #
stockStringOptionalInternal stock number associated with the vehicle
vinStringOptionalVehicle Identification Number associated with the vehicle
yearStringOptionalYear the vehicle was manufactured
makeStringRequiredThe make of the vehicle (e.g., "Ford")
modelStringRequiredThe model of the vehicle (e.g., "F-150")
colorStringOptionalThe color of the vehicle
manualBooleanRequiredWhether or not the vehicle has a manual transmission (true) or an automatic (false)
nameStringRequiredName associated with the pickup location
address_oneStringRequiredThe street address of the pickup location
address_twoStringOptionalOptional sub-address of the pickup location
cityStringRequiredThe city that the pickup address is associated with
stateStringRequiredThe state that the pickup address is associated with
zipStringRequiredThe 5-digit Zip Code that the pickup address is associated with

Request Object Structure#

{
ready_by_time_utc,
move: {
dealer_contact,
special_instructions,
reference_id,
vehicle: {
stock,
vin,
year,
make,
model,
color,
manual
},
pickup_location: {
name,
address_one,
address_two,
city,
state,
zip
},
delivery_location: {
name,
address_one,
address_two,
city,
state,
zip
}
}
}

Example Response#

For additional information, see the response section.

200 /v1/one-way-moves
{
"move": {
"move_id": 10033,
"status": null,
"cancel_status": null,
"pickup_started": null,
"pickup_arrived": null,
"pickup_successful": null,
"delivery_started": null,
"delivery_arrived": null,
"delivery_successful": null,
"tracking_link": null,
"move_uri": "https://api.hopdrive.com/v1/moves/10033",
"lane_uri": "https://api.hopdrive.com/v1/lanes/4990",
"reference_id": null,
"dealer_contact": "Jane Smith",
"special_instructions": "Check in at service center",
"vehicle": {
"stock": "BK0018",
"vin": "5GAKRBED5BJ262438",
"year": "2011",
"make": "Buick",
"model": "Enclave",
"color": "white",
"manual": false
},
"pickup_location": {
"name": "Denny's Automobiles",
"address_one": "11161 Research Plaza Way",
"city": "Richmond",
"state": "VA",
"zip": "23236",
"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",
"address_one": "888 W Broad St",
"city": "Richmond",
"state": "VA",
"zip": "23220",
"lat": 37.550209,
"lon": -77.4494655,
"google_place_id": "Eic4ODggVyBCcm9hZCBTdCwgUmljaG1vbmQsIFZBIDIzMjIwLCBVU0EiGxIZChQKEgkPDdZ3SBGxiRG2k4LRA4YLvxD4Bg",
"location_id": 2141,
"full_address": "888 W Broad St, Richmond, VA 23220, USA"
}
},
"ready_by_time_utc": "2022-03-25T14:00:00Z"
}