Получение списка виртуальных предметов

Xsolla Developers

или

Получение списка виртуальных предметовClient-side

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

Gets a virtual items list 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

In general, the use of catalog of items is available without authorization.
Only authorized users can get a personalized catalog.

SecurityXsollaLoginUserJWT

Request

path Parameters

project_id

required

integer

ID проекта. Вы можете найти этот параметр в Личном кабинете рядом с названием проекта.

Example: 44056

query Parameters

limit	integer Лимит количества элементов на странице. Example: limit=50
offset	integer Номер элемента, с которого выполняется вывод на странице (нумерация ведется с 0). Example: offset=0
locale	string Default: "en" Язык ответа. Двухбуквенный код языка в нижнем регистре в соответствии с ISO 639-1.
additional_fields[]	Array of strings Список дополнительных полей. Эти поля будут указаны в ответе, если вы отправите их в своем запросе. 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 Уникальный код, чувствительный к регистру. Содержит буквы и цифры. Example: promo_code=WINTER2021
show_inactive_time_limited_items	integer Default: 0 Отображает предметы с ограниченным сроком действия, которые недоступны пользователю. Срок действия таких предметов еще не начался или уже истек. Example: show_inactive_time_limited_items=1

Responses

200

Список виртуальных предметов успешно получен.

Request samples

curl -i -X GET \
  'https://store.xsolla.com/api/v2/project/{project_id}/items/virtual_items?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": true,
"items": [{"attributes": [{"external_id": "stack_size",
"name": {"en": "Stack size"
},
"values": [{"external_id": "size_e3364991f92e751689a68b96598a5a5a84010b85",
"value": "5"
}
]
}
],
"can_be_bought": true,
"custom_attributes": {"attr": "value",
"purchased": 0
},
"description": {"en": "Big Rocket - description"
},
"groups": [{"external_id": "accessory",
"name": {"en": "accessory"
}
}
],
"image_url": "https://popmedia.blob.core.windows.net/popyourself/male/outfit/male_armor_white_a-01.png",
"inventory_options": {"consumable": {"usages_count": 1
},
"expiration_period": {"type": "day",
"value": 1
}
},
"is_free": false,
"limits": {"per_user": {"available": 3,
"recurrent_schedule": {"interval_type": "weekly",
"reset_next_date": 1746057600
},
"total": 5
}
},
"name": {"en": "Big Rocket"
},
"periods": [{"date_from": "2020-08-11T10:00:00+03:00",
"date_until": "2020-08-11T20:00:00+03:00"
}
],
"price": {"amount": "100.99",
"amount_without_discount": "100.99",
"currency": "USD"
},
"promotions": [{"bonus": [{"image_url": "https://cdn.xsolla.net/img/misc/images/2fc5c491a47413a8e8000447889093c2.png",
"name": "Xsolla Minigun",
"quantity": 1,
"sku": "com.xsolla.minigun_1",
"type": "virtual_good"
},
{"quantity": 1,
"sku": "com.xsolla.phys_good_1",
"type": "physical_good"
},
{"bundle_type": "standard",
"image_url": "https://cdn.xsolla.net/img/misc/images/9676f06265375087e607cb79c5283688.png",
"name": "Super Lootbox with items",
"quantity": 1,
"sku": "com.xsolla.SuperLootboxBundle_1",
"type": "bundle"
}
],
"date_end": "2026-04-15T16:16:00+03:00",
"date_start": "2020-04-15T16:16:00+03:00",
"discount": null,
"name": "Bonus promotion"
}
],
"sku": "com.xsolla.big_rocket_1",
"type": "virtual_good",
"virtual_item_type": "non_renewing_subscription",
"virtual_prices": [{"amount": 100,
"amount_without_discount": 100,
"description": "description",
"image_url": "http://image.png",
"is_default": true,
"name": "SHOTGUN FOR TRUE RAIDERS",
"sku": "com.xsolla.vc_1",
"type": "virtual_currency"
}
],
"vp_rewards": [ ]
},
{"attributes": [{"external_id": "stack_size",
"name": {"en": "Stack size"
},
"values": [{"external_id": "size_e3364991f92e751689a68b96598a5a5a84010b85",
"value": "5"
}
]
},
{"external_id": "rating",
"name": {"en": "Rating"
},
"values": [{"external_id": "rating_e3364991f92e751689a68b96598a5a5a84010b85",
"value": "3.9"
}
]
}
],
"can_be_bought": true,
"description": {"en": "description"
},
"groups": [{"external_id": "hair",
"name": {"en": "hair"
}
}
],
"image_url": "http://image.png",
"inventory_options": {"consumable": {"usages_count": 1
},
"expiration_period": {"type": "day",
"value": 1
}
},
"is_free": false,
"limits": null,
"name": {"en": "SHOTGUN FOR TRUE RAIDERS"
},
"periods": [{"date_from": null,
"date_until": "2020-08-11T20:00:00+03:00"
}
],
"price": {"amount": "101.0",
"amount_without_discount": "101.0",
"currency": "USD"
},
"promotions": [ ],
"sku": "com.xsolla.shotgun_raider_1",
"type": "virtual_good",
"virtual_item_type": "non_renewing_subscription",
"virtual_prices": [{"amount": 100,
"amount_without_discount": 100,
"description": "description",
"image_url": "http://image.png",
"is_default": true,
"name": "SHOTGUN FOR TRUE RAIDERS",
"sku": "com.xsolla.vc_1",
"type": "virtual_currency"
},
{"amount": 200,
"amount_without_discount": 200,
"description": "description",
"image_url": "http://image.png",
"is_default": false,
"name": "SHOTGUN FOR TRUE RAIDERS",
"sku": "com.xsolla.vc_2",
"type": "virtual_currency"
}
],
"vp_rewards": [ ]
},
{"attributes": [ ],
"can_be_bought": true,
"description": {"en": "description"
},
"groups": [ ],
"image_url": "http://image.png",
"inventory_options": {"consumable": {"usages_count": 1
},
"expiration_period": {"type": "day",
"value": 1
}
},
"is_free": true,
"limits": null,
"name": {"en": "SHOTGUN FOR TRUE RAIDERS"
},
"periods": [ ],
"price": null,
"promotions": [ ],
"sku": "com.xsolla.shotgun_raider_2",
"type": "virtual_good",
"virtual_item_type": "non_renewing_subscription",
"virtual_prices": [ ],
"vp_rewards": [ ]
}
]
}