Xsolla-logo

Crear promoción de códigos promocionalesServer-sideAdmin

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

Crea una promoción de códigos promocionales.

SecuritybasicAuth
Request
path Parameters
project_id
required
integer

ID del proyecto. Encontrará este parámetro en su Cuenta del editor junto al nombre del proyecto.

Example: 44056
Request Body schema: application/json
external_id
required
string
Default: "coupon_external_id"

ID único de la promoción. external_id solo puede contener caracteres alfanuméricos latinos en minúsculas, puntos, guiones y guiones bajos.

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

Nombre de la promoción. Debe contener pares clave/valor en los cuales la clave es una configuración regional con el formato "^[a-z]{2}-[A-Z]{2}$", el valor es una cadena (string).

property name*
additional property
string
Array of tipo = string (objects) or Array of tipo = date (objects) or Array of tipo = number (objects)

Condiciones que se comparan con los valores de atributo de usuario. Deben satisfacerse todas las condiciones para que la acción surta efecto.

One of:

Condiciones que se comparan con los valores de atributo de usuario. Deben satisfacerse todas las condiciones para que la acción surta efecto.

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

Código de atributo de usuario.

operator
required
string

Tipo de operación realizada por condición. Para el tipo de atributo string.

Enum: Description
eq

Es igual que

ne

No es igual

value
required
string <= 255 characters

Valor de la condición con el que se comparará el valor de atributo del usuario. El tipo depende del tipo de atributo.

type
required
string

Tipo de atributo de usuario.

Value: "string"
can_be_missing
boolean

Indica que se cumple la condición aunque falte el atributo en los atributos del usuario. Transmita true para mostrar el elemento a los usuarios que no tengan este atributo. Los usuarios que tengan el atributo, pero el valor no coincida con el especificado en la condición, no verán el artículo. false - Los usuarios que tengan el atributo, pero el valor no coincida con el especificado en la condición, o falte el atributo, no verán el artículo.

Array of objects or null
Array
quantity
number
Default: 1

Cantidad del artículo.

sku
string
Default: "elven_shield"

Código (SKU) del artículo.

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

Fecha de finalización de su promoción. Puede ser null. Si la date_end es null, la promoción será ilimitada en el tiempo.

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

Fecha de inicio de su promoción.

object or null
percent
string or null
Default: "10.00"

Porcentaje de descuento. El precio de la cesta se reducirá utilizando un valor calculado utilizando este porcentaje y luego se redondeará al segundo decimal.

Array of objects or null

Lista de artículos con descuento mediante un código promocional.

Array
sku
required
string
Default: "elven_shield"

Código (SKU) del artículo.

required
object
percent
required
string
Default: "10.00"

Porcentaje de descuento.

El precio del artículo de la cesta se reducirá utilizando un valor calculado utilizando este porcentaje y luego se redondeará al segundo decimal.

redeem_code_limit
integer or null
Default: 10

Número de canjes por cada código.

redeem_total_limit
integer or null
Default: 10

Limita el número total de cupones.

redeem_user_limit
integer or null
Default: 10

Limita el número total de cupones canjeados por un mismo usuario.

Responses
201

El código promocional se creó correctamente.

401

Autenticación básica no superada o errónea. Asegúrese de haber utilizado la autenticación básica o las credenciales correctas.

422

Solicitud no válida.

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": {
    },
  • "external_id": "coupon_external_id",
  • "name": {
    },
  • "redeem_code_limit": 1,
  • "redeem_total_limit": 100,
  • "redeem_user_limit": 1
}
Response samples
application/json
{
  • "external_id": "coupon_external_id"
}