Xsolla-logo

Créer une promotion par réduction pour un objetServer-sideAdmin

post/v2/project/{project_id}/admin/promotion/item

Crée une promotion par réduction pour un objet.

Les promotions offrent une remise (%) sur les objets. La remise s'applique à tous les prix des objets spécifiés.

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

Objet contenant des données de la promotion.

required
Array of objects
Array
sku
required
string
Default: "elven_sword"

UGS de l'objet.

required
object
percent
required
string

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

required
object

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)
One of:

Conditions which are compared to user attribute values. All conditions must be met for the action to take an effect.

[ 1 .. 100 ] items
Array ([ 1 .. 100 ] items)
attribute
required
string [ 1 .. 255 ] characters ^[-_.\\d\\w]+$

User attribute code.

operator
required
string

Type of operation performed by condition. For string attribute type.

Enum: Description
eq

Equals

ne

Not equals

value
required
string <= 255 characters

Condition value which user attribute value will be compared to. Type depends on attribute type.

type
required
string

User attribute type.

Value: "string"
can_be_missing
boolean

Indicates that the condition is met even if attribute is missing from user attributes. Pass true to show the item to users who don't have this attribute. Users who have the attribute, but the value does not match that specified in the condition, will not see the item. False — users who have the attribute, but the value does not match that specified in the condition, or the attribute is missing, will not see the item.

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.

date_start
string or null <date-time>
Default: "2020-04-15T18:16:00+05:00"

Date de début de la promotion.

object

Limites de la promotion.

per_user
integer or null

Limites de la promotion pour un utilisateur spécifique.

object or null

Délai d'actualisation des limites.

interval_type = daily (object) or interval_type = weekly (object) or interval_type = monthly (object)
One of:

Type quotidien d'actualisation des limites pour l'utilisateur.

interval_type
required
string

Délai d'actualisation récurrent.

Value: "daily"
time
required
string((0[0-9]|1[0-9]|2[0-3]):00:00)(\+|-)(0[0-9]|1...

Heure d'actualisation des limites dans le fuseau horaire souhaité (arrondie en heures).

object or null

Condition d'application de la promotion aux biens dont le prix se situe dans une fourchette spécifiée. Dans l'objet price_range_condition, fournissez une valeur pour au moins un des paramètres suivants : lower_limit ou upper_limit.
Si des biens sont spécifiés dans l'objet items, la promotion ne s'applique qu'à ces biens et dans la fourchette de prix indiquée.
Pour que la condition promotionnelle s'applique à tous les biens, définissez la valeur null dans l'objet items.

lower_limit
required
string or null

Limite inférieure de la fourchette de prix pour l'application de la promotion. Si la valeur lower_limit est définie, la promotion ne s'applique qu'aux biens dont le prix est supérieur ou égal à cette valeur. La valeur du prix est exprimée dans la devise par défaut.
Exemple : "10.0000"

upper_limit
required
string or null

Limite supérieure de la fourchette de prix pour l'application de la promotion. Si la valeur upper_limit est définie, la promotion ne s'applique qu'aux biens dont le prix est inférieur ou égal à cette valeur. La valeur du prix est exprimée dans la devise par défaut.
Exemple : "20.0000"

Responses
201

La promotion a été créée 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
{
  • "attribute_conditions": [
    ],
  • "date_end": "2020-04-25T18:16:00+05:00",
  • "date_start": "2020-04-15T18:16:00+05:00",
  • "discount": {
    },
  • "items": null,
  • "name": {
    }
}
Response samples
application/json
{
  • "promotion_id": 2384756
}