Обновление акции с купонами

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

put/v2/project/{project_id}/admin/coupon/{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 (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 — пользователи у которых атрибут есть, но значение не совпадает с указанным в условии, или атрибута нет, не увидят товар.

Array of objects or null

Array

quantity	number Default: 1 Количество товара.
sku	string Default: "elven_shield" Артикул товара.

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"

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

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": [{"attribute": "account_status",
"can_be_missing": false,
"operator": "eq",
"type": "string",
"value": "golden"
}
],
"bonus": [{"quantity": 1,
"sku": "elven_sword"
}
],
"date_end": "2020-04-25T18:16:00+05:00",
"date_start": "2020-04-15T18:16:00+05:00",
"name": {"de-DE": "Neujahrsbonus",
"en-US": "New Year Bonus"
},
"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
}