Get order handling information

GET /v2/post_checkout/orders/{order_id}/handling

Retrieves handling information related to the specified order. This includes the delivery or pickup address, the coordinates of the delivery of pickup address, the information about the current shopper, and any notes or instructions included with the order.

If the remove shopper information feature is enabled, then a 200 Success response doesn’t contain the shopper object.

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}/handling' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer <token>'

Java

HttpResponse<String> response = Unirest.get("https://connect.instacart.com/v2/post_checkout/orders/{order_id}/handling")
  .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}/handling", headers=headers)

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

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

Go

package main

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

func main() {

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

	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, _ := io.ReadAll(res.Body)

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

}

Response

Field	Type	Required	Description
address	Address		The address of the delivery / pickup.
coordinates	Coordinates		The coordinates of the delivery / pickup address.
shopper	Shopper		The shopper currently fulfilling this order.
dropoff_location	string		Drop-off location instructions from the customers.
notes	string		Notes about the address.
instructions	string		Instructions associated with the delivery.
leave_unattended	boolean		Indicates whether the user wants the driver to leave the order unattended. Defaults to false.
alcoholic	boolean		Indicates whether the order contains alcohol. Defaults to false.
certified_delivery	boolean		Indicates whether the order requires a certified delivery. Defaults to false.

Address Object

Field	Type	Required	Description
address_line_1	string		First line of the address.
address_line_2	string		Second line of the address.
locality	string		The locality of this address e.g. city.
administrative_area	string		The administrative area of this address e.g. state.
postal_code	string		The address postal code.
country_code	string		The country code for the address.

Coordinates Object

Field	Type	Required	Description
latitude	number		The latitude.
longitude	number		The longitude.

Shopper Object

Field	Type	Required	Description
first_name	string		The first name of the shopper.
avatar_url	string		The url of the shopper's avatar image.

Response examples

200 Success

200 Order handling details fetched

{
  "address": {
    "address_line_1": "129 West 81st Street",
    "address_line_2": "Apartment 5A",
    "locality": "New York",
    "administrative_area": "New York",
    "postal_code": "10024",
    "country_code": "US"
  },
  "coordinates": {
    "latitude": 40.7837619,
    "longitude": -73.9765552
  },
  "shopper": {
    "first_name": "Robert",
    "avatar_url": "https://speedwagon.foundation/avatar/reospeedwagon.jpg"
  },
  "dropoff_location": "",
  "notes": "",
  "instructions": "",
  "leave_unattended": false,
  "alcoholic": false,
  "certified_delivery": false
}

200 Order handling details fetched without assigned shopper

{
  "address": {
    "address_line_1": "129 West 81st Street",
    "address_line_2": "Apartment 5A",
    "locality": "New York",
    "administrative_area": "New York",
    "postal_code": "10024",
    "country_code": "US"
  },
  "coordinates": {
    "latitude": 40.7837619,
    "longitude": -73.9765552
  },
  "dropoff_location": "",
  "notes": "",
  "instructions": "",
  "leave_unattended": true,
  "alcoholic": true,
  "certified_delivery": true,
  "shopper": {
    "first_name": "Robert",
    "avatar_url": "https://speedwagon.foundation/avatar/reospeedwagon.jpg"
  }
}

4XX Errors

Error responses return either a single error or multiple errors.

HTTP Code	Cause	Error Message	Error Code	Error Meta
404	Order not found	"Resource not found"	4000	Not applicable