Saltar al contenido
/
Crear un código de oferta...

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

Obtenga códigos de oferta de catálogos exclusivosServer-sideAdmin

Solicitud

Obtiene códigos de oferta de catálogo únicos.

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
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/v2/project/44056/admin/unique_catalog_offer/coupon_44056_1/code?limit=50&offset=0'

Respuestas

Se ha recibido correctamente la lista de códigos para una oferta de catálogo única.

Cuerpoapplication/json
codesArray of objects
total_countnumber

Número total de códigos de oferta de catálogo únicos.

Respuesta
application/json
{
  "codes": [
    { … },
    { … },
    { … },
    { … },
    { … }
  ],
  "total_count": 5
}

Crear un código de oferta de catálogo únicoServer-sideAdmin

Solicitud

Crea un código de oferta de catálogo único.

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
Cuerpoapplication/json
coupon_codestring(Promotions_coupon_code)[ 1 .. 128 ] characters^[a-zA-Z0-9]+$

Código único que distingue entre mayúsculas y minúsculas. Contiene letras y números.

Predeterminado "WINTER2021"
Ejemplo: "WINTER2021"
curl -i -X POST \
  -u <username>:<password> \
  https://xsolla.redocly.app/_mock/es/api/shop-builder/v2/project/44056/admin/unique_catalog_offer/coupon_44056_1/code \
  -H 'Content-Type: application/json' \
  -d '{
    "coupon_code": "WINTER2021"
  }'

Respuestas

El código se creó correctamente.

Cuerpoapplication/json
codestring(Promotions_coupon_code)[ 1 .. 128 ] characters^[a-zA-Z0-9]+$

Código único que distingue entre mayúsculas y minúsculas. Contiene letras y números.

Predeterminado "WINTER2021"
Ejemplo: "WINTER2021"
Respuesta
application/json
{
  "code": "WINTER2021"
}

Generar códigos de oferta de catálogo únicosServer-sideAdmin

Solicitud

Genera códigos de oferta de catálogo únicos.

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
Cuerpoapplication/json
countinteger(Promotions_coupon-generate-count)[ 1 .. 100000 ]requerido
Ejemplo: 10
curl -i -X PUT \
  -u <username>:<password> \
  https://xsolla.redocly.app/_mock/es/api/shop-builder/v2/project/44056/admin/unique_catalog_offer/coupon_44056_1/code/generate \
  -H 'Content-Type: application/json' \
  -d '{
    "count": 10
  }'

Respuestas

Los códigos se han generado correctamente.

Cuerpoapplication/json
countinteger(Promotions_coupon-generate-count)[ 1 .. 100000 ]
Ejemplo: 10
Respuesta
application/json
{
  "count": 10
}

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