Получение списка подключений пользовталея #

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

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

Возвращает постраничный список подключений пользователя

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

Параметр	Тип данных	Описание	Обязательность	Пример
limit	Число	Лимит по выводу (Minimum - 0, Maximum - 5000)	да	23
offset	Число	Выбора с какого эл-та начинать вывод (Minimum - 1, Maximum - 100)	да	10
filter	Строка	JSON-фильтр. Фильтрация по полям объектов. Документация работы фильтра: https://docs.apiship.ru/docs/api/query-filter/	да	{“providerKey”:“cdek”}

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

json

1
2
3
4
5
{
    "limit": "23",
    "offset": "10",
    "filter": {"providerKey":"cdek"}
}

xml

1
2
3
4
5
6
<?xml version="1.0" encoding="UTF-8"?>
<request>
   <filter>{"providerKey":"cdek"}</filter>
   <limit>23</limit>
   <offset>10</offset>
</request>

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

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

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

json

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
{
  "rows": [
    {
       "id": "5",
      "companyId": "1000",
      "name": "",
      "providerKey": "cdek",
      "connectParams": {
        "account": "ccd7ba1qawfe55048396349dcc854512",
        "password": "egsgDBGdgfbnwqe1234ac502b16",
        "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"
}

xml

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
<response>
    <rows>
        <item>
        <id>5</id>
        <companyId>1000</companyId>
        <name>
        </name>
        <providerKey>cdek</providerKey>
        <connectParams>
          <account>ccd7ba1qawfe55048396349dcc854512</account>
          <password>egsgDBGdgfbnwqe1234ac502b16</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>2015-09-10T13:02:19+03:00</created>
        <updated>2021-11-02T10:28:33+03:00</updated>
      </item>
        </item>
    </rows>
</response>