Эффективная интеграция и кастомизация функционала в Битрикс24 часто требует работы на уровне API. Сегодня мы подробно рассмотрим «Добавить привязку оплаты к отгрузке sale.paymentItemShipment.add». Вы узнаете экспертные методики работы с sale.paymentItemShipment.add и научитесь избегать типичных ошибок начинающих разработчиков.

Добавить привязку оплаты к отгрузке sale.paymentItemShipment.add

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

Метод добавляет привязку оплаты к отгрузке.

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

fields: {
    shipmentId: значение,
    paymentId: значение,
    xmlId: 'значение'
}

Параметр fields

Примеры кода

• cURL (Webhook)

    curl -X POST \
    -H "Content-Type: application/json" \
    -H "Accept: application/json" \
    -d '{"fields":{"shipmentId":2471,"paymentId":1025,"xmlId":"myXmlId"}}' \
    https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webbhook_here**/sale.paymentitemshipment.add

• cURL (OAuth)

    curl -X POST \
    -H "Content-Type: application/json" \
    -H "Accept: application/json" \
    -d '{"fields":{"shipmentId":2471,"paymentId":1025,"xmlId":"myXmlId"},"auth":"**put_access_token_here**"}' \
    https://**put_your_bitrix24_address**/rest/sale.paymentitemshipment.add

• JS

    try
    {
    	const response = await $b24.callMethod(
    		'sale.paymentitemshipment.add', {
    			fields: {
    				shipmentId: 2471,
    				paymentId: 1025,
    				xmlId: 'myXmlId',
    			}
    		}
    	);
    	
    	const result = response.getData().result;
    	console.info(result);
    }
    catch( error )
    {
    	console.error(error);
    }

• PHP

    try {
        $response = $b24Service
            ->core
            ->call(
                'sale.paymentitemshipment.add',
                [
                    'fields' => [
                        'shipmentId' => 2471,
                        'paymentId' => 1025,
                        'xmlId'     => 'myXmlId',
                    ],
                ]
            );
    
        $result = $response
            ->getResponseData()
            ->getResult();
    
        echo 'Success: ' . print_r($result, true);
        // Нужная вам логика обработки данных
        processData($result);
    
    } catch (Throwable $e) {
        error_log($e->getMessage());
        echo 'Error adding payment item shipment: ' . $e->getMessage();
    }

• BX24.js

    BX24.callMethod(
        'sale.paymentitemshipment.add', {
            fields: {
                shipmentId: 2471,
                paymentId: 1025,
                xmlId: 'myXmlId',
            }
        },
        function(result) {
            if (result.error()) {
                console.error(result.error());
            } else {
                console.info(result.data());
            }
        }
    );

• PHP CRest

    require_once('crest.php');

    $result = CRest::call(
        'sale.paymentitemshipment.add',
        [
            'fields' => [
                'shipmentId' => 2471,
                'paymentId' => 1025,
                'xmlId' => 'myXmlId',
            ]
        ]
    );

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

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

HTTP-статус: 200

{
    "result":{
        "paymentItemShipment":{
            "dateInsert":"2024-04-15T09:22:26+03:00",
            "id":1181,
            "paymentId":1025,
            "shipmentId":2471,
            "xmlId":"myXmlId"
        }
    },
    "time":{
        "start":1713165816.941795,
        "finish":1713165817.220281,
        "duration":0.2784857749938965,
        "processing":0.045699119567871094,
        "date_start":"2024-04-15T10:23:36+03:00",
        "date_finish":"2024-04-15T10:23:37+03:00"
    }
}

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

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

HTTP-статус: 400

{
    "error":201240400003,
    "error_description":"shipment not exists"
}

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

• [](./index)
• [](./sale-payment-item-shipment-update)
• [](./sale-payment-item-shipment-get)
• [](./sale-payment-item-shipment-list)
• [](./sale-payment-item-shipment-delete)
• [](./sale-payment-item-shipment-get-fields)