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

Catalog API ofrece endpoints para gestionar el catálogo de su tienda en el juego y procesar compras. Use los endpoints para configurar artículos virtuales, monedas virtuales, claves del juego, lotes, flujos de carrito y pago, atributos de artículos e importar artículos desde fuentes externas.

Descargar descripción de OpenAPI
Idiomas
Servidores
Mock server
https://xsolla.redocly.app/_mock/es/api/catalog/
https://store.xsolla.com/api/
Operaciones
Operaciones
Operaciones
Operaciones
Operaciones
Operaciones
Operaciones
Operaciones
Operaciones

Obtener la cesta del usuario actualClient-side

Solicitud

Devuelve la cesta del usuario actual.

Seguridad
AuthForCart
Ruta
project_idintegerrequerido

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

Ejemplo: 44056
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/catalog/v2/project/44056/cart?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": [ {} ] }

Eliminar todos los artículos de la cesta actualClient-side

Solicitud

Elimina todos los artículos 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
curl -i -X PUT \
  https://xsolla.redocly.app/_mock/es/api/catalog/v2/project/44056/cart/clear \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Respuestas

La cesta se vació correctamente.

Llenar la cesta con artículosClient-side

Solicitud

Llena la cesta con artículos. Si la cesta ya tiene un artículo con el mismo SKU, el artículo existente se sustituirá por el valor transmitido.

Seguridad
AuthForCart
Ruta
project_idintegerrequerido

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

Ejemplo: 44056
Cuerpoapplication/json
itemsArray of objectsrequerido

Lista de artículos.

Ejemplo: [{"quantity":123,"sku":"com.xsolla.booster_mega_1"}]
items[].​quantitynumberrequerido
Predeterminado 123
items[].​skustringrequerido
Predeterminado "booster_mega_1"
curl -i -X PUT \
  https://xsolla.redocly.app/_mock/es/api/catalog/v2/project/44056/cart/fill \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "items": [
      {
        "quantity": 123,
        "sku": "com.xsolla.booster_mega_1"
      }
    ]
  }'

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.

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