Регистрация заявки на вызов курьера


 

Метод позволяет осуществить вызов курьера для забора груза со склада ИМ с последующей доставкой до склада СДЭК.

Рекомендуемый минимальный диапазон времени для приезда курьера не менее 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нет
2order_uuid1Идентификатор заказа в ИС СДЭКUUIDнет
3intake_date

Дата ожидания курьера

Дата ожидания курьера не может быть больше текущей более чем на 31 день.
Заявка, созданная на текущую дату после 15:00 по времени отправителя, может быть выполнена на следующий день

date (yyyy-MM-dd)да
4intake_time_from

Время начала ожидания курьера

Не ранее 9:00 местного времени

timeда
5intake_time_to

Время окончания ожидания курьера

Не позднее 22:00 местного времени

timeда
6lunch_time_fromВремя начала обеда, должно входить в диапазон [intake_time_from; intake_time_to]timeнет
7lunch_time_toВремя окончания обеда, должно входить в диапазон [intake_time_from; intake_time_to]timeнет
8nameОписание груза
Необходимо заполнять, если не передан номер заказа. Иначе значение берется из заказа.
stringда, если не передан номер заказа
9weightОбщий вес (в граммах)
Необходимо заполнять, если не передан номер заказа. Иначе значение берется из заказа.
integerда, если не передан номер заказа
10lengthГабариты упаковки. Длина (в сантиметрах)
Необходимо заполнять, если не передан номер заказа. Иначе значение берется из заказа.
integerда, если указаны остальные габариты
11widthГабариты упаковки. Ширина (в сантиметрах)
Необходимо заполнять, если не передан номер заказа. Иначе значение берется из заказа.
integerда, если указаны остальные габариты
12heightГабариты упаковки. Высота (в сантиметрах)
Необходимо заполнять, если не передан номер заказа. Иначе значение берется из заказа.
integerда, если указаны остальные габариты
13commentКомментарий к заявке для курьераstring(255)нет
14senderОтправитель
Необходимо заполнять, если не передан номер заказа. Иначе значение берется из заказа.
Если номер заказа передан, данные об отправителе будут взяты из этого заказа. 
contactда, если не передан номер заказа
14.1companyНазвание компании отправителяstring(255)нет
14.2nameФИО контактного лицаstring(255)да
14.3phones

Список телефонов

Не более 10 номеров

phone[]да, если при регистрации заказа не был указан номер отправителя
14.3.1number*Номер телефонаstring(24)да
14.3.2additionalДополнительная информация (добавочный номер)string(255)нет
15from_location2Адрес отправителя (забора)
Необходимо заполнять, если не передан номер заказа. Иначе значение берется из заказа.
locationда, если не передан номер заказа
15.1codeКод населенного пункта СДЭК (метод "Список населенных пунктов")integerнет
15.2fias_guidУникальный идентификатор ФИАСUUIDнет
15.3postal_codeПочтовый индексstring(255)нет
15.4longitudeДолготаfloatнет
15.5latitudeШиротаfloatнет
15.6country_codeКод страны (Двухбуквенный из международного справочника. По умолчанию RU)string(2)нет
15.7regionНазвание региона, уточняющий параметр для поля city. Нельзя передавать без citystring(255)нет
15.8region_codeКод региона СДЭК, уточняющий параметр для поля city. Нельзя передавать без cityintegerнет
15.9sub_regionНазвание района региона, уточняющий параметр для поля region. Нельзя передавать без regionstring(255)нет
15.10cityНазвание города, уточняющий параметр для postal_code. Можно передавать без postal_codestring(255)нет
15.11kladr_code

Код КЛАДР 

Устаревшее поле

string(255)нет
15.12addressСтрока адреса string(255)да
16need_callНеобходим прозвон отправителя (по умолчанию - false)booleanнет
17courier_power_of_attorneyКурьеру необходима доверенность (по умолчанию - false)boolean нет
18courier_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:

Название поля

Описание

Тип поля

Обяз. для заполн.

1entityИнформация о заявкеentityнет
1.1uuidИдентификатор заявки в ИС СДЭКUUIDнет
2requestsИнформация о запросе над заявкойrequest[]да
2.1request_uuidИдентификатор запроса в ИС СДЭКUUIDнет
2.2typeТип запроса
Может принимать значения: CREATE, UPDATE, DELETE, AUTH, GET
string()да
2.3date_timeДата и время установки текущего состояния запроса (формат yyyy-MM-dd'T'HH:mm:ssZ)datetimeда
2.4state

Текущее состояние запроса
Может принимать значения: 

ACCEPTED - пройдена предварительная валидация и запрос принят
WAITING - запрос ожидает обработки (зависит от выполнения другого запроса)
SUCCESSFUL - запрос обработан успешно
INVALID - запрос обработался с ошибкой

string()да
2.5errorsОшибки, возникшие в ходе выполнения запросаerror[]нет
2.5.1codeКод ошибкиstring()да
2.5.2messageОписание ошибкиstring()да
2.6warningsПредупреждения, возникшие в ходе выполнения запросаwarning[]нет
2.6.1codeКод предупрежденияstring()да
2.6.2messageОписание предупреждения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—2024, Курьерская компания СДЭК