Record customer arrival

POST /v2/post_checkout/orders/{order_id}/pickup/user_arrived

Use this operation to record that the customer (or the customer's delegate) has arrived at the store for a curbside pickup. Instacart then notifies one or more of the store's associates so they know to run the order out to the designated pickup area.

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

Field	Type	Required	Description
is_pickup_delegate	boolean		Indicates whether the person picking up the order is a delegate. If true, then a pickup delegate object must already be associated with the order for the feature to work correctly. Defaults to false.

Request examples

cURL

curl --request POST \
  --url 'https://connect.instacart.com/v2/post_checkout/orders/{order_id}/pickup/user_arrived' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "is_pickup_delegate": true
}'

Java

HttpResponse<String> response = Unirest.post("https://connect.instacart.com/v2/post_checkout/orders/{order_id}/pickup/user_arrived")
  .header("Accept", "application/json")
  .header("Content-Type", "application/json")
  .header("Authorization", "Bearer <token>")
  .body("{\n  \"is_pickup_delegate\": true\n}")
  .asString();

Python

import http.client

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

payload = "{\n  \"is_pickup_delegate\": true\n}"

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

conn.request("POST", "/v2/post_checkout/orders/{order_id}/pickup/user_arrived", payload, headers)

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

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

Go

package main

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

func main() {

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

	payload := strings.NewReader("{\n  \"is_pickup_delegate\": true\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Accept", "application/json")
	req.Header.Add("Content-Type", "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
success	boolean		Whether the request was successful.

Response examples

200 Success

200 User arrival recorded

{
  "success": true
}

200 User arrival recorded for pickup eta order

{
  "success": true
}

4XX Errors

Error responses return either a single error or multiple errors.

HTTP Code	Cause	Error Message	Error Code	Error Meta
400	Order delivery is not staged	"Params error"	2001	{"order_delivery_id":"Order delivery is not staged."}
400	Order was not created with Fulfillment v3, trying to fetch with client credentials	"User ID not found"	4001	Not applicable
404	Order not found	"Resource not found"	4000	Not applicable
404	No pickup status found	"No pickup status found for order"	4000	Not applicable