Xsolla-logo

Crear promoción con cupones

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

Crea una promoción con cupones.

SecuritybasicAuth
Request
path Parameters
project_id
required
integer

ID del proyecto. Encontrará este parámetro en su cuenta Publisher 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 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.

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 cupón 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
{
  • "bonus": [
    ],
  • "date_end": "2020-04-15T18:16:00+05:00",
  • "date_start": "2020-04-15T18:16:00+05:00",
  • "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"
}