Skip to main content

Create or update vehicle information

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

Creates or updates the information about the customer's vehicle, such as the model, color, and license plate. When the customer arrives for curbside pickup, retailer employees use the vehicle information to locate the customer and fulfill the order.

Security

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

Parameters

NameInTypeRequiredDescription
order_idpathstringRequiredThe order ID.

Request

FieldTypeRequiredDescription
modelstringOptionalThe vehicle's make/model.
vehicle_typestringOptionalThe vehicle's type.
license_platestringOptionalThe vehicle's license plate number.
colorstringOptionalThe vehicle's color.

Request examples

curl --request PUT \
--url 'https://connect.instacart.com/v2/post_checkout/orders/{order_id}/pickup/vehicle_info' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
"model": "string",
"vehicle_type": "hatchback",
"license_plate": "string",
"color": "black"
}'

Response

FieldTypeRequiredDescription
vehicle_infoVehicleInfoRequiredThe created/updated vehicle info.

VehicleInfo Object

FieldTypeRequiredDescription
idintegerRequiredThe ID of the vehicle.
modelstringRequiredThe model of the vehicle.
vehicle_typestringRequiredThe type of vehicle.
license_platestringOptionalThe license plate of the vehicle.
colorstringRequiredThe vehicle color.
color_hexstringOptionalThe 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
400Color is not valid"is not included in the list"1001{"key":"color"}
400Vehicle type is not valid"is not included in the list"1001{"key":"vehicle_type"}
404Order not found"Resource not found"4000Not applicable