Saltar al contenido
/
Establecer puntos de valo...

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

Admin

Operaciones

Actualizar parcialmente los puntos de valor para los artículosServer-sideAdmin

Solicitud

Actualiza parcialmente la cantidad de puntos de valor de uno o más artículos según el SKU del artículo. Los usuarios reciben estos puntos de valor después de comprar los artículos especificados.

Principios de actualización de los puntos de valor:

  • Si un artículo aún no tiene puntos de valor, el envío de un valor distinto de cero en el campo amount los genera.
  • Si un artículo ya tiene puntos de valor, enviar un valor distinto de cero en el campo amount los actualiza.
  • Si amount se establece en 0, se eliminan los puntos de valor existentes para ese artículo.

A diferencia del método PUT (Establecer puntos de valor para artículos), este método PATCH no sobrescribe todos los puntos de valor existentes para los artículos del proyecto, solo actualiza los artículos especificados.

Una sola solicitud puede actualizar hasta 100 artículos. No se pueden incluir SKU de artículos duplicados en la misma solicitud.

Seguridad
basicAuth
Ruta
project_idintegerrequerido

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

Ejemplo: 44056
value_point_skustringrequerido

SKU del punto de valor.

Ejemplo: value_point_3
Cuerpoapplication/jsonArray [
amountinteger>= 0requerido

Cantidad de puntos de valor.

skustring(sku)[ 1 .. 255 ] characters^[a-zA-Z0-9_\-–.]*$requerido

ID único del artículo. El SKU solo puede contener caracteres alfanuméricos latinos en minúsculas y mayúsculas, puntos, guiones y guiones bajos.

Ejemplo: "booster_mega_1"
]
curl -i -X PATCH \
  -u <username>:<password> \
  https://xsolla.redocly.app/_mock/es/api/shop-builder/v2/project/44056/admin/items/value_point_3/value_points/rewards \
  -H 'Content-Type: application/json' \
  -d '[
    {
      "amount": 100,
      "sku": "booster_1"
    },
    {
      "amount": 0,
      "sku": "booster_mega"
    }
  ]'

Respuestas

Se actualizaron correctamente las recompensas de puntos de valor para los artículos.

Cuerpo
Respuesta
Sin contenido

Establecer puntos de valor para los artículosServer-sideAdmin

Solicitud

Asigna puntos de valor a uno o varios artículos por un SKU. Los usuarios reciben puntos de valor después de comprar estos artículos.

Recuerde que esta solicitud PUT sobrescribe todos los puntos de valor establecidos previamente para los artículos del proyecto.

Para evitar la eliminación involuntaria de puntos de valor, incluya todos los artículos y sus respectivos puntos de valor en cada solicitud PUT.

Si solo desea actualizar los puntos de valor de un artículo específico conservando los puntos de valor de otros artículos, debe recuperar el conjunto actual de puntos de valor mediante una solicitud GET, modificar los puntos de valor del artículo deseado y, luego, devolver el conjunto modificado de puntos de valor con los puntos de valor actualizados para el artículo específico.

Seguridad
basicAuth
Ruta
project_idintegerrequerido

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

Ejemplo: 44056
value_point_skustringrequerido

SKU del punto de valor.

Ejemplo: value_point_3
Cuerpoapplication/jsonArray [
amountintegerrequerido

Cantidad de puntos de valor.

skustring(sku)[ 1 .. 255 ] characters^[a-zA-Z0-9_\-–.]*$requerido

ID único del artículo. El SKU solo puede contener caracteres alfanuméricos latinos en minúsculas y mayúsculas, puntos, guiones y guiones bajos.

Ejemplo: "booster_mega_1"
]
curl -i -X PUT \
  -u <username>:<password> \
  https://xsolla.redocly.app/_mock/es/api/shop-builder/v2/project/44056/admin/items/value_point_3/value_points/rewards \
  -H 'Content-Type: application/json' \
  -d '[
    {
      "amount": 100,
      "sku": "com.xsolla.booster_1"
    },
    {
      "amount": 200,
      "sku": "com.xsolla.booster_mega"
    }
  ]'

Respuestas

Se actualizaron correctamente las recompensas de puntos de valor para los artículos.

Cuerpo
Respuesta
Sin contenido

Obtener lista de cadenas de recompensasServer-sideAdmin

Solicitud

Obtiene la lista de cadenas de recompensas.

Atención

Todos los proyectos tienen la limitación del número de artículos que se pueden obtener en la respuesta. El valor por defecto y máximo es 10 artículos por respuesta. Para obtener más datos página por página, utilice los campos limit y offset.
Seguridad
basicAuth
Ruta
project_idintegerrequerido

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

Ejemplo: 44056
Consulta
limitinteger>= 1

Límite para el número de elementos presentes en la página.

Ejemplo: limit=50
offsetinteger>= 0

Número del elemento a partir del cual se genera la lista (el conteo empieza desde el 0).

Ejemplo: offset=0
enabledinteger

Filtrar elementos por la marca is_enabled.

curl -i -X GET \
  -u <username>:<password> \
  'https://xsolla.redocly.app/_mock/es/api/shop-builder/v3/project/44056/admin/reward_chain?limit=50&offset=0&enabled=0'

Respuestas

La lista de cadenas de recompensas se recibió correctamente.

Cuerpoapplication/json
has_moreboolean(Pagination_has-more)

Se utiliza como indicador de que hay más páginas.

Ejemplo: true
itemsArray of admin-get-reward-chain-item-basic-model (object) or admin-get-reward-chain-item-clan-basic-model (object)
Respuesta
application/json
{
  "has_more": true,
  "items": [
    { … },
    { … }
  ]
}

Cliente

Operaciones

Cliente de clanes

Operaciones

Admin

Operaciones

Cliente

Operaciones

Admin

Operaciones

Cliente

Operaciones

Admin

Operaciones

Cliente

Operaciones

Admin

Operaciones