sale-order-delete.md

Удалить заказ и связанные объекты sale.order.delete

Scope: sale

Кто может выполнять метод: администратор

Метод sale.order.delete предназначен для удаления заказа и связанных объектов.

Параметры метода

{% include Сноска об обязательных параметрах %}

#| || Название тип | Описание || || id* sale_order.id | Идентификатор заказа || |#

Примеры кода

{% include Сноска о примерах %}

{% list tabs %}

• cURL (Webhook)

  -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
  

• cURL (OAuth)

  -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
  

• JS

  BX24.callMethod(
      "sale.order.delete", {
          "id": 5
      },
      function(result) {
          if (result.error()) {
              console.error(result.error());
          } else {
              console.info(result.data());
          }
      }
  );

• PHP

  require_once('crest.php');
  
  $result = CRest::call(
      'sale.order.delete',
      [
          'id' => 5
      ]
  );
  
  echo '<PRE>';
  print_r($result);
  echo '</PRE>';

{% endlist %}

Обработка ответа

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"
}

{% include notitle обработка ошибок %}

Возможные коды ошибок

#| || Код | Описание || || SALE_ORDER_CANCEL_PAYMENT_EXIST_ACTIVE | У заказа есть активные оплаты || || 200540400001 | Удаляемый заказ не найден || || 200040300020 | Недостаточно прав для удаления заказа || || 100 | Не указан параметр id || || 0 | Другие ошибки (например, фатальные ошибки) || |#

{% include системные ошибки %}

Продолжите изучение

• {#T}
• {#T}
• {#T}
• {#T}
• {#T}