Skip to main content

Get pickup instructions

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

Retrieves a set of instructions for customers to follow when picking up their order from a retailer. Instructions can be created for whichever types of pickup the retailer supports: curbside, locker, or in-store. The instructions can include text and optional images.

Security

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

Parameters

NameInTypeRequiredDescription
order_idpathstringRequiredThe ID of the order.

Request

None.

Request examples

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

Response

FieldTypeRequiredDescription
pickup_instructionsArray(PickupInstruction)RequiredThe list of order-specific pickup instructions.

PickupInstruction Object

FieldTypeRequiredDescription
categorystringRequiredThe type of pickup {curbside, locker, in_store}.
instructionstringRequiredThe instruction on how to pick up the order.
instruction_imagesArray(PickupInstructionImage)OptionalAn image to support the instructions for picking up the order.

PickupInstructionImage Object

FieldTypeRequiredDescription
urlstringRequiredThe image URL.
valuestringOptionalThe description of the image.

Response examples

200 Success

{
"pickup_instructions": [
{
"category": "curbside",
"instruction": "mock instruction",
"instruction_images": [
{
"url": "image url",
"value": "image description"
}
]
}
]
}

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