Skip to content
/
Create virtual currency

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

Get list of virtual currenciesServer-sideAdmin

Request

Gets the list of virtual currencies within a project for administration.

Note

Do not use this endpoint for building a store catalog.
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
Query
limitinteger>= 1

Limit for the number of elements on the page.

Example: limit=50
offsetinteger>= 0

Number of the element from which the list is generated (the count starts from 0).

Example: offset=0
curl -i -X GET \
  -u <username>:<password> \
  'https://xsolla.redocly.app/_mock/api/catalog/v2/project/44056/admin/items/virtual_currency?limit=50&offset=0'

Responses

The list of virtual currencies was successfully received.

Bodyapplication/json
itemsArray of objects(Virtual-Items-Currency_admin-virtual-currency)
Response
application/json
{
  "items": [
    { … },
    { … }
  ]
}

Create virtual currencyServer-sideAdmin

Request

Creates a virtual currency.

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
skustring(Virtual-Items-Currency_sku)[ 1 .. 255 ] characters^[a-zA-Z0-9_\-–.]*$required

Unique item ID. The SKU may contain only lowercase and uppercase Latin alphanumeric characters, periods, dashes, and underscores.

Example: "booster_mega_1"
name(two-letter (object or null)) or (five-letter (object or null))(name-localization-object)required

Object with localizations for item’s name. Accepts value in one of two formats: two-letter lowercase language codes (e.g., en) or five-character language codes (e.g., en-US). While both formats are accepted as input, responses return two-letter lowercase language codes. When both options for the same language are provided (e.g., en and en-US), the last provided value is stored. You can find the full list of supported languages in the documentation.

One of:

Object with localizations for item’s name. Accepts value in one of two formats: two-letter lowercase language codes (e.g., en) or five-character language codes (e.g., en-US). While both formats are accepted as input, responses return two-letter lowercase language codes. When both options for the same language are provided (e.g., en and en-US), the last provided value is stored. You can find the full list of supported languages in the documentation.

name.​enstring or null

English

name.​arstring or null

Arabic

name.​bgstring or null

Bulgarian

name.​cnstring or null

Chinese (Simplified)

name.​csstring or null

Czech

name.​destring or null

German

name.​esstring or null

Spanish (Spain)

name.​frstring or null

French

name.​hestring or null

Hebrew

name.​itstring or null

Italian

name.​jastring or null

Japanese

name.​kostring or null

Korean

name.​plstring or null

Polish

name.​ptstring or null

Portuguese

name.​rostring or null

Romanian

name.​rustring or null

Russian

name.​thstring or null

Thai

name.​trstring or null

Turkish

name.​twstring or null

Chinese (Traditional)

name.​vistring or null

Vietnamese

name.​kmstring or null

Khmer

name.​idstring or null

Indonesian

name.​lostring or null

Lao

name.​mystring or null

Burmese

name.​phstring or null

Filipino

name.​nestring or null

Nepali

description(two-letter (object or null)) or (five-letter (object or null))(description-localization-object)

Object with localizations for item’s description. Accepts value in one of two formats: two-letter lowercase language codes (e.g., en) or five-character locale codes (e.g., en-US). While both formats are accepted as input, responses return two-letter lowercase language codes. When both options for the same language are provided (e.g., en and en-US), the last provided value is stored. You can find the full list of supported languages in the documentation.

One of:

Object with localizations for item’s description. Accepts value in one of two formats: two-letter lowercase language codes (e.g., en) or five-character locale codes (e.g., en-US). While both formats are accepted as input, responses return two-letter lowercase language codes. When both options for the same language are provided (e.g., en and en-US), the last provided value is stored. You can find the full list of supported languages in the documentation.

long_description(two-letter (object or null)) or (five-letter (object or null))(long-description-localization-object)

Object with localizations for long description of item. Accepts value in one of two formats: two-letter lowercase language codes (e.g., en) or five-character locale codes (e.g., en-US). While both formats are accepted as input, responses return two-letter lowercase language codes. When both variants for the same language are provided (e.g., en and en-US), the last provided value is stored. You can find the full list of supported languages in the documentation.

Any of:

Object with localizations for long description of item. Accepts value in one of two formats: two-letter lowercase language codes (e.g., en) or five-character locale codes (e.g., en-US). While both formats are accepted as input, responses return two-letter lowercase language codes. When both variants for the same language are provided (e.g., en and en-US), the last provided value is stored. You can find the full list of supported languages in the documentation.

image_urlstring(Virtual-Items-Currency_admin-image_url)
media_listArray of objects(Virtual-Items-Currency_admin-media_list)

Item's additional assets such as screenshots, gameplay video and so on.

