Xsolla-logo

Get game key for catalog

get/v2/project/{project_id}/items/game/key/sku/{item_sku}

Gets a game key for the 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
Default: "xsollus_basic_edition_steam"

Item SKU.

query Parameters
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. Shows regional prices and restrictions for a catalog if those were specified while creating an item.

Note

If you do not specify the country explicitly, it will be set based on user's IP address.

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

Game key was successfully received.

404

Game key not found.

Request samples
Response samples
application/json
{
  • "sku": "game_1",
  • "name": "Game name",
  • "groups": [
    ],
  • "type": "game_key",
  • "description": "Game description",
  • "attributes": [
    ],
  • "is_free": false,
  • "price": {
    },
  • "virtual_prices": [ ],
  • "can_be_bought": true,
  • "drm_name": "Steam",
  • "drm_sku": "steam",
  • "has_keys": true,
  • "is_pre_order": true,
  • "release_date": "2020-08-11T10:00:00+03:00",
  • "promotions": [ ],
  • "limits": null,
  • "periods": [
    ]
}