Get Delivery Item List by Specific Payment crm.item.payment.delivery.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 delivery items 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 delivery 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 (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 goes 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 delivery items for payment in the format `{"field_1": "order_1", ... "field_N": "order_N"}`. Possible values for `field`: `id` `quantity` Possible values for `order`: `asc` — ascending order `desc` — 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":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

// callListMethod: Retrieves all data at once. Use only for small selections (< 1000 items) due to high memory load.
        
        try {
          const response = await $b24.callListMethod(
            'crm.item.payment.delivery.list',
            {
              paymentId: 1040,
              filter: {
                ">=quantity": 1,
                "@id": [1201],
              },
            },
            (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 for large volumes of data for efficient memory consumption.
        
        try {
          const generator = $b24.fetchListMethod('crm.item.payment.delivery.list', {
            paymentId: 1040,
            filter: {
              ">=quantity": 1,
              "@id": [1201],
            },
          }, 'ID');
          for await (const page of generator) {
            for (const entity of page) { console.log('Entity:', entity); }
          }
        } catch (error) {
          console.error('Request failed', error);
        }
        
        // callMethod: Manual control of pagination through the start parameter. Use for precise control over request batches. Less efficient for large data than fetchListMethod.
        
        try {
          const response = await $b24.callMethod('crm.item.payment.delivery.list', {
            paymentId: 1040,
            filter: {
              ">=quantity": 1,
              "@id": [1201],
            },
          }, 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.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>';

Successful Response

HTTP Status: 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+02:00",
              "date_finish":"2024-05-21T17:30:49+02:00"
           }
        }

Returned Data

Name `type`	Description
result `crm_item_payment_delivery[]`	Array of objects containing information about the selected delivery items for payment
time `time`	Information about the request execution time

Key result. Object of type crm_item_payment_delivery

Name `type`	Description
id `integer`	Identifier of the delivery item in the payment
paymentId `sale_order_payment.id`	Identifier of the payment
quantity `double`	Quantity
deliveryId `sale_order_shipment.id`	Identifier of the delivery

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 parameters 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

Add Delivery Item to Payment

Remove Delivery Item from Payment

Get Delivery Item List by Specific Payment crm.item.payment.delivery.list

Method ParametersMethod Parameters

Code ExamplesCode Examples

Successful ResponseSuccessful Response

Returned DataReturned Data

Key result. Object of type crm_item_payment_deliveryKey result. Object of type crm_item_payment_delivery

Error HandlingError Handling

Possible Error CodesPossible Error Codes

Error Handling FeaturesError Handling Features

Continue LearningContinue Learning