Saltar al contenido
/
Aumentar el límite de la...

Shop Builder API (2.0.0)

Overview

  • 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
index.json
index.yaml
Idiomas
Servidores
Mock server
https://xsolla.redocly.app/_mock/es/api/shop-builder/
https://store.xsolla.com/api/

Admin

Operaciones

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

Admin

Operaciones

Catálogo

Operaciones

Cesta (cliente)

Operaciones

Cesta (lado del servidor)

Operaciones

Pago (lado del cliente)

Operaciones

Pago (lado del servidor)

Operaciones

Pedido

Operaciones

Artículos gratuitos

Operaciones

Webhooks

Operaciones

Pedidos anticipados

Operaciones

Comerciante

Operaciones

Catálogo

Esta API permite obtener cualquier tipo de artículo vendible o artículo específico.

Operaciones

Regiones comunes

Operaciones

Catálogo

Operaciones

Derechos

Operaciones

Admin

Operaciones

Común

Operaciones

Cupones

Esta API le permite gestionar cupones.

Operaciones

Códigos promocionales

Esta API permite gestionar códigos promocionales.

Operaciones

Ofertas únicas por catálogo

Esta API le permite gestionar ofertas de catálogo únicas.

Operaciones

Descuentos

Esta API le permite gestionar promociones de descuento.

Operaciones

Bonificaciones

Esta API permite gestionar promociones de bonificaciones.

Operaciones

Admin

Operaciones

Catálogo

Operaciones

Pago virtual

Operaciones

Gestión

Operaciones

Obtener el límite de promoción para el usuario especificadoServer-sideAdmin

Solicitud

Obtiene el número restante de veces que el usuario especificado puede utilizar la promoción dentro del límite aplicado.

La API de límite de usuarios permite limitar el número de veces que los usuarios pueden usar una promoción. Para configurar el límite de usuario, vaya a la sección Admin del tipo de promoción deseado:

Seguridad
basicAuth
Ruta
project_idintegerrequerido

ID del proyecto. Encontrará este parámetro en su Cuenta del editor junto al nombre del proyecto.

Ejemplo: 44056
promotion_idintegerrequerido

ID de promoción. Identificador único de la promoción en el proyecto.

Ejemplo: 111425
Consulta
user_external_idstringrequerido

ID externo del usuario

Ejemplo: user_external_id=d342dad2-9d59-11e9-a384-42010aa8003f
curl -i -X GET \
  -u <username>:<password> \
  'https://xsolla.redocly.app/_mock/es/api/shop-builder/v2/project/44056/admin/user/limit/promotion/id/111425?user_external_id=d342dad2-9d59-11e9-a384-42010aa8003f'

Respuestas

Se recibieron correctamente los límites de la promoción para un usuario.

Cuerpoapplication/json
per_userobject
Respuesta
application/json
{
  "per_user": {
    "available": 9,
    "total": 10
  }
}

Aumentar el límite de la promoción para el usuario especificadoServer-sideAdmin

Solicitud

Aumenta el número restante de veces que el usuario especificado puede utilizar la promoción dentro del límite aplicado.

La API de límite de usuarios permite limitar el número de veces que los usuarios pueden usar una promoción. Para configurar el límite de usuario, vaya a la sección Admin del tipo de promoción deseado:

Seguridad
basicAuth
Ruta
project_idintegerrequerido

ID del proyecto. Encontrará este parámetro en su Cuenta del editor junto al nombre del proyecto.

Ejemplo: 44056
promotion_idintegerrequerido

ID de promoción. Identificador único de la promoción en el proyecto.

Ejemplo: 111425
Cuerpoapplication/json
availableinteger(User-limit_available)>= 1requerido

Número restante de artículos o usos de la promoción disponibles para el usuario dentro del límite aplicado.

userobject(User-limit_user)requerido
user.​user_external_idstring(User-limit_user-external-id)non-empty^\S+$requerido

ID externo del usuario.

curl -i -X POST \
  -u <username>:<password> \
  https://xsolla.redocly.app/_mock/es/api/shop-builder/v2/project/44056/admin/user/limit/promotion/id/111425 \
  -H 'Content-Type: application/json' \
  -d '{
    "available": 1,
    "user": {
      "user_external_id": "d342dad2-9d59-11e9-a384-42010aa8003f"
    }
  }'

Respuestas

Se recibieron correctamente los límites de la promoción para un usuario.

Cuerpoapplication/json
per_userobject
Respuesta
application/json
{
  "per_user": {
    "available": 9,
    "total": 10
  }
}

Establecer el límite de la promoción para el usuario especificadoServer-sideAdmin

Solicitud

Establece el número de veces que el usuario especificado puede usar una promoción dentro del límite aplicado después de que se haya aumentado o reducido.

La API de límite del usuario le permite limitar el número de veces que los usuarios pueden utilizar una promoción. Para configurar el límite de usuario, vaya a la sección Admin del tipo de promoción deseado:

Seguridad
basicAuth
Ruta
project_idintegerrequerido

ID del proyecto. Encontrará este parámetro en su Cuenta del editor junto al nombre del proyecto.

Ejemplo: 44056
promotion_idintegerrequerido

ID de promoción. Identificador único de la promoción en el proyecto.

Ejemplo: 111425
Cuerpoapplication/json
availableinteger(User-limit_available_flexible)>= 0requerido

Número restante de artículos o usos de la promoción disponibles para el usuario dentro del límite aplicado.

userobject(User-limit_user)requerido
user.​user_external_idstring(User-limit_user-external-id)non-empty^\S+$requerido

ID externo del usuario.

curl -i -X PUT \
  -u <username>:<password> \
  https://xsolla.redocly.app/_mock/es/api/shop-builder/v2/project/44056/admin/user/limit/promotion/id/111425 \
  -H 'Content-Type: application/json' \
  -d '{
    "available": 0,
    "user": {
      "user_external_id": "d342dad2-9d59-11e9-a384-42010aa8003f"
    }
  }'

Respuestas

Se recibieron correctamente los límites de la promoción para un usuario.

Cuerpoapplication/json
per_userobject
Respuesta
application/json
{
  "per_user": {
    "available": 9,
    "total": 10
  }
}

Admin

Operaciones

Cliente

Operaciones

Cliente de clanes

Operaciones

Admin

Operaciones

Cliente

Operaciones

Admin

Operaciones

Cliente

Operaciones

Admin

Operaciones

Cliente

Operaciones

Admin

Operaciones