Оптимизация производительности и безопасности — залог успешного проекта на 1С-Битрикс. Данный материал посвящен практическому применению «Получить список значений свойств отгрузки sale.shipmentpropertyvalue.list». Мы подготовили подробный разбор принципов работы и развернутые примеры интеграции.

Получить список значений свойств отгрузки sale.shipmentpropertyvalue.list

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

Метод возвращает список значений свойств отгрузки.

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

Примеры кода

• cURL (Webhook)

    curl -X POST \
    -H "Content-Type: application/json" \
    -H "Accept: application/json" \
    -d '{"select":["code","id","name","shipmentId","shipmentPropsId","shipmentPropsXmlId","value"],"filter":{"@shipmentId":[4120]},"order":{"shipmentId":"desc"}}' \
    https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/sale.shipmentpropertyvalue.list

• cURL (OAuth)

    curl -X POST \
    -H "Content-Type: application/json" \
    -H "Accept: application/json" \
    -d '{"select":["code","id","name","shipmentId","shipmentPropsId","shipmentPropsXmlId","value"],"filter":{"@shipmentId":[4120]},"order":{"shipmentId":"desc"},"auth":"**put_access_token_here**"}' \
    https://**put_your_bitrix24_address**/rest/sale.shipmentpropertyvalue.list

• JS

    // callListMethod рекомендуется использовать, когда необходимо получить весь набор списочных данных и объём записей относительно невелик (до примерно 1000 элементов). Метод загружает все данные сразу, что может привести к высокой нагрузке на память при работе с большими объемами.
    
    try {
      const response = await $b24.callListMethod(
        'sale.shipmentpropertyvalue.list',
        {
          "select": [
            "code",
            "id",
            "name",
            "shipmentId",
            "shipmentPropsId",
            "shipmentPropsXmlId",
            "value",
          ],
          "filter": {
            "@shipmentId": [4120],
          },
          "order": {
            "shipmentId": "desc",
          },
        },
        (progress) => { console.log('Progress:', progress) }
      )
      const items = response.getData() || []
      for (const entity of items) { console.log('Entity:', entity) }
    } catch (error) {
      console.error('Request failed', error)
    }
    
    // fetchListMethod предпочтителен при работе с крупными наборами данных. Метод реализует итеративную выборку с использованием генератора, что позволяет обрабатывать данные по частям и эффективно использовать память.
    
    try {
      const generator = $b24.fetchListMethod('sale.shipmentpropertyvalue.list', {
        "select": [
          "code",
          "id",
          "name",
          "shipmentId",
          "shipmentPropsId",
          "shipmentPropsXmlId",
          "value",
        ],
        "filter": {
          "@shipmentId": [4120],
        },
        "order": {
          "shipmentId": "desc",
        },
      }, 'ID')
      for await (const page of generator) {
        for (const entity of page) { console.log('Entity:', entity) }
      }
    } catch (error) {
      console.error('Request failed', error)
    }
    
    // callMethod предоставляет ручной контроль над процессом постраничного получения данных через параметр start. Подходит для сценариев, где требуется точное управление пакетами запросов. Однако при больших объемах данных может быть менее эффективным по сравнению с fetchListMethod.
    
    try {
      const response = await $b24.callMethod('sale.shipmentpropertyvalue.list', {
        "select": [
          "code",
          "id",
          "name",
          "shipmentId",
          "shipmentPropsId",
          "shipmentPropsXmlId",
          "value",
        ],
        "filter": {
          "@shipmentId": [4120],
        },
        "order": {
          "shipmentId": "desc",
        },
      }, 0)
      const result = response.getData().result || []
      for (const entity of result) { console.log('Entity:', entity) }
    } catch (error) {
      console.error('Request failed', error)
    }

• PHP

    try {
        $response = $b24Service
            ->core
            ->call(
                'sale.shipmentpropertyvalue.list',
                [
                    'select' => [
                        'code',
                        'id',
                        'name',
                        'shipmentId',
                        'shipmentPropsId',
                        'shipmentPropsXmlId',
                        'value',
                    ],
                    'filter' => [
                        '@shipmentId' => [4120],
                    ],
                    'order' => [
                        'shipmentId' => 'desc',
                    ],
                ]
            );
    
        $result = $response
            ->getResponseData()
            ->getResult();
    
        echo 'Success: ' . print_r($result, true);
    
    } catch (Throwable $e) {
        error_log($e->getMessage());
        echo 'Error fetching shipment property values: ' . $e->getMessage();
    }

• BX24.js

    BX24.callMethod(
        "sale.shipmentpropertyvalue.list", {
            "select": [
                "code",
                "id",
                "name",
                "shipmentId",
                "shipmentPropsId",
                "shipmentPropsXmlId",
                "value",
            ],
            "filter": {
                "@shipmentId": [4120],
            },
            "order": {
                "shipmentId": "desc",
            },
        },
        function(result) {
            if (result.error()) {
                console.error(result.error());
            } else {
                console.info(result.data());
            }
        }
    );

• PHP CRest

    require_once('crest.php');

    $result = CRest::call(
        'sale.shipmentpropertyvalue.list',
        [
            'select' => [
                "code",
                "id",
                "name",
                "shipmentId",
                "shipmentPropsId",
                "shipmentPropsXmlId",
                "value",
            ],
            'filter' => [
                "@shipmentId" => [4120],
            ],
            'order' => [
                "shipmentId" => "desc",
            ]
        ]
    );

    echo '<PRE>';
    print_r($result);
    echo '</PRE>';

Ответ в случае успеха

HTTP-статус: 200

{
    "result":{
        "propertyValues":[
            {
                "code":null,
                "id":38164,
                "name":"Comments",
                "shipmentId":4120,
                "shipmentPropsId":105,
                "shipmentPropsXmlId":"bx_6661d1b6690d5",
                "value":"Comments value"
            },
            {
                "code":null,
                "id":38166,
                "name":"Description",
                "shipmentId":4120,
                "shipmentPropsId":106,
                "shipmentPropsXmlId":"bx_6666cc212db52",
                "value":"Description value"
            }
        ]
    },
    "total":2,
    "time":{
        "start":1718023945.124614,
        "finish":1718023945.312019,
        "duration":0.18740510940551758,
        "processing":0.016345977783203125,
        "date_start":"2024-06-10T15:52:25+03:00",
        "date_finish":"2024-06-10T15:52:25+03:00"
    }
}

Возвращаемые данные

Обработка ошибок

HTTP-статус: 400

{
    "error":0,
    "error_description":"error"
}

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

• [](./sale-shipment-property-value-modify)
• [](./sale-shipment-property-value-get)
• [](./sale-shipment-propertyvalue-delete)
• [](./sale-shipment-property-value-get-fields)