Get order items

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

Retrieves the list of items in the order. Each item in the list includes item details of the ordered item, the current status of that item, and the current replacement for that item, if one exists. Item details include the name, quantity ordered, and cost unit.

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.
X-Treat-Ids-As-Internal	header	boolean

Request

None.

Request examples

cURL

curl --request GET \
  --url 'https://connect.instacart.com/v2/post_checkout/orders/{order_id}/items' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer <token>' \
  --header 'X-Treat-Ids-As-Internal: true'

Java

HttpResponse<String> response = Unirest.get("https://connect.instacart.com/v2/post_checkout/orders/{order_id}/items")
  .header("Accept", "application/json")
  .header("Authorization", "Bearer <token>")
  .header("X-Treat-Ids-As-Internal", "true")
  .asString();

Python

import http.client

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

headers = {
    'Accept': "application/json",
    'Authorization': "Bearer <token>",
    'X-Treat-Ids-As-Internal': "true"
}

conn.request("GET", "/v2/post_checkout/orders/{order_id}/items", 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}/items"

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

	req.Header.Add("Accept", "application/json")
	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("X-Treat-Ids-As-Internal", "true")

	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
line_items	Array(LineItem)		Array of order line items.

LineItem Object

Field	Type	Required	Description
id	string		The ID of the line item.
replacement_status	string		Reflects the customer's decision on a shopper-proposed replacement item. One of the following: SUBSTITUTION_STATUS_UNSPECIFIED: No replacement has been made. PENDING: A replacement has been proposed, but the customer hasn't responded yet. APPROVED: The customer approved the replacement. REJECTED: The customer rejected the replacement.
status	string		Reflects the current state of the originally ordered item. One of the following values: NOT_PICKED: The shopper has yet to pick the ordered item. FOUND: The shopper found the ordered item. REPLACED: The shopper replaced the ordered item. TO_REFUND: The ordered item is to be refunded.
certified_delivery	boolean		Whether the line item requires certified delivery.
line_num	string		The line number of the item.
item	OrderItem		The order line item.
replacement	OrderItem		The replacement for this item if one exists.

OrderItem Object

Field	Type	Required	Description
name	string		The name of the item.
image_url	string		The URL of the item image.
quantity	string		The number of items.
cost_unit	string		The unit of item quantity.

Response examples

200 Success

200 Order items fetched

{
  "line_items": [
    {
      "id": "qwertyuiop",
      "replacement_status": "SUBSTITUTION_STATUS_UNSPECIFIED",
      "status": "REPLACED",
      "certified_delivery": false,
      "line_num": "1",
      "item": {
        "name": "Bananas",
        "image_url": "fakeUrl.com",
        "quantity": "30.0",
        "cost_unit": "LB"
      },
      "replacement": {
        "name": "Bananas",
        "image_url": "fakeUrl.com",
        "quantity": "30.0",
        "cost_unit": "LB"
      }
    }
  ]
}

4XX Errors

Error responses return either a single error or multiple errors.

HTTP Code	Cause	Error Message	Error Code	Error Meta
400	Order was not created with Fulfillment v3, trying to fetch with client credentials	"User ID not found"	4001	Not applicable
404	Order items not found	"Resource not found"	4000	Not applicable