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

Выберите инструмент для разработки с AI-агентом:

  • используйте Битрикс24 Вайбкод, чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга
  • используйте MCP-сервер, чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации

Scope: crm

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

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

Метод сравнивает количество товара в позиции с количеством, которое уже попало в оплаты объекта CRM, и возвращает остаток. Позиции, полностью попавшие в оплаты, в ответ не войдут. Если нужны все позиции объекта CRM без учета оплат, вызовите crm.item.productrow.list.

Метод возвращает все подходящие позиции сразу, без постраничной навигации, в порядке возрастания значения sort. Если все позиции объекта CRM уже попали в оплаты, метод вернет пустой массив "productRows":[].

Вызывайте метод, когда собираете новую оплату: он показывает, какие позиции клиенту еще можно выставить. Саму оплату создают методы раздела Оплаты и доставки, а позиции в нее добавляют методы раздела Товарные позиции в оплате.

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

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

Название
тип

Описание

ownerId*
integer

Идентификатор объекта CRM.
Получить его можно методом crm.item.list или из ответа метода crm.item.add

ownerType*
string

Краткий символьный код типа объекта CRM: L — лид, D — сделка, Q — предложение, SI — новый счет, T и шестнадцатеричный идентификатор типа — смарт-процесс. Например, для типа с entityTypeId: 128 код — T80

Примеры кода

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

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
// 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 the payload returned in result (match the "response handling" section of the page)
type GetAvailableForPaymentResult = {
  productRows: {
    id: number
    ownerId: number
    ownerType: string
    productId: number
    productName: string
    price: number
    priceAccount: number
    priceExclusive: number
    priceNetto: number
    priceBrutto: number
    quantity: number
    discountTypeId: number
    discountRate: number
    discountSum: number
    taxRate: number | null
    taxIncluded: string
    taxName: string
    customized: string
    measureCode: number
    measureName: string
    sort: number
    xmlId: string
    type: number
  }[]
}

try {
  const response = await $b24.actions.v2.call.make<GetAvailableForPaymentResult>({
    method: 'crm.item.productrow.getAvailableForPayment',
    params: {
      ownerType: 'D',
      ownerId: 13144,
    },
    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(result.productRows)
  }
} 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 getAvailableForPayment() {
    try {
      // Initialize the SDK inside a Bitrix24 frame
      const $b24 = await B24Js.initializeB24Frame()

      const response = await $b24.actions.v2.call.make({
        method: 'crm.item.productrow.getAvailableForPayment',
        params: {
          ownerType: 'D',
          ownerId: 13144,
        },
        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(result.productRows)
    } catch (error) {
      // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
      console.error(error)
    }
  }

  document.addEventListener('DOMContentLoaded', getAvailableForPayment)
</script>
from b24pysdk.errors import BitrixAPIError, BitrixSDKException

try:
    bitrix_response = client.crm.item.productrow.get_available_for_payment(
        owner_type="D",
        owner_id=13144,
    ).response
    result = bitrix_response.result
    print(result)
except BitrixAPIError as error:
    print(
        "Ошибка Bitrix API",
        f"error: {error.error}",
        f"error_description: {error.error_description}",
        sep="\n",
    )
except BitrixSDKException as error:
    print(f"Ошибка Bitrix SDK: {error.message}")
except Exception as error:
    print(f"Непредвиденная ошибка: {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>';
// client и ctx уже созданы — см. раздел «SDK для Go»
res, err := client.Core().Call(ctx, "crm.item.productrow.getAvailableForPayment", b24.Params{
	"ownerType": "D",
	"ownerId":   13144,
})
if err != nil {
	return fmt.Errorf("crm.item.productrow.getAvailableForPayment: %w", err)
}

// Метод заворачивает ответ в объект с ключом "productRows".
raw, ok := b24.Unwrap(res.Result, "productRows")
if !ok {
	return fmt.Errorf("в ответе нет ключа productRows")
}

var items []struct {
	ID          b24.ID  `json:"id"`
	OwnerID     b24.ID  `json:"ownerId"`
	OwnerType   string  `json:"ownerType"`
	ProductID   b24.ID  `json:"productId"`
	ProductName string  `json:"productName"`
	Price       float64 `json:"price"`
}
if err := json.Unmarshal(raw, &items); err != nil {
	return fmt.Errorf("разбор ответа: %w", err)
}
for _, it := range items {
	fmt.Println(it.ID)
}

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

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",
            "taxName":"Без НДС",
            "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",
            "taxName":"Без НДС",
            "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

Корневой элемент ответа (подробное описание)

time
time

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

Объект result

Название
тип

Описание

productRows
crm_item_product_row[]

Массив объектов с информацией о выбранных товарных позициях.
В поле quantity каждой позиции — остаток, который еще не попал в оплаты, а не исходное количество товара

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

HTTP-статус: 400

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

Название
тип

Описание

error
string

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

error_description
string

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

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

Код

Описание

ENTITY_TYPE_NOT_SUPPORTED

Этот тип объектов CRM не поддерживает товарные позиции

ACCESS_DENIED

У пользователя нет права на чтение объекта CRM

OWNER_NOT_FOUND

Переданный объект CRM не найден

100

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

0

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

HTTP-статус: 4xx, 5xx

Описанные ниже ошибки возвращает сам REST API, а не логика конкретного метода. Они могут прийти в ответ на любой метод.

Статус

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

Описание

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

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

429

OPERATION_TIME_LIMIT
Method is blocked due to operation time limit

Метод заблокирован из-за превышения лимита на ресурсоемкость запросов. Блокировка снимается автоматически, когда накопленное время выполнения метода перестает превышать лимит

401

NO_AUTH_FOUND
Wrong authorization data

В запросе нет авторизационных данных: не передан ни access-токен, ни код вебхука

401

INVALID_REQUEST
Https required

Методы вызываются только по протоколу HTTPS

401

OVERLOAD_LIMIT
REST API is blocked due to overload

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

401

ACCESS_DENIED
REST is available only on commercial plans

REST API доступен только на коммерческих тарифах. У вебхука текст ошибки другой — REST is available only by subscription

401

INVALID_CREDENTIALS
Invalid request credentials

Не найден активный вебхук с указанным идентификатором пользователя и секретным кодом

404

ERROR_METHOD_NOT_FOUND
Method not found!

Метод с таким именем не найден. Имя написано с ошибкой, метода нет в REST API или он недоступен без нужного скоупа

401

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

Запрос требует более широких прав, чем есть у токена: у вебхука это выданные ему права, у приложения — скоуп. У приложения текст ошибки заканчивается на provided by the access token

401

expired_token
The access token provided has expired

Срок действия access-токена истек

401

user_access_error
The user does not have access to the application

Приложение установлено, но администратор Битрикс24 открыл доступ к нему только конкретным пользователям

403

PORTAL_DELETED
Portal was deleted

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

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