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

Catalog API provides endpoints to manage your in-game store catalog and process purchases. Use the endpoints to configure virtual items, virtual currencies, game keys, bundles, cart and payment flows, item attributes, and import items from external sources.

Download OpenAPI description
index.json
index.yaml
Languages
Servers
Mock server
https://xsolla.redocly.app/_mock/api/catalog/
https://store.xsolla.com/api/

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://xsolla.redocly.app/_mock/api/catalog/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://xsolla.redocly.app/_mock/api/catalog/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