Get game for catalog

Xsolla Developers

Get game for catalogClient-side

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

Gets a game 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: "full_game_1" 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" "item_order_in_group"
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

Game was successfully received.

404

Game not found.

Request samples

Response samples

application/json

{"sku": "com.xsolla.game_1",
"name": "Game name",
"groups": [{"external_id": "all",
"name": "All games",
"item_order_in_group": 2
},
{"external_id": "Xsolla",
"name": "Xsolla games",
"item_order_in_group": 1
}
],
"type": "unit",
"unit_type": "game",
"description": "Game description",
"image_url": "https://cdn.xsolla.net/img/misc/images/b79342cdf24f0f8557b63c87e8326e62.png",
"attributes": [{"external_id": "OS",
"name": "OS",
"values": [{"external_id": "9d5c5efb7c0f00a00fe4e3583f1215b0050bc723",
"value": "Windows"
}
]
},
{"external_id": "genre",
"name": "Genre",
"values": [{"external_id": "9c5774997fc072b973bd5c231075c13841413f62",
"value": "Casual, Logic"
}
]
}
],
"promotions": [ ],
"unit_items": [{"sku": "com.xsolla.game_key_01",
"type": "game_key",
"is_free": false,
"price": {"amount": "30.5",
"amount_without_discount": "30.5",
"currency": "USD"
},
"virtual_prices": [ ],
"can_be_bought": true,
"drm_name": "Steam",
"drm_sku": "steam_key_1",
"has_keys": true,
"is_pre_order": true,
"release_date": "2020-08-11T10:00:00+03:00",
"promotions": [ ],
"limits": null,
"periods": [{"date_from": "2020-08-11T10:00:00+03:00",
"date_until": "2020-08-11T20:00:00+03:00"
}
],
"vp_rewards": [{"item_id": 175232,
"sku": "com.xsolla.value_point_1",
"amount": 130,
"name": "Value point",
"image_url": "https://cdn3.xsolla.com/img/misc/images/54c0cf9d345817cdacfdde198db178e0.jpg"
},
{"item_id": 186321,
"sku": "com.xsolla.clan_value_point_1",
"amount": 50,
"name": "Clan Reward VP 1",
"image_url": "https://cdn3.xsolla.com/img/misc/images/54c0cf9d345817cdacfdde198db178e0.jpg",
"is_clan": true
}
]
},
{"sku": "com.xsolla.game_key_02",
"type": "game_key",
"is_free": false,
"price": {"amount": "30.5",
"amount_without_discount": "30.5",
"currency": "USD"
},
"virtual_prices": [ ],
"can_be_bought": true,
"drm_name": "Origin",
"drm_sku": "origin_key_1",
"has_keys": false,
"is_pre_order": false,
"release_date": null,
"promotions": [ ],
"limits": null,
"periods": [ ],
"vp_rewards": [ ]
}
]
}