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

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

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

POST /courierCall

Описание #

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

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

РазделПараметрОписаниеТипОбязательныйПример
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
extraParamsнет
key: valueТип дополнительной услуги: значениестроканетlogsis.warehouse_code:123

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

 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
29
30
31
{
  "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",
  "extraParams": {
  	"logsis.warehouse_code":"123"
  }
}
 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
29
30
31
<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>
    <extraParams>
		<logsis.warehouse_code>123</logsis.warehouse_code>
	</extraParams>
</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>

Описание логики работы метода для отдельных служб доставки #

5post #

Метод не поддерживается для данной СД. Вызов курьера согласовывается с менеджером 5post самостоятельно.

Деловые линии #

Метод не поддерживается для данной СД. Курьер вызывается автоматически при создании заказа на основе данных отправителя - sender и данных о дате и времени отгрузки - pickupDate, pickupTimeStart, pickupTimeEnd при условии, что передан параметр pickupType со значением 1 - отгрузка от двери.

Достависта #

Метод не поддерживается для данной СД. Курьер вызывается автоматически при создании заказа на основе данных отправителя - sender и данных о дате и времени отгрузки - pickupDate, pickupTimeStart, pickupTimeEnd.

КСЭ #

Метод не поддерживается для данной СД. Курьер вызывается автоматически при создании заказа на основе данных отправителя - sender и данных о дате и времени отгрузки - pickupDate, pickupTimeStart, pickupTimeEnd.

Почта России #

Метод не поддерживается для данной СД. Курьер вызывается автоматически при создании заказа на основе данных отправителя - sender и данных о дате и времени отгрузки - pickupDate, pickupTimeStart, pickupTimeEnd если заказ был создан по одному из тарифов:

  • Бизнес курьер
  • Бизнес курьер экспресс
  • Отправление EMS

В остальных случаях для вызова курьера необходимо обратиться к менеджеру Почты России.

ПЭК #

Метод не поддерживается для данной СД. Курьер вызывается автоматически при создании заказа на основе данных отправителя - sender и данных о дате и времени отгрузки - pickupDate, pickupTimeStart, pickupTimeEnd при условии, что передан параметр pickupType со значением 1 - отгрузка от двери.

СДЭК #

При создании заявки на забор груза курьером есть три возможных пути создания:

1 - При создании забора передавать все данные кроме номеров заказа - orderIds. Обычно такой путь используется в случае, если курьер осуществляет один забор с адреса за день - забор консолидированного груза. После того как курьер привозит забранное на склад - консолидация расформировывается и грузы продолжают движение уже по созданным отдельно заказам с режимом “от склада”. У курьера отображается только заявка без привязанной накладной, он заполняет накладную самостоятельно и отвозит на склад доставки в городе отправителя. В таком случае привязка к накладной не нужна.

2 - При создании забора передавать номер связанного заказа в orderIds. Такой способ используется для заказов с тарифом “от двери” - когда курьер приезжает забирать груз отдельно по нескольким заказам. Тогда каждая заявка будет иметь привязку к заказу и содержать данные отправителя.

3 - Автоматизация вызова курьера при создании заказа. Если в параметрах подключения к СДЕК установить флаг Автоматически вызывать курьера, то при создании заказа “от двери” курьер будет вызываться автоматически. В этом случае в заявке на вызов курьера будет привязка к заказу и отдельно вызывать курьера данным методом не требуется.

Яндекс.Доставка #

Курьер вызывается автоматически при создании заказа на основе данных отправителя - sender и данных о дате и времени отгрузки - pickupDate, pickupTimeStart, pickupTimeEnd если заказ был создан по одному из тарифов:

  • Доставка в течение дня
  • Экспресс грузовой
  • Экспресс доставка
  • Экспресс курьер

и в настройках интеграции с Яндекс.Доставка установлен флаг Автоподтверждение. В этом случае когда яндекс найдет водителя для заказа сервис ApiShip автоматически подтвердит заказ, и курьер приедет забирать груз. Если флаг Автоподтверждение не установлен, то при выставлении статуса ready_for_approval для заказа, нужно самостоятельно вызвать метод POST /yataxi/confirm для подтверждения заказа.

Для остальных тарифов нужно согласовывать вызов курьера с менеджером Яндекс.Доставки самостоятельно.