Перейти к содержимому
/
Удаление акции с купонами

Shop Builder 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

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
index.json
index.yaml
Языки
Серверы
Mock server
https://xsolla.redocly.app/_mock/ru/api/shop-builder/
https://store.xsolla.com/api/

Admin

Операции

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

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

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

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

Операции

Admin

Операции

Catalog

Операции

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

Операции

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

Операции

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

Операции

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

Операции

Заказ

Операции

Бесплатные товары

Операции

Вебхуки

Операции

Предзаказы

Операции

Продавец

Операции

Catalog

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

Операции

Общие регионы

Операции

Catalog

Операции

Владение играми

Операции

Admin

Операции

Общие

Операции

Купоны

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

Операции

Создание акции с купонами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

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

bonusArray of objects or null(Promotions_coupon_bonus)
external_idstring(Promotions_coupon-external_id)обязательный

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

По умолчанию "coupon_external_id"
Пример: "coupon_external_id"
nameobject(Promotions_coupon_name)обязательный

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

По умолчанию {"de-DE":"Gutscheintitel","en-US":"Coupon title"}
Пример: {"de-DE":"Gutscheintitel","en-US":"Coupon title"}
name.​property name*stringдополнительное свойство
promotion_periodsArray of objects(promotion_periods)

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

redeem_code_limitinteger or null(Promotions_redeem_code_limit)

Количество погашений по коду.

По умолчанию 10
Пример: 10
redeem_total_limitinteger or null(Promotions_coupon-redeem_total_limit)

Ограничивает общее количество купонов.

По умолчанию 10
Пример: 10
redeem_user_limitinteger or null(Promotions_coupon-redeem_user_limit)

Ограничивает общее количество купонов, погашаемых одним пользователем.

По умолчанию 10
Пример: 10
curl -i -X POST \
  -u <username>:<password> \
  https://xsolla.redocly.app/_mock/ru/api/shop-builder/v3/project/44056/admin/coupon \
  -H 'Content-Type: application/json' \
  -d '{
    "attribute_conditions": [
      {
        "attribute": "account_status",
        "can_be_missing": false,
        "operator": "eq",
        "type": "string",
        "value": "golden"
      }
    ],
    "bonus": [
      {
        "quantity": 1,
        "sku": "com.xsolla.elven_sword_2"
      }
    ],
    "external_id": "coupon_external_id",
    "name": {
      "de-DE": "Neujahrsbonus",
      "en-US": "New Year Bonus"
    },
    "promotion_periods": [
      {
        "date_from": "2020-04-15T18:16:00+05:00",
        "date_until": "2020-04-25T18:16:00+05:00"
      }
    ],
    "redeem_code_limit": 1,
    "redeem_total_limit": 100,
    "redeem_user_limit": 1
  }'

Ответы

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

Телоapplication/json
external_idstring(Promotions_coupon-external_id)

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

По умолчанию "coupon_external_id"
Пример: "coupon_external_id"
Ответ
application/json
{
  "external_id": "coupon_external_id"
}

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

Запрос

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

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

После удаления акция не может быть восстановлена. Коды купонов из удаленной акции могут быть добавлены в существующие акции.

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

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

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

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

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

Ответы

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

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

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

Запрос

Получает указанную акцию с купонами.

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

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

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

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

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

Ответы

Акция с купонами успешно получена.

Телоapplication/json
attribute_conditionsArray of type = string (object) or type = number (object) or type = date (object)(promotion_user-attribute_conditions_model-get)[ 1 .. 100 ] items

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

bonusArray of objects or null(Promotions_coupon_bonus)
external_idstring(Promotions_coupon-external_id)

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

По умолчанию "coupon_external_id"
Пример: "coupon_external_id"
is_enabledboolean(Promotions_coupon-is_enabled)
По умолчанию true
nameobject(Promotions_coupon_name)

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

По умолчанию {"de-DE":"Gutscheintitel","en-US":"Coupon title"}
Пример: {"de-DE":"Gutscheintitel","en-US":"Coupon title"}
promotion_periodsArray of objects(promotion_periods)

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

redeem_code_limitinteger or null(Promotions_redeem_code_limit)

Количество погашений по коду.

По умолчанию 10
Пример: 10
redeem_total_limitinteger or null(Promotions_coupon-redeem_total_limit)

Ограничивает общее количество купонов.

По умолчанию 10
Пример: 10
redeem_user_limitinteger or null(Promotions_coupon-redeem_user_limit)

Ограничивает общее количество купонов, погашаемых одним пользователем.

По умолчанию 10
Пример: 10
total_limit_stateobject or null(Promotions_coupon_total_limit_state)

Ограничения для каждого уникального кода купона.

Ответ
application/json
{
  "bonus": [
    { … }
  ],
  "external_id": "summer20221",
  "is_enabled": true,
  "name": {
    "en-US": "Coupon name",
    "ru-RU": "Название купона"
  },
  "promotion_periods": [
    { … },
    { … }
  ],
  "redeem_code_limit": null,
  "redeem_total_limit": 100,
  "redeem_user_limit": null,
  "total_limit_state": {
    "available": 50,
    "reserved": 10,
    "used": 40
  }
}

Промокоды

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

Операции

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

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

Операции

Скидки

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

Операции

Бонусы

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

Операции

Admin

Операции

Catalog

Операции

Виртуальная оплата

Операции

Управление

Операции

Admin

Операции

Клиент

Операции

Клиент кланов

Операции

Admin

Операции

Клиент

Операции

Admin

Операции

Клиент

Операции

Admin

Операции

Клиент

Операции

Admin

Операции