BTS API Docs

Buyurtmani bekor qilish

GET /v1/order-cancel/index?orderId=<orderId>

Ushbu bo‘lim orqali mavjud buyurtmani bekor qilish amalga oshiriladi.

So‘rov yuborilganda tizim buyurtma holatini bekor qilingan (cancelled) holatiga o‘tkazadi va buyurtma bo‘yicha yetkazib berish jarayoni to‘xtatiladi.

⚠️ Muhim shart: Buyurtmani faqat uning joriy holati status_code = 100 bo‘lgandagina bekor qilish mumkin.
Agar buyurtma boshqa holatda bo‘lsa (masalan, yetkazib berish jarayonida yoki yakunlangan bo‘lsa), tizim bekor qilishni rad etadi va xatolik xabari qaytaradi.

Ushbu endpoint faqat buyurtma holatini o‘zgartiradi va boshqa ma’lumotlarni yangilamaydi.

API Server


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

Base Path


                    /v1/order-cancel/index?orderId=<orderId>

Full URL


                        https://apitest.bts.uz:28345/v1/order-cancel/index?orderId=<orderId>

Authentication Bearer Token

Headers

Header

Value

Req.

Authorization

Bearer {access_token}

🔒

Content-Type

application/json

🔒

application/json

🔒

language

uz

🔒

Field	Type	Description
`orderId` *	integer	Bekor qilinadigan buyurtma ID. Query parametr: /v1/order-cancel/index?orderId={orderId}. Faqat JWT mijoziga tegishli buyurtma; odatda status=1 (yangi) holatdagina bekor qilish mumkin

RESPONSE

Example
Schema

HTTP 200

Response Body

{
   "status":true,
   "message":"Muvaffaqiyatli yangilandi.",
   "status_code":200,
   "data":{
      "orderId":4295353,
      "status":{
         "id":0,
         "name":"Cancelled Order"
      }
   }
}

Field	Type	Description
`status`	boolean	So'rov muvaffaqiyatli bajarilganligi (true/false)
`message`	string	Javob xabari
`status_code`	integer	HTTP status kodi
`data[orderId]`	integer	Bekor qilingan buyurtma ID
`data[status][id]`	integer	Yangi status ID. Bekor qilinganda: 0
`data[status][name]`	string	Status nomi (masalan: Cancelled Order)

Example
Schema

HTTP 400

Response Body

{
    "status": false,
    "message": "Buyurtma allaqachon bekor qilingan.",
    "status_code": 400
}

No schema defined.