Cancel Order

Cancel Order

curl --request POST \
  --url 'https://api.example.com/{{orders_api_base_url}}/orders/cancel/' \
  --header 'Content-Type: application/json' \
  --data '
{
  "store_id": "<string>",
  "order_id": "<string>",
  "reason": "<string>",
  "description": "<string>",
  "initiated_by": "<string>"
}
'

import requests

url = "https://api.example.com/{{orders_api_base_url}}/orders/cancel/"

payload = {
    "store_id": "<string>",
    "order_id": "<string>",
    "reason": "<string>",
    "description": "<string>",
    "initiated_by": "<string>"
}
headers = {"Content-Type": "application/json"}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({
    store_id: '<string>',
    order_id: '<string>',
    reason: '<string>',
    description: '<string>',
    initiated_by: '<string>'
  })
};

fetch('https://api.example.com/{{orders_api_base_url}}/orders/cancel/', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.example.com/{{orders_api_base_url}}/orders/cancel/",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'store_id' => '<string>',
    'order_id' => '<string>',
    'reason' => '<string>',
    'description' => '<string>',
    'initiated_by' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

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

func main() {

	url := "https://api.example.com/{{orders_api_base_url}}/orders/cancel/"

	payload := strings.NewReader("{\n  \"store_id\": \"<string>\",\n  \"order_id\": \"<string>\",\n  \"reason\": \"<string>\",\n  \"description\": \"<string>\",\n  \"initiated_by\": \"<string>\"\n}")

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

	req.Header.Add("Content-Type", "application/json")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.example.com/{{orders_api_base_url}}/orders/cancel/")
  .header("Content-Type", "application/json")
  .body("{\n  \"store_id\": \"<string>\",\n  \"order_id\": \"<string>\",\n  \"reason\": \"<string>\",\n  \"description\": \"<string>\",\n  \"initiated_by\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.example.com/{{orders_api_base_url}}/orders/cancel/")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n  \"store_id\": \"<string>\",\n  \"order_id\": \"<string>\",\n  \"reason\": \"<string>\",\n  \"description\": \"<string>\",\n  \"initiated_by\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

{
  "success": true,
  "message": "<string>",
  "order_id": "<string>",
  "cancellation_id": "<string>",
  "refund_amount": "<string>",
  "refund_status": "<string>",
  "platform_notified": true,
  "customer_notified": true
}

POST

{orders_api_base_url}

orders

cancel

Cancel Order

curl --request POST \
  --url 'https://api.example.com/{{orders_api_base_url}}/orders/cancel/' \
  --header 'Content-Type: application/json' \
  --data '
{
  "store_id": "<string>",
  "order_id": "<string>",
  "reason": "<string>",
  "description": "<string>",
  "initiated_by": "<string>"
}
'

import requests

url = "https://api.example.com/{{orders_api_base_url}}/orders/cancel/"

payload = {
    "store_id": "<string>",
    "order_id": "<string>",
    "reason": "<string>",
    "description": "<string>",
    "initiated_by": "<string>"
}
headers = {"Content-Type": "application/json"}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({
    store_id: '<string>',
    order_id: '<string>',
    reason: '<string>',
    description: '<string>',
    initiated_by: '<string>'
  })
};

fetch('https://api.example.com/{{orders_api_base_url}}/orders/cancel/', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.example.com/{{orders_api_base_url}}/orders/cancel/",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'store_id' => '<string>',
    'order_id' => '<string>',
    'reason' => '<string>',
    'description' => '<string>',
    'initiated_by' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

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

func main() {

	url := "https://api.example.com/{{orders_api_base_url}}/orders/cancel/"

	payload := strings.NewReader("{\n  \"store_id\": \"<string>\",\n  \"order_id\": \"<string>\",\n  \"reason\": \"<string>\",\n  \"description\": \"<string>\",\n  \"initiated_by\": \"<string>\"\n}")

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

	req.Header.Add("Content-Type", "application/json")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.example.com/{{orders_api_base_url}}/orders/cancel/")
  .header("Content-Type", "application/json")
  .body("{\n  \"store_id\": \"<string>\",\n  \"order_id\": \"<string>\",\n  \"reason\": \"<string>\",\n  \"description\": \"<string>\",\n  \"initiated_by\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.example.com/{{orders_api_base_url}}/orders/cancel/")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n  \"store_id\": \"<string>\",\n  \"order_id\": \"<string>\",\n  \"reason\": \"<string>\",\n  \"description\": \"<string>\",\n  \"initiated_by\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

{
  "success": true,
  "message": "<string>",
  "order_id": "<string>",
  "cancellation_id": "<string>",
  "refund_amount": "<string>",
  "refund_status": "<string>",
  "platform_notified": true,
  "customer_notified": true
}

This endpoint cancels an order regardless of its current status and handles all necessary cleanup including customer notifications, refunds, inventory adjustments, and delivery platform communications.

Canceling orders frequently can negatively impact your store’s rating on delivery platforms. Use this endpoint judiciously and consider alternative solutions when possible.

Request Body

string

required

The unique identifier of the store canceling the order

string

required

The unique identifier of the order to cancel

string

required

Reason for cancellation. Must be one of the predefined reason codes.

string

Additional details about the cancellation reason

string

required

Employee ID who initiated the cancellation

Cancellation Reason Codes

Available Reason Codes

Store-Related Reasons:

OUT_OF_STOCK - Required items are not available
KITCHEN_CLOSED - Kitchen is closed or unable to prepare
EQUIPMENT_FAILURE - Equipment malfunction preventing preparation
STAFF_SHORTAGE - Insufficient staff to fulfill order
STORE_EMERGENCY - Emergency situation at store

Customer-Related Reasons:

CUSTOMER_REQUEST - Customer requested cancellation
PAYMENT_ISSUE - Payment could not be processed
DELIVERY_ADDRESS_ISSUE - Delivery address problems

Platform-Related Reasons:

PLATFORM_ERROR - Technical issue with delivery platform
DUPLICATE_ORDER - Order was duplicated in system
FRAUD_SUSPECTED - Suspected fraudulent order

Other Reasons:

WEATHER_RELATED - Severe weather preventing fulfillment
OTHER - Other reason (requires description)

Response

boolean

Indicates whether the order was successfully canceled

string

Confirmation message or error details

string

The canceled order’s unique identifier

string

Unique identifier for the cancellation record

string

Amount that will be refunded to customer

string

Status of the refund process

boolean

Whether the delivery platform was successfully notified

boolean

Whether the customer was successfully notified

Request Example

{
  "store_id": "449235c1-3d04-4519-998b-40d2a621e5e0",
  "order_id": "35d18f08-6d54-421d-9476-8cef629111bc",
  "reason": "OUT_OF_STOCK",
  "description": "Main ingredient not available due to supply chain issue",
  "initiated_by": "870a05c1-bbbf-48ab-a757-e28ae0a2b2a8"
}

Response Example

{
  "success": true,
  "message": "Order successfully canceled and all parties notified",
  "order_id": "35d18f08-6d54-421d-9476-8cef629111bc",
  "cancellation_id": "c4f2d9e8-1a3b-4c5d-8e9f-2a3b4c5d6e7f",
  "refund_amount": "41.02",
  "refund_status": "processing",
  "platform_notified": true,
  "customer_notified": true
}

Cancellation Process Workflow

When an order is canceled, the following automated processes occur:

Order Status Update: Status changed to “canceled”
Inventory Release: Any reserved inventory is released back to available stock
Refund Initiation: Automatic refund processing begins
Platform Notification: Delivery platform is notified with reason
Customer Notification: Customer receives cancellation notification
Analytics Update: Cancellation metrics are updated for reporting
Audit Trail: Complete cancellation record is created for compliance

Refund Timing: Refunds typically process within 3-5 business days, but the exact timing depends on the customer’s payment method and the delivery platform’s policies.

Best Practice: When possible, contact the customer directly before canceling to explore alternatives or explain the situation. This can help maintain customer satisfaction even in difficult situations.

Error Responses

Common Error Scenarios

Order Cannot Be Canceled

{
  "success": false,
  "message": "Order is already completed and cannot be canceled",
  "error_code": "ORDER_NOT_CANCELABLE"
}

Invalid Reason Code

{
  "success": false,
  "message": "Invalid cancellation reason provided",
  "error_code": "INVALID_REASON"
}

Platform Communication Failed

{
  "success": true,
  "message": "Order canceled but platform notification failed",
  "order_id": "35d18f08-6d54-421d-9476-8cef629111bc",
  "platform_notified": false,
  "warning": "Manual platform notification may be required"
}

Manual Follow-up: If platform_notified is false, you may need to manually notify the delivery platform to avoid fulfillment conflicts.

API Documentation - Legacy

API Documentation - Latest

Request Body

Cancellation Reason Codes

Response

Request Example

Response Example

Error Responses

​Request Body

​Cancellation Reason Codes

​Response

​Request Example

​Response Example

​Error Responses

Request Body

Cancellation Reason Codes

Response

Request Example

Response Example

Error Responses