Example: [{"type":"image","url":"https://cdn3.xsolla.com/img/misc/images/71ab1e12126f2103e1868076f0acb21a.jpg"}]
groupsArray of objects(Virtual-Items-Currency_admin-groups-response)

Groups the item belongs to.

Default []
Example: [{"external_id":"horror","name":{"en":"Horror"}}]
attributesArray of objects(Virtual-Items-Currency_admin-post-put-attributes)<= 20 items

List of attributes.

Attention. You can't specify more than 20 attributes for the item. Any attempts to exceed the limit result in an error.
pricesArray of objects(Virtual-Items-Currency_admin-prices)
Example: [{"currency":"USD","amount":10.5,"is_default":true,"is_enabled":true,"country_iso":"US"}]
vc_pricesArray of objects(Virtual-Items-Currency_admin-create-vc_prices)
Example: [{"sku":"com.xsolla.gold_1","amount":10,"is_default":true,"is_enabled":true}]
is_enabledboolean(Virtual-Items-Currency_is_enabled)
is_deletedboolean(Virtual-Items-Currency_is_deleted)
is_show_in_storeboolean(Virtual-Items-Currency_is_show_in_store)
is_freeboolean(value-is_free)

If true, the item is free.

Default false
Example: false
is_hardboolean(Virtual-Items-Currency_is_hard)
orderinteger(Virtual-Items-Currency_order)

Defines arrangement order.

Example: 1
pre_orderobject(Virtual-Items-Currency_admin-pre_order)
regionsArray of objects(Virtual-Items-Currency_admin-regions)
limitsobject(Virtual-Currency-item-limit)

Item limits.

periodsArray of objects or null(item-periods)

Item sales period.

custom_attributesobject(json)(item-custom-attributes)<= 500 characters

A JSON object containing item attributes and values. Attributes allow you to add more info to items like the player's required level to use the item. Attributes enrich your game's internal logic and are accessible through dedicated GET methods and webhooks.

curl -i -X POST \
  -u <username>:<password> \
  https://xsolla.redocly.app/_mock/api/catalog/v2/project/44056/admin/items/virtual_currency \
  -H 'Content-Type: application/json' \
  -d '{
    "sku": "com.xsolla.coin_1",
    "name": {
      "en-US": "Gold coin",
      "de-DE": "Goldmünze"
    },
    "is_enabled": true,
    "is_free": false,
    "groups": [
      "gold"
    ],
    "order": 1,
    "description": {
      "en-US": "The main currency of your kingdom",
      "de-DE": "Die Hauptwährung deines Königreichs"
    },
    "prices": [
      {
        "amount": 100,
        "currency": "USD",
        "is_enabled": true,
        "is_default": true
      }
    ],
    "attributes": [
      {
        "external_id": "material",
        "name": {
          "en-US": "Material"
        },
        "values": [
          {
            "external_id": "gold",
            "value": {
              "en-US": "Gold"
            }
          }
        ]
      }
    ],
    "limits": {
      "per_user": 5,
      "per_item": 10000
    },
    "periods": [
      {
        "date_from": "2020-08-11T10:00:00+03:00",
        "date_until": "2020-08-11T20:00:00+03:00"
      }
    ],
    "custom_attributes": {
      "purchased": 0,
      "attr": "value"
    }
  }'

Responses

Virtual item was successfully created.

Bodyapplication/json
skustring
Example: "com.xsolla.item_1"
Response
application/json
{
  "sku": "com.xsolla.item_1"
}

Get virtual currencyServer-sideAdmin

Request

Gets the virtual currency within a project for administration.

Note

Do not use this endpoint for building a store catalog.
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
virtual_currency_skustringrequired

Virtual currency SKU.

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

Responses

The specified virtual currency was successfully received.

Bodyapplication/json
skustring(Virtual-Items-Currency_sku)[ 1 .. 255 ] characters^[a-zA-Z0-9_\-–.]*$

Unique item ID. The SKU may contain only lowercase and uppercase Latin alphanumeric characters, periods, dashes, and underscores.

Example: "booster_mega_1"
name(two-letter (object or null)) or (five-letter (object or null))(name-localization-object)

Object with localizations for item’s name. Accepts value in one of two formats: two-letter lowercase language codes (e.g., en) or five-character language codes (e.g., en-US). While both formats are accepted as input, responses return two-letter lowercase language codes. When both options for the same language are provided (e.g., en and en-US), the last provided value is stored. You can find the full list of supported languages in the documentation.

One of:

Object with localizations for item’s name. Accepts value in one of two formats: two-letter lowercase language codes (e.g., en) or five-character language codes (e.g., en-US). While both formats are accepted as input, responses return two-letter lowercase language codes. When both options for the same language are provided (e.g., en and en-US), the last provided value is stored. You can find the full list of supported languages in the documentation.

