Xsolla-logo

Actualizar promoción de códigos promocionalesServer-sideAdmin

put/v2/project/{project_id}/admin/promocode/{external_id}

Actualiza 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 Publisher junto al nombre del proyecto.

Example: 44056
external_id
required
integer

ID externo de la promoción. Identificador único de la promoción dentro del proyecto.

Example: coupon_44056_1
Request Body schema: application/json
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.

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
204

El código promocional se actualizó 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.

404

Código promocional no encontrado. Asegúrese de que el external_id es correcto.

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",
  • "discount": {
    },
  • "discounted_items": [
    ],
  • "name": {
    },
  • "redeem_code_limit": 10,
  • "redeem_total_limit": 10,
  • "redeem_user_limit": 10
}
Response samples
application/json
{
  • "errorCode": 1020,
  • "errorMessage": "[0401-1020]: Error in Authentication method occurred",
  • "statusCode": 401
}