Page tree
Skip to end of metadata
Go to start of metadata

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

Условия формирования заявки:

  • забор консолидированного груза в один день с одного адреса возможен только единожды;

  • количество выездов курьера на один адрес в один день для штучного забора не ограничен;
  • рекомендуемый минимальный диапазон времени для приезда курьера не менее 3х часов.

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

Для использования необходимо отправить POST-запрос на URL:

Тело запроса

Необходимо передавать в формате JSON (Content-Type: application/json).

Поддерживаются следующие поля:

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

Описание

Тип поля

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

1

cdek_number1Номер заказа СДЭКlongнет
2order_uuid1Идентификатор заказа в ИС СДЭКUUIDнет
3intake_date

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

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

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

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

timeда
5intake_time_toВремя окончания ожидания курьераtimeда
6lunch_time_fromВремя начала обеда, должно входить в диапозон [intake_time_to;intake_time_to]timeнет
7lunch_time_toВремя окончания обеда, должно входить в диапозон [intake_time_to;intake_time_to]timeнет
8nameОписание груза
Необходимо заполнять, если не передан номер заказа. Иначе значение берется из заказа.
stringда, если не передан номер заказа
9weightОбщий вес (в граммах)
Необходимо заполнять, если не передан номер заказа. Иначе значение берется из заказа.
integerда, если не передан номер заказа
10lengthГабариты упаковки. Длина (в сантиметрах)
Необходимо заполнять, если не передан номер заказа. Иначе значение берется из заказа.
integerда, если указаны остальные габариты
11widthГабариты упаковки. Ширина (в сантиметрах)
Необходимо заполнять, если не передан номер заказа. Иначе значение берется из заказа.
integerда, если указаны остальные габариты
12heightГабариты упаковки. Высота (в сантиметрах)
Необходимо заполнять, если не передан номер заказа. Иначе значение берется из заказа.
integerда, если указаны остальные габариты
13commentКомментарий к заявке для курьераstringнет
14senderОтправитель
Необходимо заполнять, если не передан номер заказа. Иначе значение берется из заказа.
contactда, если не передан номер заказа
14.1companyНазвание компании отправителяstring(255)нет
14.2nameФИО контактного лицаstring(255)да
14.3phonesСписок телефоновphone[]да, если при регистрации заказа не был указан номер отправителя
14.3.1numberНомер телефона string(255)да
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Код страны (двухбуквенный из международного справочника)string(2)нет
15.7regionНазвание регионаstring(255)нет
15.8region_codeКод региона СДЭКintegerнет
15.9sub_regionНазвание района регионаstring(255)нет
15.10cityНазвание городаstring(255)нет
15.11kladr_codeКод КЛАДРstring(255)нет
15.12addressСтрока адресаstring(255)да
16need_callНеобходим прозвон отправителя (по умолчанию - false)booleanнет

1 Если не передан cdek_number и order_uuid, то создается заявка на забор консолидированного груза. 

2 Идентификация города производится по следующему алгоритму в порядке приоритетности:

  • По уникальному коду города из базы СДЭК. Коды городов базы СДЭК можно найти по ссылке https://cdek.ru/storage/source/document/1/CDEK_city.zip. Значения передаются в атрибутах from_location.code и to_location.code.
  • По уникальному идентификатору ФИАС (код адресного объекта, подробнее: https://fias.nalog.ru/). Значения передаются в атрибутах from_location.fias_guid и to_location.fias_guid. 
  • По почтовому индексу города. Значения передаются в атрибутах from_location.postal_code и to_location.postal_code. 
  • По коду страны, названию региона и названию города: from_location.country_code +  from_location.region +  from_location.city и to_location.country_code +  to_location.region +  to_location.city. Также в качестве уточняющего параметра может быть передан район региона - from_location.sub_region и to_location.sub_region.
  • По координатам: необходимо передавать значения долготы - from_location_longitude и to_location_longitude и широты - from_location_latitude и to_location_latitude.
  • По строке адреса. Значения передаются в атрибутах from_location.address и to_location.address. В качестве уточняющего параметра может быть передан код КЛАДР (подробнее: https://kladr-rf.ru/).

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

Ответ возвращается в формате 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": []
        }
    ]
}



  • No labels