Skip to content
/
Set number of items avail...

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

Increase number of items available to specified userServer-sideAdmin

Request

Increases the remaining number of items available to the specified user within the limit applied.

User limit API allows you to sell an item in a limited quantity. To configure the purchase limits, go to the Admin section of the desired item type module:

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
item_skustringrequired

Item SKU.

Example: booster_mega_1
Bodyapplication/json
userobject(User-limit_user)required
user.​user_external_idstring(User-limit_user-external-id)non-empty^\S+$required

User external ID.

availableinteger(User-limit_available)>= 1required

Remaining number of items or promotion uses available to the user within the limit applied.

curl -i -X POST \
  -u <username>:<password> \
  https://xsolla.redocly.app/_mock/api/catalog/v2/project/44056/admin/user/limit/item/sku/booster_mega_1 \
  -H 'Content-Type: application/json' \
  -d '{
    "user": {
      "user_external_id": "d342dad2-9d59-11e9-a384-42010aa8003f"
    },
    "available": 1
  }'

Responses

Purchase limits for a user were successfully received.

Bodyapplication/json
per_userobject
Response
application/json
{
  "per_user": {
    "total": 10,
    "available": 9
  }
}

Set number of items available to specified userServer-sideAdmin

Request

Sets the number of items the specified user can buy within the limit applied after it was increased or decreased.

User limit API allows you to sell an item in a limited quantity. To configure the purchase limits, go to the Admin section of the desired item type module:

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
item_skustringrequired

Item SKU.

Example: booster_mega_1
Bodyapplication/json
userobject(User-limit_user)required
user.​user_external_idstring(User-limit_user-external-id)non-empty^\S+$required

User external ID.

availableinteger(User-limit_available_flexible)>= 0required

Remaining number of items or promotion uses available to the user within the limit applied.

curl -i -X PUT \
  -u <username>:<password> \
  https://xsolla.redocly.app/_mock/api/catalog/v2/project/44056/admin/user/limit/item/sku/booster_mega_1 \
  -H 'Content-Type: application/json' \
  -d '{
    "user": {
      "user_external_id": "d342dad2-9d59-11e9-a384-42010aa8003f"
    },
    "available": 0
  }'

Responses

Purchase limits for a user were successfully received.

Bodyapplication/json
per_userobject
Response
application/json
{
  "per_user": {
    "total": 10,
    "available": 9
  }
}

Decrease number of items available to specified userServer-sideAdmin

Request

Decreases the remaining number of items available to the specified user within the limit applied.

User limit API allows you to sell an item in a limited quantity. To configure the purchase limits, go to the Admin section of the desired item type module:

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
item_skustringrequired

Item SKU.

Example: booster_mega_1
Bodyapplication/json
userobject(User-limit_user)required
user.​user_external_idstring(User-limit_user-external-id)non-empty^\S+$required

User external ID.

availableinteger(User-limit_available)>= 1required

Remaining number of items or promotion uses available to the user within the limit applied.

curl -i -X DELETE \
  -u <username>:<password> \
  https://xsolla.redocly.app/_mock/api/catalog/v2/project/44056/admin/user/limit/item/sku/booster_mega_1 \
  -H 'Content-Type: application/json' \
  -d '{
    "user": {
      "user_external_id": "d342dad2-9d59-11e9-a384-42010aa8003f"
    },
    "available": 1
  }'

Responses

Purchase limits for a user were successfully received.

Bodyapplication/json
per_userobject
Response
application/json
{
  "per_user": {
    "total": 10,
    "available": 9
  }
}

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