метод REST
scope: sale
sale.order.delete
Удалить заказ и связанные объекты
Описание
Метод sale.order.delete предназначен для удаления заказа и связанных объектов.
Параметры
id
sale_order.id
обязательный
Идентификатор заказа
Примеры запроса
-X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"id":5}' \
https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/sale.order.delete
-X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"id":5,"auth":"**put_access_token_here**"}' \
https://**put_your_bitrix24_address**/rest/sale.order.delete
// This snippet is an ES module: top-level await requires type="module" or a bundler.
// $b24 is an already-initialized SDK instance (see the SDK "Get started" guide).
import { Text } from '@bitrix24/b24jssdk'
import type { B24Frame } from '@bitrix24/b24jssdk'
declare const $b24: B24Frame
try {
const response = await $b24.actions.v2.call.make<boolean>({
method: 'sale.order.delete',
params: {
id: 5,
},
requestId: Text.getUuidRfc4122()
})
// The payload is available only on a successful response
if (!response.isSuccess) {
console.error(response.getErrorMessages().join('; '))
} else {
const result = response.getData()!.result
console.info('Order deleted:', result)
}
} catch (error) {
// Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
console.error(error)
}
<!-- Load the SDK (UMD build); it is exposed as the global B24Js -->
<script src="https://unpkg.com/@bitrix24/b24jssdk@1/dist/umd/index.min.js"></script>
<script>
async function deleteOrder() {
try {
// Initialize the SDK inside a Bitrix24 frame
const $b24 = await B24Js.initializeB24Frame()
const response = await $b24.actions.v2.call.make({
method: 'sale.order.delete',
params: {
id: 5,
},
requestId: B24Js.Text.getUuidRfc4122()
})
// The payload is available only on a successful response
if (!response.isSuccess) {
console.error(response.getErrorMessages().join('; '))
return
}
const result = response.getData().result
console.info('Order deleted:', result)
} catch (error) {
// Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
console.error(error)
}
}
document.addEventListener('DOMContentLoaded', deleteOrder)
</script>
from b24pysdk.errors import BitrixAPIError, BitrixSDKException
try:
bitrix_response = client.sale.order.delete(
bitrix_id=5,
).response
result = bitrix_response.result
print(result)
except BitrixAPIError as error:
print(
"Ошибка Bitrix API",
f"error: {error.error}",
f"error_description: {error.error_description}",
sep="\n",
)
except BitrixSDKException as error:
print(f"Ошибка Bitrix SDK: {error.message}")
except Exception as error:
print(f"Непредвиденная ошибка: {error}")
try {
$response = $b24Service
->core
->call(
'sale.order.delete',
[
'id' => 5,
]
);
$result = $response
->getResponseData()
->getResult();
if ($result->error()) {
error_log($result->error());
echo 'Error: ' . $result->error();
} else {
echo 'Info: ' . print_r($result->data(), true);
}
} catch (Throwable $e) {
error_log($e->getMessage());
echo 'Error deleting sale order: ' . $e->getMessage();
}
BX24.callMethod(
"sale.order.delete", {
"id": 5
},
function(result) {
if (result.error()) {
console.error(result.error());
} else {
console.info(result.data());
}
}
);
require_once('crest.php');
$result = CRest::call(
'sale.order.delete',
[
'id' => 5
]
);
echo '<PRE>';
print_r($result);
echo '</PRE>';
// client и ctx уже созданы — см. раздел «SDK для Go»
res, err := client.Core().Call(ctx, "sale.order.delete", b24.Params{
"id": 5,
})
if err != nil {
return fmt.Errorf("sale.order.delete: %w", err)
}
var ok bool
if err := json.Unmarshal(res.Result, &ok); err != nil {
return fmt.Errorf("разбор ответа: %w", err)
}
fmt.Println("выполнено:", ok)
Ответ
HTTP-статус: 200
{
"result": true,
"time": {
"start": 1712761141.260635,
"finish": 1712761143.127523,
"duration": 1.8668880462646484,
"processing": 1.4157729148864746,
"date_start": "2024-04-10T17:59:01+03:00",
"date_finish": "2024-04-10T17:59:03+03:00"
}
}
Возвращаемые данные
result
boolean
Результат удаления заказа
time
time
Информация о времени выполнения запроса
Обработка ошибок
HTTP-статус: 400
{
"error":200540400001,
"error_description":"order is not exists"
}
| Код | Описание | Значение |
|---|---|---|
SALE_ORDER_CANCEL_PAYMENT_EXIST_ACTIVE |
У заказа есть активные оплаты | |
200540400001 |
Удаляемый заказ не найден | |
200040300020 |
Недостаточно прав для удаления заказа | |
100 |
Не указан параметр id |
|
0 |
Другие ошибки (например, фатальные ошибки) |

