Получить список привязок sale.paymentItemShipment.list
Scope:
saleКто может выполнять метод: администратор
Метод получает список привязок оплат к отгрузкам по фильтру.
Параметры метода
|
Название |
Описание |
|
select |
Массив, содержащий список полей, которые необходимо выбрать (смотрите поля объекта sale_payment_item_shipment). Если не передан или передан пустой массив, то будут выбраны все доступные поля привязок оплат к отгрузкам |
|
filter |
Объект для фильтрации выбранных привязок оплат к отгрузкам в формате Возможные значения для Ключу может быть задан дополнительный префикс, уточняющий поведение фильтра. Возможные значения префикса:
|
|
order |
Объект для сортировки выбранных привязок оплат к отгрузкам в формате Возможные значения для Возможные значения для
|
|
start |
Параметр используется для управления постраничной навигацией. Размер страницы результатов всегда статичный: 50 записей. Чтобы выбрать вторую страницу результатов необходимо передавать значение Формула расчета значения параметра
|
Примеры кода
Как использовать примеры в документации
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"select":["id","shipmentId","paymentId","xmlId","dateInsert"],"filter":{"paymentId":1025,"shipmentId":2467},"order":{"id":"desc"}}' \
https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/sale.paymentitemshipment.list
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"select":["id","shipmentId","paymentId","xmlId","dateInsert"],"filter":{"paymentId":1025,"shipmentId":2467},"order":{"id":"desc"},"auth":"**put_access_token_here**"}' \
https://**put_your_bitrix24_address**/rest/sale.paymentitemshipment.list
// callListMethod: Получает все данные сразу. Используйте только для небольших выборок (< 1000 элементов) из-за высокой нагрузки на память.
try {
const response = await $b24.callListMethod(
'sale.paymentitemshipment.list',
{
"select": [
"id",
"shipmentId",
"paymentId",
"xmlId",
"dateInsert",
],
"filter": {
"paymentId": 1025,
"shipmentId": 2467,
},
"order": {
"id": "desc",
}
},
(progress) => { console.log('Progress:', progress) }
)
const items = response.getData() || []
for (const entity of items) { console.log('Entity:', entity) }
} catch (error) {
console.error('Request failed', error)
}
// fetchListMethod: Выбирает данные по частям с помощью итератора. Используйте для больших объемов данных для эффективного потребления памяти.
try {
const generator = $b24.fetchListMethod('sale.paymentitemshipment.list', {
"select": [
"id",
"shipmentId",
"paymentId",
"xmlId",
"dateInsert",
],
"filter": {
"paymentId": 1025,
"shipmentId": 2467,
},
"order": {
"id": "desc",
}
}, 'ID')
for await (const page of generator) {
for (const entity of page) { console.log('Entity:', entity) }
}
} catch (error) {
console.error('Request failed', error)
}
// callMethod: Ручное управление постраничной навигацией через параметр start. Используйте для точного контроля над пакетами запросов. Для больших данных менее эффективен, чем fetchListMethod.
try {
const response = await $b24.callMethod('sale.paymentitemshipment.list', {
"select": [
"id",
"shipmentId",
"paymentId",
"xmlId",
"dateInsert",
],
"filter": {
"paymentId": 1025,
"shipmentId": 2467,
},
"order": {
"id": "desc",
}
}, 0)
const result = response.getData().result || []
for (const entity of result) { console.log('Entity:', entity) }
} catch (error) {
console.error('Request failed', error)
}
try {
$response = $b24Service
->core
->call(
'sale.paymentitemshipment.list',
[
'select' => [
'id',
'shipmentId',
'paymentId',
'xmlId',
'dateInsert',
],
'filter' => [
'paymentId' => 1025,
'shipmentId' => 2467,
],
'order' => [
'id' => 'desc',
],
]
);
$result = $response
->getResponseData()
->getResult();
if ($result->error()) {
error_log($result->error());
echo 'Error: ' . $result->error();
} else {
echo 'Success: ' . print_r($result->data(), true);
}
} catch (Throwable $e) {
error_log($e->getMessage());
echo 'Error fetching payment item shipments: ' . $e->getMessage();
}
BX24.callMethod(
"sale.paymentitemshipment.list", {
"select": [
"id",
"shipmentId",
"paymentId",
"xmlId",
"dateInsert",
],
"filter": {
"paymentId": 1025,
"shipmentId": 2467,
},
"order": {
"id": "desc",
}
},
function(result) {
if (result.error()) {
console.error(result.error());
} else {
console.info(result.data());
}
}
);
require_once('crest.php');
$result = CRest::call(
'sale.paymentitemshipment.list',
[
'select' => [
'id',
'shipmentId',
'paymentId',
'xmlId',
'dateInsert',
],
'filter' => [
'paymentId' => 1025,
'shipmentId' => 2467,
],
'order' => [
'id' => 'desc',
]
]
);
echo '<PRE>';
print_r($result);
echo '</PRE>';
Обработка ответа
HTTP-статус: 200
{
"result":{
"paymentItemsShipment":[
{
"dateInsert":"2024-04-11T16:59:21+03:00",
"id":1180,
"paymentId":1025,
"shipmentId":2467,
"xmlId":"bx_6617fac9afe1e"
}
]
},
"total":1,
"time":{
"start":1713172802.193215,
"finish":1713172802.464073,
"duration":0.2708580493927002,
"processing":0.018366098403930664,
"date_start":"2024-04-15T12:20:02+03:00",
"date_finish":"2024-04-15T12:20:02+03:00"
}
}
Возвращаемые данные
|
Название |
Описание |
|
result |
Корневой элемент ответа |
|
paymentItemsShipment |
Массив объектов с информацией о выбранных привязках оплат к отгрузкам |
|
total |
Общее количество найденных записей |
|
time |
Информация о времени выполнения запроса |
Обработка ошибок
HTTP-статус: 400
{
"error":0,
"error_description":"error"
}
|
Название |
Описание |
|
error |
Строковый код ошибки. Может состоять из цифр, латинских букв и знака подчеркивания |
|
error_description |
Текстовое описание ошибки. Описание не предназначено для показа конечному пользователю в необработанном виде |
Возможные коды ошибок
|
Код |
Описание |
|
|
Недостаточно прав для чтения элементов табличной части отгрузки |
|
|
Другие ошибки (например, фатальные ошибки) |
Статусы и коды системных ошибок
HTTP-статус: 20x, 40x, 50x
Описанные ниже ошибки могут возникнуть при вызове любого метода
|
Статус |
Код |
Описание |
|
|
|
Возникла внутренняя ошибка сервера, обратитесь к администратору сервера или в техническую поддержку Битрикс24 |
|
|
|
Возникла внутренняя ошибка сервера, обратитесь к администратору сервера или в техническую поддержку Битрикс24 |
|
|
|
Превышен лимит на интенсивность запросов |
|
|
|
Текущий метод не разрешен для вызова с помощью batch |
|
|
|
Превышена максимальная длина параметров, переданных в метод batch |
|
|
|
Неверный access-токен или код вебхука |
|
|
|
Для вызовов методов требуется использовать протокол HTTPS |
|
|
|
REST API заблокирован из-за перегрузки. Это ручная индивидуальная блокировка, для снятия необходимо обращаться в техническую поддержку Битрикс24 |
|
|
|
REST API доступен только на коммерческих планах |
|
|
|
У пользователя, с чьим access-токеном или вебхуком был вызван метод, не хватает прав |
|
|
|
Манифест недоступен |
|
|
|
Запрос требует более высоких привилегий, чем предоставляет токен вебхука |
|
|
|
Предоставленный access-токен доступа истек |
|
|
|
Пользователь не имеет доступа к приложению. Это означает, что приложение установлено, но администратор портала разрешил доступ к этому приложению только конкретным пользователям |
|
|
|
Публичная часть сайта закрыта. Чтобы открыть публичную часть сайта на коробочной установке отключите опцию «Временное закрытие публичной части сайта». Путь к настройке: Рабочий стол > Настройки > Настройки продукта > Настройки модулей > Главный модуль > Временное закрытие публичной части сайта |
Продолжите изучение
- Привязка оплат к отгрузкам в Интернет-магазине: обзор методов
- Добавить привязку оплаты к отгрузке sale.paymentItemShipment.add
- Изменить привязку оплаты к отгрузке sale.paymentItemShipment.update
- Получить привязку по Id sale.paymentItemShipment.get
- Удалить привязку sale.paymentItemShipment.delete
- Получить поля привязки sale.paymentItemShipment.getFields