Saltar al contenido
/
Establecer periodos de va...

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

Obtener periodos de validez

Solicitud

Obtiene rangos de fecha/hora cuando una promoción es válida.

Aviso

Esta llamada API no contiene el parámetro de rutaproject_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}/periods'

Respuestas

ACEPTAR.

Cuerpoapplication/json
idinteger
periodsArray of objects

Intervalos de fecha/hora.

Respuesta
application/json
{
  "id": 17840,
  "periods": [
    { … }
  ]
}

Establecer periodos de validez

Solicitud

Establece los rangos de fecha y hora en los que una promoción es válida. Si la promoción es de solo lectura (read_only = true), no puede editar los períodos existentes, pero puede agregar otros nuevos.

Aviso

Esta llamada API no contiene el parámetro de rutaproject_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.

Cuerpoapplication/jsonrequerido
periodsArray of objects

Intervalos de fecha/hora.

curl -i -X PUT \
  -u <username>:<password> \
  'https://xsolla.redocly.app/_mock/es/api/subscriptions/merchants/{merchant_id}/promotions/{promotion_id}/periods' \
  -H 'Content-Type: application/json' \
  -d '{
    "periods": [
      {
        "from": "2019-03-02T00:00:00+04:00",
        "to": "2019-04-02T00:00:00+04:00"
      }
    ]
  }'

Respuestas

No content (Sin contenido).

Revisar promoción

Solicitud

Debes revisar una promoción antes de activarla. Este método devuelve la lista de errores, si los hay.

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}/review'

Respuestas

ACEPTAR.

Cuerpoapplication/jsonArray [
componentstring
messagestring
]
Respuesta
application/json
[
  {
    "component": "rewards",
    "message": "Please select a reward"
  }
]

Cupones

Operaciones

Subscription management

Operaciones