Перейти к содержимому
/
Привязка кампании к акции

Subscriptions API (2.0)

Введение

  • Версия: 2.0
  • Серверы: https://api.xsolla.com/merchant/v2/

Этот справочник API описывает методы для управления подписками, купонами и акциями. Подробная информация о продукте Subscriptions приведена в руководстве по продукту и глоссарии.

Скачать описание OpenAPI
index.json
index.yaml
Языки
Серверы
Mock server
https://xsolla.redocly.app/_mock/ru/api/subscriptions/

Токен

Операции

Планы

Операции

Продукты

Операции

Subscription management

Операции

Платежи

Операции

Акции

Операции

Купоны

Операции

Добавление купона в кампанию

Запрос

Добавьте код купона в купонную кампанию.

Внимание

Этот метод API не включает в себя path-параметр project_id, поэтому для авторизации вам необходимо использовать ключ API, который действует во всех проектах.

Безопасность
basicAuth
Путь
merchant_idintegerобязательный

ID продавца.

campaign_idintegerобязательный

ID кампании.

Телоapplication/jsonобязательный
coupon_codestringобязательный

Код купона.

Пример: "34bryrb3"
curl -i -X POST \
  -u <username>:<password> \
  'https://xsolla.redocly.app/_mock/ru/api/subscriptions/merchants/{merchant_id}/coupon_promotions/{campaign_id}/coupons' \
  -H 'Content-Type: application/json' \
  -d '{
    "coupon_code": "34bryrb3"
  }'

Ответы

No content.

Привязка кампании к акции

Запрос

Прикрепите купонную кампанию к определенной акции.

Внимание

Этот метод API не включает в себя path-параметр project_id, поэтому для авторизации вам необходимо использовать ключ API, который действует во всех проектах.

Безопасность
basicAuth
Путь
merchant_idintegerобязательный

ID продавца.

promotion_idintegerобязательный

ID акции.

Телоapplication/jsonобязательный
campaignsArray of integersобязательный

Массив с ID кампаний.

Пример: [9135]
curl -i -X PUT \
  -u <username>:<password> \
  'https://xsolla.redocly.app/_mock/ru/api/subscriptions/merchants/{merchant_id}/promotions/{promotion_id}/coupons' \
  -H 'Content-Type: application/json' \
  -d '{
    "campaigns": [
      9135
    ]
  }'

Ответы

No content.

Информация о купоне

Запрос

Информация о купоне по его коду.

Безопасность
basicAuth
Путь
project_idintegerобязательный

ID проекта.

codestringобязательный

Код купона.

curl -i -X GET \
  -u <username>:<password> \
  'https://xsolla.redocly.app/_mock/ru/api/subscriptions/projects/{project_id}/coupons/{code}/details'

Ответы

OK.

Телоapplication/json
keystring

Ключ атрибута пользователя.

list_of_valuesArray of objects

Массив возможных значений атрибута типа enum.

nameobject

Массив локализованных названий атрибутов пользователя.

skip_condition_on_nonexistent_keyboolean

Должно ли условие пропускаться, если ключа не существует.

typestring

Тип ключа.

Перечисление"int""string""enum""date"
visibleboolean
Ответ
application/json
{
  "key": "12",
  "list_of_values": [],
  "name": {
    "en": "Level",
    "ru": "Уровень"
  },
  "skip_condition_on_nonexistent_key": true,
  "type": "int",
  "visible": false
}

Subscription management

Операции