Promotion adds free bonus items to the purchase made by a user.
The promotion can be applied to every purchase within a project or to a purchase that includes particular 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
required
Array of objects or null
Set of items required to be included in the purchase for applying a promotion. If this parameters is null, a promotion will be applied to any purchases within a project.
Array
sku
string
Default: "elven_sword"
Item SKU.
required
Array of objects or null
Array
sku
string
Default: "elven_shield"
Item SKU.
quantity
number
Default: 1
Item quantity.
required
object
Name of promotion. Should contain key/value pairs where key is a locale with "^[a-z]{2}-[A-Z]{2}$" format, value is string.
property name*
additional property
string
id
integer
Promotion ID. Unique promotion identifier within the project.
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. If date_end is null, promotion will be unlimited by time.
Array of type = string (objects) or Array of type = date (objects) or Array of type = number (objects)
One of:
Conditions which are compared to user attribute values.
All conditions must be met for the action to take an effect.
[ 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
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)
