# Get virtual items list

Gets a virtual items list for building a catalog.

AttentionAll projects have the limitation to the number of items that you can get in the response. The default and maximum value is 50 items per response. To get more data page by page, use limit and offset fields.  NoteThe use of the item catalog API calls is available without authorization, but to get a personalized catalog, you must pass the user JWT in the Authorization header.

Endpoint: GET /v2/project/{project_id}/items/virtual_items
Version: 2.0.0
Security: XsollaLoginUserJWT

## Path parameters:

  - `project_id` (integer, required)
    Project ID. You can find this parameter in your Publisher Account next to the name of the project.
    Example: 44056

## Query parameters:

  - `limit` (integer)
    Limit for the number of elements on the page.
    Example: 50

  - `offset` (integer)
    Number of the element from which the list is generated (the count starts from 0).

  - `locale` (string)
    Response language. Two-letter lowercase language code per ISO 639-1.

  - `additional_fields[]` (array)
    The list of additional fields. These fields will be in the response if you send them in your request.
    Enum: "media_list", "order", "long_description", "custom_attributes", "item_order_in_group"

  - `country` (string)
    Two-letter uppercase country code per ISO 3166-1 alpha-2. Check the documentation for detailed information about countries supported by Xsolla and the process of determining the country.
    Example: "US"

  - `promo_code` (string)
    Unique case sensitive code. Contains letters and numbers.
    Example: "WINTER2021"

  - `show_inactive_time_limited_items` (integer)
    Shows time-limited items that are not available to the user. The validity period of such items has not started or has already expired.
    Example: 1

## Response 200 fields (application/json):

  - `has_more` (boolean)
    Used as an indicator that there are more pages.
    Example: true

  - `items` (array)

  - `items.item_id` (number)
    Item ID.

  - `items.sku` (string)
    Unique item ID. The SKU may contain only lowercase and uppercase Latin alphanumeric characters, periods, dashes, and underscores.
    Example: "big_rocket"

  - `items.name` (object)
    Item name.
    Example: "Big Rocket"

  - `items.groups` (array)
    Groups the item belongs to.
    Example: [{"external_id":"exclusive","name":"Exclusive"}]

  - `items.groups.external_id` (string)
    A unique identifier for the group, typically used for referencing it in API requests or external systems.
    Example: "exclusive"

  - `items.groups.name` (string)
    Name of the group.
    Example: "Exclusive"

  - `items.groups.item_order_in_group` (integer)
    The item’s position within the group, used to determine its display order.
