Получение подключения СД #

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

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

Возвращает информацию по подключению службы доставки

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

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

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

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

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

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

Параметр	Описание	Тип	Пример
id	ID подключения	Строка	1
companyId	ID компании	Строка	1000
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": "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"
}

xml

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
<?xml version="1.0" encoding="UTF-8"?>
  <response>
    <id>5</id>
    <companyId>1000</companyId>
    <name>Основное подключение к службе доставки</name>
    <providerKey>cdek</providerKey>
    <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>
    <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>