Получение виртуальной валюты

Admin
Копировать для LLM
Копировать страницу как Markdown для LLM
Просмотреть как Markdown
Открыть эту страницу как Markdown
Открыть в ChatGPT
Получить анализ от ChatGPT
Открыть в Claude
Получить инсайты от Claude

Операции

Удаление виртуальной валютыServer-sideAdmin

Запрос

Удаляет виртуальную валюту.

Безопасность

basicAuth

Путь

project_idintegerобязательный

ID проекта. Вы можете найти этот параметр в Личном кабинете рядом с названием проекта.

Пример: 44056

virtual_currency_skustringобязательный

Артикул виртуальной валюты.

Пример: crystal

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

Ответы

Виртуальная валюта успешно удалена.

Тело

Ответ

Нет содержимого

Получение виртуальной валютыServer-sideAdmin

Запрос

Получает виртуальную валюту в рамках проекта для администрирования.

Примечание

Не используйте данный метод для построения каталога магазина.

Безопасность

basicAuth

Путь

project_idintegerобязательный

ID проекта. Вы можете найти этот параметр в Личном кабинете рядом с названием проекта.

Пример: 44056

virtual_currency_skustringобязательный

Артикул виртуальной валюты.

Пример: crystal

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

Ответы

Указанная виртуальная валюта успешно получена.

Телоapplication/json

attributesArray of objects(Virtual-Items-Currency_admin-attributes)

Список атрибутов.

Пример: [{"external_id":"attribute_external_id","name":{"de":"Attributname","en":"Attribute name"},"values":[{"external_id":"value_1","name":{"de":"wert 1","en":"value 1"}},{"external_id":"value_2","name":{"de":"wert 2","en":"value 2"}}]}]

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

JSON-объект, содержащий атрибуты товара и их значения.

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

Объект с локализованными описаниями товара. Принимает значения в одном из двух форматов: двухбуквенный код языка в нижнем регистре (например, en) или код локали из пяти символов (например, en-US). Оба формата допустимы при отправке запроса, но в ответе всегда используется код из двух символов. Если для одного языка указаны оба варианта (например, en и en-US), будет сохранено последнее переданное значение. Полный список поддерживаемых языков приведен в документации.

One of:

Объект с локализованными описаниями товара. Принимает значения в одном из двух форматов: двухбуквенный код языка в нижнем регистре (например, en) или код локали из пяти символов (например, en-US). Оба формата допустимы при отправке запроса, но в ответе всегда используется код из двух символов. Если для одного языка указаны оба варианта (например, en и en-US), будет сохранено последнее переданное значение. Полный список поддерживаемых языков приведен в документации.

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

Группы, к которым принадлежит товар.

По умолчанию []

Пример: [{"external_id":"horror","name":{"en":"Horror"}}]

image_urlstring(Virtual-Items-Currency_admin-image_url)

is_enabledboolean(Virtual-Items-Currency_is_enabled)

is_freeboolean(value-is_free)

Если true, товар бесплатный.

По умолчанию false

Пример: false

is_hardboolean(Virtual-Items-Currency_is_hard)

is_show_in_storeboolean(Virtual-Items-Currency_is_show_in_store)

limitsobject or null(admin-item-limit-response)

Ограничения на продажу товара.

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

Объект с локализованными длинными описаниями товара. Принимает значения в одном из двух форматов: двухбуквенный код языка в нижнем регистре (например, en) или код локали из пяти символов (например, en-US). Оба формата допустимы при отправке запроса, но в ответе всегда используется код из двух символов. Если для одного языка указаны оба варианта (например, en и en-US), будет сохранено последнее переданное значение. Полный список поддерживаемых языков приведен в документации.

Any of:

Объект с локализованными длинными описаниями товара. Принимает значения в одном из двух форматов: двухбуквенный код языка в нижнем регистре (например, en) или код локали из пяти символов (например, en-US). Оба формата допустимы при отправке запроса, но в ответе всегда используется код из двух символов. Если для одного языка указаны оба варианта (например, en и en-US), будет сохранено последнее переданное значение. Полный список поддерживаемых языков приведен в документации.

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

Дополнительные ассеты предмета, такие как скриншоты, видео игрового процесса и так далее.

