Xsolla-logo

Создание акции с бонусами

post/v2/project/{project_id}/admin/promotion/bonus

Создает акцию с бонусами.

Акция добавляет бесплатные бонусные товары к покупке, совершенной пользователем. Акция может быть применена к каждой покупке в рамках проекта или к покупке, включающей определенные товары.

SecuritybasicAuth
Request
path Parameters
project_id
required
integer

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

Example: 44056
Request Body schema: application/json
required
Array of objects or null

Набор товаров, которые необходимо включить в покупку для применения акции. Если этот параметр равен null, акция будет применена к любым покупкам в рамках проекта.

Array
sku
string
Default: "elven_sword"

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

required
Array of objects or null
Array
quantity
number
Default: 1

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

sku
string
Default: "elven_shield"

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

required
object

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

property name*
additional property
string
Array of type = string (objects) or Array of type = date (objects) or Array of type = number (objects)
One of:

Условия, которые сравниваются со значениями пользовательских атрибутов. Чтобы действие вступило в силу, все условия должны быть выполнены.

[ 1 .. 100 ] items
Array ([ 1 .. 100 ] items)
attribute
required
string [ 1 .. 255 ] characters ^[-_.\\d\\w]+$

Код атрибута пользователя.

operator
required
string

Тип операции, выполняемой по условию. Для типа атрибута string.

Enum: Description
eq

Равно

ne

Не равно

value
required
string <= 255 characters

Значение условия, с которым будет сравниваться значение атрибута пользователя. Тип зависит от типа атрибута.

type
required
string

Тип атрибута пользователя.

Value: "string"
can_be_missing
boolean

Считается ли условие выполненным, если этот атрибут отсутствует в атрибутах пользователя. Передайте true, чтобы показывать товар пользователям, у которых нет этого атрибута. Пользователи у которых атрибут есть, но значение не совпадает с указанным в условии, не увидят товар.false — пользователи у которых атрибут есть, но значение не совпадает с указанным в условии, или атрибута нет, не увидят товар.

date_end
string or null <date-time>
Default: "2020-04-15T18:16:00+05:00"

Дата, когда ваша акция будет завершена. Может быть null. Если date_end равно null, акция будет неограниченна по времени.

date_start
string or null <date-time>
Default: "2020-04-15T18:16:00+05:00"

Дата, когда начнется ваша акция.

id
integer

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

object

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

per_user
integer or null

Ограничение количества использований акций отдельным пользователем.

object or null

Период обновления установленный ограничений.

interval_type = daily (object) or interval_type = weekly (object) or interval_type = monthly (object)
One of:

Ежедневное обновления пользовательских ограничений.

interval_type
required
string

Период обновления ограничений.

Value: "daily"
time
required
string((0[0-9]|1[0-9]|2[0-3]):00:00)(\+|-)(0[0-9]|1...

Время обновления ограничений в желаемом часовом поясе (округление до часов).

Responses
201

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

401

Данные для базовой аутентификации не переданы или ошибочны. Убедитесь, что использовали базовую аутентификацию и проверьте правильность учетных данных.

422

Неверный запрос.

Request samples
application/json
{
  • "attribute_conditions": [
    ],
  • "bonus": [
    ],
  • "condition": [
    ],
  • "date_end": "2020-04-25T18:16:00+05:00",
  • "date_start": "2020-04-15T18:16:00+05:00",
  • "name": {
    }
}
Response samples
application/json
{
  • "promotion_id": 2384756
}