Перейти к содержимому

Введение

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

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

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

Настройка предмета акции

Запрос

Определяет тему рекламной акции. Если рекламная акция доступна только для чтения (read_only = true), вы не сможете обновить тему. Тема может принимать следующие значения: purchase, items или packages.

Внимание

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

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

ID продавца.

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

ID акции.

Телоapplication/jsonобязательный
digital_contentsobject or null
itemsArray of objects

Акция действует на указанные предметы.

packagesArray of objects or null

Акция действует на указанные пакеты виртуальной валюты.

purchaseboolean

Действует ли акция на весь заказ.

subscriptionsobject or null

Объект с информцией о рекуррентных планах или продуктах, на которые будет действовать акция.

curl -i -X PUT \
  -u <username>:<password> \
  'https://xsolla.redocly.app/_mock/ru/api/subscriptions/merchants/{merchant_id}/promotions/{promotion_id}/subject' \
  -H 'Content-Type: application/json' \
  -d '{
    "digital_contents": null,
    "items": [
      {
        "sku": "1234"
      }
    ],
    "packages": null,
    "purchase": false,
    "subscriptions": null
  }'

Ответы

No content.

Переключатель акции

Запрос

Переключает статус акции с enabled на disabled и наоборот.

Внимание

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

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

ID продавца.

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

ID акции.

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

Ответы

No content.

Операции
Операции