Xsolla-logo

Get items list by specified groupClient-side

get/v2/project/{project_id}/items/virtual_items/group/{external_id}

Gets an items list from the specified group for building a catalog.

Attention

All 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.

Note

This endpoint, accessible without authorization, returns generic data. However, authorization enriches the response with user-specific details for a personalized result, such as available user limits and promotions.
SecurityXsollaLoginUserJWT
Request
path Parameters
project_id
required
integer

Project ID. You can find this parameter in your Publisher Account next to the name of the project.

Example: 44056
external_id
required
string
Default: "all"

Group external ID.

query Parameters
limit
integer

Limit for the number of elements on the page.

Example: limit=50
offset
integer

Number of the element from which the list is generated (the count starts from 0).

Example: offset=0
locale
string
Default: "en"

Response language. Two-letter lowercase language code per ISO 639-1.

additional_fields[]
Array of strings

The list of additional fields. These fields will be in the response if you send them in your request.

Items Enum: "media_list" "order" "long_description" "custom_attributes"
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: country=US
promo_code
string [ 1 .. 128 ] characters

Unique case sensitive code. Contains letters and numbers.

Example: promo_code=WINTER2021
show_inactive_time_limited_items
integer
Default: 0

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: show_inactive_time_limited_items=1
Responses
200

The list of items from the specified group was successfully received.

404

The group wasn’t found. Make sure that the external_id is correct and the group isn’t turned off or deleted.

Request samples
Response samples
application/json
{
  • "has_more": false,
  • "items": [
    ]
}