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

Eliminar artículo de la cesta actualClient-side

Solicitud

Elimina un artículo de la cesta.

Seguridad
AuthForCart
Ruta
project_idintegerrequerido

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

Ejemplo: 44056
item_skustringrequerido

Código (SKU) del artículo.

Ejemplo: booster_mega_1
curl -i -X DELETE \
  https://xsolla.redocly.app/_mock/es/api/shop-builder/v2/project/44056/cart/item/booster_mega_1 \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Respuestas

El artículo de la cesta se eliminó correctamente.

Respuesta
Sin contenido

Actualizar artículo de la cesta actualClient-side

Solicitud

Actualiza un artículo de la cesta existente o crea el de la cesta.

Seguridad
AuthForCart
Ruta
project_idintegerrequerido

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

Ejemplo: 44056
item_skustringrequerido

Código (SKU) del artículo.

Ejemplo: booster_mega_1
Cuerpoapplication/json
quantitynumber

Cantidad del artículo.

Predeterminado 123
curl -i -X PUT \
  https://xsolla.redocly.app/_mock/es/api/shop-builder/v2/project/44056/cart/item/booster_mega_1 \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "quantity": 123
  }'

Respuestas

La cesta se actualizó correctamente.

Respuesta
Sin contenido

Obtener cesta por el ID de la cestaClient-side

Solicitud

Devuelve la cesta del usuario por el ID de la cesta.

Seguridad
AuthForCart
Ruta
project_idintegerrequerido

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

Ejemplo: 44056
cart_idstringrequerido

ID de la cesta.

Ejemplo: custom_id
Consulta
currencystring

Moneda en la que se muestra el precio del artículo en la cesta. Código de moneda de tres letras según ISO 4217. Consulte la documentación para obtener información detallada sobre monedas soportadas por Xsolla.

Predeterminado "USD"
localestring

Idioma de respuesta. Código de idioma de dos letras minúsculas según la norma ISO 639-1.

Predeterminado "en"
curl -i -X GET \
  'https://xsolla.redocly.app/_mock/es/api/shop-builder/v2/project/44056/cart/custom_id?currency=USD&locale=en' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Respuestas

La cesta con artículos se devolvió correctamente.

Cuerpoapplication/json
cart_idstring

ID de la cesta.

Ejemplo: "cart_id"
is_freeboolean(value-cart_is_free)

Si true, la cesta es gratuita.

Predeterminado false
Ejemplo: false
itemsArray of objects
priceobject or null

Precio de la cesta.

Ejemplo: {"amount":"6150.0000000000000000","amount_without_discount":"6150.0000000000000000","currency":"USD"}
promotionsArray of objects(Catalog_cart_promotions)

Promociones aplicadas a toda la cesta. La matriz se devuelve en los siguientes casos:

  • Una promoción afecta al importe total de la cesta, como un código promocional con el parámetro Descuento en la compra.

  • Una promoción añade artículos de bonificación a la cesta.

Si no se aplican promociones a nivel de pedido, se devuelve una matriz vacía.

Respuesta
application/json
{ "cart_id": "cart_id", "is_free": false, "items": [ {} ], "price": { "amount": "6150.0000000000000000", "amount_without_discount": "6150.0000000000000000", "currency": "USD" }, "promotions": [ {} ] }
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
Operaciones
Operaciones