Пример: [{"type":"image","url":"https://cdn3.xsolla.com/img/misc/images/71ab1e12126f2103e1868076f0acb21a.jpg"}]

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

Объект с локализованными названиями товара. Принимает значения в одном из двух форматов: двухбуквенный код языка в нижнем регистре (например, en) или код языка из пяти символов (например, en-US). Оба формата допустимы при отправке запроса, но в ответе всегда используется двухбуквенный код языка. Если для одного языка указаны оба варианта (например, en и en-US), будет сохранено последнее переданное значение. Полный список поддерживаемых языков приведен в документации.

One of:

Объект с локализованными названиями товара. Принимает значения в одном из двух форматов: двухбуквенный код языка в нижнем регистре (например, en) или код языка из пяти символов (например, en-US). Оба формата допустимы при отправке запроса, но в ответе всегда используется двухбуквенный код языка. Если для одного языка указаны оба варианта (например, en и en-US), будет сохранено последнее переданное значение. Полный список поддерживаемых языков приведен в документации.

orderinteger(Virtual-Items-Currency_order)

Определяет порядок расположения.

Пример: 1

periodsArray of objects(item-periods-response)

Период продажи товара.

pricesArray of objects(Virtual-Items-Currency_admin-prices)

Пример: [{"amount":10.5,"country_iso":"US","currency":"USD","is_default":true,"is_enabled":true}]

regionsArray of objects(Virtual-Items-Currency_admin-regions)

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

Уникальный ID товара. Артикул может содержать только строчные и заглавные латинские буквы, цифры, точки, тире и подчеркивания.

Пример: "booster_mega_1"

typestring(Virtual-Items-Currency_type)

Тип товара: virtual_good/virtual_currency/bundle/physical_good/unit.

vc_pricesArray of objects(Virtual-Items-Currency_admin-get-vc_prices)

Пример: [{"amount":10,"is_default":true,"sku":"com.xsolla.gold_1"}]

Ответ

application/json

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

Обновление виртуальной валютыServer-sideAdmin

Запрос

Обновляет виртуальную валюту.

Безопасность

basicAuth

Путь

project_idintegerобязательный

ID проекта. Вы можете найти этот параметр в Личном кабинете рядом с названием проекта.

Пример: 44056

virtual_currency_skustringобязательный

Артикул виртуальной валюты.

Пример: crystal

Телоapplication/json

attributesArray of objects(Virtual-Items-Currency_admin-post-put-attributes)<= 20 items

Список атрибутов.

Внимание. Для товара невозможно указать более 20 атрибутов. Любые попытки превысить данное ограничение вызовут ошибку.

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

JSON-объект, содержащий атрибуты товара и их значения. Атрибуты позволяют добавить дополнительную информацию к товарам. Например, указать уровень игрока, на котором ему станет доступен этот товар. Атрибуты дополняют внутреннюю логику игры и могут быть получены через GET-методы и вебхуки.

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

Объект с локализованными описаниями товара. Принимает значения в одном из двух форматов: двухбуквенный код языка в нижнем регистре (например, en) или код локали из пяти символов (например, en-US). Оба формата допустимы при отправке запроса, но в ответе всегда используется код из двух символов. Если для одного языка указаны оба варианта (например, en и en-US), будет сохранено последнее переданное значение. Полный список поддерживаемых языков приведен в документации.

One of:

Объект с локализованными описаниями товара. Принимает значения в одном из двух форматов: двухбуквенный код языка в нижнем регистре (например, en) или код локали из пяти символов (например, en-US). Оба формата допустимы при отправке запроса, но в ответе всегда используется код из двух символов. Если для одного языка указаны оба варианта (например, en и en-US), будет сохранено последнее переданное значение. Полный список поддерживаемых языков приведен в документации.

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

Группы, к которым принадлежит товар.

По умолчанию []

Пример: [{"external_id":"horror","name":{"en":"Horror"}}]

image_urlstring(Virtual-Items-Currency_admin-image_url)

is_deletedboolean(Virtual-Items-Currency_is_deleted)

is_enabledboolean(Virtual-Items-Currency_is_enabled)

is_freeboolean(value-is_free)

Если true, товар бесплатный.

По умолчанию false

Пример: false

