Skip to content
/
Get virtual item

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 items by specified group idServer-sideAdmin

Request

Gets the list of virtual items within a group 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
group_idintegerrequired

Group ID.

Example: 10
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_items/group/id/10?limit=50&offset=0'

Responses

The list of virtual items was successfully received.

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

Get virtual itemServer-sideAdmin

Request

Gets the virtual item 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
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/virtual_items/sku/booster_mega_1

Responses

The specified virtual item 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"
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"}}]}]
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"}}]
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_admin-prices)
Example: [{"currency":"USD","amount":10.5,"is_default":true,"is_enabled":true}]
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_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_enabledboolean(Virtual-Items-Currency_is_enabled)
is_show_in_storeboolean(Virtual-Items-Currency_is_show_in_store)
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.swords_1",
  "name": {
    "en": "Sword Xsolla Skin"
  },
  "type": "virtual_good",
  "description": {
    "en": "Honshu Boshin Wakizashi - Modern Tactical Samurai / Ninja Sword - Hand Forged 1060 Carbon Steel - Full Tang, Fully Functional, Battle Ready - Black TPR, Steel Guard and Pommel"
  },
  "image_url": "https://cdn.xsolla.net/img/misc/images/8ab44fe99038a56de01950ba4a971b77.png",
  "long_description": {
    "en": "Honshu Boshin Wakizashi - Modern Tactical Samurai / Ninja Sword - Hand Forged 1060 Carbon Steel - Full Tang, Fully Functional, Battle Ready - Black TPR, Steel Guard and Pommel"
  },
  "attributes": [
    { … }
  ],
  "is_free": false,
  "order": 1,
  "groups": [
    { … },
    { … }
  ],
  "prices": [
    { … }
  ],
  "media_list": [],
  "vc_prices": [],
  "is_enabled": true,
  "is_show_in_store": true,
  "regions": [],
  "limits": {
    "per_user": { … },
    "per_item": null,
    "recurrent_schedule": { … }
  },
  "periods": [
    { … }
  ],
  "custom_attributes": {
    "purchased": 0,
    "attr": "value"
  }
}

Update virtual itemServer-sideAdmin

Request

Updates a virtual item.

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
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.

image_urlstring(Virtual-Items-Currency_schemas-admin-image_url)

Image URL.

Example: "https://image.example.com"
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 strings(Virtual-Items-Currency_admin-groups-create)

Groups the item belongs to.

Note. The string value refers to group `external_id`.
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_admin-prices)
Example: [{"currency":"USD","amount":10.5,"is_default":true,"is_enabled":true}]
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
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-Item-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 PUT \
  -u <username>:<password> \
  https://xsolla.redocly.app/_mock/api/catalog/v2/project/44056/admin/items/virtual_items/sku/booster_mega_1 \
  -H 'Content-Type: application/json' \
  -d '{
    "sku": "com.xsolla.sword_1",
    "name": {
      "en": "Sword",
      "de": "Schwert"
    },
    "is_enabled": true,
    "is_free": false,
    "groups": [
      "weapons"
    ],
    "order": 1,
    "description": {
      "en": "A sword is a bladed melee weapon intended for cutting or thrusting that is longer than a knife or dagger, consisting of a long blade attached to a hilt.",
      "de": "Ein Schwert ist eine Nahkampfwaffe mit Klinge, die zum Schneiden oder Stechen bestimmt ist, länger als ein Messer oder Dolch ist und aus einer langen Klinge besteht, die an einem Griff befestigt ist."
    },
    "prices": [
      {
        "amount": 100,
        "currency": "USD",
        "is_enabled": true,
        "is_default": true
      },
      {
        "amount": 200,
        "currency": "CZK",
        "country_iso": "CZ",
        "is_enabled": false,
        "is_default": true
      }
    ],
    "vc_prices": [],
    "is_show_in_store": true,
    "attributes": [
      {
        "external_id": "craft-materials",
        "name": {
          "en": "Craft materials"
        },
        "values": [
          {
            "external_id": "steel",
            "value": {
              "en-US": "5"
            }
          },
          {
            "external_id": "leather",
            "value": {
              "en-US": "1"
            }
          }
        ]
      }
    ],
    "limits": {
      "per_user": 5,
      "per_item": 100
    },
    "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 updated.

Body
Response
No content

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