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
Operaciones

Llenar la cesta con artículosServer-side

Solicitud

Rellena la cesta actual 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
basicAuth
Ruta
project_idintegerrequerido

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

Ejemplo: 44056
Consulta
localestring

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

Predeterminado "en"
Encabezados
x-user-forstring

El identificador de usuario puede transferirse utilizando el JWT de usuario de Xsolla Login o el token de acceso a Pay Station.

Ejemplo: ACCESS_TOKEN/LOGIN_JWT
x-user-idstring<= 32 characters

Puede utilizar su propio ID de usuario para vender una cesta con juegos.

Ejemplo: UNIQUE_ID
Cuerpoapplication/json
countrystring= 2 characters

Código de país de dos letras mayúsculas de conformidad con la norma ISO 3166-1 alpha-2. Consulte la documentación para obtener información detallada sobre los países admitidos por Xsolla.
Ejemplo: country=US

Ejemplo: "US"
currencystring= 3 characters

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

Ejemplo: "USD"
itemsArray of objectsnon-emptyrequerido
items[].​quantitynumber>= 1requerido

Cantidad del artículo.

Ejemplo: 2
items[].​skustringnon-emptyrequerido

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: "t-shirt"
curl -i -X PUT \
  -u <username>:<password> \
  'https://xsolla.redocly.app/_mock/es/api/catalog/v2/admin/project/44056/cart/fill?locale=en' \
  -H 'Content-Type: application/json' \
  -H 'x-user-for: ACCESS_TOKEN/LOGIN_JWT' \
  -H 'x-user-id: UNIQUE_ID' \
  -d '{
    "currency": "USD",
    "items": [
      {
        "quantity": 2,
        "sku": "com.xsolla.cup01"
      },
      {
        "quantity": 1,
        "sku": "com.xsolla.t-shirt01"
      },
      {
        "quantity": 1,
        "sku": "com.xsolla.cup01"
      },
      {
        "quantity": 1,
        "sku": "com.xsolla.hat01"
      }
    ]
  }'

Respuestas

La cesta con artículos se devolvió correctamente.

Cuerpoapplication/json
cart_idstring

ID de cesta. Transmítalo a la consulta de la página de compra o a los puntos finales de la API de pago.

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.

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": "15.97", "amount_without_discount": "22.96", "currency": "USD" }, "promotions": [ {} ], "warnings": [ {} ] }

Llenar la cesta con artículos por el ID de la cestaServer-side

Solicitud

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

Seguridad
basicAuth
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
localestring

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

Predeterminado "en"
Encabezados
x-user-forstring

El identificador de usuario puede transferirse utilizando el JWT de usuario de Xsolla Login o el token de acceso a Pay Station.

Ejemplo: ACCESS_TOKEN/LOGIN_JWT
x-user-idstring<= 32 characters

Puede utilizar su propio ID de usuario para vender una cesta con juegos.

Ejemplo: UNIQUE_ID
Cuerpoapplication/json
countrystring= 2 characters

Código de país de dos letras mayúsculas de conformidad con la norma ISO 3166-1 alpha-2. Consulte la documentación para obtener información detallada sobre los países admitidos por Xsolla.
Ejemplo: country=US

Ejemplo: "US"
currencystring= 3 characters

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

Ejemplo: "USD"
itemsArray of objectsnon-emptyrequerido
items[].​quantitynumber>= 1requerido

Cantidad del artículo.

Ejemplo: 2
items[].​skustringnon-emptyrequerido

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: "t-shirt"
curl -i -X PUT \
  -u <username>:<password> \
  'https://xsolla.redocly.app/_mock/es/api/catalog/v2/admin/project/44056/cart/custom_id/fill?locale=en' \
  -H 'Content-Type: application/json' \
  -H 'x-user-for: ACCESS_TOKEN/LOGIN_JWT' \
  -H 'x-user-id: UNIQUE_ID' \
  -d '{
    "currency": "USD",
    "items": [
      {
        "quantity": 2,
        "sku": "com.xsolla.cup01"
      },
      {
        "quantity": 1,
        "sku": "com.xsolla.t-shirt01"
      },
      {
        "quantity": 1,
        "sku": "com.xsolla.cup01"
      },
      {
        "quantity": 1,
        "sku": "com.xsolla.hat01"
      }
    ]
  }'

Respuestas

La cesta con artículos se devolvió correctamente.

Cuerpoapplication/json
cart_idstring

ID de cesta. Transmítalo a la consulta de la página de compra o a los puntos finales de la API de pago.

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.

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": "15.97", "amount_without_discount": "22.96", "currency": "USD" }, "promotions": [ {} ], "warnings": [ {} ] }
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