crm.item.payment.delivery.list
Получить список позиций доставки по конкретной оплате
Описание
Метод получает список позиций доставки по конкретной оплате.
Параметры
paymentId
sale_order_payment.id
обязательный
Идентификатор оплаты.
Можно получить с помощью метода sale.payment.list
filter
object
обязательный
Объект для фильтрации выбранных позиций доставки в формате {"field_1": "value_1", ... "field_N": "value_N"}.
Возможные значения для field:
- id
- quantity
Ключу может быть задан дополнительный префикс, уточняющий поведение фильтра. Возможные значения префикса:
=— равно, точное совпадение (используется по умолчанию)%— LIKE, поиск по подстроке. Символ % в значении фильтра передавать не нужно. Поиск ищет подстроку в любой позиции строки>— больше<— меньше!=— не равно!%— NOT LIKE, поиск по подстроке. Символ % в значении фильтра передавать не нужно. Поиск идет с обоих сторон.>=— больше либо равно<=— меньше либо равно@— IN, в качестве значения передается массив!@— NOT IN, в качестве значения передается массив=%— LIKE, поиск по подстроке. Символ % нужно передавать в значении. Примеры:
-"мол%"— ищем значения начинающиеся с «мол»
-"%мол"— ищем значения заканчивающиеся на «мол»
-"%мол%"— ищем значения, где «мол» может быть в любой позиции%=— LIKE (смотрите описание выше)!=%— NOT LIKE, поиск по подстроке. Символ % нужно передавать в значении. Примеры:
-"мол%"— ищем значения не начинающиеся с «мол»
-"%мол"— ищем значения не заканчивающиеся на «мол»
-"%мол%"— ищем значения, где подстроки «мол» нет в любой позиции!%=— NOT LIKE (смотрите описание выше)
order
object
необязательный
Объект для сортировки выбранных позиций доставки оплаты в формате {"field_1": "order_1", ... "field_N": "order_N"}.
Возможные значения для field:
- id
- quantity
Возможные значения для order:
asc— в порядке возрастанияdesc— в порядке убывания
Примеры запроса
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"paymentId":1040,"filter":{"@id":[1201], ">=quantity":1}}' \
https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/crm.item.payment.delivery.list
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"paymentId":1040,"filter":{"@id":[1201], ">=quantity":1},"auth":"**put_access_token_here**"}' \
https://**put_your_bitrix24_address**/rest/crm.item.payment.delivery.list
// 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 } from '@bitrix24/b24jssdk'
declare const $b24: B24Frame
// Shape of each item returned in result[]
type CrmItemPaymentDelivery = {
id: number
paymentId: number
quantity: number
deliveryId: number
}
try {
// crm.item.payment.delivery.list returns a single page (max 50 records). For the whole result set
// use a list helper: $b24.actions.v2.callList.make() returns every record as one
// array, $b24.actions.v2.fetchList.make() yields them in chunks (async generator).
// NOTE: the list helpers do not accept `order` (it is excluded from their params, so
// passing it is a TS error) — keep this call.make + `start` variant when sort matters.
const response = await $b24.actions.v2.call.make<CrmItemPaymentDelivery[]>({
method: 'crm.item.payment.delivery.list',
params: {
paymentId: 1040,
filter: {
'>=quantity': 1,
'@id': [1201],
},
start: 0,
},
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('Delivery items count:', result.length, result)
}
} 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 listPaymentDeliveries() {
try {
// Initialize the SDK inside a Bitrix24 frame
const $b24 = await B24Js.initializeB24Frame()
// crm.item.payment.delivery.list returns a single page (max 50 records). For the whole result set
// use a list helper: $b24.actions.v2.callList.make() returns every record as one
// array, $b24.actions.v2.fetchList.make() yields them in chunks (async generator).
// NOTE: the list helpers do not accept `order` (it is excluded from their params, so
// passing it is a TS error) — keep this call.make + `start` variant when sort matters.
const response = await $b24.actions.v2.call.make({
method: 'crm.item.payment.delivery.list',
params: {
paymentId: 1040,
filter: {
'>=quantity': 1,
'@id': [1201],
},
start: 0,
},
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('Delivery items count:', result.length, result)
} catch (error) {
// Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
console.error(error)
}
}
document.addEventListener('DOMContentLoaded', listPaymentDeliveries)
</script>
from b24pysdk.errors import BitrixAPIError, BitrixSDKException
try:
bitrix_response = client.crm.item.payment.delivery.list(
payment_id=1040,
filter={
"@id": [
1201,
],
">=quantity": 1,
},
).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}")
from b24pysdk.errors import BitrixAPIError, BitrixSDKException
try:
bitrix_response = client.crm.item.payment.delivery.list(
payment_id=1040,
filter={
"@id": [
1201,
],
">=quantity": 1,
},
).as_list().response
result = bitrix_response.result
for item in result:
print(item)
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}")
from b24pysdk.errors import BitrixAPIError, BitrixSDKException
try:
bitrix_response = client.crm.item.payment.delivery.list(
payment_id=1040,
filter={
"@id": [
1201,
],
">=quantity": 1,
},
).as_list_fast(descending=True).response
result = bitrix_response.result
for item in result:
print(item)
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(
'crm.item.payment.delivery.list',
[
'paymentId' => 1040,
'filter' => [
">=quantity" => 1,
"@id" => [1201],
],
]
);
$result = $response
->getResponseData()
->getResult();
echo 'Success: ' . print_r($result, true);
} catch (Throwable $e) {
error_log($e->getMessage());
echo 'Error fetching payment delivery list: ' . $e->getMessage();
}
BX24.callMethod(
'crm.item.payment.delivery.list', {
paymentId: 1040,
filter: {
">=quantity": 1,
"@id": [1201],
},
},
function(result) {
if (result.error()) {
console.error(result.error());
} else {
console.log(result.data());
}
}
);
require_once('crest.php');
$result = CRest::call(
'crm.item.payment.delivery.list',
[
'paymentId' => 1040,
'filter' => [
'>=quantity' => 1,
'@id' => [1201],
]
]
);
echo '<PRE>';
print_r($result);
echo '</PRE>';
// client и ctx уже созданы — см. раздел «SDK для Go»
res, err := client.Core().Call(ctx, "crm.item.payment.delivery.list", b24.Params{
"paymentId": 1040,
"filter": b24.Params{
"@id": []int{1201},
">=quantity": 1,
},
}, b24.WithIdempotent())
if err != nil {
return fmt.Errorf("crm.item.payment.delivery.list: %w", err)
}
var items []struct {
ID b24.ID `json:"id"`
PaymentID b24.ID `json:"paymentId"`
Quantity int `json:"quantity"`
DeliveryID b24.ID `json:"deliveryId"`
}
if err := json.Unmarshal(res.Result, &items); err != nil {
return fmt.Errorf("разбор ответа: %w", err)
}
for _, it := range items {
fmt.Println(it.ID, it.PaymentID)
}
// Total и Next заполняют списочные методы; для полного
// обхода списка есть client.Core().Pages и Scan.
if res.Total != nil {
fmt.Println("всего:", *res.Total)
}
Ответ
HTTP-статус: 200
{
"result":[
{
"id":1201,
"paymentId":1040,
"quantity":1,
"deliveryId":4073
}
],
"time":{
"start":1716301848.792584,
"finish":1716301849.095721,
"duration":0.30313706398010254,
"processing":0.05563783645629883,
"date_start":"2024-05-21T17:30:48+03:00",
"date_finish":"2024-05-21T17:30:49+03:00"
}
}
Возвращаемые данные
result
crm_item_payment_delivery[]
Массив объектов, содержащий информацию о выбранных позициях доставки оплаты
time
time
Информация о времени выполнения запроса
Обработка ошибок
HTTP-статус: 400
{
"error":0,
"error_description":"Payment has not been found"
}
| Код | Описание | Значение |
|---|---|---|
0 |
Оплата не найдена | |
0 |
Доступ запрещен | |
100 |
Не переданы обязательные параметры | |
0 |
Другие ошибки (например, фатальные ошибки) |

