Get a list of payment product items crm.item.payment.product.list

Scope: crm

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

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

Method Parameters

Required parameters are marked with *

Name `type`	Description
paymentId* `sale_order_payment.id`	Payment identifier. Can be obtained using the `sale.payment.list` method
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 in the filter value does not need to be passed. The search looks for the substring in any position of the string `>` — greater than `<` — less than `!=` — not equal `!%` — NOT LIKE, substring search. The % symbol in the filter value does not need to be passed. The search goes from both sides. `>=` — greater than or equal to `<=` — less than or equal to `=%` — LIKE, substring search. The % symbol needs to be passed 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 needs to be passed 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 (Webhook)

cURL (OAuth)

PHP

BX24.js

PHP CRest

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

// callListMethod: Retrieves all data at once. Use only for small selections (< 1000 items) due to high memory usage.
        
        try {
          const response = await $b24.callListMethod(
            'crm.item.payment.product.list',
            {
              paymentId: 1039,
              filter: {
                ">=quantity": 2,
                "@id": [1195, 1196],
              },
            },
            (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: Retrieves data in parts using an iterator. Use it for large data volumes to optimize memory usage.
        
        try {
          const generator = $b24.fetchListMethod('crm.item.payment.product.list', {
            paymentId: 1039,
            filter: {
              ">=quantity": 2,
              "@id": [1195, 1196],
            },
          }, 'ID')
          for await (const page of generator) {
            for (const entity of page) { console.log('Entity:', entity) }
          }
        } catch (error) {
          console.error('Request failed', error)
        }
        
        // callMethod: Manually controls pagination through the start parameter. Use it for precise control of request batches. For large datasets, it is less efficient than fetchListMethod.
        
        try {
          const response = await $b24.callMethod('crm.item.payment.product.list', {
            paymentId: 1039,
            filter: {
              ">=quantity": 2,
              "@id": [1195, 1196],
            },
          }, 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(
                    '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>';

Successful Response

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+02:00",
              "date_finish":"2024-05-21T13:09:00+02: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 execution time of the request

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 entity

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 not provided
`0`	Other errors (e.g., fatal errors)

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 allowed to be called 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 methods must be called using the HTTPS protocol
`503`	`OVERLOAD_LIMIT` REST API is blocked due to overload	The REST API is blocked due to overload. This is a manual individual block, to remove it you need to contact Bitrix24 technical support
`403`	`ACCESS_DENIED` REST API is available only on commercial plans	The REST API is available only on commercial plans
`403`	`INVALID_CREDENTIALS` Invalid request credentials	The user whose access token or webhook was used to call the method lacks 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 account administrator has allowed access to this application only for specific users
`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 option "Temporary closure of the public part of the site". Path to the setting: Desktop > Settings > Product Settings > Module Settings > Main Module > Temporary closure of the public part of the site

Continue Learning

Add Product Item

Delete Product Item

Get a list of payment product items crm.item.payment.product.list

Method ParametersMethod Parameters

Code ExamplesCode Examples

Successful ResponseSuccessful Response

Returned DataReturned Data

Key result. Object of type crm_item_payment_productKey result. Object of type crm_item_payment_product

Error HandlingError Handling

Possible Error CodesPossible Error Codes

Continue LearningContinue Learning