Swagger API Личный кабинет Центр поддержки

Удаление подключения СД #

Адрес метода #

DELETE /connections/{id}

Предназначение #

Подключение помечается удаленным. Можно будет восстановить через службу поддержки.

Параметры запроса #

ПараметрОписаниеТипОбязательныйПример
idID подключенияСтрокаДа5

Пример данных запроса #

curl -X DELETE --header 'Accept: application/json' 
    --header 'Authorization: XXXXXXXXXXXXXXXXXXXX' 
       'https://api.apiship.ru/v1/connections/5'

где 5 - ID подключения.

Параметры ответа #

ПараметрОписаниеТипПример
idID подключенияСтрока1
companyIdID компанииСтрока1000
nameНазвание подключенияСтрокаОсновное подключение к службе доставки
providerKeyКод службы доставкиСтрокаcdek
connectParamsДанные берутся из метода /connections/schemasМассив строк
cashServiceRateСвоя для компании процентная ставка кассового обслуживания (%) - перекрывает общую для СДЧисло1
insuranceRateСвоя для компании процентная ставка страховки (%) - перекрывает общую для СДЧисло1
isUseBaseConnect0 - никогда не использовать базовое подключение ApiShip; 1 - подключение будет использовать базовое подключение ApiShip, т.е. передавать connectParams не нужно; 2 - будет использовано базовое подключение, если в процессе калькуляции по текущим параметрам подключения возникнет ошибка;Число0
createdДата созданияСтрока (дата-время)2015-09-10T13:02:19+03:00
updatedДата обновления (изменения)Строка (дата-время)2017-10-25T15:02:00+03:00

Пример данных ответа #

ok либо Error: Not Found.

ok - подключение пометилось удаленным. Error: Not Found - id с таким подключением не существует.