Saltar al contenido
/
Crear pedido con una cest...

Catalog 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

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
index.json
index.yaml
Idiomas
Servidores
Mock server
https://xsolla.redocly.app/_mock/es/api/catalog/
https://store.xsolla.com/api/

Admin

Operaciones

Catálogo

Operaciones

Pago virtual

Operaciones

Catálogo

Operaciones

Derechos

Operaciones

Admin

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

Crear pedido con cesta gratuitaClient-side

Solicitud

Crea un pedido con todos los artículos de la cesta gratuita. El pedido creado obtendrá el estado de pedido done.

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
currencystring

Divisa del precio del pedido. 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.

custom_parametersobject[ 1 .. 200 ] properties

Parámetros específicos del proyecto.

localestring

Idioma de respuesta.

sandboxboolean

Crea un pedido en el modo aislador de proceso (sandbox). La opción está disponible para los usuarios especificados en la lista de usuarios de la empresa.

Predeterminado false
settingsobject

Configuración del proceso de pago y de la interfaz de pago para un usuario.

curl -i -X POST \
  https://xsolla.redocly.app/_mock/es/api/catalog/v2/project/44056/free/cart \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "custom_parameters": {
      "character_id": "ingameUsername"
    },
    "sandbox": true,
    "settings": {
      "ui": {
        "desktop": {
          "header": {
            "close_button": false,
            "is_visible": true,
            "type": "normal",
            "visible_logo": true,
            "visible_name": true,
            "visible_purchase": true
          }
        },
        "theme": "63295a9a2e47fab76f7708e1"
      }
    }
  }'

Respuestas

El pedido gratuito se creó correctamente.

Cuerpoapplication/json
order_idinteger

ID del pedido.

Respuesta
application/json
{
  "order_id": 641
}

Crear pedido con una cesta gratuita concretaClient-side

Solicitud

Crea un pedido con todos los artículos de la cesta gratuita concreta. El pedido creado obtendrá el estado de pedido done.

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
Cuerpoapplication/json
currencystring

Divisa del precio del pedido. 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.

custom_parametersobject[ 1 .. 200 ] properties

Parámetros específicos del proyecto.

localestring

Idioma de respuesta.

sandboxboolean

Crea un pedido en el modo aislador de proceso (sandbox). La opción está disponible para los usuarios especificados en la lista de usuarios de la empresa.

Predeterminado false
settingsobject

Configuración del proceso de pago y de la interfaz de pago para un usuario.

curl -i -X POST \
  https://xsolla.redocly.app/_mock/es/api/catalog/v2/project/44056/free/cart/custom_id \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "custom_parameters": {
      "character_id": "ingameUsername"
    },
    "sandbox": true,
    "settings": {
      "ui": {
        "desktop": {
          "header": {
            "close_button": false,
            "is_visible": true,
            "type": "normal",
            "visible_logo": true,
            "visible_name": true,
            "visible_purchase": true
          }
        },
        "theme": "63295a9a2e47fab76f7708e1"
      }
    }
  }'

Respuestas

El pedido gratuito se creó correctamente.

Cuerpoapplication/json
order_idinteger

ID del pedido.

Respuesta
application/json
{
  "order_id": 641
}

Crear pedido con un artículo gratuito especificadoClient-side

Solicitud

Crea un pedido con un artículo gratuito especificado. El pedido creado obtendrá el estado de pedido done.

Seguridad
XsollaLoginUserJWT
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
currencystring

Divisa del precio del pedido. 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.

custom_parametersobject[ 1 .. 200 ] properties

Parámetros específicos del proyecto.

localestring

Idioma de respuesta.

promo_codestring

Canjea un código de una promoción de códigos promocionales con pago.

quantityinteger>= 1

Cantidad del artículo.

Predeterminado 1
sandboxboolean

Crea un pedido en el modo aislador de proceso (sandbox). La opción está disponible para los usuarios especificados en la lista de usuarios de la empresa.

Predeterminado false
settingsobject

Configuración del proceso de pago y de la interfaz de pago para un usuario.

curl -i -X POST \
  https://xsolla.redocly.app/_mock/es/api/catalog/v2/project/44056/free/item/booster_mega_1 \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "custom_parameters": {
      "character_id": "ingameUsername"
    },
    "promo_code": "discount_code",
    "quantity": 5,
    "sandbox": true,
    "settings": {
      "ui": {
        "desktop": {
          "header": {
            "close_button": false,
            "is_visible": true,
            "type": "normal",
            "visible_logo": true,
            "visible_name": true,
            "visible_purchase": true
          }
        },
        "theme": "63295a9a2e47fab76f7708e1"
      }
    }
  }'

Respuestas

El pedido gratuito se creó correctamente.

Cuerpoapplication/json
order_idinteger

ID del pedido.

Respuesta
application/json
{
  "order_id": 641
}

Gestión

Operaciones

Admin

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

Admin

Operaciones