is_hardboolean(Virtual-Items-Currency_is_hard)

is_show_in_storeboolean(Virtual-Items-Currency_is_show_in_store)

limitsobject(Virtual-Currency-item-limit)

Ограничения на продажу товара.

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

Объект с локализованными длинными описаниями товара. Принимает значения в одном из двух форматов: двухбуквенный код языка в нижнем регистре (например, en) или код локали из пяти символов (например, en-US). Оба формата допустимы при отправке запроса, но в ответе всегда используется код из двух символов. Если для одного языка указаны оба варианта (например, en и en-US), будет сохранено последнее переданное значение. Полный список поддерживаемых языков приведен в документации.

Any of:

Объект с локализованными длинными описаниями товара. Принимает значения в одном из двух форматов: двухбуквенный код языка в нижнем регистре (например, en) или код локали из пяти символов (например, en-US). Оба формата допустимы при отправке запроса, но в ответе всегда используется код из двух символов. Если для одного языка указаны оба варианта (например, en и en-US), будет сохранено последнее переданное значение. Полный список поддерживаемых языков приведен в документации.

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

Дополнительные ассеты предмета, такие как скриншоты, видео игрового процесса и так далее.

Пример: [{"type":"image","url":"https://cdn3.xsolla.com/img/misc/images/71ab1e12126f2103e1868076f0acb21a.jpg"}]

name(two-letter (object or null)) or (five-letter (object or null))(name-localization-object)обязательный

Объект с локализованными названиями товара. Принимает значения в одном из двух форматов: двухбуквенный код языка в нижнем регистре (например, en) или код языка из пяти символов (например, en-US). Оба формата допустимы при отправке запроса, но в ответе всегда используется двухбуквенный код языка. Если для одного языка указаны оба варианта (например, en и en-US), будет сохранено последнее переданное значение. Полный список поддерживаемых языков приведен в документации.

One of:

Объект с локализованными названиями товара. Принимает значения в одном из двух форматов: двухбуквенный код языка в нижнем регистре (например, en) или код языка из пяти символов (например, en-US). Оба формата допустимы при отправке запроса, но в ответе всегда используется двухбуквенный код языка. Если для одного языка указаны оба варианта (например, en и en-US), будет сохранено последнее переданное значение. Полный список поддерживаемых языков приведен в документации.

name.arstring or null

Арабский

name.bgstring or null

Болгарский

name.cnstring or null

Китайский упрощенный

name.csstring or null

Чешский

name.destring or null

Немецкий

name.enstring or null

Английский

name.esstring or null

Spanish (Spain)

name.frstring or null

Французский

name.hestring or null

Иврит

name.idstring or null

Индонезийский

name.itstring or null

Итальянский

name.jastring or null

Японский

name.kmstring or null

Кхмерский

name.kostring or null

Корейский

name.lostring or null

Лаосский

name.mystring or null

Бирманский

name.nestring or null

Непальский

name.phstring or null

Филиппинский

name.plstring or null

Польский

name.ptstring or null

Португальский

name.rostring or null

Румынский

name.rustring or null

Русский

name.thstring or null

Тайский

name.trstring or null

Турецкий

name.twstring or null

Китайский традиционный

name.vistring or null

Вьетнамский

orderinteger(Virtual-Items-Currency_order)

Определяет порядок расположения.

Пример: 1

periodsArray of objects or null(item-periods)

Период продажи товара.

pre_orderobject(Virtual-Items-Currency_admin-pre_order)

pricesArray of objects(Virtual-Items-Currency_admin-prices)

Пример: [{"amount":10.5,"country_iso":"US","currency":"USD","is_default":true,"is_enabled":true}]

regionsArray of objects(Virtual-Items-Currency_admin-regions)

skustring(Virtual-Items-Currency_sku)[ 1 .. 255 ] characters^[a-zA-Z0-9_\-–.]*$обязательный

Уникальный ID товара. Артикул может содержать только строчные и заглавные латинские буквы, цифры, точки, тире и подчеркивания.

Пример: "booster_mega_1"

vc_pricesArray of objects(Virtual-Items-Currency_admin-create-vc_prices)

Пример: [{"amount":10,"is_default":true,"is_enabled":true,"sku":"com.xsolla.gold_1"}]

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