Создание заявки на вызов курьера #
Адрес метода #
Описание #
Метод вызывает курьера для забора посылок. Иногда поведение метода отличается, например, для Яндекс.Доставки.
Параметры запроса #
| Раздел | Параметр | Описание | Тип | Обязательный | Пример |
|---|---|---|---|---|---|
| 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 |
Пример данных ответа #
| |
| |
Описание логики работы метода для отдельных служб доставки #
5post #
Метод не поддерживается для данной СД. Вызов курьера согласовывается с менеджером 5post самостоятельно.
Деловые линии #
Метод не поддерживается для данной СД. Курьер вызывается автоматически при создании заказа на основе данных отправителя - sender и данных о дате и времени отгрузки - pickupDate, pickupTimeStart, pickupTimeEnd при условии, что передан параметр pickupType со значением 1 - отгрузка от двери.
Достависта #
Метод не поддерживается для данной СД. Курьер вызывается автоматически при создании заказа на основе данных отправителя - sender и данных о дате и времени отгрузки - pickupDate, pickupTimeStart, pickupTimeEnd.
КСЭ #
Метод не поддерживается для данной СД. Курьер вызывается автоматически при создании заказа на основе данных отправителя - sender и данных о дате и времени отгрузки - pickupDate, pickupTimeStart, pickupTimeEnd.
Почта России #
Курьер вызывается автоматически при создании заказа на основе данных
отправителя - sender и данных о дате и времени отгрузки - pickupDate, pickupTimeStart, pickupTimeEnd если заказ
был создан по одному из тарифов:
- Бизнес курьер
- Бизнес курьер экспресс
- Отправление EMS
В остальных случаях для вызова курьера на доступные по договору адреса необходимо вызвать метод POST /orders/waybills для создания партии и финализации. После этого можно вызвать метод вызова курьера POST /courierCall
ПЭК #
Метод не поддерживается для данной СД. Курьер вызывается автоматически при создании заказа на основе данных отправителя - sender и данных о дате и времени отгрузки - pickupDate, pickupTimeStart, pickupTimeEnd при условии, что передан параметр pickupType со значением 1 - отгрузка от двери.
СДЭК #
При создании заявки на забор груза курьером есть три возможных пути создания:
1 - При создании забора передавать все данные кроме номеров заказа - orderIds. Обычно такой путь используется в случае, если курьер осуществляет один забор с адреса за день - забор консолидированного груза. После того как курьер привозит забранное на склад - консолидация расформировывается и грузы продолжают движение уже по созданным отдельно заказам с режимом “от склада”. У курьера отображается только заявка без привязанной накладной, он заполняет накладную самостоятельно и отвозит на склад доставки в городе отправителя. В таком случае привязка к накладной не нужна.
2 - При создании забора передавать номер связанного заказа в orderIds. Такой способ используется для заказов с тарифом “от двери” - когда курьер приезжает забирать груз отдельно по нескольким заказам. Тогда каждая заявка будет иметь привязку к заказу и содержать данные отправителя.
3 - Автоматизация вызова курьера при создании заказа. Если в параметрах подключения к СДЕК установить флаг Автоматически вызывать курьера, то при создании заказа “от двери” курьер будет вызываться автоматически. В этом случае в заявке на вызов курьера будет привязка к заказу и отдельно вызывать курьера данным методом не требуется.
Яндекс.Доставка #
Курьер вызывается автоматически при создании заказа на основе данных
отправителя - sender и данных о дате и времени отгрузки - pickupDate, pickupTimeStart, pickupTimeEnd если заказ
был создан по одному из тарифов:
- Доставка в течение дня
- Экспресс грузовой
- Экспресс доставка
- Экспресс курьер
и в настройках интеграции с Яндекс.Доставка установлен флаг Автоподтверждение. В этом случае когда яндекс найдет водителя для заказа сервис ApiShip автоматически подтвердит заказ, и курьер приедет забирать груз. Если флаг Автоподтверждение не установлен, то при выставлении статуса ready_for_approval для заказа, нужно самостоятельно вызвать метод POST /yataxi/confirm для подтверждения заказа.
Для остальных тарифов нужно согласовывать вызов курьера с менеджером Яндекс.Доставки самостоятельно.