Skip to content

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

Pre-Orders

Operations

Get information about item pre-order limitServer-sideAdmin

Request

Get pre-order limit of the item.

Pre-Order limit API allows you to sell an item in a limited quantity. For configuring the pre-order itself, go to the Admin section of the desired item module:

Aliases for this endpoint:

  • /v2/project/{project_id}/admin/items/pre_order/limit/item/id/{item_id}
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
curl -i -X GET \
  -u <username>:<password> \
  https://xsolla.redocly.app/_mock/api/catalog/v2/project/44056/admin/items/pre_order/limit/item/sku/booster_mega_1

Responses

Information about the item pre-order limit was successfully received.

Bodyapplication/json
item_idinteger
Example: 1
skustring
Example: "com.xsolla.item_1"
is_pre_order_limit_enabledboolean
Example: true
availableinteger
Example: 431
reservedinteger
Example: 13
soldinteger
Example: 556
Response
application/json
{
  "item_id": 1,
  "sku": "com.xsolla.item_1",
  "is_pre_order_limit_enabled": true,
  "available": 431,
  "reserved": 13,
  "sold": 556
}

Add quantity to item pre-order limitServer-sideAdmin

Request

Add quantity to pre-order limit of the item.

Pre-Order limit API allows you to sell an item in a limited quantity. For configuring the pre-order itself, go to the Admin section of the desired item module:

Aliases for this endpoint:

  • /v2/project/{project_id}/admin/items/pre_order/limit/item/id/{item_id}
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
quantityintegerrequired

Quantity to add.

curl -i -X POST \
  -u <username>:<password> \
  https://xsolla.redocly.app/_mock/api/catalog/v2/project/44056/admin/items/pre_order/limit/item/sku/booster_mega_1 \
  -H 'Content-Type: application/json' \
  -d '{
    "quantity": 100000
  }'

Responses

The quantity to limit was successfully added.

Response
No content

Set quantity of item pre-order limitServer-sideAdmin

Request

Set quantity of pre-order limit of the item.

Pre-Order limit API allows you to sell an item in a limited quantity. For configuring the pre-order itself, go to the Admin section of the desired item module:

Aliases for this endpoint:

  • /v2/project/{project_id}/admin/items/pre_order/limit/item/id/{item_id}
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
quantityintegerrequired

Quantity to set.

curl -i -X PUT \
  -u <username>:<password> \
  https://xsolla.redocly.app/_mock/api/catalog/v2/project/44056/admin/items/pre_order/limit/item/sku/booster_mega_1 \
  -H 'Content-Type: application/json' \
  -d '{
    "quantity": 100000
  }'

Responses

The quantity to limit was successfully set.

Response
No content

Merchant

Operations

Catalog

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

Operations

Common regions

Operations

Admin

Operations