Saltar al contenido
/
Obtener promoción del art...

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

Eliminar la promoción de artículosServer-sideAdmin

Solicitud

Elimina la promoción de descuento. La promoción eliminada:

  • Desaparece de la lista de promociones establecidas en su proyecto.
  • Ya no se aplica al catálogo de artículos ni a la cesta. El usuario no puede obtener artículos con esta promoción.

Después de eliminarla, la promoción no se puede restaurar.

Seguridad
basicAuth
Ruta
project_idintegerrequerido

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

Ejemplo: 44056
promotion_idintegerrequerido

ID de promoción. Identificador único de la promoción en el proyecto.

Ejemplo: 111425
curl -i -X DELETE \
  -u <username>:<password> \
  https://xsolla.redocly.app/_mock/es/api/shop-builder/v3/project/44056/admin/promotion/111425/item

Respuestas

La promoción se eliminó correctamente.

Respuesta
Sin contenido

Obtener promoción del artículoServer-sideAdmin

Solicitud

Obtiene la promoción aplicada a artículos concretos.

Las promociones proporcionan un descuento (%) para los artículos. El descuento se aplicará a todos los precios de los artículos especificados.

Seguridad
basicAuth
Ruta
project_idintegerrequerido

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

Ejemplo: 44056
promotion_idintegerrequerido

ID de promoción. Identificador único de la promoción en el proyecto.

Ejemplo: 111425
curl -i -X GET \
  -u <username>:<password> \
  https://xsolla.redocly.app/_mock/es/api/shop-builder/v3/project/44056/admin/promotion/111425/item

Respuestas

La promoción del artículo se recibió correctamente.

Cuerpoapplication/json
attribute_conditionsArray of tipo = string (object) or tipo = number (object) or tipo = date (object)(promotion_user-attribute_conditions_model-get)[ 1 .. 100 ] items

Condiciones para validar los atributos de usuario. Determina la disponibilidad de la promoción en función de si los atributos de usuario cumplen todas las condiciones especificadas.

discountobject
Ejemplo: {"percent":"15.00"}
excluded_promotionsArray of integers(excluded_promotions)

Lista de ID de promociones a excluir al aplicar esta promoción.
Example: [12, 789].

Ejemplo: [12,789]
idinteger

ID de promoción. Identificador único de la promoción en el proyecto.

Ejemplo: 1
is_enabledboolean(Promotions_is_enabled)

Si la promoción está habilitada o no.

Ejemplo: true
itemsArray of objects or null
Ejemplo: [{"sku":"com.xsolla.elven_sword_1"},{"sku":"com.xsolla.elven_helmet_1"},{"sku":"com.xsolla.elven_armor_1"}]
limitsobject(Promotions_promotion_limits_response)

Límites de la promoción.

nameobject

Nombre de la promoción. Debe contener pares clave/valor, en los cuales la clave es la configuración regional con el formato "^[a-z]{2}-[A-Z]{2}$", el valor es una cadena (string).

Ejemplo: {"en-US":"Promotion","ru-RU":"Акция"}
price_conditionsArray of objects or null(price_conditions_discount)

Matriz de objetos con condiciones que establecen el rango de precios para aplicar la promoción.
La promoción solo se aplica a los artículos cuyo precio cumple todas las condiciones de la matriz. Si transmite esta matriz, establezca el valor del objeto items en null.

promotion_periodsArray of objects(promotion_periods)

Periodos de validez de la promoción. Si se especifican varios periodos, es necesario tanto date_from como date_until.

Respuesta
application/json
{
  "discount": {
    "percent": "20.00"
  },
  "excluded_promotions": [
    23,
    45
  ],
  "id": 1,
  "is_enabled": true,
  "items": [
    { … },
    { … }
  ],
  "limits": {
    "per_item": null,
    "per_user": { … },
    "recurrent_schedule": { … }
  },
  "name": {
    "en-US": "Promotion",
    "ru-RU": "Акция"
  },
  "price_conditions": [
    { … },
    { … }
  ],
  "promotion_periods": [
    { … }
  ]
}

Actualizar la promoción del artículoServer-sideAdmin

Solicitud

Actualiza la promoción.

Nota

Los nuevos datos sustituirán a los antiguos. Si desea actualizar sólo una parte de una promoción, deberá transferir también todos los datos necesarios en la solicitud.

Las promociones ofrecen un descuento (%) en los artículos. El descuento se aplicará a todos los precios de los artículos especificados.

Seguridad
basicAuth
Ruta
project_idintegerrequerido

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

Ejemplo: 44056
promotion_idintegerrequerido

ID de promoción. Identificador único de la promoción en el proyecto.

Ejemplo: 111425
Cuerpoapplication/jsonrequerido

Objeto con datos de la promoción.

attribute_conditionsArray of tipo = string (object) or tipo = number (object) or tipo = date (object)(promotion_user-attribute_conditions_model-post)[ 1 .. 100 ] items

Condiciones para validar los atributos de usuario. Determina la disponibilidad de la promoción en función de si los atributos de usuario cumplen todas las condiciones especificadas.

discountobjectrequerido
discount.​percentstringrequerido

Porcentaje de descuento. El precio del artículo se reducirá utilizando un valor calculado usando este porcentaje y luego se redondeará al segundo decimal.

Ejemplo: 10
excluded_promotionsArray of integers(excluded_promotions)

Lista de ID de promociones a excluir al aplicar esta promoción.
Example: [12, 789].

Ejemplo: [12,789]
is_enabledboolean(Promotions_is_enabled)

Si la promoción está habilitada o no.

Ejemplo: true
itemsArray of objectsrequerido
items[].​skustringrequerido

SKU del artículo.

Predeterminado "elven_sword"
limitsobject(Promotions_promotion_limits)

Límites de la promoción.

nameobjectrequerido

Nombre de la promoción. Debe contener pares clave/valor, en los cuales la clave es la configuración regional con el formato "^[a-z]{2}-[A-Z]{2}$", el valor es una cadena (string).

Ejemplo: {"en-US":"Promotion","ru-RU":"Акция"}
name.​property name*stringpropiedad adicional
price_conditionsArray of objects or null(price_conditions_discount)

Matriz de objetos con condiciones que establecen el rango de precios para aplicar la promoción.
La promoción solo se aplica a los artículos cuyo precio cumple todas las condiciones de la matriz. Si transmite esta matriz, establezca el valor del objeto items en null.

promotion_periodsArray of objects(promotion_periods)

Periodos de validez de la promoción. Si se especifican varios periodos, es necesario tanto date_from como date_until.

curl -i -X PUT \
  -u <username>:<password> \
  https://xsolla.redocly.app/_mock/es/api/shop-builder/v3/project/44056/admin/promotion/111425/item \
  -H 'Content-Type: application/json' \
  -d '{
    "attribute_conditions": [
      {
        "attribute": "race",
        "operator": "eq",
        "type": "string",
        "value": "ork"
      },
      {
        "attribute": "level",
        "can_be_missing": true,
        "operator": "eq",
        "type": "number",
        "value": "10"
      }
    ],
    "discount": {
      "percent": "24.00"
    },
    "is_enabled": true,
    "items": [],
    "name": {
      "en-US": "Ork set discount",
      "ru-RU": "Скидка на набор для орка"
    },
    "promotion_periods": [
      {
        "date_from": "2020-04-15T18:16:00+05:00",
        "date_until": "2020-04-25T18:16:00+05:00"
      }
    ]
  }'

Respuestas

La promoción se actualizó correctamente.

Respuesta
Sin contenido

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

Cliente

Operaciones

Admin

Operaciones

Cliente

Operaciones

Admin

Operaciones