description(two-letter (object or null)) or (five-letter (object or null))(description-localization-object)

Object with localizations for item’s description. Accepts value in one of two formats: two-letter lowercase language codes (e.g., en) or five-character locale codes (e.g., en-US). While both formats are accepted as input, responses return two-letter lowercase language codes. When both options for the same language are provided (e.g., en and en-US), the last provided value is stored. You can find the full list of supported languages in the documentation.

One of:

Object with localizations for item’s description. Accepts value in one of two formats: two-letter lowercase language codes (e.g., en) or five-character locale codes (e.g., en-US). While both formats are accepted as input, responses return two-letter lowercase language codes. When both options for the same language are provided (e.g., en and en-US), the last provided value is stored. You can find the full list of supported languages in the documentation.

long_description(two-letter (object or null)) or (five-letter (object or null))(long-description-localization-object)

Object with localizations for long description of item. Accepts value in one of two formats: two-letter lowercase language codes (e.g., en) or five-character locale codes (e.g., en-US). While both formats are accepted as input, responses return two-letter lowercase language codes. When both variants for the same language are provided (e.g., en and en-US), the last provided value is stored. You can find the full list of supported languages in the documentation.

Any of:

Object with localizations for long description of item. Accepts value in one of two formats: two-letter lowercase language codes (e.g., en) or five-character locale codes (e.g., en-US). While both formats are accepted as input, responses return two-letter lowercase language codes. When both variants for the same language are provided (e.g., en and en-US), the last provided value is stored. You can find the full list of supported languages in the documentation.

groupsArray of objects(Virtual-Items-Currency_admin-groups-response)

Groups the item belongs to.

Default []
Example: [{"external_id":"horror","name":{"en":"Horror"}}]
attributesArray of objects(Virtual-Items-Currency_admin-attributes)

List of attributes.

Example: [{"external_id":"attribute_external_id","name":{"en":"Attribute name","de":"Attributname"},"values":[{"external_id":"value_1","name":{"en":"value 1","de":"wert 1"}},{"external_id":"value_2","name":{"en":"value 2","de":"wert 2"}}]}]
media_listArray of objects(Virtual-Items-Currency_admin-media_list)

Item's additional assets such as screenshots, gameplay video and so on.

Example: [{"type":"image","url":"https://cdn3.xsolla.com/img/misc/images/71ab1e12126f2103e1868076f0acb21a.jpg"}]
typestring(Virtual-Items-Currency_type)

Type of item: virtual_good/virtual_currency/bundle/physical_good/unit.

pricesArray of objects(Virtual-Items-Currency_admin-prices)
Example: [{"currency":"USD","amount":10.5,"is_default":true,"is_enabled":true,"country_iso":"US"}]
vc_pricesArray of objects(Virtual-Items-Currency_admin-get-vc_prices)
Example: [{"sku":"com.xsolla.gold_1","amount":10,"is_default":true}]
image_urlstring(Virtual-Items-Currency_admin-image_url)
is_enabledboolean(Virtual-Items-Currency_is_enabled)
is_freeboolean(value-is_free)

If true, the item is free.

Default false
Example: false
orderinteger(Virtual-Items-Currency_order)

Defines arrangement order.

Example: 1
is_show_in_storeboolean(Virtual-Items-Currency_is_show_in_store)
is_hardboolean(Virtual-Items-Currency_is_hard)
regionsArray of objects(Virtual-Items-Currency_admin-regions)
limitsobject or null(admin-item-limit-response)

Item limits.

periodsArray of objects(item-periods-response)

Item sales period.

custom_attributesobject(json)(item-custom-attributes-response)

A JSON object containing item attributes and values.

Response
application/json
{
  "sku": "com.xsolla.crystal_1",
  "name": {
    "en": "Crystals",
    "ru": "Crystals"
  },
  "type": "virtual_currency",
  "description": {
    "en": "Main in-game currency"
  },
  "image_url": "https://cdn3.xsolla.com/img/misc/images/da33ab6cc1d7e5899cfdc5b6b6180fad.png",
  "long_description": null,
  "attributes": [
    { … }
  ],
  "is_free": false,
  "order": 1,
  "groups": [],
  "prices": [
    { … }
  ],
  "media_list": [],
  "vc_prices": [],
  "is_enabled": true,
  "is_show_in_store": true,
  "regions": [],
  "is_hard": false,
  "limits": {
    "per_user": null,
    "per_item": null,
    "recurrent_schedule": null
  },
  "periods": [],
  "custom_attributes": {
    "purchased": 0,
    "attr": "value"
  }
}

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

Admin

Operations