This field is included in the response only if requested via the additional_fields[] query parameter.
    Example: 1

  - `items.attributes` (array)
    List of attributes and their values corresponding to the item. Can be used for catalog filtering.
    Example: {"value":{"external_id":"genre","name":"Жанр","values":[{"external_id":"genre_e3364991f92e751689a68b96598a5a5a84010b85","value":"Casual"},{"external_id":"genre_eba07bfd0f982940773cba3744d97264dd58acd7","value":"Strategy"},{"external_id":"genre_b8d0c6d8f0524c2b2d79ebb93aa3cd0e8b5199a8","value":"Mobile"}]}}

  - `items.attributes.external_id` (string)
    Unique attribute ID. The external_id may contain only lowercase and uppercase Latin alphanumeric characters, dashes, and underscores.
    Example: "attribute_1"

  - `items.attributes.name` (object)
    Name of attribute.
    Example: "Genre"

  - `items.attributes.values` (array)

  - `items.attributes.values.external_id` (string)
    Unique value ID for an attribute. The external_id may only contain lowercase Latin alphanumeric characters, dashes, and underscores.
    Example: "attribute_value"

  - `items.attributes.values.value` (string)
    Value of attribute.
    Example: "Strategy"

  - `items.type` (string)
    Type of item: virtual_good/virtual_currency/bundle.
    Example: "virtual_good"

  - `items.description` (object)
    Item description.
    Example: "Big Rocket - description"

  - `items.image_url` (string)
    Image URL.
    Example: "https://popmedia.blob.core.windows.net/popyourself/male/outfit/male_armor_white_a-01.png"

  - `items.is_free` (boolean)
    If true, the item is free.

  - `items.price` (object,null)
    Item prices.

  - `items.price.amount` (string)
    Discounted item price.
    Example: "100.99"

  - `items.price.amount_without_discount` (string)
    Item price.
    Example: "100.99"

  - `items.price.currency` (string)
    Item price currency. Three-letter code per [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217). Check the documentation for detailed information about [currencies supported by Xsolla](https://developers.xsolla.com/doc/pay-station/references/supported-currencies/).
    Example: "USD"

  - `items.virtual_prices` (array)
    Virtual prices.

  - `items.virtual_prices.amount` (integer)
    Discounted item price in virtual currency.
    Example: 100

  - `items.virtual_prices.sku` (string)
    Virtual currency item SKU.
    Example: "vc_test"

  - `items.virtual_prices.is_default` (boolean)
    Whether price is default for item.
    Example: true

  - `items.virtual_prices.image_url` (string)
    Image of virtual currency.
    Example: "http://image.png"

  - `items.virtual_prices.name` (string)
    Virtual currency name.
    Example: "SHOTGUN FOR TRUE RAIDERS"

  - `items.virtual_prices.type` (string)
    Virtual currency type.
    Example: "virtual_currency"

  - `items.virtual_prices.description` (string)
    Virtual currency description.
    Example: "Big Rocket - description"

  - `items.can_be_bought` (boolean)
    If true, the user can buy an item.
    Example: true

  - `items.virtual_item_type` (string)
    Type of virtual item.
    Enum: "consumable", "non_consumable", "non_renewing_subscription"

  - `items.promotions` (array)
    Applied promotions for specific items in the cart. The array is returned in the following cases:

* A discount promotion is configured for a specific item.

* A promo code with the Discount on selected items setting is applied.

If no item-level promotions are applied, an empty array is returned.

  - `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)
    Bonus item type.
    Enum: "virtual_good", "virtual_currency", "bundle", "physical_good", "game_key", "nft"

  - `items.promotions.bonus.name` (string)
    Bonus item name. Not available for physical_good bonus item type.

  - `items.promotions.bonus.image_url` (string)
    Bonus item image URL. Not available for physical_good bonus item type.

  - `items.promotions.bonus.bundle_type` (string)
    Bonus bundle item type. Available only for bundle bonus item type.
    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)
    Item limits.

  - `items.limits.per_user` (object,null)
    Item limitation for a separate user.

  - `items.limits.per_user.total` (integer)
    Maximum number of items a single user can purchase.

  - `items.limits.per_user.available` (integer)
    Remaining number of items the current user can purchase.

  - `items.limits.per_user.recurrent_schedule` (object,null)
    Item limits recurrent refresh period for a user.

  - `items.limits.per_user.recurrent_schedule.interval_type` (string)
    Recurrent refresh period type.
    Enum: "daily", "weekly", "monthly", "hourly"

  - `items.limits.per_user.recurrent_schedule.reset_next_date` (integer)
    Date and time when limits reset (Unix Timestamp).
    Example: 1677553200

  - `items.limits.per_user.limit_exceeded_visibility` (string)
    Determines the visibility of the item in the catalog after the purchase limit is reached, until the next limit reset.

Applies to items for which recurring limit resets are configured in the recurrent_schedule array.

If limit resets are not configured, the item doesn't appear in the catalog after the purchase limit is reached, regardless of the limit_exceeded_visibility value.
    Enum: "show", "hide"

  - `items.limits.per_item` (object,null)
    Global item limitation.

  - `items.limits.per_item.total` (integer)
    Maximum number of items all users can purchase.

  - `items.limits.per_item.available` (integer)
    Remaining number of items all users can purchase.

  - `items.periods` (array)
    Item sales period.

  - `items.periods.date_from` (string,null)
    Date when the specified item will be available for sale.
    Example: "2020-08-11T10:00:00+03:00"

  - `items.periods.date_until` (string,null)
    Date when the specified item will become unavailable for sale. Can be null.
    Example: "2020-08-11T20:00:00+03:00"

  - `items.custom_attributes` (object)
    A JSON object containing item attributes and values.

  - `items.vp_rewards` (array)
    Value point item reward.

  - `items.vp_rewards.item_id` (integer)
    Internal unique item ID.
    Example: 1

  - `items.vp_rewards.sku` (string)
    Unique value point ID.

  - `items.vp_rewards.amount` (integer)
    Amount of value points.

  - `items.vp_rewards.name` (string)
    Value point name.

  - `items.vp_rewards.is_clan` (boolean)
    Whether the value point is used in clan reward chains.
    Example: true