Xsolla-logoXsolla Developers
ou
Vers le Compte éditeur

Lire une liste d'objets par groupe spécifiqueClient-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

ID de projet. Ce paramètre se trouve dans le Compte éditeur à côté du nom du projet.

Example: 44056
external_id
required
string
Default: "all"

External ID du groupe.

query Parameters
limit
integer

Nombre maximal d'éléments sur une page.

Example: limit=50
offset
integer

Numéro de l'élément à partir duquel la liste est générée (le décompte commence à 0).

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

Langue de la réponse. Code de langue à deux lettres minuscules selon la norme ISO 639-1.

additional_fields[]
Array of strings

La liste des champs supplémentaires. Ces champs figureront dans la réponse si vous les envoyez dans votre requête.

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

Code unique sensible à la casse. Comprend des lettres et des chiffres.

Example: promo_code=WINTER2021
show_inactive_time_limited_items
integer
Default: 0

Affiche les objets à durée limitée qui ne sont pas disponibles pour l'utilisateur. La période de validité de ces objets n'ayant pas commencé ou ayant déjà expiré.

Example: show_inactive_time_limited_items=1
Responses
200

La liste d'objets du groupe spécifié a été reçue avec succès.

404

Groupe non trouvé. Assurez-vous que le paramètre external_id est correct et que le groupe n'est pas désactivé ou supprimé.

Request samples
curl -i -X GET \
  'https://store.xsolla.com/api/v2/project/{project_id}/items/virtual_items/group/{external_id}?limit=50&offset=0&locale=en&additional_fields%5B%5D=media_list&country=US&promo_code=WINTER2021&show_inactive_time_limited_items=1' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'
Response samples
application/json
{
  • "has_more": false,
  • "items": [
    ]
}