Saltar al contenido
/
Eliminar la promoción de...

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

Crear una promoción única de ofertas por catálogoServer-sideAdmin

Solicitud

Crea una promoción de oferta de catálogo única.

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
date_endstring or null(date-time)(Promotions_coupon_date_end)

Fecha de finalización de su promoción. Puede ser null. Si la date_end es null, la promoción será ilimitada en el tiempo.

Predeterminado "2020-04-15T18:16:00+05:00"
date_startstring or null(date-time)(Promotions_coupon_date_start)

Fecha de inicio de la promoción.

Predeterminado "2020-04-15T18:16:00+05:00"
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"
itemsArray of strings(Promotions_unique_catalog_offer_items)

Una lista de artículos SKU que están disponibles después de utilizar la oferta única de catálogo.

Ejemplo: ["booster_mega_1"]
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
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/unique_catalog_offer \
  -H 'Content-Type: application/json' \
  -d '{
    "date_end": "2020-04-25T18:16:00+05:00",
    "date_start": "2020-04-15T18:16:00+05:00",
    "external_id": "offer_external_id",
    "items": [
      "elven_sword",
      "elven_boots"
    ],
    "name": {
      "de-DE": "Neujahrsangebot",
      "en-US": "New Year Offer"
    },
    "redeem_code_limit": 1,
    "redeem_total_limit": 100,
    "redeem_user_limit": 1
  }'

Respuestas

Se ha creado correctamente una oferta de catálogo única.

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 la promoción de oferta única de catálogoServer-sideAdmin

Solicitud

Elimina la promoción única de oferta de catálogo. 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 comprar 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
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/unique_catalog_offer/coupon_44056_1

Respuestas

La oferta única de catálogo se eliminó correctamente.

Respuesta
Sin contenido

Consiga una promoción de oferta de catálogo únicaServer-sideAdmin

Solicitud

Obtiene la promoción de oferta de catálogo única especificada.

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 GET \
  -u <username>:<password> \
  https://xsolla.redocly.app/_mock/es/api/shop-builder/v3/project/44056/admin/unique_catalog_offer/coupon_44056_1

Respuestas

Se ha recibido correctamente una oferta única de catálogo.

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"
is_enabledboolean(Promotions_coupon-is_enabled)
Predeterminado true
itemsArray of strings(Promotions_unique_catalog_offer_items)

Una lista de artículos SKU que están disponibles después de utilizar la oferta única de catálogo.

Ejemplo: ["booster_mega_1"]
nameobject(Promotions_coupon_name)

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"}
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
total_limit_stateobject or null(Promotions_coupon_total_limit_state)

Límites para cada código único de cupón.

Respuesta
application/json
{
  "external_id": "secret_shop",
  "is_enabled": true,
  "items": [
    "helmet",
    "sword",
    "shield"
  ],
  "name": {
    "en-US": "Secret shop",
    "ru-RU": "Секретный магазин"
  },
  "promotion_periods": [
    { … },
    { … }
  ],
  "redeem_code_limit": 1,
  "redeem_total_limit": 100,
  "redeem_user_limit": 1,
  "total_limit_state": {
    "available": 50,
    "reserved": 10,
    "used": 40
  }
}

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