Skip to main content

Concierge

Pick up your customer's vehicle and bring it in for service, or return it to them. Need to issue your customer a loaner vehicle in the meantime? See Concierge + Loaner.

Example Request#

POST /v1/concierge-moves
{
"appointment_time_utc": "2022-03-25T14:00:00Z",
"customer_name": "Harry Stevens",
"customer_phone": "888-888-8888",
"customer_action": "pickup",
"customer_move": {
"reference_id": "RO# 12345",
"dealer_contact": "Jane Smith",
"special_instructions": "Vehicle parked in spot 13C",
"vehicle": {
"stock": "BK0018",
"vin": "5GAKRBED5BJ262438",
"year": "2011",
"make": "Buick",
"model": "Enclave",
"color": "white",
"manual": false
},
"pickup_location": {
"name": "210 S Mulberry St",
"address_one": "210 S Mulberry St",
"city": "Richmond",
"state": "VA",
"zip": "23220"
},
"delivery_location": {
"name": "Denny's Automobiles",
"address_one": "11161 Research Plaza Way",
"city": "Richmond",
"state": "VA",
"zip": "23236"
}
}
}

Body Params#

FieldTypeRequired?Description
appointment_time_utcStringRequiredThe date and time in YYYY-MM-DD hh:mm:ss format, using UTC/Zulu time. Reference
customer_nameStringRequiredThe name of the customer whose vehicle is being moved
customer_phoneStringRequiredThe phone number of the customer (automated SMS updates will be sent to this number)
customer_actionStringRequiredThe type of concierge move being performed, either "pickup" or "return" customer action types
dealer_contactStringOptionalPoint of contact for our driver when arriving at the service 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 location
address_oneStringRequiredThe street address of the location
address_twoStringOptionalOptional sub-address of the location
cityStringRequiredThe city that the location address is associated with
stateStringRequiredThe state that the location address is associated with
zipStringRequiredThe 5-digit Zip Code that the location address is associated with

Customer Action Types#

  • pickup - Pick up a customer's vehicle from their location (residence, work, etc.) and bring their car to the service center.

  • return - Return your customer's vehicle from the service center to their location (residence, work, etc.).

Request Object Structure#

{
appointment_time_utc,
customer_name,
customer_phone,
customer_action,
customer_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/concierge-moves
{
"customer_move": {
"move_id": 10042,
"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/10042",
"lane_uri": "https://api.hopdrive.com/v1/lanes/6769",
"reference_id": "RO# 12345",
"dealer_contact": "Jane Smith",
"special_instructions": "Vehicle parked in spot 13C",
"vehicle": {
"stock": "BK0018",
"vin": "5GAKRBED5BJ262438",
"year": "2011",
"make": "Buick",
"model": "Enclave",
"color": "white",
"manual": false
},
"pickup_location": {
"name": "210 S Mulberry St",
"address_one": "210 S Mulberry St",
"city": "Richmond",
"state": "VA",
"zip": "23220",
"lat": 37.5500942,
"lon": -77.475998,
"google_place_id": "EioyMTAgUyBNdWxiZXJyeSBTdCwgUmljaG1vbmQsIFZBIDIzMjIwLCBVU0EiGxIZChQKEgkvOB-B4xOxiRGtaNzxgEUxRBDSAQ",
"location_id": 343,
"full_address": "210 S Mulberry St, Richmond, VA 23220, USA"
},
"delivery_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"
}
},
"ready_by_time_utc": "2022-03-25T14:00:00Z",
"customer_name": "Harry Stevens",
"customer_phone": "888-888-8888",
"customer_action": "pickup"
}