Xsolla-logo

Créer une offre promotionnelle unique dans le catalogueServer-sideAdmin

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

Crée une offre promotionnelle unique dans le catalogue.

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

items
Array of strings

Liste d'UGS des objets qui sont disponibles après avoir utilisé une offre unique du catalogue.

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

L'offre unique a été créée avec succès dans le catalogue.

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
{
  • "date_end": "2020-04-25T18:16:00+05:00",
  • "date_start": "2020-04-15T18:16:00+05:00",
  • "external_id": "offer_external_id",
  • "items": "elven_sword elven_boots",
  • "name": {
    },
  • "redeem_code_limit": 1,
  • "redeem_total_limit": 100,
  • "redeem_user_limit": 1
}
Response samples
application/json
{
  • "external_id": "coupon_external_id"
}