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

Choose a tool for developing with an AI agent:

  • use Alaio Vibecode to build an app for Bitrix24 from a task description without knowing any programming language. The agent writes the code and deploys the app to a server, with no manual hosting setup
  • use the MCP server to develop a REST API integration in your own project. The agent refers to the official REST documentation

Scope: crm

Who can execute the method: a user with "read" access permission for the CRM object associated with the payment

The method crm.item.payment.product.list returns all product items of a payment in a single response, without pagination.

Method Parameters

Required parameters are marked with *

Name
type

Description

paymentId*
sale_order_payment.id

Identifier of the payment. You can retrieve the payment identifiers of a CRM object using the crm.item.payment.list method

filter
object

Filter in the format {"field": "value"}. Available fields:

  • id — identifier of the product item in the payment
  • quantity — quantity
  • entityId — identifier of the product in the order basket

You can add an operator prefix to the key:

  • = — equals, used by default
  • != — not equal
  • >, >=, <, <= — greater than, greater than or equal to, less than, less than or equal to
  • @ — in an array of values
  • !@ — not in an array of values

All filter fields are numeric, so the substring search operators %, =%, %=, and their negations do not apply: the method accepts them without an error but finds no matches.

If you pass another field, the method returns the Internal server error. error. By default, no filter is applied. In the Python SDK, filter is a required method argument: if you do not need a filter, pass {}

order
object

Sort order in the format {"field": "direction"}. The fields are the same as in filter. Direction:

  • ASC — ascending
  • DESC — descending

Defaults to {"id": "ASC"}

The method does not support the start parameter: all payment items are returned in a single response.

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,
          entityId?: number,
          rowId?: number,
        }
        
        try {
          const response = await $b24.actions.v2.call.make<PaymentProductItem[]>({
            method: 'crm.item.payment.product.list',
            params: {
              paymentId: 1039,
              filter: {
                '>=quantity': 2,
                '@id': [1195, 1196],
              },
            },
            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()
        
              const response = await $b24.actions.v2.call.make({
                method: 'crm.item.payment.product.list',
                params: {
                  paymentId: 1039,
                  filter: {
                    '>=quantity': 2,
                    '@id': [1195, 1196],
                  },
                },
                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>
        

Example


        from b24pysdk.errors import BitrixAPIError, BitrixSDKException
        
        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.errors import BitrixAPIError, BitrixSDKException
        
        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}")
        
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();
        }
        
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>';
        
// client and ctx are already created — see the Go SDK section
        res, err := client.Core().Call(ctx, "crm.item.payment.product.list", b24.Params{
        	"paymentId": 1039,
        	"filter": b24.Params{
        		">=quantity": 2,
        		"@id":        []int{1195, 1196},
        	},
        }, b24.WithIdempotent())
        if err != nil {
        	return fmt.Errorf("crm.item.payment.product.list: %w", err)
        }
        
        var items []struct {
            ID        b24.ID  `json:"id"`
            PaymentID b24.ID  `json:"paymentId"`
            Quantity  int     `json:"quantity"`
            EntityID  *b24.ID `json:"entityId"`
            RowID     *b24.ID `json:"rowId"`
        }
        if err := json.Unmarshal(res.Result, &items); err != nil {
        	return fmt.Errorf("parse response: %w", err)
        }
        for _, it := range items {
        	fmt.Println(it.ID, it.PaymentID)
        }
        
        // Total and Next are filled in by list methods; for a full
        // list traversal, use client.Core().Pages and Scan.
        if res.Total != nil {
        	fmt.Println("total:", *res.Total)
        }
        

Response Handling

HTTP status: 200

{
           "result":[
              {
                 "id":433,
                 "paymentId":553,
                 "quantity":2,
                 "entityId":1349
              }
           ],
           "time":{
              "start":1790581835,
              "finish":1790581835.956596,
              "duration":0.9565958976745605,
              "processing":0,
              "date_start":"2026-09-28T10:50:35+03:00",
              "date_finish":"2026-09-28T10:50:35+03:00",
              "operating_reset_at":1790582435,
              "operating":0
           }
        }
        

Returned Data

Name
type

Description

result
crm_item_payment_product[]

Array of product items of the payment (detailed description). If there are no items, an empty array is returned

time
time

Information about the request execution time

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

entityId
integer

Identifier of the order product item. Returned if the payment item is not matched to a product row in the CRM object

rowId
integer

Identifier of the product row in the CRM object. Returned if the payment item is matched to a product row 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 consists of digits, Latin letters, and underscores. It may arrive empty — in that case only error_description shows the reason

error_description
string

Error message for the developer. Do not show it to the end user without processing

Possible Error Codes

Status

Code

Description

Value

400

0

Payment has not been found

The payment with the passed paymentId was not found

400

ACCESS_DENIED

Access denied

The user does not have permission to read the payment

400

100

Internal server error.

An unsupported field was passed in filter or order

400

100

Could not find value for parameter

The required parameter paymentId was not provided

The method returns code 0 for several different errors. To determine the cause, check the text in error_description.

Statuses and System Error Codes

HTTP Status: 4xx, 5xx

The errors described below are returned by the REST API itself, not by the logic of a specific method. They can arrive in response to any method.

Status

Code
Error Message

Description

500

INTERNAL_SERVER_ERROR
Internal server error

An internal server error has occurred. Retry the call, and if the error persists, contact the server administrator or Bitrix24 technical support

500

ERROR_UNEXPECTED_ANSWER
Server returned an unexpected response

The server returned an unexpected response. Retry the call, and if the error persists, contact the server administrator or Bitrix24 technical support

503

QUERY_LIMIT_EXCEEDED
Too many requests

The request intensity limit has been exceeded

429

OPERATION_TIME_LIMIT
Method is blocked due to operation time limit

The method is blocked because the request resource intensity limit has been exceeded. The block is lifted automatically once the accumulated execution time of the method no longer exceeds the limit

401

NO_AUTH_FOUND
Wrong authorization data

The request contains no authorization data: neither an access token nor a webhook code was passed

401

INVALID_REQUEST
Https required

Methods are called over the HTTPS protocol only

401

OVERLOAD_LIMIT
REST API is blocked due to overload

The REST API is blocked due to overload. This is a manual individual block. To have it lifted, contact Bitrix24 technical support

401

ACCESS_DENIED
REST is available only on commercial plans

REST API access is not active for this account. In Bitrix24 Cloud, check the current plan or trial status: Vibe+ plans include REST API access, while Essentials plans do not. A webhook receives a different error message — REST is available only by subscription

401

INVALID_CREDENTIALS
Invalid request credentials

No active webhook with the specified user identifier and secret code was found

404

ERROR_METHOD_NOT_FOUND
Method not found!

No method with this name was found. The name is misspelled, the method does not exist in the REST API, or it is unavailable without the required scope

401

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

The request requires broader permissions than the token has: for a webhook these are the permissions granted to it, for an application it is the scope. For an application, the error message ends with provided by the access token

401

expired_token
The access token provided has expired

The access token has expired

401

user_access_error
The user does not have access to the application

The application is installed, but the Bitrix24 administrator has granted access to it only to specific users

403

PORTAL_DELETED
Portal was deleted

The public part of the site is closed. To open it 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