Прекращение отношений партнерства

Запрос: POST v2/invitations/break

HTTP-заголовки:

Authorization: Bearer access_token
Content-Type: application/json
Accept: application/json

Тело запроса:

{
    "BoxId": "string",              // "наш" ящик, из которого мы прекращаем отношения партнерства
    "ContractorBoxId": "string"     // идентификатор ящика контрагента
}

Описание запроса

Запрос позволяет прекратить установленные ранее отношения партнерства с одним контрагентом.

Отношения прекращаются от имени какого-то «нашего» ящика, т. е. ящика, настроенного в Продукте. Идентификатор «нашего» ящика задается в поле BoxId.

Контрагент, отношения с которым прекращаются, задается полем ContractorBoxId.

Когда можно отправлять запрос

Прекращать отношения партнерства можно, если текущий статус отношений партнерства с контрагентом - «Отношения партнерства установлены» (код статуса CV). Для получения статуса следует запросить данные контрагента.

Ответ на запрос

Прекращение отношений партнерства выполняется асинхронно. В случае успешного выполнения запроса ставится задача на прекращение отношений партнерства. Идентификатор задачи не возвращается.

Статус задачи

Отдельный запрос для получения статуса задачи на прекращение отношений партнерства не предусмотрен.

По результатам обработки задачи интеграционным модулем для контрагента поступит новый статус. Для получения статуса следует повторно запросить данные контрагента.

Если задача была обработана успешно, то поступит статус «Отношение партнерства не установлены» (код статуса CX).

Если задача была обработана с ошибкой, то поступит статус «Ошибка» (код статуса E).