метод REST scope: sale

sale.paymentItemShipment.add

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

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

Описание

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

Параметры

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

Ответ

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"
}
Код Описание Значение
201250000001 Элемент с указанными значениями полей shipmentId и paymentId уже существует.

В случае, если требуется изменить указанный ранее внешний идентификатор привязки, нужно воспользоваться методом sale.paymentitemshipment.update
201240400002 Оплата не найдена. Некорректное значение переданного параметра paymentId
201240400003 Отгрузка не найдена. Некорректное значение переданного параметра shipmentId
200040300020 Недостаточно прав для добавления привязки оплаты к отгрузке
100 Не указан или пустой параметр fields
0 Не переданы обязательные поля
0 Другие ошибки (например, фатальные ошибки)

Что будем искать? Например,Продвижение

Этот сайт использует куки-файлы. Оставаясь на сайте, Вы соглашаетесь на их использование. Для получения дополнительной информации, пожалуйста, ознакомьтесь с политикой в отношении персональных данных.