Swagger API Личный кабинет Центр поддержки
  • Languages Русский

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

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

POST /connections

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

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

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

ПараметрТип данныхОписаниеОбязательностьПример
providerKeyСтрокаКод службы доставкидаcdek
nameCтрокаНазвание подключениядаОсновное подключение к службе доставки
innСтрокаИНН вашей компаниида
insuranceRateЧислоСвоя для компании процентная ставка страховки (%) - перекрывает общую для СДда1
cashServiceRateЧислоСвоя для компании процентная ставка кассового обслуживания (%) - перекрывает общую для СДда0
connectParamsМассив строкДанные берутся из метода /connections/schemasда
isUseBaseConnectЧисло0 - никогда не использовать базовое подключение ApiShip; 1 - подключение будет использовать базовое подключение ApiShip, т.е. передавать connectParams не нужно; 2 - будет использовано базовое подключение, если в процессе калькуляции по текущим параметрам подключения возникнет ошибка;да0

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

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19

{
  "providerKey": "cdek",
  "name": "Основное подключение к службе доставки",
  "inn": "1234567890",
  "insuranceRate": 0,
  "cashServiceRate": 0,
  "connectParams": {
        "account": "4kPTTTcFWnVCafwag15rIlv90C9WudrzA",
        "password": "3qzGFeFB62awfaawefgo7yjyYNyIjxrZwz",
        "labelSize": "disable",
        "printCount": "2",
        "sendSender": "1",
        "callCourier": false,
        "sendDeliveryAsItem": false,
        "notSendItemArticle": false,
        "test": false
      },
  "isUseBaseConnect": 0
}

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20

<?xml version="1.0" encoding="UTF-8"?>
<Connection>
	<providerKey>cdek</providerKey>
	<name>Основное подключение к службе доставки</name>
    <inn>1234567890</inn>
	<insuranceRate>0</insuranceRate>
	<cashServiceRate>0</cashServiceRate>
	<connectParams>
		<account>4kPTTTcFWnVCafwag15rIlv90C9WudrzA</account>
		<password>3qzGFeFB62awfaawefgo7yjyYNyIjxrZwz</password>
		<labelSize>disable</labelSize>
        <printCount>2</printCount>
        <sendSender>1</sendSender>
        <callCourier>false</callCourier>
        <sendDeliveryAsItem>false</sendDeliveryAsItem>
        <notSendItemArticle>false</notSendItemArticle>
        <test>false</test>
	</connectParams>
	<isUseBaseConnect>0</isUseBaseConnect>
</Connection>

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

ПараметрОписаниеТипПример
idID подключенияСтрока1
companyIdID компанииСтрока1000
nameНазвание подключенияСтрокаОсновное подключение к службе доставки
innИНН вашей компанииСтрока1234567890
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

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

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23

{
      "id": "5",
      "companyId": "1000",
      "name": "Основное подключение к службе доставки",
      "inn": "1234567890",
      "providerKey": "cdek",
      "connectParams": {
        "account": "4kPTTTcFWnVCafwag15rIlv90C9WudrzA",
        "password": "3qzGFeFB62awfaawefgo7yjyYNyIjxrZwz",
        "labelSize": "A6",
        "printCount": "2",
        "sendSender": "1",
        "callCourier": false,
        "sendDeliveryAsItem": false,
        "notSendItemArticle": false,
        "test": false
      },
      "cashServiceRate": 0,
      "insuranceRate": 0,
      "isUseBaseConnect": 0,
      "created": "2015-09-10T13:02:19+03:00",
      "updated": "2021-11-02T10:28:33+03:00"
}

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24

<?xml version="1.0" encoding="UTF-8"?>
  <response>
    <id>5</id>
    <companyId>1000</companyId>
    <name>Основное подключение к службе доставки</name>
    <inn>1234567890</inn>
    <providerKey>cdek</providerKey>
    <connectParams>
      <account>4kPTTTcFWnVCafwag15rIlv90C9WudrzA</account>
      <password>3qzGFeFB62awfaawefgo7yjyYNyIjxrZwz</password>
      <labelSize>A6</labelSize>
      <printCount>2</printCount>
      <sendSender>1</sendSender>
      <callCourier>false</callCourier>
      <sendDeliveryAsItem>false</sendDeliveryAsItem>
      <notSendItemArticle>false</notSendItemArticle>
      <test>false</test>
    </connectParams>
    <cashServiceRate>0</cashServiceRate>
    <insuranceRate>0</insuranceRate>
    <isUseBaseConnect>0</isUseBaseConnect>
    <created>2021-11-09T13:57:38+03:00</created>
    <updated>2021-11-09T13:57:38+03:00</updated>
  </response>