Xsolla-logo

Get virtual item by SKUClient-side

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

Gets a virtual item by SKU for building a catalog.

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
item_sku
required
string

Item SKU.

Example: booster_mega_1
query Parameters
locale
string
Default: "en"

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

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
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 virtual item was successfully received.

404

The item was not found. Make sure the project_id and the item_sku are correct.

Request samples
Response samples
application/json
{
  • "item_id": 488833,
  • "sku": "swords_1",
  • "type": "virtual_good",
  • "name": {
    },
  • "description": {
    },
  • "price": {
    },
  • "virtual_prices": [ ],
  • "can_be_bought": true,
  • "promotions": [ ],
  • "limits": {
    },
  • "periods": [
    ],
  • "attributes": [
    ],
  • "is_free": false,
  • "groups": [
    ],
  • "virtual_item_type": "non_consumable",
  • "vp_rewards": [ ],
  • "inventory_options": {
    },
  • "custom_attributes": {
    }
}