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

Scope: sale

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

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

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

Обязательные параметры отмечены *

Название
тип

Описание

fields*
object

Значения полей (подробное описание приведено ниже) для создания привязки оплаты к отгрузке в виде структуры:

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

Параметр fields

Обязательные параметры отмечены *

Название
тип

Описание

shipmentId*
sale_order_shipment.id

Идентификатор отгрузки

paymentId*
sale_order_payment.id

Идентификатор оплаты

xmlId
string

Внешний идентификатор записи

Примеры кода

Как использовать примеры в документации

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_webhook_here**/sale.paymentitemshipment.add
        
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
        
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);
        }
        
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.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());
                }
            }
        );
        
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"
            }
        }

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

Название
тип

Описание

result
object

Корневой элемент ответа

paymentItemShipment
sale_payment_item_shipment

Объект с информацией о добавленной привязке оплаты к отгрузке

time
time

Информация о времени выполнения запроса

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

HTTP-статус: 400

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

Название
тип

Описание

error
string

Строковый код ошибки. Может состоять из цифр, латинских букв и знака подчеркивания

error_description
error_description

Текстовое описание ошибки. Описание не предназначено для показа конечному пользователю в необработанном виде

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

Код

Описание

201250000001

Элемент с указанными значениями полей shipmentId и paymentId уже существует.

В случае, если требуется изменить указанный ранее внешний идентификатор привязки, нужно воспользоваться методом sale.paymentitemshipment.update

201240400002

Оплата не найдена. Некорректное значение переданного параметра paymentId

201240400003

Отгрузка не найдена. Некорректное значение переданного параметра shipmentId

200040300020

Недостаточно прав для добавления привязки оплаты к отгрузке

100

Не указан или пустой параметр fields

0

Не переданы обязательные поля

0

Другие ошибки (например, фатальные ошибки)

Статусы и коды системных ошибок

HTTP-статус: 20x, 40x, 50x

Описанные ниже ошибки могут возникнуть при вызове любого метода

Статус

Код
Текст ошибки

Описание

500

INTERNAL_SERVER_ERROR
Internal server error

Возникла внутренняя ошибка сервера, обратитесь к администратору сервера или в техническую поддержку Битрикс24

500

ERROR_UNEXPECTED_ANSWER
Server returned an unexpected response

Возникла внутренняя ошибка сервера, обратитесь к администратору сервера или в техническую поддержку Битрикс24

503

QUERY_LIMIT_EXCEEDED
Too many requests

Превышен лимит на интенсивность запросов

405

ERROR_BATCH_METHOD_NOT_ALLOWED
Method is not allowed for batch usage

Текущий метод не разрешен для вызова с помощью batch

400

ERROR_BATCH_LENGTH_EXCEEDED
Max batch length exceeded

Превышена максимальная длина параметров, переданных в метод batch

401

NO_AUTH_FOUND
Wrong authorization data

Неверный access-токен или код вебхука

400

INVALID_REQUEST
Https required

Для вызовов методов требуется использовать протокол HTTPS

503

OVERLOAD_LIMIT
REST API is blocked due to overload

REST API заблокирован из-за перегрузки. Это ручная индивидуальная блокировка, для снятия необходимо обращаться в техническую поддержку Битрикс24

403

ACCESS_DENIED
REST API is available only on commercial plans

REST API доступен только на коммерческих планах

403

INVALID_CREDENTIALS
Invalid request credentials

У пользователя, с чьим access-токеном или вебхуком был вызван метод, не хватает прав

404

ERROR_MANIFEST_IS_NOT_AVAILABLE
Manifest is not available

Манифест недоступен

403

insufficient_scope
The request requires higher privileges than provided by the webhook token

Запрос требует более высоких привилегий, чем предоставляет токен вебхука

401

expired_token
The access token provided has expired

Предоставленный access-токен доступа истек

403

user_access_error
The user does not have access to the application

Пользователь не имеет доступа к приложению. Это означает, что приложение установлено, но администратор портала разрешил доступ к этому приложению только конкретным пользователям

500

PORTAL_DELETED
Portal was deleted

Публичная часть сайта закрыта. Чтобы открыть публичную часть сайта на коробочной установке отключите опцию «Временное закрытие публичной части сайта». Путь к настройке: Рабочий стол > Настройки > Настройки продукта > Настройки модулей > Главный модуль > Временное закрытие публичной части сайта

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

Предыдущая
Обзор методов
Следующая
Изменить привязку оплаты к отгрузке