Create discount promotion for item

Create discount promotion for itemServer-sideAdmin

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

Creates a discount promotion for an item.

Promotions provide a discount (%) on items. The discount will be applied to all prices of the specified items.

SecuritybasicAuth

Request

path Parameters

project_id

required

integer

Project ID. You can find this parameter in your Publisher Account next to the name of the project.

Example: 44056

Request Body schema: application/json

Object with promotion data.

required

Array of objects

Array

sku

required

string

Default: "elven_sword"

Item SKU.

required

object

percent

required

string

Percent discount. The price of item will be decreased using a value calculated by using this percent and then rounded to 2 decimal places.

required

object

Name of promotion. Should contain key/value pairs, where key is locale with format "^[a-z]{2}-[A-Z]{2}$", value is string.

property name*

additional property

string

date_start

string or null <date-time>

Default: "2020-04-15T18:16:00+05:00"

Date when your promotion will be started.

date_end

string or null <date-time>

Default: "2020-04-15T18:16:00+05:00"

Date when your promotion will be finished. Can be null.

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]+$

User attribute code.

operator

required

string

Type of operation performed by condition. For string attribute type.

Enum:	Description
eq	Equals
ne	Not equals

value

required

string <= 255 characters

Condition value which user attribute value will be compared to. Type depends on attribute type.

type

required

string

User attribute type.

Value: "string"

can_be_missing

boolean

Indicates that the condition is met even if attribute is missing from user attributes. Pass true to show the item to users who don't have this attribute. Users who have the attribute, but the value does not match that specified in the condition, will not see the item. false — users who have the attribute, but the value does not match that specified in the condition, or the attribute is missing, will not see the item.

object or null

Condition for applying the promotion to items priced within the specified price range. In the price_range_condition object, you need to provide a value for at least one of the parameters: lower_limit or upper_limit.
If you have specified items in the items object, the promotion only applies to the items within this object and within the specified price range.
To make the promotional condition apply to all items, pass the value null in the items object.

lower_limit required	string or null Lower limit of the price range for applying the promotion. If the `lower_limit` value is set, the promotions will only apply to items whose price is greater than or equal to this value. The price value should be specified in the default currency. Example: `"10.0000"`
upper_limit required	string or null Upper limit of the price range for applying the promotion. If the `upper_limit` is set, the promotions will only apply to items whose price is less than or equal to this value. The price value should be specified in the default currency. Example: `"20.0000"`

object

Promotion limits.

per_user

integer or null

Promotion limitation for a separate user.

object or null

Limit refresh period.

interval_type = daily (object) or interval_type = weekly (object) or interval_type = monthly (object)

One of:

Daily type of user limits refresh.

interval_type required	string Recurrent refresh period. Value: "daily"
time required	string((0[0-9]\|1[0-9]\|2[0-3]):00:00)(\+\|-)(0[0-9]\|1... Time of limit refresh in the desired time zone (rounding to hours).

Responses

201

Promotion was successfully created.

401

Basic authentication not passed or wrong. Make sure you used basic authentication or correct credentials.

422

Invalid request.

Request samples

application/json

{"date_start": "2020-04-15T18:16:00+05:00",
"date_end": "2020-04-25T18:16:00+05:00",
"discount": {"percent": "10.00"
},
"items": [{"sku": "elven_sword"
},
{"sku": "elven_helmet"
},
{"sku": "elven_armor"
}
],
"name": {"en-US": "Promotion",
"ru-RU": "Акция"
}
}

Response samples

application/json

{"promotion_id": 2384756
}