Esta API le permite gestionar cupones.
- Obtener el límite de códigos promocionales para el usuario especificado
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 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
Eliminar promoción de códigos promocionales
Obtener promoción de códigos promocionales
Actualizar promoción de códigos promocionales
Obtener el límite de códi...
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}/admin/promocode/{external_id}/deactivate
- https://store.xsolla.com/api/v2/project/{project_id}/admin/promocode/{external_id}/deactivate
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X PUT \
-u <username>:<password> \
https://xsolla.redocly.app/_mock/es/api/shop-builder/v2/project/44056/admin/promocode/coupon_44056_1/deactivateSolicitud
Obtiene el número restante de veces que el usuario especificado puede utilizar el código promocional.
La API de límite del usuario permite limitar el número de veces que los usuarios pueden utilizar un código promocional. Para configurar el límite del usuario, vaya a Admin:
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/v2/project/{project_id}/admin/user/limit/promocode/external_id/{external_id}
- https://store.xsolla.com/api/v2/project/{project_id}/admin/user/limit/promocode/external_id/{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/v2/project/44056/admin/user/limit/promocode/external_id/coupon_44056_1?user_external_id=d342dad2-9d59-11e9-a384-42010aa8003f'Respuesta
application/json
{ "per_user": { "available": 9, "total": 10 } }
Solicitud
Obtiene las recompensas de códigos promocionales por su código. Pueden utilizarse para permitir a los usuarios elegir uno de varios artículos como bonificación. El caso más habitual es elegir un DRM (gestión de derechos digitales) si el código promocional contiene un juego como bonificación (type=unit).
Seguridad
XsollaLoginUserJWT
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}/promocode/code/{promocode_code}/rewards
- https://store.xsolla.com/api/v2/project/{project_id}/promocode/code/{promocode_code}/rewards
- 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/promocode/code/SO6rew99j9/rewards \
-H 'Authorization: Bearer <YOUR_JWT_HERE>'La lista de recompensas de códigos promocionales se recibió correctamente.
Porcentaje de descuento. El precio de la cesta se reducirá utilizando un valor calculado utilizando este porcentaje y luego se redondeará al segundo decimal.
Lista de artículos con descuento mediante un código promocional.
Respuesta
application/json
{ "bonus": [ { … }, { … } ], "discount": { "percent": "10.00" }, "discounted_items": [ { … } ], "is_selectable": true }