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

Обновление акции с промокодамиServer-sideAdmin

put/v3/project/{project_id}/admin/promocode/{external_id}

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

SecuritybasicAuth
Request
path Parameters
project_id
required
integer

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

Example: 44056
external_id
required
integer

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

Example: coupon_44056_1
Request Body schema: application/json
required
object
Default: {"de-DE":"Gutscheintitel","en-US":"Coupon title"}

Название акции. Данный параметр должен содержать пары ключ/значение, где ключ — это локаль в формате "^[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 — пользователи у которых атрибут есть, но значение не совпадает с указанным в условии, или атрибута нет, не увидят товар.

Array of objects or null
Array
quantity
number
Default: 1

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

sku
string
Default: "elven_shield"

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

object or null
percent
string or null
Default: "10.00"

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

Array of objects or null

Список товаров, на которые действует скидка по промокоду.

Array
sku
required
string
Default: "elven_shield"

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

required
object
percent
required
string
Default: "10.00"

Процент скидки.

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

excluded_promotions
Array of integers

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

Array of objects or null

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

Array
operator
required
string

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

Enum: Description
eq

Равно

ge

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

gt

Больше чем

le

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

lt

Меньше чем

ne

Не равно

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

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

Array of objects or null

Массив объектов с условиями, задающими ценовой диапазон применения акции для отдельных товаров в корзине.
Стоимость каждого товара в корзине пользователя сравнивается с заданным в условии ценовым диапазоном. Бонусы и скидки применяются только к тем товарам в корзине, цена которых удовлетворяет условию.
Если вы передаете этот массив, в массиве discounted_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, только если указан один период действия.

redeem_code_limit
integer or null
Default: 10

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

redeem_total_limit
integer or null
Default: 10

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

redeem_user_limit
integer or null
Default: 10

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

Responses
204

Промокод успешно обновлен.

401

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

404

Промокод не найден. Убедитесь, что external_id указан правильно.

422

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

Request samples
application/json
{
  • "attribute_conditions": [
    ],
  • "discount": {
    },
  • "name": {
    },
  • "promotion_periods": [
    ],
  • "redeem_code_limit": 1,
  • "redeem_total_limit": 100,
  • "redeem_user_limit": 1
}
Response samples
application/json
{
  • "errorCode": 1020,
  • "errorMessage": "[0401-1020]: Error in Authentication method occurred",
  • "statusCode": 401
}

Privacy Settings

Privacy PolicyEnd User License Agreement
System statusAll services operational
© 2006–2026 Xsolla Inc.