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

Name	In	Description
Authorization	header	The Authorization header with the bearer token acquired during authentication.

Parameters

Name	In	Type	Required	Description
order_id	path	string		The ID of the order.

Request

None.

Request examples

cURL

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

Java

HttpResponse<String> response = Unirest.get("https://connect.instacart.com/v2/post_checkout/orders/{order_id}/pickup/details")
  .header("Accept", "application/json")
  .header("Authorization", "Bearer <token>")
  .asString();

Python

import http.client

conn = http.client.HTTPSConnection("connect.instacart.com")

headers = {
    'Accept': "application/json",
    'Authorization': "Bearer <token>"
    }

conn.request("GET", "/v2/post_checkout/orders/{order_id}/pickup/details", headers=headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))

Go

package main

import (
	"fmt"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "https://connect.instacart.com/v2/post_checkout/orders/{order_id}/pickup/details"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Accept", "application/json")
	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}

Response

Field	Type	Required	Description
pickup_instructions	Array(PickupInstruction)		The list of order-specific pickup instructions.

PickupInstruction Object

Field	Type	Required	Description
category	string		The type of pickup {curbside, locker, in_store}.
instruction	string		The instruction on how to pick up the order.
instruction_images	Array(PickupInstructionImage)		An image to support the instructions for picking up the order.

PickupInstructionImage Object

Field	Type	Required	Description
url	string		The image URL.
value	string		The description of the image.

Response examples

200 Success

200 Pickup instruction fetched

{
  "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 Code	Cause	Error Message	Error Code	Error Meta
400	Invalid params	"Pickup unavailable for non-pickup orders"	4001	Not applicable
404	Order not found	"Resource not found"	4000	Not applicable