Créer une promotion par coupon

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

Crée une promotion par coupon.

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 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.

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 coupon 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

application/json

{"bonus": [{"quantity": 1,
"sku": "elven_shield"
}
],
"date_end": "2020-04-15T18:16:00+05:00",
"date_start": "2020-04-15T18:16:00+05:00",
"external_id": "coupon_external_id",
"name": {"de-DE": "Gutscheintitel",
"en-US": "Coupon title"
},
"redeem_code_limit": 10,
"redeem_total_limit": 10,
"redeem_user_limit": 10
}

Response samples

application/json

{"coupon_id": "coupon_external_id"
}