метод REST
scope: sale
sale.paymentItemShipment.get
Получить привязку по Id
Описание
Метод sale.paymentItemShipment.get получает привязку оплаты к отгрузке по идентификатору.
Параметры
id
sale_payment_item_shipment.id
обязательный
Идентификатор привязки оплаты к отгрузке
Примеры запроса
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"id":1183}' \
https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/sale.paymentitemshipment.get
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"id":1183,"auth":"**put_access_token_here**"}' \
https://**put_your_bitrix24_address**/rest/sale.paymentitemshipment.get
// 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 PaymentItemShipmentResult = {
paymentItemShipment: {
dateInsert: ISODate | null
id: number
paymentId: number
shipmentId: number
xmlId: string
}
}
try {
const response = await $b24.actions.v2.call.make<PaymentItemShipmentResult>({
method: 'sale.paymentitemshipment.get',
params: {
id: 1183,
},
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.id, result.paymentItemShipment.paymentId, result.paymentItemShipment.shipmentId)
}
} 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 getPaymentItemShipment() {
try {
// Initialize the SDK inside a Bitrix24 frame
const $b24 = await B24Js.initializeB24Frame()
const response = await $b24.actions.v2.call.make({
method: 'sale.paymentitemshipment.get',
params: {
id: 1183,
},
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.id, result.paymentItemShipment.paymentId, result.paymentItemShipment.shipmentId)
} catch (error) {
// Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
console.error(error)
}
}
document.addEventListener('DOMContentLoaded', getPaymentItemShipment)
</script>
from b24pysdk.errors import BitrixAPIError, BitrixSDKException
try:
bitrix_response = client.sale.paymentitemshipment.get(
bitrix_id=1183,
).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.get',
[
'id' => 1183,
]
);
$result = $response
->getResponseData()
->getResult();
echo 'Success: ' . print_r($result, true);
// Нужная вам логика обработки данных
processData($result);
} catch (Throwable $e) {
error_log($e->getMessage());
echo 'Error getting payment item shipment: ' . $e->getMessage();
}
BX24.callMethod(
"sale.paymentitemshipment.get",
{
"id": 1183
},
function(result) {
if (result.error()) {
console.error(result.error());
} else {
console.info(result.data());
}
}
);
require_once('crest.php');
$result = CRest::call(
'sale.paymentitemshipment.get',
[
'id' => 1183
]
);
echo '<PRE>';
print_r($result);
echo '</PRE>';
// client и ctx уже созданы — см. раздел «SDK для Go»
res, err := client.Core().Call(ctx, "sale.paymentitemshipment.get", b24.Params{
"id": 1183,
}, b24.WithIdempotent())
if err != nil {
return fmt.Errorf("sale.paymentitemshipment.get: %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-15T10:53:42+03:00",
"id":1183,
"paymentId":1025,
"shipmentId":2471,
"xmlId":"myXmlId"
}
},
"time":{
"start":1713171284.974848,
"finish":1713171285.256904,
"duration":0.2820558547973633,
"processing":0.035675048828125,
"date_start":"2024-04-15T11:54:44+03:00",
"date_finish":"2024-04-15T11:54:45+03:00"
}
}
Возвращаемые данные
result
object
Корневой элемент ответа
paymentItemShipment
sale_payment_item_shipment
Информация о привязке оплаты к отгрузке
time
time
Информация о времени выполнения запроса
Обработка ошибок
HTTP-статус: 400
{
"error":201240400001,
"error_description":"payment item is not exists"
}
| Код | Описание | Значение |
|---|---|---|
201240400001 |
Привязка оплаты к отгрузке не найдена | |
200040300010 |
Недостаточно прав для чтения данных о привязке оплаты к отгрузке | |
100 |
Не указан параметр id |
|
0 |
Другие ошибки (например, фатальные ошибки) |

