Как использовать метод SDK sale.order.list в Битрикс24

При разработке и поддержке проектов на платформе 1С-Битрикс критически важно использовать современные стандарты D7 API. В этом руководстве мы детально изучим тему «Как использовать метод SDK sale.order.list в Битрикс24», разберем архитектурные особенности и предоставим готовые к интеграции примеры кода.

Описание метода SDK sale.order.list

Метод sale.order.list является частью официального Bitrix24 PHP SDK и предназначен для выполнения REST-запросов к порталу. Retrieves a list of orders.

Параметры и сигнатура метода

В рамках SDK метод объявлен в пространстве имен \Bitrix24\SDK\Services\Sale\Order\Service\Order со следующей сигнатурой:

public function list(
      array $filter = [],
      array $order = [],
      array $select = [],
      int $start = 0
  ): Result

Пример использования на PHP

Ниже представлен готовый практический пример интеграции с использованием Bitrix24 PHP SDK. Этот пример показывает, как правильно инициализировать сервис-билдер и вызвать метод list:

<?php
declare(strict_types=1);

use Bitrix24\SDK\Services\ServiceBuilderFactory;

// Инициализация официального Bitrix24 PHP SDK через входящий вебхук
$webhookUrl = 'https://your-portal.bitrix24.ru/rest/1/your-webhook-code/';
$serviceBuilder = ServiceBuilderFactory::createServiceBuilderFromWebhook($webhookUrl);

try {
    // Подготовка параметров для вызова метода sale.order.list
    $filter = [];
    $order = [];
    $select = [];
    $start = 123;

    // Выполнение запроса через Scope getSaleScope и сервис order
    $result = $serviceBuilder->getSaleScope()->order()->list(
          $filter,
          $order,
          $select,
          $start
      );

    // Обработка полученных данных
    print_r($result->getResponseData()->getResult());

} catch (\Throwable $exception) {
    // Обработка исключений при интеграции
    echo "Ошибка при выполнении метода sale.order.list: " . $exception->getMessage();
}

Полезные ссылки

• Официальная REST API документация: https://apidocs.bitrix24.com/api-reference/sale/order/sale-order-list.html
• Репозиторий PHP SDK на GitHub: bitrix24-php-sdk