Skip to content
/
Revoke entitlement (admin...

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

Grant entitlement (admin)Server-sideAdmin

Request

Grants entitlement to user.

Attention

Game codes or games for DRM free platform can be granted only.
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
user_external_idstringrequired

Unique user identifier.

Example: "user-external-id"
gameobjectrequired

Object with game properties.

Example: {"sku":"com.xsolla.game_1"}
game.​skustring(Game-Keys_game_sku)[ 1 .. 255 ] characters^[a-zA-Z0-9_\-–.]*$required

Unique key package ID.

Example: "theGreatestGameSku"
drmobjectrequired

Object with DRM properties.

Example: {"sku":"com.xsolla.key_1"}
drm.​skustring(Game-Keys_drm_sku)required

Unique DRM ID.

Enum"steam""playstation""xbox""uplay""origin""drmfree""gog""epicgames""nintendo_eshop""discord_game_store"
Example: "steam"
codestring or null

Game code of the game.

Example: "AAAA-BBBB-CCCC-DDDD"
modestringrequired

What type of entitlements should be granted. If the parameter is set to sandbox, the entitlement will be granted to the user in the sandbox mode. If the parameter is set to default, the entitlement will be granted to the user in the live mode.

Enum"default""sandbox"
Example: "default"
user_countrystring or null

User's country.

Example: "US"
curl -i -X POST \
  -u <username>:<password> \
  https://xsolla.redocly.app/_mock/api/catalog/v2/project/44056/admin/entitlement/grant \
  -H 'Content-Type: application/json' \
  -d '{
    "user_external_id": "user-external-id",
    "game": {
      "sku": "com.xsolla.game_1"
    },
    "drm": {
      "sku": "com.xsolla.key_1"
    },
    "code": "AAAA-BBBB-CCCC-DDDD",
    "mode": "default",
    "user_country": "US"
  }'

Responses

Entitlement was granted.

Response
No content

Revoke entitlement (admin)Server-sideAdmin

Request

Revokes entitlement of user.

Attention

Game codes or games for DRM free platform can be revoked only.
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
user_external_idstringrequired

Unique user identifier.

Example: "user-external-id"
gameobjectrequired

Object with game properties.

Example: {"sku":"com.xsolla.game_1"}
game.​skustring(Game-Keys_game_sku)[ 1 .. 255 ] characters^[a-zA-Z0-9_\-–.]*$required

Unique key package ID.

Example: "theGreatestGameSku"
drmobjectrequired

Object with DRM properties.

Example: {"sku":"com.xsolla.key_1"}
drm.​skustring(Game-Keys_drm_sku)required

Unique DRM ID.

Enum"steam""playstation""xbox""uplay""origin""drmfree""gog""epicgames""nintendo_eshop""discord_game_store"
Example: "steam"
modestringrequired

What type of entitlements should be revoked. If the parameter is set to sandbox, the entitlement will be revoked from the user in the sandbox mode. If the parameter is set to default, the entitlement will be revoked from the user in the live mode.

Enum"default""sandbox"
Example: "default"
curl -i -X POST \
  -u <username>:<password> \
  https://xsolla.redocly.app/_mock/api/catalog/v2/project/44056/admin/entitlement/revoke \
  -H 'Content-Type: application/json' \
  -d '{
    "user_external_id": "user-external-id",
    "game": {
      "sku": "com.xsolla.game_1"
    },
    "drm": {
      "sku": "com.xsolla.key_1"
    },
    "mode": "default"
  }'

Responses

Successful revoke.

Response
No content

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

Pre-Orders

Operations

Merchant

Operations

Catalog

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

Operations

Common regions

Operations

Admin

Operations