Saltar al contenido
/
Obtener las cadenas de of...

Shop Builder 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

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

Admin

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

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

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

Catálogo

Operaciones

Derechos

Operaciones

Admin

Operaciones

Común

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

Admin

Operaciones

Catálogo

Operaciones

Pago virtual

Operaciones

Gestión

Operaciones

Admin

Operaciones

Cliente

Operaciones

Cliente de clanes

Operaciones

Admin

Operaciones

Cliente

Operaciones

Obtener las cadenas de ofertas del usuario actualClient-side

Solicitud

Obtiene las cadenas de ofertas del usuario actual.

Aviso

Todos los proyectos tienen un límite de número de artículos que pueden devolverse en una sola respuesta. El valor por defecto y máximo es 30 artículos por respuesta. Para obtener más datos, utilice los parámetros de consulta limit y offset para la paginación.
Seguridad
XsollaLoginUserJWT
Ruta
project_idintegerrequerido

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

Ejemplo: 44056
Consulta
limitinteger>= 1

Límite para el número de elementos presentes en la página.

Ejemplo: limit=50
offsetinteger>= 0

Número del elemento a partir del cual se genera la lista (el conteo empieza desde el 0).

Ejemplo: offset=0
curl -i -X GET \
  'https://xsolla.redocly.app/_mock/es/api/shop-builder/v2/project/44056/user/offer_chain?limit=50&offset=0' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Respuestas

La lista de cadenas de ofertas se ha recibido correctamente.

Cuerpoapplication/json
has_moreboolean

Indica si hay más páginas disponibles.

Ejemplo: true
itemsArray of objects(client-offer-chain-model)
total_items_countinteger

Número total de cadenas de ofertas disponibles.

Ejemplo: 10
Respuesta
application/json
{
  "has_more": false,
  "items": [
    { … },
    { … },
    { … }
  ],
  "total_items_count": 3
}

Obtener la cadena de ofertas del usuario actual por IDClient-side

Solicitud

Obtiene la cadena de ofertas del usuario actual por el ID de la cadena de ofertas.

Seguridad
XsollaLoginUserJWT
Ruta
project_idintegerrequerido

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

Ejemplo: 44056
offer_chain_idintegerrequerido

ID de cadena de ofertas.

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

Respuestas

La cadena de ofertas del usuario se ha obtenido correctamente.

Cuerpoapplication/json
date_endstring or null(date-time)(offer_chain_date_end)

Fecha en la que finaliza la cadena de ofertas. Puede ser null. Si date_end es null, la cadena de ofertas no tendrá límite de tiempo.

Ejemplo: "2020-04-15T18:16:00+05:00"
date_startstring(date-time)(offer_chain_date_start)

Fecha de inicio de la cadena de ofertas.

Ejemplo: "2020-04-15T18:16:00+05:00"
descriptionstring or null

Descripción de cadena de ofertas.

Ejemplo: "Major weekly quest"
idinteger

ID de cadena de ofertas.

Ejemplo: 9
namestring

Nombre de cadena de ofertas.

Ejemplo: "Weekly quest"
next_step_numberinteger or null

Número del siguiente paso de la cadena de ofertas. null si se ha completado la cadena de ofertas.

Ejemplo: 1
orderinteger(order)

Define el orden de disposición.

Ejemplo: 1
recurrent_scheduleobject or null(offer_chain_recurrent_schedule_client_side)

Periodo de reinicio de la cadena de ofertas.

stepsArray of objects(client-offer-chain-step-model)
Respuesta
application/json
{
  "date_end": "2025-04-25T18:16:00+05:00",
  "date_start": "2010-04-15T18:16:00+05:00",
  "description": null,
  "id": 4,
  "name": "Offer chain with bundles",
  "next_step_number": 1,
  "order": 1,
  "recurrent_schedule": null,
  "steps": [
    { … },
    { … }
  ]
}

Reclamar paso de cadena de ofertas gratuitoClient-side

Solicitud

Completa la progresión del usuario actual por el paso de la cadena de ofertas y concede la recompensa asociada.

Aviso

Utilice esta llamada solo para los pasos gratuitos de la cadena de ofertas. Para los pasos que requieran un pago en moneda real, utilice la llamada Crear pedido para el paso de cadena de ofertas de pago.
Seguridad
XsollaLoginUserJWT
Ruta
project_idintegerrequerido

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

Ejemplo: 44056
offer_chain_idintegerrequerido

ID de cadena de ofertas.

Ejemplo: 101
step_numberintegerrequerido

Número de paso de cadena de ofertas.

Ejemplo: 1
curl -i -X POST \
  https://xsolla.redocly.app/_mock/es/api/shop-builder/v2/project/44056/user/offer_chain/101/step/number/1/claim \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Respuestas

El paso gratuito se ha reclamado correctamente y se ha concedido la recompensa.

Cuerpoapplication/json
order_idinteger

ID del pedido.

Respuesta
application/json
{
  "order_id": 641
}

Admin

Operaciones

Cliente

Operaciones

Admin

Operaciones

Cliente

Operaciones

Admin

Operaciones