Obtiene la lista de promociones de un proyecto.
- Obtener toda la lista de promociones
Activar promoción
Desactivar promoción
Verificar el código de promoción
Obtener promoción canjeable por código
Obtener toda la lista de...
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
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/v2/project/{project_id}/promotion/code/{code}/verify
- https://store.xsolla.com/api/v2/project/{project_id}/promotion/code/{code}/verify
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
https://xsolla.redocly.app/_mock/es/api/shop-builder/v2/project/44056/promotion/code/WINTER2021/verify \
-H 'Authorization: Bearer <YOUR_JWT_HERE>'Respuesta
application/json
{ "code": "WINTER2023", "rewards": { "bonus": [ … ], "is_selectable": true }, "type": "coupon" }
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/promotion
- https://store.xsolla.com/api/v3/project/{project_id}/admin/promotion
- 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/promotion?limit=50&offset=0&enabled=0'Respuesta
application/json
{ "active_promotions_count": 3, "inactive_promotions_count": 2, "promotions": [ { … }, { … }, { … }, { … }, { … } ], "total_promotions_count": 5 }
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/promotion/redeemable/code/{code}
- https://store.xsolla.com/api/v3/project/{project_id}/admin/promotion/redeemable/code/{code}
- 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/promotion/redeemable/code/WINTER2021La promoción se recibió correctamente.
Lista de artículos con descuento mediante un código promocional. Solo para códigos promocionales.
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"
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"}
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": [ { … } ], "external_id": "coupon_fall_hammer_2", "is_enabled": true, "name": { "en": "This is a Coupon code for Epic Fall Hammer", "ru": "Eto kod kupona на Epic Fall Hammer" }, "promotion_periods": [ { … }, { … } ], "redeem_code_limit": null, "redeem_total_limit": 99, "redeem_user_limit": 1 }