Saltar al contenido

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

Catálogo

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

Operaciones
Operaciones
Operaciones
Operaciones
Operaciones
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
Operaciones
Operaciones
Operaciones
Operaciones
Operaciones
Operaciones
Operaciones
Operaciones
Operaciones
Operaciones
Operaciones
Operaciones

Obtener información sobre la venta adicional en proyectoServer-sideAdmin

Solicitud

Recupera la información sobre la venta adicional en el proyecto: si está activada, el tipo de venta adicional y la lista de SKU de los artículos que forman parte de esta venta adicional.

Seguridad
XsollaLoginUserJWT
Ruta
project_idintegerrequerido

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

Ejemplo: 44056
curl -i -X GET \
  https://xsolla.redocly.app/_mock/es/api/shop-builder/v2/project/44056/admin/items/upsell \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Respuestas

La lista de detalles de configuración y artículos utilizados para la venta adicional en el proyecto.

Cuerpoapplication/jsonArray [
is_enabledboolean

Si está activada la venta adicional para el proyecto.

Ejemplo: true
itemsArray of objects

La lista de SKU de artículos que forman parte de la venta adicional en el proyecto.

Ejemplo: [{"item_id":1,"name":{"de":"Name des Artikels","en":"Item's name"},"sku":"com.xsolla.booster_mega_1","type":"virtual_good"}]
typestring

El tipo de venta adicional.

Enumeración"fixed_list""most_sellable""only_promotions"
Ejemplo: "fixed_list"
]
Respuesta
application/json
[ { "is_enabled": true, "items": [], "type": "fixed_list" } ]

Crear venta adicionalServer-sideAdmin

Solicitud

Crea una venta adicional para un proyecto.

Seguridad
XsollaLoginUserJWT
Ruta
project_idintegerrequerido

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

Ejemplo: 44056
Cuerpoapplication/json
One of:

Tipo de venta adicional.

is_enabledboolean(is_enabled)requerido
Ejemplo: true
itemsArray of stringsrequerido

Matriz de SKU de artículos.

Predeterminado null
Ejemplo: ["game_sku"]
typestringrequerido
Valor"fixed_list"
Ejemplo: true
curl -i -X POST \
  https://xsolla.redocly.app/_mock/es/api/shop-builder/v2/project/44056/admin/items/upsell \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "is_enabled": true,
    "items": [
      "game_sku_1",
      "game_sku_2",
      "game_sku_3"
    ],
    "type": "fixed_list"
  }'

Respuestas

Se ha creado una venta adicional para el proyecto.

Respuesta
Sin contenido

Actualizar venta adicionalServer-sideAdmin

Solicitud

Actualizar una venta adicional de un proyecto.

Seguridad
XsollaLoginUserJWT
Ruta
project_idintegerrequerido

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

Ejemplo: 44056
Cuerpoapplication/json
One of:

Tipo de venta adicional.

is_enabledboolean(is_enabled)requerido
Ejemplo: true
itemsArray of stringsrequerido

Matriz de SKU de artículos.

Predeterminado null
Ejemplo: ["game_sku"]
typestringrequerido
Valor"fixed_list"
Ejemplo: true
curl -i -X PUT \
  https://xsolla.redocly.app/_mock/es/api/shop-builder/v2/project/44056/admin/items/upsell \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "is_enabled": true,
    "items": [
      "game_sku_1",
      "game_sku_2",
      "game_sku_3"
    ],
    "type": "fixed_list"
  }'

Respuestas

Se ha actualizado la venta adicional del proyecto.

Respuesta
Sin contenido
Operaciones
Operaciones