Saltar al contenido
/
Eliminar promoción

Subscriptions API (2.0)

Información general

  • Versión: 2.0
  • Servidores: https://api.xsolla.com/merchant/v2/

Esta referencia de API describe los extremos para administrar suscripciones, cupones y promociones. Para obtener más información sobre las suscripciones, consulta la página guía del producto y el glosario.

Descargar descripción de OpenAPI
index.json
index.yaml
Idiomas
Servidores
Mock server
https://xsolla.redocly.app/_mock/es/api/subscriptions/

Token

Operaciones

Planes

Operaciones

Productos

Operaciones

Subscription management

Operaciones

Pagos

Operaciones

Promociones

Operaciones

Crear promoción

Solicitud

Crear una nueva campaña de cupones.

Aviso

Esta llamada API no contiene el parámetro de ruta project_id, por lo que tiene que usar la clave de API que sea válida en todos los proyectos de la empresa para establecer la autorización.

Seguridad
basicAuth
Ruta
merchant_idintegerrequerido

ID de vendedor.

Cuerpoapplication/jsonrequerido
descriptionobject

Matriz de descripciones de promociones localizadas.

labelobject

Matriz de etiquetas localizadas que se mostrarán en la interfaz de pago.

nameobject

Matriz de nombres de promociones localizados.

project_idintegerrequerido

ID de proyecto.

technical_namestringrequerido

Nombre técnico de la promoción.

enabledboolean
idinteger
read_onlyboolean
show_bannerboolean
curl -i -X POST \
  -u <username>:<password> \
  'https://xsolla.redocly.app/_mock/es/api/subscriptions/merchants/{merchant_id}/promotions' \
  -H 'Content-Type: application/json' \
  -d '{
    "description": {
      "en": "Promotion with 30% discount",
      "ru": "Акция со скидкой 30%"
    },
    "label": {
      "en": "30%",
      "ru": "30%"
    },
    "name": {
      "en": "30% discount",
      "ru": "скидка 30%"
    },
    "project_id": 12345,
    "technical_name": "Sale promotion"
  }'

Respuestas

Created.

Cuerpoapplication/json
idinteger

ID de promoción.

Respuesta
application/json
{
  "id": 17890
}

Eliminar promoción

Solicitud

Elimina una promoción. Solo puedes eliminar promociones con enabled = false.

Aviso

Esta llamada API no contiene el parámetro de ruta project_id, por lo que tiene que usar la clave de API que sea válida en todos los proyectos de la empresa para establecer la autorización.

Seguridad
basicAuth
Ruta
merchant_idintegerrequerido

ID de vendedor.

promotion_idintegerrequerido

ID de promoción.

curl -i -X DELETE \
  -u <username>:<password> \
  'https://xsolla.redocly.app/_mock/es/api/subscriptions/merchants/{merchant_id}/promotions/{promotion_id}'

Respuestas

No content (Sin contenido).

Obtener promoción

Solicitud

Recupera una promoción.

Aviso

Esta llamada API no contiene el parámetro de ruta project_id, por lo que tiene que usar la clave de API que sea válida en todos los proyectos de la empresa para establecer la autorización.

Seguridad
basicAuth
Ruta
merchant_idintegerrequerido

ID de vendedor.

promotion_idintegerrequerido

ID de promoción.

curl -i -X GET \
  -u <username>:<password> \
  'https://xsolla.redocly.app/_mock/es/api/subscriptions/merchants/{merchant_id}/promotions/{promotion_id}'

Respuestas

ACEPTAR.

Cuerpoapplication/json
descriptionobject

Matriz de descripciones de promociones localizadas.

labelobject

Matriz de etiquetas localizadas que se mostrarán en la interfaz de pago.

nameobject

Matriz de nombres de promociones localizados.

project_idinteger

ID de proyecto.

technical_namestring

Nombre técnico de la promoción.

enabledboolean
idinteger
read_onlyboolean
show_bannerboolean
Respuesta
application/json
{
  "description": {
    "en": "Promotion with 30% discount",
    "ru": "Акция со скидкой 30%"
  },
  "enabled": false,
  "id": 17890,
  "label": {
    "en": "30%",
    "ru": "30%"
  },
  "name": {
    "en": "30% discount",
    "ru": "Скидка 30%"
  },
  "project_id": 40544,
  "read_only": false,
  "show_banner": true,
  "technical_name": "Sale promotion"
}

Cupones

Operaciones

Subscription management

Operaciones