Saltar al contenido
/
Actualizar recompensa dia...

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

Admin

Operaciones

Obtener recompensa diariaServer-sideAdmin

Solicitud

Obtiene una recompensa diaria concreta para su administración.

Seguridad
basicAuth
Ruta
project_idintegerrequerido

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

Ejemplo: 44056
daily_chain_idintegerrequerido

ID de recompensa diaria.

Ejemplo: 101
curl -i -X GET \
  -u <username>:<password> \
  https://xsolla.redocly.app/_mock/es/api/shop-builder/v2/project/44056/admin/daily_chain/id/101

Respuestas

Los datos de recompensa diaria se han obtenido correctamente.

Cuerpoapplication/json
date_startstring(date-time)(calendar_hard_date_start)

Fecha de inicio de la recompensa diaria.

Ejemplo: "2020-04-15T18:16:00+05:00"
is_recurrentboolean(calendar_hard_is_recurrent)

Si la recompensa diaria es recurrente. Si es true, la recompensa diaria se restablecerá automáticamente después de la fecha de finalización. La siguiente programación de start_date y end_date se basa en el número de pasos de recompensa diaria y el tiempo inicial establecidos en start_date.

Predeterminado false
Ejemplo: true
typestring

Tipo de recompensa diaria que determina cuándo los usuarios pueden reclamar recompensas.

Enumeración ValorDescripción
calendar_hard

Desbloquea la recompensa del siguiente paso cada 24 horas. Las recompensas de paso sin reclamar se pierden para siempre cuando se desbloquea la recompensa del siguiente paso.

rolling_skippable

Desbloquea la recompensa del siguiente paso cada 24 horas en función de date_start. La progresión es secuencial: no se desbloqueará una nueva recompensa hasta que se haya reclamado la anterior. Si un usuario se salta uno o más días, continuará desde donde lo dejó; los días perdidos no otorgan múltiples recompensas.

rolling_unskippable

Desbloquea la recompensa del siguiente paso cada 24 horas en función de date_start. La progresión es secuencial: no se desbloqueará una nueva recompensa hasta que se haya reclamado la anterior. Sin embargo, si un usuario se salta un día, su progreso se reinicia y debe volver a empezar desde el primer paso.

Discriminador
date_endstring or null(date-time)(daily_chain_date_end)

Fecha en la que finaliza su recompensa diaria. Puede ser null. Al establecer el tipo calendar_hard, esta fecha se fijará automáticamente en función del número de pasos añadidos, por lo que puede dejarla como null.

Ejemplo: "2020-04-15T18:16:00+05:00"
description(two-letter (object or null)) or (cinco letras (object or null))(description-localization-object)

Objeto con traducciones para la descripción del artículo. Acepta valores en uno de dos formatos: códigos de idioma de dos letras en minúscula (p. ej., en) o códigos de configuración regional de cinco caracteres (p. ej., en-US). Aunque ambos formatos se aceptan como entradas, las respuestas devuelven códigos de idioma de dos letras en minúscula. Cuando se facilitan ambas opciones para el mismo idioma (p. ej. en y en-US), se almacena el último valor proporcionado. Puede consultar la lista completa de idiomas admitidos en la documentación.

One of:

Objeto con traducciones para la descripción del artículo. Acepta valores en uno de dos formatos: códigos de idioma de dos letras en minúscula (p. ej., en) o códigos de configuración regional de cinco caracteres (p. ej., en-US). Aunque ambos formatos se aceptan como entradas, las respuestas devuelven códigos de idioma de dos letras en minúscula. Cuando se facilitan ambas opciones para el mismo idioma (p. ej. en y en-US), se almacena el último valor proporcionado. Puede consultar la lista completa de idiomas admitidos en la documentación.

idinteger(daily_chain_id)

ID único de recompensa diaria.

Ejemplo: 9
is_enabledboolean(is_enabled)
Ejemplo: true
name(two-letter (object or null)) or (cinco letras (object or null))(name-localization-object)

Objeto con traducciones para la descripción del artículo. Acepta valores en uno de estos dos formatos: códigos de idioma de dos letras en minúscula (p. ej., en) o códigos de idioma de cinco caracteres (p. ej., en-US). Aunque ambos formatos se aceptan como entradas, las respuestas devuelven códigos de idioma de dos letras en minúscula. Cuando se facilitan ambas opciones para el mismo idioma (p. ej. en y en-US), se almacena el último valor proporcionado. Puede consultar la lista completa de idiomas admitidos en la documentación.

One of:

Objeto con traducciones para la descripción del artículo. Acepta valores en uno de estos dos formatos: códigos de idioma de dos letras en minúscula (p. ej., en) o códigos de idioma de cinco caracteres (p. ej., en-US). Aunque ambos formatos se aceptan como entradas, las respuestas devuelven códigos de idioma de dos letras en minúscula. Cuando se facilitan ambas opciones para el mismo idioma (p. ej. en y en-US), se almacena el último valor proporcionado. Puede consultar la lista completa de idiomas admitidos en la documentación.

