Создание заявки на вызов курьера #
Адрес метода #
Описание #
Метод вызывает курьера для забора посылок. Иногда поведение метода отличается, например, для Яндекс.Доставки.
Параметры запроса #
Раздел | Параметр | Описание | Тип | Обязательный | Пример |
---|---|---|---|---|---|
providerKey | Код службы доставки | строка | да | cdek | |
providerKey | ID подключения вашей компании к СД | число | нет | 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 | Город или населенный пункт | строка | да | Демидов | |
cityGuid | ID города в базе ФИАС | строка | нет | dd8caeab-c685-4f2a-bf5f-550aca1bbc48 | |
street | Улица | строка | да | Мелиоративная улица | |
house | Дом | строка | да | 1 | |
block | Строение/Корпус | строка | нет | с2к1 | |
office | Офис/Квартира | строка | нет | 5 | |
companyName | Название компании | строка | нет | ООО Иванов | |
contactName | ФИО контактного лица | строка | да | Иванов Иван Иванович | |
phone | Контактный телефон | строка | да | 79999999999 | |
Контактный email адрес | строка | нет | info@domain.com | ||
extraParams | нет | ||||
key: value | Тип дополнительной услуги: значение | строка | нет | logsis.warehouse_code:123 |
Пример запроса #
|
|
|
|
Параметры ответа #
Параметр | Описание | Тип | Обязательный | Пример |
---|---|---|---|---|
id | массив ID заказов в системе ApiShip | число | нет | 125255 |
providerNumber | массив ID заказов в системе клиента | строка | нет | 83197 |
created | Дата создания заказа | строка | нет | 2021-03-03T12:38:22+03:00 |
Пример данных ответа #
|
|
|
|
Яндекс.Доставка #
Если у клиента есть складской процесс, то он может не выдерживать требования Яндекс.Доставки на интервал 10 минут между созданием и подтверждением заявки. Поэтому метод вызова курьера обновляет переданные заказы в системе СД с повышением версии без изменения данных, далее при выставлении статуса ready_for_approval
автоматически вызывается метод для подтверждения заказа.