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
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
// This snippet is an ES module: top-level await requires type="module" or a bundler.
// $b24 is an already-initialized SDK instance (see the SDK "Get started" guide).
import { Text } from '@bitrix24/b24jssdk'
import type { B24Frame, ISODate } from '@bitrix24/b24jssdk'
declare const $b24: B24Frame
// Shape of the payload returned in result (match the "response handling" section of the page)
type PaymentItemShipmentAddResult = {
paymentItemShipment: {
dateInsert: ISODate | null
id: number
paymentId: number
shipmentId: number
xmlId: string
}
}
try {
const response = await $b24.actions.v2.call.make<PaymentItemShipmentAddResult>({
method: 'sale.paymentitemshipment.add',
params: {
fields: {
shipmentId: 2471,
paymentId: 1025,
xmlId: 'myXmlId',
},
},
requestId: Text.getUuidRfc4122()
})
// The payload is available only on a successful response
if (!response.isSuccess) {
console.error(response.getErrorMessages().join('; '))
} else {
const result = response.getData()!.result
console.info(result.paymentItemShipment)
}
} catch (error) {
// Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
console.error(error)
}
<!-- Load the SDK (UMD build); it is exposed as the global B24Js -->
<script src="https://unpkg.com/@bitrix24/b24jssdk@1/dist/umd/index.min.js"></script>
<script>
async function addPaymentItemShipment() {
try {
// Initialize the SDK inside a Bitrix24 frame
const $b24 = await B24Js.initializeB24Frame()
const response = await $b24.actions.v2.call.make({
method: 'sale.paymentitemshipment.add',
params: {
fields: {
shipmentId: 2471,
paymentId: 1025,
xmlId: 'myXmlId',
},
},
requestId: B24Js.Text.getUuidRfc4122()
})
// The payload is available only on a successful response
if (!response.isSuccess) {
console.error(response.getErrorMessages().join('; '))
return
}
const result = response.getData().result
console.info(result.paymentItemShipment)
} catch (error) {
// Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
console.error(error)
}
}
document.addEventListener('DOMContentLoaded', addPaymentItemShipment)
</script>
from b24pysdk.errors import BitrixAPIError, BitrixSDKException
fields = {
"shipmentId": 2471,
"paymentId": 1025,
"xmlId": "myXmlId",
}
try:
bitrix_response = client.sale.paymentitemshipment.add(
fields=fields,
).response
result = bitrix_response.result
print(result)
except BitrixAPIError as error:
print(
"Ошибка Bitrix API",
f"error: {error.error}",
f"error_description: {error.error_description}",
sep="\n",
)
except BitrixSDKException as error:
print(f"Ошибка Bitrix SDK: {error.message}")
except Exception as error:
print(f"Непредвиденная ошибка: {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>';
// client и ctx уже созданы — см. раздел «SDK для Go»
res, err := client.Core().Call(ctx, "sale.paymentitemshipment.add", b24.Params{
"fields": b24.Params{
"shipmentId": 2471,
"paymentId": 1025,
"xmlId": "myXmlId",
},
})
if err != nil {
return fmt.Errorf("sale.paymentitemshipment.add: %w", err)
}
// Метод заворачивает ответ в объект с ключом "paymentItemShipment".
raw, ok := b24.Unwrap(res.Result, "paymentItemShipment")
if !ok {
return fmt.Errorf("в ответе нет ключа paymentItemShipment")
}
var item struct {
DateInsert string `json:"dateInsert"`
ID b24.ID `json:"id"`
PaymentID b24.ID `json:"paymentId"`
ShipmentID b24.ID `json:"shipmentId"`
XmlID string `json:"xmlId"`
}
if err := json.Unmarshal(raw, &item); err != nil {
return fmt.Errorf("разбор ответа: %w", err)
}
fmt.Println(item.DateInsert, item.ID)
Ответ
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 |
Другие ошибки (например, фатальные ошибки) |