number_of_stepsinteger(daily_chain_number_of_step)

Es el número de pasos configurados en la recompensa diaria. Cada paso aquí representa un día en la recompensa diaria.

Ejemplo: 3
orderinteger(order)

Define el orden de disposición.

Ejemplo: 1
stepsArray of objects(admin-daily-chain-step-model)
Respuesta
application/json
{
  "date_end": "2025-04-25T18:16:00+05:00",
  "date_start": "2023-04-15T18:16:00+05:00",
  "description": {
    "en": "Daily reward short description"
  },
  "id": 3,
  "is_enabled": true,
  "is_recurrent": false,
  "name": {
    "en": "Daily reward",
    "ru": "Ежедневная награда"
  },
  "number_of_steps": 3,
  "order": 1,
  "steps": [
    { … },
    { … },
    { … }
  ],
  "type": "calendar_hard"
}

Actualizar recompensa diariaServer-sideAdmin

Solicitud

Actualiza una recompensa diaria concreta.

Seguridad
basicAuth
Ruta
project_idintegerrequerido

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

Ejemplo: 44056
daily_chain_idintegerrequerido

ID de recompensa diaria.

Ejemplo: 101
Cuerpoapplication/json
One of:

Una recompensa diaria para el tipo calendar_hard.

date_startstring(date-time)(calendar_hard_date_start)requerido

Fecha de inicio de la recompensa diaria.

Ejemplo: "2020-04-15T18:16:00+05:00"
is_recurrentboolean(calendar_hard_is_recurrent)

Si la recompensa diaria es recurrente. Si es true, la recompensa diaria se restablecerá automáticamente después de la fecha de finalización. La siguiente programación de start_date y end_date se basa en el número de pasos de recompensa diaria y el tiempo inicial establecidos en start_date.

Predeterminado false
Ejemplo: true
typestringrequerido

Tipo de recompensa diaria que determina cuándo los usuarios pueden reclamar recompensas.

Enumeración ValorDescripción
calendar_hard

Desbloquea la recompensa del siguiente paso cada 24 horas. Las recompensas de paso sin reclamar se pierden para siempre cuando se desbloquea la recompensa del siguiente paso.

rolling_skippable

Desbloquea la recompensa del siguiente paso cada 24 horas en función de date_start. La progresión es secuencial: no se desbloqueará una nueva recompensa hasta que se haya reclamado la anterior. Si un usuario se salta uno o más días, continuará desde donde lo dejó; los días perdidos no otorgan múltiples recompensas.

rolling_unskippable

Desbloquea la recompensa del siguiente paso cada 24 horas en función de date_start. La progresión es secuencial: no se desbloqueará una nueva recompensa hasta que se haya reclamado la anterior. Sin embargo, si un usuario se salta un día, su progreso se reinicia y debe volver a empezar desde el primer paso.

description(two-letter (object or null)) or (cinco letras (object or null))(description-localization-object)

Objeto con traducciones para la descripción del artículo. Acepta valores en uno de dos formatos: códigos de idioma de dos letras en minúscula (p. ej., en) o códigos de configuración regional de cinco caracteres (p. ej., en-US). Aunque ambos formatos se aceptan como entradas, las respuestas devuelven códigos de idioma de dos letras en minúscula. Cuando se facilitan ambas opciones para el mismo idioma (p. ej. en y en-US), se almacena el último valor proporcionado. Puede consultar la lista completa de idiomas admitidos en la documentación.

One of:

Objeto con traducciones para la descripción del artículo. Acepta valores en uno de dos formatos: códigos de idioma de dos letras en minúscula (p. ej., en) o códigos de configuración regional de cinco caracteres (p. ej., en-US). Aunque ambos formatos se aceptan como entradas, las respuestas devuelven códigos de idioma de dos letras en minúscula. Cuando se facilitan ambas opciones para el mismo idioma (p. ej. en y en-US), se almacena el último valor proporcionado. Puede consultar la lista completa de idiomas admitidos en la documentación.

idinteger(daily_chain_id)

ID único de recompensa diaria.

Ejemplo: 9
is_enabledboolean(is_enabled)requerido
Ejemplo: true
name(two-letter (object or null)) or (cinco letras (object or null))(name-localization-object)requerido

Objeto con traducciones para la descripción del artículo. Acepta valores en uno de estos dos formatos: códigos de idioma de dos letras en minúscula (p. ej., en) o códigos de idioma de cinco caracteres (p. ej., en-US). Aunque ambos formatos se aceptan como entradas, las respuestas devuelven códigos de idioma de dos letras en minúscula. Cuando se facilitan ambas opciones para el mismo idioma (p. ej. en y en-US), se almacena el último valor proporcionado. Puede consultar la lista completa de idiomas admitidos en la documentación.

