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

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 Платежей Иксолла.

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

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

Операции

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

Операции

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

Операции

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

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

Catalog

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

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

Купоны

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

Операции

Промокоды

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

Операции

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

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

Операции

Скидки

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

Операции

Получение списка акций со скидкамиServer-sideAdmin

Запрос

Получает список акций со скидками в рамках проекта.

Акция дает скидку (%) на товары. Скидка будет применена ко всем ценам на указанные товары.

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

ID проекта.

По умолчанию 59080
Запрос
limitinteger

Лимит количества элементов на странице.

offsetinteger

Номер элемента, с которого выполняется вывод на странице (нумерация ведется с 0).

curl -i -X GET \
  -u <username>:<password> \
  'https://xsolla.redocly.app/_mock/ru/api/shop-builder/v3/project/{project_id}/admin/promotion/item?limit=0&offset=0'

Ответы

Список акций со скидками успешно получен.

Телоapplication/json
active_promotions_countinteger(active_promotions_count)

Количество активных акций.

inactive_promotions_countinteger(inactive_promotions_count)

Количество отключенных акций.

promotionsArray of objects
total_promotions_countinteger(total_promotions_count)

Общее количество акций.

Ответ
application/json
{ "active_promotions_count": 4, "inactive_promotions_count": 0, "promotions": [ {}, {}, {}, {} ], "total_promotions_count": 4 }

Создание акции со скидками для товараServer-sideAdmin

Запрос

Создает акцию со скидками для товара.

Акция дает скидку (%) на товары. Скидка будет применена ко всем ценам на указанные товары.

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

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

Пример: 44056
Телоapplication/jsonобязательный

Объект с данными акции.

attribute_conditionsArray of type = string (object) or type = number (object) or type = date (object)(promotion_user-attribute_conditions_model-post)[ 1 .. 100 ] items

Условия для проверки атрибутов пользователя. Определяют доступность акции на основе соответствия атрибутов пользователя всем указанным условиям.

discountobjectобязательный
discount.​percentstringобязательный

Процент скидки. Цена товара будет уменьшена с использованием значения, рассчитанного с использованием этого процента, а затем округлена до 2 знаков после запятой.

Пример: 10
excluded_promotionsArray of integers(excluded_promotions)

Список акций, которые исключаются при применении этой акции.
Example: [12, 789]

Пример: [12,789]
is_enabledboolean(Promotions_is_enabled)

Активирована ли акция.

Пример: true
itemsArray of objectsобязательный
items[].​skustringобязательный

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

По умолчанию "elven_sword"
limitsobject(Promotions_promotion_limits)

Ограничения акции.

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

Название акции. Данный параметр должен содержать пары ключ/значение, где ключ — это локаль в формате "^[a-z]{2}-[A-Z]{2}$", значение — строка.

Пример: {"en-US":"Promotion","ru-RU":"Акция"}
name.​property name*stringдополнительное свойство
price_conditionsArray of objects or null(price_conditions_discount)

Массив объектов с условиями, задающими ценовой диапазон применения акции.
Акция применяется только к товарам, цена которых удовлетворяет всем условиям в массиве. Если вы передаете этот массив, в объекте items передайте значение null.

promotion_periodsArray of objects(promotion_periods)

Периоды действия акции. Если указано больше одного периода, параметры date_from и date_until становятся обязательными.

curl -i -X POST \
  -u <username>:<password> \
  https://xsolla.redocly.app/_mock/ru/api/shop-builder/v3/project/44056/admin/promotion/item \
  -H 'Content-Type: application/json' \
  -d '{
    "attribute_conditions": [
      {
        "attribute": "race",
        "operator": "eq",
        "type": "string",
        "value": "ork"
      },
      {
        "attribute": "level",
        "can_be_missing": true,
        "operator": "eq",
        "type": "number",
        "value": "10"
      }
    ],
    "discount": {
      "percent": "24.00"
    },
    "is_enabled": true,
    "items": [],
    "name": {
      "en-US": "Ork set discount",
      "ru-RU": "Скидка на набор для орка"
    },
    "promotion_periods": [
      {
        "date_from": "2020-04-15T18:16:00+05:00",
        "date_until": "2020-04-25T18:16:00+05:00"
      }
    ]
  }'

Ответы

Акция успешно создана.

Телоapplication/json
promotion_idinteger

ID акции. Уникальный идентификатор акции в рамках проекта.

Ответ
application/json
{ "promotion_id": 2384756 }

Удаление скидочной акцииServer-sideAdmin

Запрос

Удаляет скидочную акцию. Удаленная акция:

  • Пропадет из списка акций, настроенных в вашем проекте.
  • Не будет применяться к каталогу товаров и к корзине. Пользователь не сможет купить товары с применением этой акции.

После удаления акция не может быть восстановлена.

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

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

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

ID акции. Уникальный идентификатор акции в рамках проекта.

Пример: 111425
curl -i -X DELETE \
  -u <username>:<password> \
  https://xsolla.redocly.app/_mock/ru/api/shop-builder/v3/project/44056/admin/promotion/111425/item

Ответы

Акция была успешно удалена.

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

Бонусы

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

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