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

Введение

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

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

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

Запрос

Обновляет акцию. Если акция доступна только для чтения (read_only = true), вам не разрешается изменять параметр project_id.

Внимание

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

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

ID продавца.

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

ID акции.

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

Массив локализованных описаний акции.

description.​arstring

Арабский.

description.​bgstring

Болгарский.

description.​cnstring

Китайский упрощенный.

description.​csstring

Чешский.

description.​destring

Немецкий.

description.​enstring

Английский.

description.​esstring

Испанский.

description.​frstring

Французский.

description.​hestring

Иврит.

description.​itstring

Итальянский.

description.​jastring

Японский.

description.​kostring

Корейский.

description.​plstring

Польский.

description.​ptstring

Португальский.

description.​rostring

Румынский.

description.​rustring

Русский.

description.​thstring

Тайский.

description.​trstring

Турецкий.

description.​twstring

Китайский традиционный.

description.​vistring

Вьетнамский.

labelobject

Массив локализованных лейблов, будут показаны в платежном интерфейсе.

label.​arstring

Арабский.

label.​bgstring

Болгарский.

label.​cnstring

Китайский упрощенный.

label.​csstring

Чешский.

label.​destring

Немецкий.

label.​enstring

Английский.

label.​esstring

Испанский.

label.​frstring

Французский.

label.​hestring

Иврит.

label.​itstring

Итальянский.

label.​jastring

Японский.

label.​kostring

Корейский.

label.​plstring

Польский.

label.​ptstring

Португальский.

label.​rostring

Румынский.

label.​rustring

Русский.

label.​thstring

Тайский.

label.​trstring

Турецкий.

label.​twstring

Китайский традиционный.

label.​vistring

Вьетнамский.

nameobject

Массив локализованных названий акции.

name.​arstring

Арабский.

name.​bgstring

Болгарский.

name.​cnstring

Китайский упрощенный.

name.​csstring

Чешский.

name.​destring

Немецкий.

name.​enstring

Английский.

name.​esstring

Испанский.

name.​frstring

Французский.

name.​hestring

Иврит.

name.​itstring

Итальянский.

name.​jastring

Японский.

name.​kostring

Корейский.

name.​plstring

Польский.

name.​ptstring

Португальский.

name.​rostring

Румынский.

name.​rustring

Русский.

name.​thstring

Тайский.

name.​trstring

Турецкий.

name.​twstring

Китайский традиционный.

name.​vistring

Вьетнамский.

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

ID проекта.

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

Техническое название акции.

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

Ответы

No content.

Список платежных систем

Запрос

Получает доступ к платежным системам, поддерживаемым в рамках акции. Если список пуст, акция будет распространяться на все платежные системы.

Внимание

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

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

ID продавца.

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

ID акции.

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

Ответы

OK.

Телоapplication/json
idinteger
payment_systemsArray of objects

Платежные системы.

payment_systems[].​idinteger

Уникальный ID платежной системы.

payment_systems[].​namestring

Название платежной системы.

Ответ
application/json
{ "id": 17840, "payment_systems": [ {} ] }

Настройка способов оплаты

Запрос

Определяет платежные системы, поддерживаемые для акции. Если список пуст, акция будет применяться ко всем платежным системам. Если акция доступна только для чтения (read_only = true), вы не сможете использовать этот метод.

Внимание

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

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

ID продавца.

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

ID акции.

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

Платежные системы.

payment_systems[].​idinteger

Уникальный ID платежной системы.

payment_systems[].​namestring

Название платежной системы.

curl -i -X PUT \
  -u <username>:<password> \
  'https://xsolla.redocly.app/_mock/ru/api/subscriptions/merchants/{merchant_id}/promotions/{promotion_id}/payment_systems' \
  -H 'Content-Type: application/json' \
  -d '{
    "payment_systems": [
      {
        "id": 24,
        "name": "PayPal"
      }
    ]
  }'

Ответы

No content.

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