Получить неоплаченные товарные позиции объекта CRM crm.item.productrow.getAvailableForPayment

Scope: crm

Кто может выполнять метод: требуется право на чтение объекта CRM, товарные позиции которого выбираются

Метод получает товарные позиции объекта CRM, по которым клиенту еще не была выставлена оплата.

Параметры метода

Обязательные параметры отмечены *

Название
тип

Описание

ownerId*
integer

Идентификатор объекта CRM

ownerType*
string

Идентификатор типа объекта CRM. Передавайте Краткий символьный код типа

Примеры кода

Как использовать примеры в документации

curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"ownerType":"D","ownerId":13144}' \
        https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/crm.item.productrow.getAvailableForPayment
        
curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"ownerType":"D","ownerId":13144,"auth":"**put_access_token_here**"}' \
        https://**put_your_bitrix24_address**/rest/crm.item.productrow.getAvailableForPayment
        
try
        {
        	const response = await $b24.callMethod(
        		'crm.item.productrow.getAvailableForPayment', {
        			ownerType: 'D',
        			ownerId: 13144,
        		}
        	);
        	
        	const result = response.getData().result;
        	console.log(result);
        }
        catch( error )
        {
        	console.error(error);
        }
        
try {
            $response = $b24Service
                ->core
                ->call(
                    'crm.item.productrow.getAvailableForPayment',
                    [
                        'ownerType' => 'D',
                        'ownerId'   => 13144,
                    ]
                );
        
            $result = $response
                ->getResponseData()
                ->getResult();
        
            echo 'Success: ' . print_r($result, true);
        
        } catch (Throwable $e) {
            error_log($e->getMessage());
            echo 'Error getting available product rows for payment: ' . $e->getMessage();
        }
        
BX24.callMethod(
            'crm.item.productrow.getAvailableForPayment', {
                ownerType: 'D',
                ownerId: 13144,
            },
            function(result) {
                if (result.error()) {
                    console.error(result.error());
                } else {
                    console.log(result.data());
                }
            }
        );
        
require_once('crest.php');
        
        $result = CRest::call(
            'crm.item.productrow.getAvailableForPayment',
            [
                'ownerType' => 'D',
                'ownerId' => 13144
            ]
        );
        
        echo '<PRE>';
        print_r($result);
        echo '</PRE>';

Ответ в случае успеха

HTTP-статус: 200

{
           "result":{
              "productRows":[
                 {
                    "id":17657,
                    "ownerId":13144,
                    "ownerType":"D",
                    "productId":9621,
                    "productName":"iphone 14",
                    "price":79999,
                    "priceAccount":79999,
                    "priceExclusive":79999,
                    "priceNetto":79999,
                    "priceBrutto":79999,
                    "quantity":3,
                    "discountTypeId":2,
                    "discountRate":0,
                    "discountSum":0,
                    "taxRate":null,
                    "taxIncluded":"Y",
                    "customized":"Y",
                    "measureCode":796,
                    "measureName":"шт",
                    "sort":10,
                    "xmlId":"sale_basket_8149",
                    "type":4
                 },
                 {
                    "id":17658,
                    "ownerId":13144,
                    "ownerType":"D",
                    "productId":9623,
                    "productName":"iphone 10xs",
                    "price":5550,
                    "priceAccount":5550,
                    "priceExclusive":5550,
                    "priceNetto":5550,
                    "priceBrutto":5550,
                    "quantity":3,
                    "discountTypeId":2,
                    "discountRate":0,
                    "discountSum":0,
                    "taxRate":null,
                    "taxIncluded":"Y",
                    "customized":"Y",
                    "measureCode":796,
                    "measureName":"шт",
                    "sort":20,
                    "xmlId":"sale_basket_8150",
                    "type":4
                 }
              ]
           },
           "time":{
              "start":1716966560.3205,
              "finish":1716966560.742781,
              "duration":0.42228102684020996,
              "processing":0.17676782608032227,
              "date_start":"2024-05-29T10:09:20+03:00",
              "date_finish":"2024-05-29T10:09:20+03:00"
           }
        }

Возвращаемые данные

Название
тип

Описание

result
object

Корневой элемент ответа

productRows
crm_item_product_row[]

Массив объектов, содержащий информацию о всех товарных позициях объекта CRM, по которым клиенту еще не была выставлена оплата

time
time

Информация о времени выполнения запроса

Обработка ошибок

HTTP-статус: 400

{
           "error":"ACCESS_DENIED",
           "error_description":"Доступ запрещен"
        }

Название
тип

Описание

error
string

Строковый код ошибки. Может состоять из цифр, латинских букв и знака подчеркивания

error_description
error_description

Текстовое описание ошибки. Описание не предназначено для показа конечному пользователю в необработанном виде

Возможные коды ошибок

Код

Описание

ACCESS_DENIED

Доступ запрещен

100

Не переданы обязательные параметры

0

Другие ошибки (например, фатальные ошибки)

HTTP-статус: 20x, 40x, 50x

Описанные ниже ошибки могут возникнуть при вызове любого метода

Статус

Код
Текст ошибки

Описание

500

INTERNAL_SERVER_ERROR
Internal server error

Возникла внутренняя ошибка сервера, обратитесь к администратору сервера или в техническую поддержку Битрикс24

500

ERROR_UNEXPECTED_ANSWER
Server returned an unexpected response

Возникла внутренняя ошибка сервера, обратитесь к администратору сервера или в техническую поддержку Битрикс24

503

QUERY_LIMIT_EXCEEDED
Too many requests

Превышен лимит на интенсивность запросов

405

ERROR_BATCH_METHOD_NOT_ALLOWED
Method is not allowed for batch usage

Текущий метод не разрешен для вызова с помощью batch

400

ERROR_BATCH_LENGTH_EXCEEDED
Max batch length exceeded

Превышена максимальная длина параметров, переданных в метод batch

401

NO_AUTH_FOUND
Wrong authorization data

Неверный access-токен или код вебхука

400

INVALID_REQUEST
Https required

Для вызовов методов требуется использовать протокол HTTPS

503

OVERLOAD_LIMIT
REST API is blocked due to overload

REST API заблокирован из-за перегрузки. Это ручная индивидуальная блокировка, для снятия необходимо обращаться в техническую поддержку Битрикс24

403

ACCESS_DENIED
REST API is available only on commercial plans

REST API доступен только на коммерческих планах

403

INVALID_CREDENTIALS
Invalid request credentials

У пользователя, с чьим access-токеном или вебхуком был вызван метод, не хватает прав

404

ERROR_MANIFEST_IS_NOT_AVAILABLE
Manifest is not available

Манифест недоступен

403

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

Запрос требует более высоких привилегий, чем предоставляет токен вебхука

401

expired_token
The access token provided has expired

Предоставленный access-токен доступа истек

403

user_access_error
The user does not have access to the application

Пользователь не имеет доступа к приложению. Это означает, что приложение установлено, но администратор портала разрешил доступ к этому приложению только конкретным пользователям

500

PORTAL_DELETED
Portal was deleted

Публичная часть сайта закрыта. Чтобы открыть публичную часть сайта на коробочной установке отключите опцию «Временное закрытие публичной части сайта». Путь к настройке: Рабочий стол > Настройки > Настройки продукта > Настройки модулей > Главный модуль > Временное закрытие публичной части сайта

Продолжите изучение

Предыдущая
Получить список товарных позиций
Следующая
Удалить товарную позицию