Перейти к содержимому

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

Shop Builder API provides a third-party solution for implementing the server side for your store interface. Use the endpoints to manage in-game items, in-game currencies, cart, player inventory, promotions, game library, etc.

Скачать описание OpenAPI
Языки
Серверы
Mock server
https://xsolla.redocly.app/_mock/ru/api/shop-builder/
https://store.xsolla.com/api/
Операции

Персонализированный каталог

Данный API позволяет задавать правила для пользовательских атрибутов. Если пользователь соответствует всем условиям для конкретного правила, будут показаны персонализированные товары.

Узнать о персонализированных акциях можно в подразделе "Скидки" раздела "Акции".

Чтобы передать атрибуты перед покупкой, вы можете использовать API Авторизации Иксолла или передать их в свойство user.attributes при генерации токена с помощью API Платежей Иксолла.

Операции
Операции
Операции

Корзина (на стороне клиента)

Операции

Корзина (на стороне сервера)

Операции

Оплата (на стороне клиента)

Операции

Оплата (на стороне сервера)

Операции
Операции
Операции

Создание заказа с помощью бесплатной корзиныClient-side

Запрос

Создает заказ со всеми товарами из бесплатной корзины. Созданному заказу будет присвоен статус заказа done.

Безопасность
AuthForCart
Путь
project_idintegerобязательный

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

Пример: 44056
Телоapplication/json
currencystring

Валюта, в которой указана стоимость заказа. Трехбуквенный код валюты в соответствии с ISO 4217. Подробную информацию о валютах, поддерживаемых Xsolla, смотрите в документации.

custom_parametersobject[ 1 .. 200 ] properties

Дополнительные пользовательские параметры проекта.

localestring

Язык ответа.

sandboxboolean

Создает заказ в тестовом окружении. Эта возможность доступна для пользователей, указанных в списке пользователей компании.

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

Параметры для настройки процесса оплаты и платежного интерфейса для пользователя.

curl -i -X POST \
  https://xsolla.redocly.app/_mock/ru/api/shop-builder/v2/project/44056/free/cart \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "custom_parameters": {
      "character_id": "ingameUsername"
    },
    "sandbox": true,
    "settings": {
      "ui": {
        "desktop": {
          "header": {
            "close_button": false,
            "is_visible": true,
            "type": "normal",
            "visible_logo": true,
            "visible_name": true,
            "visible_purchase": true
          }
        },
        "theme": "63295a9a2e47fab76f7708e1"
      }
    }
  }'

Ответы

Бесплатный заказ успешно создан.

Телоapplication/json
order_idinteger

ID заказа.

Ответ
application/json
{ "order_id": 641 }

Создание заказа с помощью определенной бесплатной корзиныClient-side

Запрос

Создает заказ со всеми товарами из определенной бесплатной корзины. Созданному заказу будет присвоен статус заказа done.

Безопасность
AuthForCart
Путь
project_idintegerобязательный

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

Пример: 44056
cart_idstringобязательный

ID корзины.

Пример: custom_id
Телоapplication/json
currencystring

Валюта, в которой указана стоимость заказа. Трехбуквенный код валюты в соответствии с ISO 4217. Подробную информацию о валютах, поддерживаемых Xsolla, смотрите в документации.

custom_parametersobject[ 1 .. 200 ] properties

Дополнительные пользовательские параметры проекта.

localestring

Язык ответа.

sandboxboolean

Создает заказ в тестовом окружении. Эта возможность доступна для пользователей, указанных в списке пользователей компании.

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

Параметры для настройки процесса оплаты и платежного интерфейса для пользователя.

curl -i -X POST \
  https://xsolla.redocly.app/_mock/ru/api/shop-builder/v2/project/44056/free/cart/custom_id \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "custom_parameters": {
      "character_id": "ingameUsername"
    },
    "sandbox": true,
    "settings": {
      "ui": {
        "desktop": {
          "header": {
            "close_button": false,
            "is_visible": true,
            "type": "normal",
            "visible_logo": true,
            "visible_name": true,
            "visible_purchase": true
          }
        },
        "theme": "63295a9a2e47fab76f7708e1"
      }
    }
  }'

Ответы

Бесплатный заказ успешно создан.

Телоapplication/json
order_idinteger

ID заказа.

Ответ
application/json
{ "order_id": 641 }

Создание заказа с указанным бесплатным товаромClient-side

Запрос

Создает заказ с указанным бесплатным товаром. Созданному заказу будет присвоен статус заказа done.

Безопасность
XsollaLoginUserJWT
Путь
project_idintegerобязательный

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

Пример: 44056
item_skustringобязательный

Артикул товара.

Пример: booster_mega_1
Телоapplication/json
currencystring

Валюта, в которой указана стоимость заказа. Трехбуквенный код валюты в соответствии с ISO 4217. Подробную информацию о валютах, поддерживаемых Xsolla, смотрите в документации.

custom_parametersobject[ 1 .. 200 ] properties

Дополнительные пользовательские параметры проекта.

localestring

Язык ответа.

promo_codestring

Погашает промокод при оплате.

quantityinteger>= 1

Количество товаров.

По умолчанию 1
sandboxboolean

Создает заказ в тестовом окружении. Эта возможность доступна для пользователей, указанных в списке пользователей компании.

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

Параметры для настройки процесса оплаты и платежного интерфейса для пользователя.

curl -i -X POST \
  https://xsolla.redocly.app/_mock/ru/api/shop-builder/v2/project/44056/free/item/booster_mega_1 \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "custom_parameters": {
      "character_id": "ingameUsername"
    },
    "promo_code": "discount_code",
    "quantity": 5,
    "sandbox": true,
    "settings": {
      "ui": {
        "desktop": {
          "header": {
            "close_button": false,
            "is_visible": true,
            "type": "normal",
            "visible_logo": true,
            "visible_name": true,
            "visible_purchase": true
          }
        },
        "theme": "63295a9a2e47fab76f7708e1"
      }
    }
  }'

Ответы

Бесплатный заказ успешно создан.

Телоapplication/json
order_idinteger

ID заказа.

Ответ
application/json
{ "order_id": 641 }
Операции
Операции
Операции

Catalog

Данный API позволяет получать продаваемые товары любого вида или конкретный товар.

Операции
Операции
Операции
Операции
Операции
Операции

Купоны

Этот API позволяет вам управлять купонами.

Операции

Промокоды

Этот API позволяет вам управлять промокодами.

Операции

Уникальный каталог предложений

Этот API позволяет вам управлять уникальными предложениями каталога.

Операции

Скидки

Этот API позволяет вам управлять скидочными акциями.

Операции

Бонусы

Этот API позволяет вам управлять бонусными акциями.

Операции
Операции
Операции
Операции
Операции
Операции
Операции
Операции
Операции
Операции
Операции
Операции
Операции
Операции
Операции