Cancel Order API Reference

This section provides detailed information about the Cancel Order API endpoint in our system. Use this guide to understand how to initiate and manage order cancellations through our API.

Overview

The Cancel Order API is designed to allow authorized users to cancel orders in our system. It is crucial for managing inventory, ensuring customer satisfaction, and maintaining business operations.

Endpoint

The endpoint for canceling an order is /en/support-center/api-reference/order-processing/cancel-order.

Usage

To use this endpoint, you need to provide the following parameters:

order_id: The unique identifier of the order you wish to cancel.
reason: Optional. The reason for canceling the order. This information helps in tracking and improving our services.

Request Format

The request format is as follows:

{
  "order_id": "123456789",
  "reason": "Customer request"
}

Response Format

Upon successfully canceling an order, the API will return a response with the following structure:

{
  "status": "success",
  "message": "Order canceled successfully"
}

In case of an error, the response will include the error details:

{
  "status": "error",
  "message": "Order not found"
}

Example

Here's an example of how to use the Cancel Order API:

GET /en/support-center/api-reference/order-processing/cancel-order?order_id=123456789&reason=Customer+request