Xsolla-logo

Créer une promotion par code promo

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

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
application/json
{
  • "bonus": [
    ],
  • "date_end": "2020-04-15T18:16:00+05:00",
  • "date_start": "2020-04-15T18:16:00+05:00",
  • "discount": {
    },
  • "discounted_items": [
    ],
  • "external_id": "coupon_external_id",
  • "name": {
    },
  • "redeem_code_limit": 10,
  • "redeem_total_limit": 10,
  • "redeem_user_limit": 10
}
Response samples
application/json
{
  • "coupon_id": "coupon_external_id"
}