One of:

Objeto con traducciones para la descripción del artículo. Acepta valores en uno de estos dos formatos: códigos de idioma de dos letras en minúscula (p. ej., en) o códigos de idioma de cinco caracteres (p. ej., en-US). Aunque ambos formatos se aceptan como entradas, las respuestas devuelven códigos de idioma de dos letras en minúscula. Cuando se facilitan ambas opciones para el mismo idioma (p. ej. en y en-US), se almacena el último valor proporcionado. Puede consultar la lista completa de idiomas admitidos en la documentación.

name.​arstring or null

Árabe

name.​bgstring or null

Búlgaro

name.​cnstring or null

Chino (simplificado)

name.​csstring or null

Checo

name.​destring or null

Alemán

name.​enstring or null

Inglés

name.​esstring or null

Español (España)

name.​frstring or null

Francés

name.​hestring or null

Hebreo

name.​idstring or null

Indonesio

name.​itstring or null

Italiano

name.​jastring or null

Japonés

name.​kmstring or null

Jemer

name.​kostring or null

Coreano

name.​lostring or null

Lao

name.​mystring or null

Birmano

name.​nestring or null

Nepalí

name.​phstring or null

Filipino

name.​plstring or null

Polaco

name.​ptstring or null

Portugués

name.​rostring or null

Rumano

name.​rustring or null

Ruso

name.​thstring or null

Tailandés

name.​trstring or null

Turco

name.​twstring or null

Chino (tradicional)

name.​vistring or null

Vietnamita

orderinteger(order)

Define el orden de disposición.

Ejemplo: 1
stepsArray of objects(modify-daily-chain-step-model)requerido
steps[].​itemsArray of objects(modify-daily-chain-item-model)non-emptyrequerido
steps[].​items[].​quantityinteger>= 1requerido

Cantidad de pasos de recompensa diaria para este sku

steps[].​items[].​skustring(sku)[ 1 .. 255 ] characters^[a-zA-Z0-9_\-–.]*$requerido

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: "booster_mega_1"
steps[].​step_idinteger or null(daily_chain_update_step_id)>= 1

Identificador único del paso de recompensa diaria. Especifíquelo durante la actualización para conservar el progreso del usuario en este paso.

Ejemplo: 10
steps[].​step_numberinteger(daily_chain_step_number)>= 1requerido

Número del paso.

Ejemplo: 2
curl -i -X PUT \
  -u <username>:<password> \
  https://xsolla.redocly.app/_mock/es/api/shop-builder/v2/project/44056/admin/daily_chain/id/101 \
  -H 'Content-Type: application/json' \
  -d '{
    "date_start": "2023-04-15T18:16:00+05:00",
    "description": {
      "en": "Updated daily reward description"
    },
    "is_enabled": true,
    "name": {
      "en": "Updated daily reward",
      "ru": "Обновленная ежедневная награда"
    },
    "order": 4,
    "steps": [
      {
        "items": [
          {
            "quantity": 1,
            "sku": "vg_enabled_shown_in_store_1"
          }
        ],
        "step_number": 1
      },
      {
        "items": [
          {
            "quantity": 1,
            "sku": "vg_enabled_shown_in_store_2"
          }
        ],
        "step_number": 2
      },
      {
        "items": [
          {
            "quantity": 1,
            "sku": "vg_not_shown_in_store"
          }
        ],
        "step_id": 10,
        "step_number": 3
      },
      {
        "items": [
          {
            "quantity": 1,
            "sku": "bundle_enabled_shown_in_store_with_2_enabled_shown_in_store_vg"
          }
        ],
        "step_id": 8,
        "step_number": 4
      },
      {
        "items": [
          {
            "quantity": 1,
            "sku": "vcp_enabled_shown_in_store_1_of_10_vc_enabled_shown_in_store_1"
          }
        ],
        "step_number": 5
      }
    ],
    "type": "calendar_hard"
  }'

Respuestas

La recompensa diaria se ha actualizado correctamente.

Cuerpo
Respuesta
Sin contenido

Restablecer recompensa diariaServer-sideAdmin

Solicitud

Restablece el progreso de todos los usuarios en la recompensa diaria. Solo se aplica a las recompensas diarias del tipo rolling.

Seguridad
basicAuth
Ruta
project_idintegerrequerido

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

Ejemplo: 44056
daily_chain_idintegerrequerido

ID de recompensa diaria.

Ejemplo: 101
curl -i -X POST \
  -u <username>:<password> \
  https://xsolla.redocly.app/_mock/es/api/shop-builder/v2/project/44056/admin/daily_chain/id/101/reset

Respuestas

Se ha restablecido la recompensa diaria.

Cuerpo
Respuesta
Sin contenido

Cliente

Operaciones

Admin

Operaciones

Cliente

Operaciones

Admin

Operaciones