Esta API le permite gestionar cupones.
- Eliminar promoción de códigos promocionales
Obtener límite del código promocional para los códigos
Activar promoción de códigos promocionales
Obtener códigos de una promoción de códigos promocionales
Crear código de promoción de códigos promocionales
Generar códigos para una promoción de códigos promocionales
Desactivar promoción de códigos promocionales
Obtener el límite de códigos promocionales para el usuario especificado
Obtener recompensas de códigos promocionales
Canjear código promocional
Eliminar código promocional de la cesta
Obtener la lista de promociones de códigos promocionales
Crear promoción de códigos promocionales
Obtener promoción de códigos promocionales
Actualizar promoción de códigos promocionales
Eliminar promoción de cód...
Shop Builder API (2.0.0)
- Version: 2.0.0
- Servers:
https://store.xsolla.com/api - Contact Us by Email
- Contact URL: https://xsolla.com/
- Required TLS version: 1.2
Shop Builder API provides a third-party solution for implementing the server side for your store interface. Use the endpoints to manage in-game items, in-game currencies, cart, player inventory, promotions, game library, etc.
Descargar descripción de OpenAPI
Idiomas
Servidores
Mock server
https://xsolla.redocly.app/_mock/es/api/shop-builder/
https://store.xsolla.com/api/
Catálogo personalizado
Esta API permite especificar reglas para los atributos de usuario. Si el usuario cumple todas las condiciones de una regla específica, se mostrarán los elementos personalizados.
Para promociones personalizadas, consulte la sección Promotions.
Para transmitir atributos antes de una compra, puede utilizar Xsolla Login API o transmitirlos a la propiedad user.attributes mientras se genera el token utilizando Pay Station API.
Operaciones
Ruta
Cuerpoapplication/jsonID del proyecto. Encontrará este parámetro en su Cuenta del editor junto al nombre del proyecto.
Ejemplo: 44056
attribute_conditionsArray of tipo = string (object) or tipo = number (object) or tipo = date (object)(promotion_user-attribute_conditions_model-post)[ 1 .. 100 ] items
Condiciones para validar los atributos de usuario. Determina la disponibilidad de la promoción en función de si los atributos de usuario cumplen todas las condiciones especificadas.
Lista de artículos con descuento mediante un código promocional.
Lista de ID de promociones a excluir al aplicar esta promoción.
Example: [12, 789].
Ejemplo: [12,789]
ID único de promoción. El external_id solo puede contener caracteres alfanuméricos latinos en minúsculas y mayúsculas, puntos, guiones y guiones bajos.
Predeterminado "coupon_external_id"
Ejemplo: "coupon_external_id"
Matriz de objetos con condiciones que establecen el rango de precios para aplicar la promoción a determinados artículos de la cesta.
El precio de cada artículo en la cesta del usuario se compara con el rango de precios especificado en la condición. Se aplican bonificaciones y descuentos únicamente a aquellos artículos de la cesta cuyo precio cumple la condición.
Si transmite esta matriz, establezca el valor de la matriz discounted_items como null.
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).
Predeterminado {"de-DE":"Gutscheintitel","en-US":"Coupon title"}
Ejemplo: {"de-DE":"Gutscheintitel","en-US":"Coupon title"}
Matriz de objetos con condiciones que establecen el rango de precios para aplicar la promoción a toda la cesta.
El precio total de todos los artículos de la cesta del usuario se compara con el rango de precios especificado en la condición. Las bonificaciones y los descuentos se aplican a todos los artículos de la cesta si el precio de la cesta cumple la condición especificada.
Si transmite esta matriz, establezca el valor de la matriz discounted_items como null.
Periodos de validez de la promoción. Si se especifican varios periodos, es necesario tanto date_from como date_until.
Número de canjes por cada código.
Predeterminado 10
Ejemplo: 10
Limita el número total de cupones.
Predeterminado 10
Ejemplo: 10
- Mock serverhttps://xsolla.redocly.app/_mock/es/api/shop-builder/v3/project/{project_id}/admin/promocode
- https://store.xsolla.com/api/v3/project/{project_id}/admin/promocode
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X POST \
-u <username>:<password> \
https://xsolla.redocly.app/_mock/es/api/shop-builder/v3/project/44056/admin/promocode \
-H 'Content-Type: application/json' \
-d '{
"attribute_conditions": [
{
"attribute": "account_status",
"can_be_missing": false,
"operator": "eq",
"type": "string",
"value": "golden"
}
],
"discount": {
"percent": "10.10"
},
"external_id": "coupon_external_id",
"name": {
"de-DE": "Neujahrsrabatt",
"en-US": "New Year Discount"
},
"promotion_periods": [
{
"date_from": "2020-04-15T18:16:00+05:00",
"date_until": "2020-04-25T18:16:00+05:00"
}
],
"redeem_code_limit": 1,
"redeem_total_limit": 100,
"redeem_user_limit": 1
}'Respuesta
application/json
{ "external_id": "coupon_external_id" }
Solicitud
Elimina la promoción de códigos promocionales. La promoción eliminada:
- Desaparece de la lista de promociones establecidas en su proyecto.
- Ya no se aplica al catálogo de artículos ni a la cesta. El usuario no puede obtener artículos de bonificación ni comprar artículos usando esta promoción.
Después de eliminarla, la promoción no se puede restaurar. Los códigos promocionales de la promoción eliminada se pueden añadir a las promociones existentes.
Seguridad
basicAuth
Ruta
ID del proyecto. Encontrará este parámetro en su Cuenta del editor junto al nombre del proyecto.
Ejemplo: 44056
- Mock serverhttps://xsolla.redocly.app/_mock/es/api/shop-builder/v3/project/{project_id}/admin/promocode/{external_id}
- https://store.xsolla.com/api/v3/project/{project_id}/admin/promocode/{external_id}
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X DELETE \
-u <username>:<password> \
https://xsolla.redocly.app/_mock/es/api/shop-builder/v3/project/44056/admin/promocode/coupon_44056_1Ruta
ID del proyecto. Encontrará este parámetro en su Cuenta del editor junto al nombre del proyecto.
Ejemplo: 44056
- Mock serverhttps://xsolla.redocly.app/_mock/es/api/shop-builder/v3/project/{project_id}/admin/promocode/{external_id}
- https://store.xsolla.com/api/v3/project/{project_id}/admin/promocode/{external_id}
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
-u <username>:<password> \
https://xsolla.redocly.app/_mock/es/api/shop-builder/v3/project/44056/admin/promocode/coupon_44056_1El código promocional se recibió correctamente.
attribute_conditionsArray of tipo = string (object) or tipo = number (object) or tipo = date (object)(promotion_user-attribute_conditions_model-get)[ 1 .. 100 ] items
Condiciones para validar los atributos de usuario. Determina la disponibilidad de la promoción en función de si los atributos de usuario cumplen todas las condiciones especificadas.
Lista de artículos con descuento mediante un código promocional.
Lista de ID de promociones a excluir al aplicar esta promoción.
Example: [12, 789].
Ejemplo: [12,789]
ID único de promoción. El external_id solo puede contener caracteres alfanuméricos latinos en minúsculas y mayúsculas, puntos, guiones y guiones bajos.
Predeterminado "coupon_external_id"
Ejemplo: "coupon_external_id"
Matriz de objetos con condiciones que establecen el rango de precios para aplicar la promoción a determinados artículos de la cesta.
El precio de cada artículo en la cesta del usuario se compara con el rango de precios especificado en la condición. Se aplican bonificaciones y descuentos únicamente a aquellos artículos de la cesta cuyo precio cumple la condición.
Si transmite esta matriz, establezca el valor de la matriz discounted_items como null.
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).
Predeterminado {"de-DE":"Gutscheintitel","en-US":"Coupon title"}
Ejemplo: {"de-DE":"Gutscheintitel","en-US":"Coupon title"}
Matriz de objetos con condiciones que establecen el rango de precios para aplicar la promoción a toda la cesta.
El precio total de todos los artículos de la cesta del usuario se compara con el rango de precios especificado en la condición. Las bonificaciones y los descuentos se aplican a todos los artículos de la cesta si el precio de la cesta cumple la condición especificada.
Si transmite esta matriz, establezca el valor de la matriz discounted_items como null.
Periodos de validez de la promoción. Si se especifican varios periodos, es necesario tanto date_from como date_until.
Número de canjes por cada código.
Predeterminado 10
Ejemplo: 10
Limita el número total de cupones.
Predeterminado 10
Ejemplo: 10
Limita el número total de cupones canjeados por un mismo usuario.
Predeterminado 10
Ejemplo: 10
Respuesta
application/json
{ "bonus": [ { … } ], "discount": { "percent": "10.99" }, "discounted_items": null, "excluded_promotions": [ 23, 45 ], "external_id": "summer20221", "is_enabled": true, "name": { "en-US": "Coupon name", "ru-RU": "Название купона" }, "promotion_periods": [ { … }, { … } ], "redeem_code_limit": 1, "redeem_total_limit": 100, "redeem_user_limit": null, "total_limit_state": { "available": 50, "reserved": 10, "used": 40 } }