Get a list of order bindings to CRM entities crm.orderentity.list

Scope: crm

Who can execute the method: online store manager

The method returns a list of order bindings to CRM entities.

Method Parameters

Name `type`	Description
select `array`	An array of fields to select (see fields of the crm_orderentity object). If the array is not provided or an empty array is passed, all available fields of the order binding to the CRM entity will be selected.
filter `object`	An object for filtering selected records in the format `{"field_1": "value_1", ... "field_N": "value_N"}`. Possible values for `field_N` correspond to the fields of the crm_orderentity object. An additional prefix can be specified for the key to clarify the filter behavior. Possible prefix values: `>=` — greater than or equal to `>` — greater than `<=` — less than or equal to `<` — less than `@` — IN, an array is passed as the value `!@` — NOT IN, an array is passed as the value `%` — LIKE, substring search. The `%` character should not be passed in the filter value. The search looks for the substring in any position of the string `=%` — LIKE, substring search. The `%` character must be passed in the value. Examples: `"mol%"` — searches for values starting with "mol" `"%mol"` — searches for values ending with "mol" `"%mol%"` — searches for values where "mol" can be in any position `%=` — LIKE (similar to `=%`) `!%` — NOT LIKE, substring search. The `%` character should not be passed in the filter value. The search goes from both sides `!=%` — NOT LIKE, substring search. The `%` character must be passed in the value. Examples: `"mol%"` — searches for values not starting with "mol" `"%mol"` — searches for values not ending with "mol" `"%mol%"` — searches for values where the substring "mol" is not present in any position `!%=` — NOT LIKE (similar to `!=%`) `=` — equal, exact match (used by default) `!=` — not equal `!` — not equal
order `object`	An object for sorting records in the format `{"field_1": "order_1", ... "field_N": "order_N"}`, where `field_N` is the identifier of the crm_orderentity field. Possible values for `order_N`: `asc` — in ascending order `desc` — in descending order If the object is not provided or an empty object is passed, sorting will be in ascending order of the crm_orderentity.OWNER_ID field.
start `integer`	This parameter is used for pagination control. The page size of results is always static: 50 records. To select the second page of results, you need to pass the value `50`. To select the third page of results, the value is `100`, and so on. The formula for calculating the `start` parameter value: `start = (N-1) * 50`, where `N` is the desired page number. If you specify the value `-1`, all records that meet the filter conditions will be selected.

Code Examples

How to Use Examples in Documentation

Get the IDs of orders linked to three deals:

cURL (Webhook)

cURL (OAuth)

PHP

BX24.js

PHP CRest

curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"select":["orderId","ownerId"],"filter":{"=ownerTypeId":2,"@ownerId":[6938,6937,6933]},"order":{"orderId":"asc"}}' \
        https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/crm.orderentity.list

curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"select":["orderId","ownerId"],"filter":{"=ownerTypeId":2,"@ownerId":[6938,6937,6933]},"order":{"orderId":"asc"},"auth":"**put_access_token_here**"}' \
        https://**put_your_bitrix24_address**/rest/crm.orderentity.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.orderentity.list',
            {
              select: [
                'orderId',
                'ownerId',
              ],
              filter: {
                '=ownerTypeId': 2,
                '@ownerId': [6938, 6937, 6933],
              },
              order: {
                orderId: 'asc'
              },
            },
            (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.orderentity.list', {
            select: [
              'orderId',
              'ownerId',
            ],
            filter: {
              '=ownerTypeId': 2,
              '@ownerId': [6938,6937,6933],
            },
            order: {
              orderId: 'asc'
            },
          }, 'orderId');
          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.orderentity.list', {
            select: [
              'orderId',
              'ownerId',
            ],
            filter: {
              '=ownerTypeId': 2,
              '@ownerId': [6938, 6937, 6933],
            },
            order: {
              orderId: 'asc'
            },
          }, 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.orderentity.list',
                    [
                        'select' => [
                            'orderId',
                            'ownerId',
                        ],
                        'filter' => [
                            '=ownerTypeId' => 2,
                            '@ownerId'    => [6938, 6937, 6933],
                        ],
                        'order'  => [
                            'orderId' => 'asc',
                        ],
                    ]
                );
        
            $result = $response
                ->getResponseData()
                ->getResult();
        
            echo 'Success: ' . print_r($result, true);
            // Your logic for processing data
            processData($result);
        
        } catch (Throwable $e) {
            error_log($e->getMessage());
            echo 'Error fetching order entities: ' . $e->getMessage();
        }

BX24.callMethod(
            "crm.orderentity.list",
            {
                select: [
                    'orderId',
                    'ownerId',
                ],
                filter: {
                    '=ownerTypeId': 2,
                    '@ownerId': [6938, 6937, 6933],
                },
                order: {
                    orderId: 'asc'
                },
            },)
            .then(
                function(result)
                {
                    if (result.error())
                    {
                        console.error(result.error());
                    }
                    else
                    {
                        console.log(result.data);
                    }
                },
                function(error)
                {
                    console.info(error);
                }
            );

require_once('crest.php');
        
        $result = CRest::call(
            'crm.orderentity.list',
            [
                'select' => [
                    'orderId',
                    'ownerId',
                ],
                'filter' => [
                    '=ownerTypeId' => 2,
                    '@ownerId' => [6938, 6937, 6933],
                ],
                'order' => [
                    'orderId' => 'asc'
                ]
            ]
        );
        
        echo '<PRE>';
        print_r($result);
        echo '</PRE>';

Response Handling

HTTP status: 200

{
            "result": {
                "orderEntity": [
                    {
                        "orderId": 5125,
                        "ownerId": 6933
                    },
                    {
                        "orderId": 5127,
                        "ownerId": 6937
                    },
                    {
                        "orderId": 5128,
                        "ownerId": 6938
                    }
                ]
            },
            "total": 3,
            "time": {
                "start": 1719315806.858516,
                "finish": 1719315807.569731,
                "duration": 0.7112150192260742,
                "processing": 0.039324045181274414,
                "date_start": "2024-06-25T13:43:26+02:00",
                "date_finish": "2024-06-25T13:43:27+02:00",
                "operating": 0
            }
        }

Returned Data

Name `type`	Description
result `object`	The root element of the response
orderEntity `crm_orderentity[]`	An array of objects with information about the selected orders
total `integer`	The total number of selected records
time `time`	Information about the execution time of the request

Error Handling

HTTP status: 400

{
            "error": "200040300010",
            "error_description": "Access Denied"
        }

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 Errors

Code	Description
`200040300010`	`Access Denied` Insufficient access permissions
`200540400002`	`module sale does not exist` The `Online Store` (sale) module is missing

Statuses and System Error Codes

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 Order Link to CRM Entity

Remove Order Link from CRM Entity

Get a list of order bindings to CRM entities crm.orderentity.list

Method ParametersMethod Parameters

Code ExamplesCode Examples

Response HandlingResponse Handling

Returned DataReturned Data

Error HandlingError Handling

Possible ErrorsPossible Errors

Statuses and System Error CodesStatuses and System Error Codes

Continue LearningContinue Learning