Actualizar promoción de códigos promocionales

Xsolla Developers

A Cuenta del editor

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 del editor 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 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	Igual que
ne	No es igual que

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 de artículo (SKU).

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 la 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 de artículo (SKU).

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.

excluded_promotions

Array of integers

Lista de ID de promociones a excluir al aplicar esta promoción.
Example: [12, 789].

Array of objects or null

Array of objects with conditions that set the price range for applying the promotion to certain items in the cart.
The price of each item in the user's cart is compared with the price range specified in the condition. Bonuses and discounts are applied only to those items in the cart whose price meets the condition.
If you pass this array, set the value of the discounted_items array to null.

Array

operator

required

string

Operador de comparación para establecer el rango de precios para aplicar la promoción.

Enum:	Description
eq	Igual que
ge	Mayor o igual que
gt	Mayor que
le	Menos o igual que
lt	Menos que
ne	No es igual que

value

required

string^\d+(\.\d{1,4})?$

Valor para determinar el rango de precios para aplicar la promoción.

Array of objects or null

Array of objects with conditions that set the price range for applying the promotion to the entire cart.
The total price of all items in the user's cart is compared with the price range specified in the condition. Bonuses and discounts are applied to all items in the cart if the price of the cart meets the specified condition.
If you pass this array, set the value of the discounted_items array to null.

Array

operator

required

string

Operador de comparación para establecer el rango de precios para aplicar la promoción.

Enum:	Description
eq	Igual que
ge	Mayor o igual que
gt	Mayor que
le	Menos o igual que
lt	Menos que
ne	No es igual que

value

required

string^\d+(\.\d{1,4})?$

Valor para determinar el rango de precios para aplicar la 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

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

Response samples

application/json

{"errorCode": 1020,
"errorMessage": "[0401-1020]: Error in Authentication method occurred",
"statusCode": 401
}