Get a List of Payment Product Items crm.item.payment.product.list

If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the MCP server so that the assistant can utilize the official REST documentation.

Scope: crm

Who can execute the method: read access permission for payment order is required

This method retrieves a list of product items (goods or services) associated with a specific payment.

Method Parameters

Required parameters are marked with *

Name
type

Description

paymentId*
sale_order_payment.id

Identifier of the payment.
Can be obtained using the method sale.payment.list

filter*
object

Object for filtering selected payment product items in the format {"field_1": "value_1", ... "field_N": "value_N"}.

Possible values for field:

  • id
  • quantity

An additional prefix can be specified for the key to clarify the filter behavior. Possible prefix values:

  • = — equals, exact match (used by default)
  • % — LIKE, substring search. The % symbol should not be included in the filter value. The search looks for the substring in any position of the string.
  • > — greater than
  • < — less than
  • != — not equal
  • !% — NOT LIKE, substring search. The % symbol should not be included in the filter value. The search is conducted from both sides.
  • >= — greater than or equal to
  • <= — less than or equal to
  • @ — IN, an array is passed as the value
  • !@ — NOT IN, an array is passed as the value
  • =% — LIKE, substring search. The % symbol must be included in the value. Examples:
    • "mol%" — searching for values starting with "mol"
    • "%mol" — searching for values ending with "mol"
    • "%mol%" — searching for values where "mol" can be in any position
  • %= — LIKE (see description above)
  • !=% — NOT LIKE, substring search. The % symbol must be included in the value. Examples:
    • "mol%" — searching for values not starting with "mol"
    • "%mol" — searching for values not ending with "mol"
    • "%mol%" — searching for values where the substring "mol" is not present in any position
  • !%= — NOT LIKE (see description above)

order
object

Object for sorting selected payment product items in the format {"field_1": "order_1", ... "field_N": "order_N"}.

Possible values for field:

  • id
  • quantity

Possible values for order:

  • asc — in ascending order
  • desc — in descending order

Code Examples

How to Use Examples in Documentation

curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"paymentId":1039,"filter":{"\u003E=quantity":2,"@id":[1195,1196]}}' \
        https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/crm.item.payment.product.list
        
curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"paymentId":1039,"filter":{"\u003E=quantity":2,"@id":[1195,1196]},"auth":"**put_access_token_here**"}' \
        https://**put_your_bitrix24_address**/rest/crm.item.payment.product.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 PaymentProductItem = {
          id: number,
          paymentId: number,
          quantity: number,
          rowId: number,
        }
        
        try {
          // crm.item.payment.product.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<PaymentProductItem[]>({
            method: 'crm.item.payment.product.list',
            params: {
              paymentId: 1039,
              filter: {
                '>=quantity': 2,
                '@id': [1195, 1196],
              },
              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('Payment products:', 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 fetchPaymentProductList() {
            try {
              // Initialize the SDK inside a Bitrix24 frame
              const $b24 = await B24Js.initializeB24Frame()
        
              // crm.item.payment.product.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.product.list',
                params: {
                  paymentId: 1039,
                  filter: {
                    '>=quantity': 2,
                    '@id': [1195, 1196],
                  },
                  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('Payment products:', result.length, result)
            } catch (error) {
              // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
              console.error(error)
            }
          }
        
          document.addEventListener('DOMContentLoaded', fetchPaymentProductList)
        </script>
        
try {
            $response = $b24Service
                ->core
                ->call(
                    'crm.item.payment.product.list',
                    [
                        'paymentId' => 1039,
                        'filter'    => [
                            '>=quantity' => 2,
                            '@id'        => [1195, 1196],
                        ],
                    ]
                );
        
            $result = $response
                ->getResponseData()
                ->getResult();
        
            echo 'Success: ' . print_r($result, true);
        
        } catch (Throwable $e) {
            error_log($e->getMessage());
            echo 'Error fetching payment product list: ' . $e->getMessage();
        }
        

Example

from b24pysdk.client import BaseClient
        from b24pysdk.errors import BitrixAPIError, BitrixSDKException
        
        client: BaseClient
        
        try:
            bitrix_response = client.crm.item.payment.product.list(
                payment_id=1039,
                filter={
                    ">=quantity": 2,
                    "@id": [1195, 1196],
                },
            ).response
            result = bitrix_response.result
            print(result)
        except BitrixAPIError as error:
            print(
                "Bitrix API Error",
                f"error: {error.error}",
                f"error_description: {error.error_description}",
                sep="\n",
            )
        except BitrixSDKException as error:
            print(f"Bitrix SDK Error: {error.message}")
        except Exception as error:
            print(f"Unexpected error: {error}")
        

Example as_list

from b24pysdk.client import BaseClient
        from b24pysdk.errors import BitrixAPIError, BitrixSDKException
        
        client: BaseClient
        
        try:
            bitrix_response = client.crm.item.payment.product.list(
                payment_id=1039,
                filter={
                    ">=quantity": 2,
                    "@id": [1195, 1196],
                },
            ).as_list().response
            result = bitrix_response.result
            for item in result:
                print(item)
        except BitrixAPIError as error:
            print(
                "Bitrix API Error",
                f"error: {error.error}",
                f"error_description: {error.error_description}",
                sep="\n",
            )
        except BitrixSDKException as error:
            print(f"Bitrix SDK Error: {error.message}")
        except Exception as error:
            print(f"Unexpected error: {error}")
        

Example as_list_fast

from b24pysdk.client import BaseClient
        from b24pysdk.errors import BitrixAPIError, BitrixSDKException
        
        client: BaseClient
        
        try:
            bitrix_response = client.crm.item.payment.product.list(
                payment_id=1039,
                filter={
                    ">=quantity": 2,
                    "@id": [1195, 1196],
                },
            ).as_list_fast(descending=True).response
            result = bitrix_response.result
            for item in result:
                print(item)
        except BitrixAPIError as error:
            print(
                "Bitrix API Error",
                f"error: {error.error}",
                f"error_description: {error.error_description}",
                sep="\n",
            )
        except BitrixSDKException as error:
            print(f"Bitrix SDK Error: {error.message}")
        except Exception as error:
            print(f"Unexpected error: {error}")
        
BX24.callMethod(
            'crm.item.payment.product.list', {
                paymentId: 1039,
                filter: {
                    ">=quantity": 2,
                    "@id": [1195, 1196],
                },
            },
            function(result) {
                if (result.error()) {
                    console.error(result.error());
                } else {
                    console.log(result.data());
                }
            }
        );
        
require_once('crest.php');
        
        $result = CRest::call(
            'crm.item.payment.product.list',
            [
                'paymentId' => 1039,
                'filter' => [
                    ">=quantity" => 2,
                    "@id" => [1195, 1196],
                ]
            ]
        );
        
        echo '<PRE>';
        print_r($result);
        echo '</PRE>';
        

Response on Success

HTTP status: 200

{
           "result":[
              {
                 "id":1195,
                 "paymentId":1039,
                 "quantity":2,
                 "rowId":17587
              },
              {
                 "id":1196,
                 "paymentId":1039,
                 "quantity":3,
                 "rowId":17588
              }
           ],
           "time":{
              "start":1716286140.489916,
              "finish":1716286140.802505,
              "duration":0.3125889301300049,
              "processing":0.053195953369140625,
              "date_start":"2024-05-21T13:09:00+03:00",
              "date_finish":"2024-05-21T13:09:00+03:00"
           }
        }
        

Returned Data

Name
type

Description

result
crm_item_payment_product[]

Array of objects containing information about the selected payment product items

time
time

Information about the request execution time

Key Result. Object of Type Crm_Item_Payment_Product

Name
type

Description

id
integer

Identifier of the product item in the payment

paymentId
sale_order_payment.id

Payment identifier

quantity
double

Quantity of the product

rowId
integer

Identifier of the product item in the CRM object

Error Handling

HTTP status: 400

{
           "error":0,
           "error_description":"Payment has not been found"
        }
        

Name
type

Description

error
string

String error code. It may consist of digits, Latin letters, and underscores

error_description
error_description

Textual description of the error. The description is not intended to be shown to the end user in its raw form

Possible Error Codes

Code

Description

0

Payment not found

0

Access denied

100

Required fields are not provided

0

Other errors (e.g., fatal errors)

Error Handling Features

For business errors, the method may return error: 0. In this case, refer to error_description and match it with the list of errors above.

HTTP Status: 20x, 40x, 50x

The errors described below may occur when calling any method.

Status

Code
Error Message

Description

500

INTERNAL_SERVER_ERROR
Internal server error

An internal server error has occurred. Please contact the server administrator or Bitrix24 technical support

500

ERROR_UNEXPECTED_ANSWER
Server returned an unexpected response

An internal server error has occurred. Please contact the server administrator or Bitrix24 technical support

503

QUERY_LIMIT_EXCEEDED
Too many requests

The request intensity limit has been exceeded

405

ERROR_BATCH_METHOD_NOT_ALLOWED
Method is not allowed for batch usage

The current method is not permitted for calls using batch

400

ERROR_BATCH_LENGTH_EXCEEDED
Max batch length exceeded

The maximum length of parameters passed to the batch method has been exceeded

401

NO_AUTH_FOUND
Wrong authorization data

Invalid access token or webhook code

400

INVALID_REQUEST
Https required

The HTTPS protocol is required for method calls

503

OVERLOAD_LIMIT
REST API is blocked due to overload

The REST API is blocked due to overload. This is a manual individual block; please contact Bitrix24 technical support to lift it

403

ACCESS_DENIED
REST API is available only on commercial plans

The REST API is only available on commercial plans

403

INVALID_CREDENTIALS
Invalid request credentials

The user associated with the access token or webhook used to call the method lacks the necessary permissions

404

ERROR_MANIFEST_IS_NOT_AVAILABLE
Manifest is not available

The manifest is not available

403

insufficient_scope
The request requires higher privileges than provided by the webhook token

The request requires higher privileges than those provided by the webhook token

401

expired_token
The access token provided has expired

The provided access token has expired

403

user_access_error
The user does not have access to the application

The user does not have access to the application. This means that the application is installed, but the portal administrator has restricted access to this application to specific users only

500

PORTAL_DELETED
Portal was deleted

The public part of the site is closed. To open the public part of the site on an on-premise installation, disable the "Temporary closure of the public part of the site" option. Path to the setting: Desktop > Settings > Product Settings > Module Settings > Main Module > Temporary closure of the public part of the site

Continue Learning