Cancel a dispatch last mile delivery order

POST /v2/fulfillment/lastmile/orders/{order_id}/cancel

warning

This endpoint works only with dispatch last mile delivery orders.

Cancels a dispatch last mile delivery order.

To successfully perform this operation, the order's status value must be brand_new. In other words, once a shopper is assigned and status moves to acknowledged, you can no longer use this endpoint to cancel the order.

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
user_id	string		The ID of the user.

Request examples

cURL

curl --request POST \
  --url 'https://connect.instacart.com/v2/fulfillment/lastmile/orders/{order_id}/cancel' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "user_id": "string"
}'

Java

HttpResponse<String> response = Unirest.post("https://connect.instacart.com/v2/fulfillment/lastmile/orders/{order_id}/cancel")
  .header("Accept", "application/json")
  .header("Content-Type", "application/json")
  .header("Authorization", "Bearer <token>")
  .body("{\n  \"user_id\": \"string\"\n}")
  .asString();

Python

import http.client

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

payload = "{\n  \"user_id\": \"string\"\n}"

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

conn.request("POST", "/v2/fulfillment/lastmile/orders/{order_id}/cancel", 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/fulfillment/lastmile/orders/{order_id}/cancel"

	payload := strings.NewReader("{\n  \"user_id\": \"string\"\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
id	string		The retailer-generated order ID.
status	string		The current status of the order.
order_url	string		The URL of the Instacart-hosted order status page. If the retailer has opted not to use this feature, this field will be null or empty.
created_at	string		The time of order creation in ISO 8601 format.
cancellation_reason	string		The reason the order was canceled. Only present in canceled orders. One of the following: customer_driven: The customer triggered the cancellation instacart_driven: Instacart triggered the cancellation retailer_driven: The retailer triggered the cancellation shopper_driven: The shopper triggered the cancellation unbatchable: The Instacart batch system triggered the cancellation other: The cancellation was triggered for another reason not listed above.
locale	string		Indicates how the order is localized.
is_express	boolean		Deprecated. Use is_instacartplus instead. Indicates whether the order received Instacart+ membership benefits. Defaults to false.
is_instacartplus	boolean		Indicates whether the order received Instacart+ membership benefits. Defaults to false.
metadata	Hash		The order-level metadata.
fulfillment_details	OrderFulfillmentDetails		The order's fulfillment details.

OrderFulfillmentDetails Object

Field	Type	Required	Description
store_location	string		The location code of the store where the order was fulfilled. This field's value is often the same as the location_code included in the create order request. However, orders can be fulfilled from a store that's different from the one specified by location_code.
window_starts_at	string		The start of the fulfillment window in ISO 8601 format.
window_ends_at	string		The end of the fulfillment window in ISO 8601 format.
delivered_at	string		The time the order was delivered to the customer in ISO 8601 format. Only present for completed deliveries.
bag_count	integer		The number of bags in the order, as reported by the shopper.
handoff_window_starts_at	string		The start of the store-associate-to-Instacart-shopper handoff window in ISO 8601 format. This field is only populated for last mile delivery (i.e., delivery only) orders.
handoff_window_ends_at	string		The end of the store-associate-to-Instacart-shopper handoff window in ISO 8601 format. This field is only populated for last mile delivery (i.e., delivery only) orders.

Response examples

200 Success

200 Order canceled

{
  "id": "12345676789012345678780",
  "status": "canceled",
  "order_url": "https://example.com/example-order",
  "created_at": "2018-02-22T00:00:00Z",
  "cancellation_reason": "shopper_driven",
  "locale": "en_US",
  "is_express": true,
  "is_instacartplus": true,
  "fulfillment_details": {
    "window_starts_at": "2018-02-22T00:00:00Z",
    "window_ends_at": "2018-02-22T00:30:00Z"
  }
}

4XX Errors

Error responses return either a single error or multiple errors.

HTTP Code	Cause	Error Message	Error Code	Error Meta
400	Order could not be cancelled at this time	"The order could not be cancelled at this time, try again later."	2003	{"wait":"30"}
400	Too late to cancel order	"too_late"	1001	{"key":"order_id"}
400	Request could not be processed at this time	"The request could not be completed at this time, try again later."	2003	{"wait":"30"}
400	User Not Found	"User Not Found"	1001	{"key":"user_id"}
404	Order not found	"Resource not found"	4000	Not applicable