Xsolla-logo
или
Личный кабинет

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

post/v3/project/{project_id}/admin/promotion/item

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

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

SecuritybasicAuth
Request
path Parameters
project_id
required
integer

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

Example: 44056
Request Body schema: application/json

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

required
Array of objects
Array
sku
required
string
Default: "elven_sword"

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

required
object
percent
required
string

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

required
object

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

property name*
additional property
string
Array of type = string (object) or type = number (object) or type = date (object) [ 1 .. 100 ] items

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

Array ([ 1 .. 100 ] items)
One of:
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 — пользователи у которых атрибут есть, но значение не совпадает с указанным в условии, или атрибута нет, не увидят товар.

excluded_promotions
Array of integers

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

is_enabled
boolean

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

object

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

per_user
integer or null

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

object or null

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

object

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

day_of_month
integer or null [ 1 .. 31 ]

День месяца, когда обновляются ограничения. Если в месяце нет указанного дня, поскольку месяц короче, обновление произойдет в последний день месяца. Не null только для периода monthly.

day_of_week
integer or null [ 1 .. 7 ]

День недели, когда обновляются ограничения: 1 — понедельник, 7 — воскресенье. Не null только для типа периода weekly.

displayable_reset_next_date
string <date-time>

Дата и время, когда ограничения должны быть сброшены (ISO 8601).

displayable_reset_start_date
string <date-time>

Дата и время первого обновления ограничения (ISO 8601).

interval_type
string

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

Enum: "daily" "weekly" "monthly"
reset_next_date
integer

Дата и время обновления ограничений (Unix Timestamp).

time
string <full-time>

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

Array of objects or null

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

Array
operator
required
string

Оператор сравнения для задания ценового диапазона применения акции.

Enum: Description
eq

Равно

ge

Больше или равно

gt

Больше чем

le

Меньше или равно

lt

Меньше чем

ne

Не равно

value
required
string^\d+(\.\d{1,4})?$

Значение для определения ценового диапазона применения акции.

Array of objects

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

Array
date_from
required
string <date-time>

Дата начала действия указанной акции.

date_until
string or null <date-time>

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

Responses
201

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

401

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

422

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

Request samples
application/json
{
  • "attribute_conditions": [
    ],
  • "discount": {
    },
  • "is_enabled": true,
  • "items": [ ],
  • "name": {
    },
  • "promotion_periods": [
    ]
}
Response samples
application/json
{
  • "promotion_id": 2384756
}