Créer une promotion par code promo

Créer une promotion par code promoServer-sideAdmin

post/v2/project/{project_id}/admin/promocode

Crée une promotion par code promo.

SecuritybasicAuth

Request

path Parameters

project_id

required

integer

ID de projet. Ce paramètre se trouve dans le Compte éditeur à côté du nom du projet.

Example: 44056

Request Body schema: application/json

external_id

required

string

Default: "coupon_external_id"

ID unique de la promotion. Le paramètre external_id ne peut comprendre que des caractères alphanumériques latins minuscules, des points, des tirets et des traits bas.

required

object

Default: {"de-DE":"Gutscheintitel","en-US":"Coupon title"}

Nom de la promotion. Doit comprendre des paires clé/valeur où la clé est une région au format "^[a-z]{2}-[A-Z]{2}$", la valeur est une chaîne.

property name*

additional property

string

Array of type = string (objects) or Array of type = date (objects) or Array of type = number (objects)

Conditions comparées aux valeurs des attributs utilisateur. Toutes les conditions doivent être remplies pour que l'action ait un effet.

One of:

Conditions comparées aux valeurs des attributs utilisateur. Toutes les conditions doivent être remplies pour que l'action ait un effet.

[ 1 .. 100 ] items

Array ([ 1 .. 100 ] items)

attribute

required

string [ 1 .. 255 ] characters ^[-_.\\d\\w]+$

Code d'attribut utilisateur.

operator

required

string

Type d'opération effectuée par la condition. Pour le type d'attribut string.

Enum:	Description
eq	Égal
ne	Différent de

value

required

string <= 255 characters

Valeur de la condition à laquelle la valeur de l'attribut utilisateur sera comparée. Le type dépend du type d'attribut.

type

required

string

Type d'attribut utilisateur.

Value: "string"

can_be_missing

boolean

Indique que la condition est remplie même si l'attribut est absent des attributs de l'utilisateur. Passez true pour afficher l'objet pour les utilisateurs ne possédant pas cet attribut. Les utilisateurs ayant l'attribut, mais dont la valeur ne correspond pas à celle définie dans la condition ne verront pas l'objet. Si vous passez false, les utilisateurs dont l'attribut est manquant ou dont la valeur ne correspond pas à celle spécifiée dans la condition ne verront pas l'objet.

Array of objects or null

Array

quantity	number Default: 1 Quantité de l'objet.
sku	string Default: "elven_shield" UGS de l'objet.

date_end

string or null <date-time>

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

Date de fin de la promotion. Peut prendre la valeur null. Si date_end est défini sur null, la promotion sera illimitée dans le temps.

date_start

string or null <date-time>

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

Date de début de la promotion.

object or null

percent

string or null

Default: "10.00"

Pourcentage de la remise. Le prix du panier sera réduit d'une valeur calculée à l'aide de ce pourcentage et arrondie à 2 décimales.

Array of objects or null

Liste des objets bénéficiant d'une remise grâce à un code promo.

Array

sku

required

string

Default: "elven_shield"

UGS de l'objet.

required

object

percent

required

string

Default: "10.00"

Pourcentage de la remise.

Le prix du panier sera réduit d'une valeur calculée à l'aide de ce pourcentage et arrondie à 2 décimales.

excluded_promotions

Array of integers

Liste des ID de promotion à exclure lors de l'application de cette promotion.
Example: [12, 789]

Array of objects or null

Tableau d'objets avec des conditions définissant la fourchette de prix pour l'application de la promotion à certains biens du panier.
Le prix de chaque bien du panier de l'utilisateur est comparé à la fourchette de prix spécifiée dans la condition. Les bonus et les réductions ne s'appliquent qu'aux biens du panier dont le prix répond à la condition.
Si vous passez ce tableau, définissez la valeur du tableau discounted_items sur null.

Array

operator

required

string

Opérateur de comparaison pour définir la fourchette de prix pour l'application de la promotion.

Enum:	Description
eq	Égal
ge	Supérieur ou égal
gt	Supérieure à
le	Inférieur ou égal
lt	Inférieur à
ne	Différent de

value

required

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

Valeur permettant de déterminer la fourchette de prix pour l'application de la promotion.

Array of objects or null

Tableau d'objets avec des conditions définissant la fourchette de prix pour l'application de la promotion à l'ensemble du panier.
Le prix total de tous les biens du panier de l'utilisateur est comparé à la fourchette de prix spécifiée dans la condition. Les bonus et les réductions s'appliquent à tous les biens du panier si le prix du panier répond à la condition spécifiée.
Si vous passez ce tableau, définissez la valeur du tableau discounted_items sur null.

Array

operator

required

string

Opérateur de comparaison pour définir la fourchette de prix pour l'application de la promotion.

Enum:	Description
eq	Égal
ge	Supérieur ou égal
gt	Supérieure à
le	Inférieur ou égal
lt	Inférieur à
ne	Différent de

value

required

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

Valeur permettant de déterminer la fourchette de prix pour l'application de la promotion.

redeem_code_limit

integer or null

Default: 10

Nombre d'échanges par code.

redeem_total_limit

integer or null

Default: 10

Limite le nombre total de coupons.

redeem_user_limit

integer or null

Default: 10

Limite le nombre total de coupons pouvant être échangés par un seul utilisateur.

Responses

201

Le code promo a été créé avec succès.

401

L'authentification de base n'a pas été passée ou est incorrecte. Vérifiez que vous avez utilisé l'authentification de base ou des informations d'identification correctes.

422

Requête non valide.

Request samples

Response samples

application/json

{"external_id": "coupon_external_id"
}