Skip to content
/
Get information about web...

Catalog API (2.0.0)

Overview

  • Version: 2.0.0
  • Servers: https://store.xsolla.com/api
  • Contact Us by Email
  • Contact URL: https://xsolla.com/
  • Required TLS version: 1.2

The Catalog API allows you to configure a catalog of in-game items on the Xsolla side and display the catalog to users in your store.

The API allows you to manage the following catalog entities:

  • Virtual items — in-game items such as weapons, skins, boosters.
  • Virtual currency — virtual money used to purchase virtual goods.
  • Virtual currency packages — predefined bundles of virtual currency.
  • Bundles — combined packages of virtual items, currency, or game keys sold as a single SKU.
  • Game keys — keys for games and DLCs distributed via platforms like Steam or other DRM providers.
  • Groups — logical groupings for organizing and sorting items within the catalog.

API calls

The API is divided into the following groups:

  • Admin — calls for creating, updating, deleting, and configuring catalog items and groups. Authenticated via basic access authentication with your merchant or project credentials. Not intended for storefront use.
  • Catalog — calls for retrieving items and building custom storefronts for end users. Designed to handle high-load scenarios. Support optional user JWT authorization to return personalized data such as user-specific limits and active promotions.
Download OpenAPI description
index.json
index.yaml
Languages
Servers
https://store.xsolla.com/api/
Mock server
https://xsolla.redocly.app/_mock/api/catalog/

Admin

Operations

Catalog

Operations

Virtual payment

Operations

Catalog

Operations

Entitlement

Operations

Admin

Operations

Admin

Operations

Catalog

Operations

Cart (client-side)

Operations

Cart (server-side)

Operations

Payment (client-side)

Operations

Payment (server-side)

Operations

Order

Operations

Free items

Operations

Management

Operations

Admin

Operations

Webhooks

Operations

Get information about webhook settingsServer-sideAdmin

Request

Gets the information about the webhook settings in Store. Check webhooks documentation to learn more.

Security
basicAuth
Path
project_idintegerrequired

Project ID. You can find this parameter in your Publisher Account next to the name of the project.

Example: 44056
curl -i -X GET \
  -u <username>:<password> \
  https://store.xsolla.com/api/v2/project/44056/admin/webhook

Responses

Information about webhook settings was successfully received.

Bodyapplication/json
urlstring
Example: "http://site.ru/webhook"
secretstring
Example: "my_secret"
is_enabledboolean
Example: true
Response
application/json
{
  "url": "http://site.ru/webhook",
  "secret": "my_secret",
  "is_enabled": true
}

Update information about webhook settingsServer-sideAdmin

Request

Updates the information about the webhook settings in Store. Check webhooks documentation to learn more.

Security
basicAuth
Path
project_idintegerrequired

Project ID. You can find this parameter in your Publisher Account next to the name of the project.

Example: 44056
Bodyapplication/jsonrequired

Information about webhook settings.

urlstringrequired

URL of your server for receiving Game services webhooks. The URL must be publicly accessible and use the HTTPS protocol, for example https://example.com. You can also specify the URL you find in any tool for testing webhooks.

For Game services webhooks, the setting specified in this API call takes precedence over the setting configured in Publisher Account in Project Settings > Webhooks section.

Example: "http://site.ru/webhook"
secretstringrequired

The project secret key for signing Game services webhooks.

For Game services, the key specified in this API call takes precedence over the key generated in Publisher Account in Project Settings > Webhooks section.

Example: "my_secret_key"
is_enabledbooleanrequired

Whether Game services webhooks are enabled.

For Game services webhooks, the setting specified in this API call takes precedence over the setting configured in Publisher Account in Project Settings > Webhooks section.

Example: true
versioninteger

Webhooks version. In version 2, the items array includes the parameters is_free, is_bonus, and is_bundle_content, which are not present in version 1 (default).

Enum12
Example: 1
curl -i -X PUT \
  -u <username>:<password> \
  https://store.xsolla.com/api/v2/project/44056/admin/webhook \
  -H 'Content-Type: application/json' \
  -d '{
    "url": "http://site.ru/webhook",
    "secret": "my_secret_key",
    "is_enabled": true,
    "version": 1
  }'

Responses

Information about webhook settings was successfully updated.

Response
No content

Pre-Orders

Operations

Merchant

Operations

Catalog

This API allows getting any kind of sellable items or specific item.

Operations

Common regions

Operations

Admin

Operations