Skip to main content

Get vehicle information

GET /v2/post_checkout/orders/{order_id}/pickup/vehicle_info

Retrieves information about the customer's vehicle. With the make and model, the runner can easily find the vehicle within the store's designated pickup area. With the license plate number, the runner can verify that they have the correct customer before placing the order in the vehicle.

Security

NameInDescription
AuthorizationheaderThe Authorization header with the bearer token acquired during authentication.

Parameters

NameInTypeRequiredDescription
order_idpathstringRequired

The ID of the order.

Request

None.

Request examples

curl --request GET \
--url 'https://connect.instacart.com/v2/post_checkout/orders/{order_id}/pickup/vehicle_info' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer <token>'

Response

FieldTypeRequiredDescription
vehicle_infoVehicleInfoOptional

The vehicle info.

VehicleInfo Object

FieldTypeRequiredDescription
idintegerRequired

The ID of the vehicle.

modelstringRequired

The model of the vehicle.

vehicle_typestringRequired

The type of vehicle.

license_platestringOptional

The license plate of the vehicle.

colorstringRequired

The vehicle color.

color_hexstringOptional

The vehicle color in hexadecimal.

Response examples

200 Success

{
"vehicle_info": {
"id": 123,
"model": "SomeCarModel",
"vehicle_type": "sedan",
"license_plate": "F4K3L1C3NC3",
"color": "silver",
"color_hex": "#E8E8E8"
}
}

4XX Errors

Error responses return either a single error or multiple errors.

HTTP CodeCauseError MessageError CodeError Meta
400Invalid params"Pickup unavailable for non-pickup orders"4001Not applicable
404Order not found"Resource not found"4000Not applicable