BTS API Docs

Cancel order

GET /v1/order-cancel/index

This section is used to cancel an existing order.

When the request is sent, the system changes the order status to cancelled and stops any further delivery processing.

⚠️ Important condition: Cancellation is allowed only when the current order status equals status_code = 100.
If the order is in any other status (for example, already in delivery or completed), the system will reject the request and return an error message.

This endpoint only updates the order status and does not modify any other order data.

API Server


                    https://apitest.bts.uz:28345/

Base Path


                    /v1/order-cancel/index

Full URL


                        https://apitest.bts.uz:28345/v1/order-cancel/index

Authentication Bearer Token

Headers

Header

Value

Req.

Authorization

Bearer {access_token}

🔒

Content-Type

application/json

🔒

application/json

🔒

language

uz

🔒

No schema defined.

RESPONSE

Example
Schema

HTTP 200

Response Body

{
    "status": true,
    "message": "success.updated",
    "status_code": 200,
    "data": {
        "orderId": 4293646,
        "status": {
            "id": 0,
            "name": "Cancelled Order"
        }
    }
}

No schema defined.

Example
Schema

HTTP 400

Response Body

{
    "status": false,
    "message": "error.already_cancelled",
    "status_code": 400
}

No schema defined.