Saltar al contenido
/
Crear promoción de código...

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

Obtener la lista de promociones de códigos promocionalesServer-sideAdmin

Solicitud

Obtiene la lista de códigos promocionales de un proyecto.

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
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 \
  -u <username>:<password> \
  'https://xsolla.redocly.app/_mock/es/api/shop-builder/v3/project/44056/admin/promocode?limit=50&offset=0'

Respuestas

La lista de códigos promocionales se recibió correctamente.

Cuerpoapplication/json
active_promotions_countinteger(active_promotions_count)

Número de promociones activas.

inactive_promotions_countinteger(inactive_promotions_count)

Número de promociones desactivadas.

itemsArray of objects(Promotions_200-get-promocode-promotion-model)
total_promotions_countinteger(total_promotions_count)

Número total de promociones.

Respuesta
application/json
{
  "active_promotions_count": 2,
  "inactive_promotions_count": 0,
  "items": [
    { … },
    { … }
  ],
  "total_promotions_count": 2
}

Crear promoción de códigos promocionalesServer-sideAdmin

Solicitud

Crea una promoción de códigos promocionales.

Seguridad
basicAuth
Ruta
project_idintegerrequerido

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

Ejemplo: 44056
Cuerpoapplication/json
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.

bonusArray of objects or null(Promotions_coupon_bonus)
discountobject or null
Ejemplo: {"percent":"10.10"}
discounted_itemsArray of objects or null(Promotions_discounted_items)

Lista de artículos con descuento mediante un código promocional.

excluded_promotionsArray of integers(excluded_promotions)

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

Ejemplo: [12,789]
external_idstring(Promotions_coupon-external_id)requerido

ID único de promoción. El external_id solo puede contener caracteres alfanuméricos latinos en minúsculas y mayúsculas, puntos, guiones y guiones bajos.

Predeterminado "coupon_external_id"
Ejemplo: "coupon_external_id"
item_price_conditionsArray of objects or null(item_price_conditions_promocode)

Matriz de objetos con condiciones que establecen el rango de precios para aplicar la promoción a determinados artículos de la cesta.
El precio de cada artículo en la cesta del usuario se compara con el rango de precios especificado en la condición. Se aplican bonificaciones y descuentos únicamente a aquellos artículos de la cesta cuyo precio cumple la condición.
Si transmite esta matriz, establezca el valor de la matriz discounted_items como null.

nameobject(Promotions_coupon_name)requerido

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

Predeterminado {"de-DE":"Gutscheintitel","en-US":"Coupon title"}
Ejemplo: {"de-DE":"Gutscheintitel","en-US":"Coupon title"}
name.​property name*stringpropiedad adicional
price_conditionsArray of objects or null(price_conditions_promocode)

Matriz de objetos con condiciones que establecen el rango de precios para aplicar la promoción a toda la cesta.
El precio total de todos los artículos de la cesta del usuario se compara con el rango de precios especificado en la condición. Las bonificaciones y los descuentos se aplican a todos los artículos de la cesta si el precio de la cesta cumple la condición especificada.
Si transmite esta matriz, establezca el valor de la matriz discounted_items como 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.

redeem_code_limitinteger or null(Promotions_redeem_code_limit)

Número de canjes por cada código.

Predeterminado 10
Ejemplo: 10
redeem_total_limitinteger or null(Promotions_coupon-redeem_total_limit)

Limita el número total de cupones.

Predeterminado 10
Ejemplo: 10
redeem_user_limitinteger or null(Promotions_coupon-redeem_user_limit)

Limita el número total de cupones canjeados por un mismo usuario.

Predeterminado 10
Ejemplo: 10
curl -i -X POST \
  -u <username>:<password> \
  https://xsolla.redocly.app/_mock/es/api/shop-builder/v3/project/44056/admin/promocode \
  -H 'Content-Type: application/json' \
  -d '{
    "attribute_conditions": [
      {
        "attribute": "account_status",
        "can_be_missing": false,
        "operator": "eq",
        "type": "string",
        "value": "golden"
      }
    ],
    "discount": {
      "percent": "10.10"
    },
    "external_id": "coupon_external_id",
    "name": {
      "de-DE": "Neujahrsrabatt",
      "en-US": "New Year Discount"
    },
    "promotion_periods": [
      {
        "date_from": "2020-04-15T18:16:00+05:00",
        "date_until": "2020-04-25T18:16:00+05:00"
      }
    ],
    "redeem_code_limit": 1,
    "redeem_total_limit": 100,
    "redeem_user_limit": 1
  }'

Respuestas

El código promocional se creó correctamente.

Cuerpoapplication/json
external_idstring(Promotions_coupon-external_id)

ID único de promoción. El external_id solo puede contener caracteres alfanuméricos latinos en minúsculas y mayúsculas, puntos, guiones y guiones bajos.

Predeterminado "coupon_external_id"
Ejemplo: "coupon_external_id"
Respuesta
application/json
{
  "external_id": "coupon_external_id"
}

Eliminar promoción de códigos promocionalesServer-sideAdmin

Solicitud

Elimina la promoción de códigos promocionales. 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 de bonificación ni comprar artículos usando esta promoción.

Después de eliminarla, la promoción no se puede restaurar. Los códigos promocionales de la promoción eliminada se pueden añadir a las promociones existentes.

Seguridad
basicAuth
Ruta
project_idintegerrequerido

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

Ejemplo: 44056
external_idintegerrequerido

ID externo de la promoción. Identificador único de la promoción dentro del proyecto.

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

Respuestas

La promoción de códigos promocionales se eliminó correctamente.

Respuesta
Sin contenido

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

Cliente

Operaciones

Admin

Operaciones

Cliente

Operaciones

Admin

Operaciones