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

Создание заявки на вызов курьера #

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

POST /courierCall

Описание #

Метод вызывает курьера для забора посылок. Иногда поведение метода отличается, например, для Yandex.Go доставки.

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

ПараметрОписаниеТипОбязательныйПример
providerKeyКод службы доставкистрокадаcdek
providerKeyID подключения вашей компании к СДчислонетXXX
dateДата отгрузкистрокада2021-03-03
timeStartНачальное время отгрузкистрокада15:10
timeEndКонечное время отгрузкистрокада18:10
weightВес всего заказа (в граммах)числода1500
widthШирина заказа (в сантиметрах)числода25
heightВысота заказа (в сантиметрах)числода20
lengthДлина заказа (в сантиметрах)числода30
orderIdsНомера заказов которые планируются передать с этим курьероммассив чиселда125255
postIndexПочтовый индексчислонет162604
countryCodeКод страны в соответствии с ISO 3166-1 alpha-2строканетRU”
regionОбласть или республика или крайстрокадаСмоленская область
areaРайонстроканетДемидовский район
cityГород или населенный пунктстрокадаДемидов
cityGuidID города в базе ФИАСстроканетdd8caeab-c685-4f2a-bf5f-550aca1bbc48
streetУлицастрокадаМелиоративная улица
houseДомстрокада1
blockСтроение/Корпусстроканетс2к1
officeОфис/Квартирастроканет5
companyNameНазвание компаниистроканетООО Иванов
contactNameФИО контактного лицастрокадаИванов Иван Иванович
phoneКонтактный телефонстрокада79999999999
emailКонтактный email адресстроканетinfo@domain.com

Пример запроса #

 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
{
  "providerKey": "cdek",
  "providerConnectId": 12345,
  "date": "2021-03-03",
  "timeStart": "15:10",
  "timeEnd": "18:10",
  "weight": 1500,
  "width": 25,
  "height": 20,
  "length": 30,
  "orderIds": [
   125255
  ],
  "postIndex": "162604",
  "countryCode": "RU",
  "region": "Смоленская область",
  "area": "Демидовский район",
  "city": "Демидов",
  "cityGuid": "dd8caeab-c685-4f2a-bf5f-550aca1bbc48",
  "street": "Мелиоративная улица",
  "house": "1",
  "block": "с2к1",
  "office": "5",
  "companyName": "ООО Иванов",
  "contactName": "Иванов Иван Иванович",
  "phone": "79999999999",
  "email": "info@domain.com"
}
 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
<request>
   <area>Демидовский район</area>
   <block>с2к1</block>
   <city>Демидов</city>
   <cityGuid>dd8caeab-c685-4f2a-bf5f-550aca1bbc48</cityGuid>
   <companyName>ООО Иванов</companyName>
   <contactName>Иванов Иван Иванович</contactName>
   <countryCode>RU</countryCode>
   <date>2021-03-03</date>
   <email>info@domain.com</email>
   <height>20</height>
   <house>1</house>
   <length>30</length>
   <office>5</office>
   <orderIds>
      <element>125255</element>
   </orderIds>
   <phone>79999999999</phone>
   <postIndex>162604</postIndex>
   <providerConnectId>12345</providerConnectId>
   <providerKey>cdek</providerKey>
   <region>Смоленская область</region>
   <street>Мелиоративная улица</street>
   <timeEnd>18:10</timeEnd>
   <timeStart>15:10</timeStart>
   <weight>1500</weight>
   <width>25</width>
</request>

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

ПараметрОписаниеТипОбязательныйПример
idмассив ID заказов в системе ApiShipчислонет125255
providerNumberмассив ID заказов в системе клиентастроканет83197
createdДата создания заказастроканет2021-03-03T12:38:22+03:00

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

1
2
3
4
5
{
 "id": 125255,
 "providerNumber": "83197",
 "created": "2021-03-03T12:38:22+03:00"
}
1
2
3
4
5
<responce>
   <created>2021-03-03T12:38:22+03:00</created>
   <id>125255</id>
   <providerNumber>83197</providerNumber>
</responce>

Yandex.Go #

Если у клиента есть складкой процесс, то он может не выдерживать требования Yandex.Go на интервал 10 минут между созданием и подтверждением заявки. Поэтому метод вызова курьера обновляет переданные заказы в системе СД с повышением версии без изменения данных, далее при выставлении статуса ready_for_approval автоматически вызывается метод для подтверждения заказа.