Skip to content
/
Create region

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

Merchant

Operations

Catalog

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

Operations

Common regions

Operations

Get list of regionsServer-sideAdmin

Request

Gets list of regions.

You can use a region for managing your regional restrictions.

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/region

Responses

List of regions was successfully received.

Bodyapplication/json
regionsArray of objects(Regions_200-region-short-model)
Response
application/json
{
  "regions": [
    { … },
    { … }
  ]
}

Create regionServer-sideAdmin

Request

Creates region.

You can use a region for managing your regional restrictions.

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/json
countriesArray of strings(Regions_countries)required

List of countries to be added in a region.
Two-letter uppercase country code per ISO 3166-1 alpha-2. Check the documentation for detailed information about countries supported by Xsolla.
Example: ["JP", "CN", "VN"]

nameobject(Regions_name)required

Name of region. Should contain key/value pairs where key is a locale with the "^[a-z]{2}-[A-Z]{2}$" format, the value is string.

Default {"en-US":"Asia","de-DE":"Asien"}
Example: {"en-US":"Asia","de-DE":"Asien"}
name.​property name*stringadditional property
curl -i -X POST \
  -u <username>:<password> \
  https://xsolla.redocly.app/_mock/api/catalog/v2/project/44056/admin/region \
  -H 'Content-Type: application/json' \
  -d '{
    "name": {
      "en-US": "Asia",
      "de-DE": "Asien"
    },
    "countries": [
      "JP",
      "CN",
      "VN"
    ]
  }'

Responses

Region was successfully created.

Bodyapplication/json
region_idinteger(Regions_region_id)

Region ID. Unique region identifier within the project.

Example: 42
Response
application/json
{
  "region_id": 42
}

Get regionServer-sideAdmin

Request

Gets particular region.

You can use a region for managing your regional restrictions.

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
region_idintegerrequired

Region ID. Unique region identifier within the project.

Example: 42
curl -i -X GET \
  -u <username>:<password> \
  https://xsolla.redocly.app/_mock/api/catalog/v2/project/44056/admin/region/42

Responses

Specified region was successfully received.

Bodyapplication/json
idinteger(Regions_region_id)

Region ID. Unique region identifier within the project.

Example: 42
nameobject(Regions_name)

Name of region. Should contain key/value pairs where key is a locale with the "^[a-z]{2}-[A-Z]{2}$" format, the value is string.

Default {"en-US":"Asia","de-DE":"Asien"}
Example: {"en-US":"Asia","de-DE":"Asien"}
countriesArray of strings(Regions_countries)

List of countries to be added in a region.
Two-letter uppercase country code per ISO 3166-1 alpha-2. Check the documentation for detailed information about countries supported by Xsolla.
Example: ["JP", "CN", "VN"]

Response
application/json
{
  "value": {
    "id": 44,
    "name": { … },
    "countries": [ … ]
  }
}

Admin

Operations