Регистрация заявки на вызов курьера
Метод позволяет осуществить вызов курьера для забора груза со склада ИМ с последующей доставкой до склада СДЭК.
Рекомендуемый минимальный диапазон времени для приезда курьера не менее 3х часов.
Запрос на регистрацию заявки на вызов курьера
Для использования необходимо отправить POST-запрос на URL:
Среда | URL |
---|---|
тестовая | https://api.edu.cdek.ru/v2/intakes |
боевая | https://api.cdek.ru/v2/intakes |
Тело запроса
Необходимо передавать в формате JSON (Content-Type: application/json).
Поддерживаются следующие поля:
№ | Название поля | Описание | Тип поля | Обяз. для заполн. |
---|---|---|---|---|
1 | cdek_number1 | Номер заказа СДЭК | string | нет |
2 | order_uuid1 | Идентификатор заказа в ИС СДЭК | UUID | нет |
3 | intake_date | Дата ожидания курьера Дата ожидания курьера не может быть больше текущей более чем на 31 день. | date (yyyy-MM-dd) | да |
4 | intake_time_from | Время начала ожидания курьера Не ранее 9:00 местного времени | time | да |
5 | intake_time_to | Время окончания ожидания курьера Не позднее 22:00 местного времени | time | да |
6 | lunch_time_from | Время начала обеда, должно входить в диапазон [intake_time_from; intake_time_to] | time | нет |
7 | lunch_time_to | Время окончания обеда, должно входить в диапазон [intake_time_from; intake_time_to] | time | нет |
8 | name | Описание груза Необходимо заполнять, если не передан номер заказа. Иначе значение берется из заказа. | string | да, если не передан номер заказа |
9 | weight | Общий вес (в граммах) Необходимо заполнять, если не передан номер заказа. Иначе значение берется из заказа. | integer | да, если не передан номер заказа |
10 | length | Габариты упаковки. Длина (в сантиметрах) Необходимо заполнять, если не передан номер заказа. Иначе значение берется из заказа. | integer | да, если указаны остальные габариты |
11 | width | Габариты упаковки. Ширина (в сантиметрах) Необходимо заполнять, если не передан номер заказа. Иначе значение берется из заказа. | integer | да, если указаны остальные габариты |
12 | height | Габариты упаковки. Высота (в сантиметрах) Необходимо заполнять, если не передан номер заказа. Иначе значение берется из заказа. | integer | да, если указаны остальные габариты |
13 | comment | Комментарий к заявке для курьера | string(255) | нет |
14 | sender | Отправитель Необходимо заполнять, если не передан номер заказа. Иначе значение берется из заказа. | contact | да, если не передан номер заказа |
14.1 | company | Название компании отправителя | string(255) | нет |
14.2 | name | ФИО контактного лица | string(255) | да |
14.3 | phones | Список телефонов Не более 10 номеров | phone[] | да, если при регистрации заказа не был указан номер отправителя |
14.3.1 | number* | Номер телефона | string(24) | да |
14.3.2 | additional | Дополнительная информация (добавочный номер) | string(255) | нет |
15 | from_location2 | Адрес отправителя (забора) Необходимо заполнять, если не передан номер заказа. Иначе значение берется из заказа. | location | да, если не передан номер заказа |
15.1 | code | Код населенного пункта СДЭК (метод "Список населенных пунктов") | integer | нет |
15.2 | fias_guid | Уникальный идентификатор ФИАС | UUID | нет |
15.3 | postal_code | Почтовый индекс | string(255) | нет |
15.4 | longitude | Долгота | float | нет |
15.5 | latitude | Широта | float | нет |
15.6 | country_code | Код страны (Двухбуквенный из международного справочника. По умолчанию RU) | string(2) | нет |
15.7 | region | Название региона, уточняющий параметр для поля city. Нельзя передавать без city | string(255) | нет |
15.8 | region_code | Код региона СДЭК, уточняющий параметр для поля city. Нельзя передавать без city | integer | нет |
15.9 | sub_region | Название района региона, уточняющий параметр для поля region. Нельзя передавать без region | string(255) | нет |
15.10 | city | Название города, уточняющий параметр для postal_code. Можно передавать без postal_code | string(255) | нет |
15.11 | kladr_code | Код КЛАДР Устаревшее поле | string(255) | нет |
15.12 | address | Строка адреса | string(255) | да |
16 | need_call | Необходим прозвон отправителя (по умолчанию - false) | boolean | нет |
17 | courier_power_of_attorney | Курьеру необходима доверенность (по умолчанию - false) | boolean | нет |
18 | courier_identity_card | Курьеру необходим документ удостоверяющий личность (по умолчанию - false) | boolean | нет |
1 Если не передан cdek_number и order_uuid, то создается заявка на забор консолидированного груза.
2 Идентификация города производится по следующему алгоритму в порядке приоритетности:
• По уникальному коду населенного пункта СДЭК. Значения передаются в атрибутах и to_location.code.
• По уникальному идентификатору ФИАС (код адресного объекта, подробнее: https://fias.nalog.ru/). Значения передаются в атрибутах from_location.fias_guid и to_location.fias_guid.
• По почтовому индексу города, коду страны, названию региона и названию города: *_location.code + *_location.country_code + *_location.region + *_location.city. Также в качестве уточняющего параметра может быть передан район региона: *_location.sub_region.
• По строке адреса. Если атрибуты, используемые в предыдущем пункте не пустые, то из них формируется адресная строка + используется атрибут *_location.address, если он не пуст. Этот поиск работает только по территории России.
• По координатам: необходимо передавать значения долготы - *_location_longitude и to_location_longitude и широты - *_location_latitude и to_location_latitude.
(*) Номер телефона отправителя валидируется на соответствие формату телефонов в стране отправителя (телефонный код, количество символов).
Ответ на регистрацию заявки на вызов курьера
Ответ возвращается в формате JSON:
№ | Название поля | Описание | Тип поля | Обяз. для заполн. |
---|---|---|---|---|
1 | entity | Информация о заявке | entity | нет |
1.1 | uuid | Идентификатор заявки в ИС СДЭК | UUID | нет |
2 | requests | Информация о запросе над заявкой | request[] | да |
2.1 | request_uuid | Идентификатор запроса в ИС СДЭК | UUID | нет |
2.2 | type | Тип запроса Может принимать значения: CREATE, UPDATE, DELETE, AUTH, GET | string() | да |
2.3 | date_time | Дата и время установки текущего состояния запроса (формат yyyy-MM-dd'T'HH:mm:ssZ) | datetime | да |
2.4 | state | Текущее состояние запроса ACCEPTED - пройдена предварительная валидация и запрос принят | string() | да |
2.5 | errors | Ошибки, возникшие в ходе выполнения запроса | error[] | нет |
2.5.1 | code | Код ошибки | string() | да |
2.5.2 | message | Описание ошибки | string() | да |
2.6 | warnings | Предупреждения, возникшие в ходе выполнения запроса | warning[] | нет |
2.6.1 | code | Код предупреждения | string() | да |
2.6.2 | message | Описание предупреждения | string() | да |
Полученный uuid необходимо использовать в методе "Информация по заявке" для получения номера заявки в ИС СДЭК |
{ "intake_date": "2019-10-02", "intake_time_from": "10:00", "intake_time_to": "17:00", "name": "Консолидированный груз", "weight": 1000, "length": 10, "width": 10, "height": 10, "comment": "Комментарий курьеру", "sender": { "company": "Компания", "name": "Иванов Иван", "phones": [ { "number": "+79589441654" } ] }, "from_location": { "code": "44", "fias_guid": "0c5b2444-70a0-4932-980c-b4dc0d3f02b5", "postal_code": "109004", "longitude": 37.6204, "latitude": 55.754, "country_code": "RU", "region": "Москва", "sub_region": "Москва", "city": "Москва", "kladr_code": "7700000000000", "address": "ул. Блюхера, 32" }, "need_call": false } |
{ "entity": { "uuid": "72753031-8f2c-4d67-9511-8c81b6e15919" }, "requests": [ { "request_uuid": "72753031-bc35-4bea-924d-3ad0ed60b7aa", "type": "CREATE", "state": "ACCEPTED", "date_time": "2020-02-10T12:00:23+0700", "errors": [], "warnings": [] } ] } |
© 2000—2023, Курьерская компания СДЭК