# Получение списка виртуальных валют по указанной группе

Retrieves a list of virtual currencies from the specified group for building a catalog.


. Внимание
Все проекты имеют ограничение на количество товаров, которые вы можете получить в ответе. Значение по умолчанию и максимальное значение — 50 товаров на ответ.Чтобы получить больше данных постранично, используйте поля limit и offset.





Примечание
Без авторизации метод возвращает общие данные по каталогу товаров. Используйте авторизацию, чтобы получить персонализированные данные пользователя, такие как лимиты и акции, связанные с этим товаром. Для этого необходимо передать JWT пользователя в заголовке Authorization. Подробная информация о JWT пользователя приведена в блоке Безопасность для этого метода.

Endpoint: GET /v2/project/{project_id}/items/virtual_currency/group/{external_id}
Version: 2.0.0
Security: XsollaLoginUserJWT

## Path parameters:

  - `project_id` (integer, required)
    ID проекта. Вы можете найти этот параметр в Личном кабинете рядом с названием проекта, а также в адресной строке браузера при работе с проектом. URL-адрес имеет следующий формат: https://publisher.xsolla.com//projects/.
    Example: 44056

  - `external_id` (string, required)
    External item group ID specified during creation.
    Example: "weapons"

## Query parameters:

  - `limit` (integer)
    Лимит количества элементов на странице.
    Example: 50

  - `offset` (integer)
    Номер элемента, с которого выполняется вывод на странице (нумерация ведется с 0).

  - `locale` (string)
    Язык ответа. Двухбуквенный код языка в нижнем регистре по стандарту ISO 639-1 (например, en).Коды локали из пяти символов (например, en-US) поддерживаются в полях локализации (например, name, description),но в ответах приводятся к двухбуквенному формату. Полный список поддерживаемых языков приведен в документации.

  - `additional_fields[]` (array)
    Additional fields to include in the response. By default, these fields are not returned. Pass the required values to include them.
    Enum: "media_list", "order", "long_description", "custom_attributes", "item_order_in_group"

  - `country` (string)
    Двухбуквенное обозначение страны в верхнем регистре согласно стандарту ISO 3166-1 alpha-2. Ознакомьтесь со списком стран, поддерживаемых Xsolla, а также с процессом определения страны.
    Example: "US"

  - `promo_code` (string)
    Уникальный код, чувствительный к регистру. Содержит буквы и цифры.
    Example: "WINTER2021"

  - `show_inactive_time_limited_items` (integer)
    Отображает предметы с ограниченным сроком действия, которые недоступны пользователю. Срок действия таких предметов еще не начался или уже истек.
    Example: 1

