Create a promotion

Query Parameters

Parameter	Details
with	Array of strings string Enum: customData

Request body

required

Parameter	Details
id readonly MinLength: 24 MaxLength: 24	string Example: 645e0c241a93369ff53f26e0
version readonly MinLength: 24 MaxLength: 24	string Example: 645e0c241a93369ff53f26e0
name required MinLength: 3	string Example: Christmas Promotion
displayName	object Example: { "de_DE": "Weihnachtsaktion", "en_US": "Christmas promotion" }
status required	string Enum: archived inactive active Example: active
activationType required	string Enum: automatic code Example: code
level required	string Enum: basket item
schedule required	object from string Format: date-time Pattern: ^((?:(\d{4}-\d{2}-\d{2})(T)(\d{2}:\d{2}:\d{2}(?:\.\d{2})?))(Z\|[\+-]\d{2}:\d{2}))$ Example: 2023-05-10T10:00:00+00:00 to string Format: date-time Pattern: ^((?:(\d{4}-\d{2}-\d{2})(T)(\d{2}:\d{2}:\d{2}(?:\.\d{2})?))(Z\|[\+-]\d{2}:\d{2}))$ Example: 2024-05-10T10:00:00+00:00
companyIds required	integer Example: 100
shopCountryIds required	object allowList array uniqueItems MinItems: 1 Example: [ 1, 2 ] integer blockList array uniqueItems MinItems: 1 Example: [ 3, 4 ] integer
siblingPromotions required	object enabled boolean allowList array uniqueItems Example: [ "645e0c241a93369ff53f26e0", "646235bf496f8f56171c3762" ] string MinLength: 24 MaxLength: 24 blockList array uniqueItems Example: [ "64623787496f8f56171c3763" ] string MinLength: 24 MaxLength: 24 level string Example: basket Enum: basket
audiences	object allowList array uniqueItems Example: [ "645e0c241a93369ff53f26e0", "646235bf496f8f56171c3762" ] string MinLength: 24 MaxLength: 24 blockList array uniqueItems Example: [ "64623787496f8f56171c3763" ] string MinLength: 24 MaxLength: 24
effect required	object type string Example: buy_x_get_y Enum: buy_x_get_y automatic_discount combo_deal additionalData
conditions required	object level string Example: global Enum: global item key string Example: mov_100 condition string MinLength: 1 Example: payload.items.exists(i, 11003 in i.variant.id)
itemSetIds MinLength: 24 MaxLength: 24	string Example: 645e0c241a93369ff53f26e0
priority	integer Example: 1
customData	object Example: { "legalText": "Supported neglected met she therefore unwilling discovery remainder. Way sentiments two indulgence uncommonly own." }
tiers	object name string MinLength: 1 Example: Tier 1 additionalData object required type string Example: relative Enum: relative absolute value number Format: float Example: 10 mov integer Example: 10000
usageLimit	object promotion object promotionCodes object

Responses

201

Promotion was successfully created.

application/json

Success

string

Example:

645e0c241a93369ff53f26e0

version

string

Example:

645e0c241a93369ff53f26e0

namerequired

string

Example:

Christmas Promotion

object

Example:

{
  "de_DE": "Weihnachtsaktion",
  "en_US": "Christmas promotion"
}

statusrequired

string

Example:

active

activationTyperequired

string

Example:

code

levelrequired

string

required

object

companyIdsrequired

Array of integer

required

object

required

object

required

Array of object

itemSetIds

Array of string

priority

integer

Example:

object

Example:

{
  "legalText": "Supported neglected met she therefore unwilling discovery remainder. Way sentiments two indulgence uncommonly own."
}

Array of object

object

400

Bad Request

application/json

Error

401

Unauthorized

application/json

Error

403

Forbidden

application/json

Error

500

Service unavailable error

application/json

Error

POST/promotions

Request samples

Response samples

201

Promotion:

Content type: application/json