## Response 200 fields (application/json):

  - `has_more` (boolean)
    Используется как индикатор того, что остались еще страницы.

  - `items` (array)

  - `items.item_id` (integer)
    Уникальный ID товара, назначенный Xsolla.

  - `items.sku` (string)
    Уникальный ID товара. Артикул может содержать только строчные и заглавные латинские буквы, цифры, точки, тире и подчеркивания.
    Example: "crystal"

  - `items.name` (string)
    Название товара.
    Example: "Crystals"

  - `items.groups` (array)
    Группы, к которым принадлежит товар.

  - `items.groups.external_id` (string)
    [External item group ID](/ru/api/catalog/item-groups-admin/admin-create-item-group#item-groups-admin/admin-create-item-group/t=request&path=external_id) specified during creation.
    Example: "exclusive"

  - `items.groups.name` (string)
    Название группы.
    Example: "Exclusive"

  - `items.groups.item_order_in_group` (integer)
    Позиция предмета внутри группы, определяющая порядок отображения.
Возвращается в ответ только при указании в запросе query-параметра additional_fields[].
    Example: 1

  - `items.attributes` (array)
    Список атрибутов и их значений, соответствующих товару. Может использоваться для фильтрации каталога.

  - `items.attributes.external_id` (string)
    Уникальный ID атрибута. external_id может содержать только строчные и заглавные латинские буквы, цифры, тире и подчеркивания.

  - `items.attributes.name` (object)
    Название атрибута.
    Example: "Genre"

  - `items.attributes.values` (array)

  - `items.attributes.values.external_id` (string)
    Уникальный ID значения атрибута. external_id может содержать только строчные латинские буквы, цифры, тире и подчеркивания.

  - `items.attributes.values.value` (string)
    Значение атрибута.
    Example: "Strategy"

  - `items.type` (string)
    Тип товара: virtual_good/virtual_currency/bundle.
    Example: "virtual_currency"

  - `items.description` (string)
    Описание товара.
    Example: "Crystals - description"

  - `items.image_url` (string)
    URL-адрес изображения.
    Example: "https://popmedia.blob.core.windows.net/popyourself/male/outfit/male_armor_white_a-01.png"

  - `items.is_free` (boolean)
    Является ли товар бесплатным.

  - `items.price` (object,null)
    Цены на товар.

  - `items.price.amount` (string)
    Цена товара со скидкой.
    Example: "100.99"

  - `items.price.amount_without_discount` (string)
    Цена товара.
    Example: "100.99"

  - `items.price.currency` (string)
    Валюта, в которой указана цена товара. Трехбуквенный код в соответствии с [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217). Подробную информацию о [валютах, поддерживаемых Xsolla, смотрите в документации](https://developers.xsolla.com/ru/doc/pay-station/references/supported-currencies/).
    Example: "USD"

  - `items.virtual_prices` (array)
    Виртуальные цены.
    Example: [{"amount":100,"sku":"com.xsolla.crystals_1","is_default":true,"amount_without_discount":100,"image_url":"http://image.png"}]

  - `items.virtual_prices.amount` (integer)
    Цена товара в виртуальной валюте.
    Example: 100

  - `items.virtual_prices.amount_without_discount` (integer)
    Item price in virtual currency without discount. Always equal to amount since discounts are not applied to prices in virtual currency.
    Example: 200

  - `items.virtual_prices.sku` (string)
    Артикул виртуальной валюты.
    Example: "vc_gold"

  - `items.virtual_prices.is_default` (boolean)
    Является ли ценой в виртуальной валюте по умолчанию.
    Example: true

  - `items.virtual_prices.image_url` (string,null)
    URL-адрес изображения виртуальной валюты.
    Example: "http://image.png"

  - `items.virtual_prices.name` (string)
    Название виртуальной валюты.
    Example: "Gold"

  - `items.virtual_prices.type` (string)
    Item type. For virtual currency, it is virtual_currency.
    Example: "virtual_currency"

  - `items.virtual_prices.description` (string,null)
    Virtual currency description.
    Example: "In-game currency used to purchase weapons and upgrades"

  - `items.can_be_bought` (boolean)
    Если true, пользователь может купить товар.

  - `items.promotions` (array)
    Примененные акции для отдельных товаров в корзине. Массив возвращается, если:

* Скидочная акция настроена для отдельного товара.

* Используется промокод с настройкой Скидка на выбранные товары.

Если акции на уровне отдельных товаров не применялись, возвращается пустой массив.

  - `items.promotions.name` (string)

  - `items.promotions.date_start` (string,null)

  - `items.promotions.date_end` (string,null)

  - `items.promotions.discount` (object,null)

  - `items.promotions.discount.percent` (string,null)

  - `items.promotions.discount.value` (string,null)

  - `items.promotions.bonus` (array)

  - `items.promotions.bonus.sku` (string)

  - `items.promotions.bonus.quantity` (integer)

  - `items.promotions.bonus.type` (string)
    Тип бонусного товара.
    Enum: "virtual_good", "virtual_currency", "bundle", "physical_good", "game_key", "nft"

  - `items.promotions.bonus.name` (string)
    Название бонусного товара. Недоступно для типа бонусного товара physical_good.

  - `items.promotions.bonus.image_url` (string)
    URL-адрес изображения бонусного бандла. Недоступно для типа бонусного товара physical_good.

  - `items.promotions.bonus.bundle_type` (string)
    Тип товара бонусного бандла. Доступно только для бонусного товара типа bundle.
    Enum: "standard", "virtual_currency_package"

  - `items.promotions.limits` (object)

  - `items.promotions.limits.per_user` (object)

  - `items.promotions.limits.per_user.available` (integer)

  - `items.promotions.limits.per_user.total` (integer)

  - `items.limits` (object,null)
    Ограничения на продажу товара.

  - `items.limits.per_user` (object,null)
    Ограничения на продажу товара для пользователя.

  - `items.limits.per_user.total` (integer)
    Максимальное количество товара, которое может приобрести один пользователь.
    Example: 5

  - `items.limits.per_user.available` (integer)
    Оставшееся количество товара, которое может приобрести текущий пользователь.
    Example: 3

  - `items.limits.per_user.recurrent_schedule` (any)

  - `items.limits.per_user.limit_exceeded_visibility` (string)
    Определяет видимость товара в каталоге после достижения лимита покупок до момента следующего обновления лимитов.

Применяется к товарам, для которых задано регулярное обновление лимитов в массиве recurrent_schedule.

Если обновление лимитов не задано, товар не отображается в каталоге после достижения лимита независимо от значения limit_exceeded_visibility.

Возможные значения:
- show — Товар возвращается в методах получения каталога товаров после достижения лимита покупок. В клиентских методах получения каталога после достижения лимита товар возвращается с флагом can_be_bought: false. Дата следующего сброса возвращается в reset_next_date.
- hide — Товар не возвращается в методах получения каталога товаров после достижения лимита покупок до момента сброса лимитов.
    Enum: "show", "hide"

  - `items.limits.per_item` (object,null)
    Ограничения на продажу для конкретного товара.

  - `items.limits.per_item.total` (integer)
    Максимальное количество товара, которое могут приобрести все пользователи.
    Example: 5

  - `items.limits.per_item.available` (integer)
    Оставшееся количество товара, которое могут приобрести все пользователи.
    Example: 3

  - `items.periods` (array)
    Период продажи товара.

  - `items.periods.date_from` (string,null)
    Дата, когда указанный товар будет доступен для продажи.
    Example: "2020-08-11T10:00:00+03:00"

  - `items.periods.date_until` (string,null)
    Дата, когда указанный товар станет недоступен для продажи. Может быть null.
    Example: "2020-08-11T20:00:00+03:00"

  - `items.custom_attributes` (object)
    JSON-объект, содержащий атрибуты товара и их значения.

  - `items.vp_rewards` (array)
    Список призовых баллов для товара.

  - `items.vp_rewards.item_id` (integer)
    Внутренний уникальный ID виртуального предмета или валюты.

  - `items.vp_rewards.sku` (string)
    Уникальный ID призовых баллов.

  - `items.vp_rewards.amount` (integer)
    Количество призовых баллов.

  - `items.vp_rewards.name` (string)
    Название призовых баллов.

  - `items.vp_rewards.is_clan` (boolean)
    Может ли призовой балл использоваться в цепочках наград для клана.

## Response 404 fields (application/json):

  - `statusCode` (integer)
    HTTP response status code.
    Example: 404

  - `errorCode` (integer)
    Xsolla error code
    Example: 4403

  - `errorMessage` (string)
    Краткое описание ошибки.
    Example: "[0401-4403]: Item group not found"