Информация о заявке
Метод предназначен для получения информации по заданной заявке.
Запрос на получение информации о заявке
Для использования необходимо отправить GET-запрос на URL:
Среда | URL |
---|---|
тестовая | https://api.edu.cdek.ru/v2/intakes/{uuid} |
боевая | https://api.cdek.ru/v2/intakes/{uuid} |
{uuid} - идентификатор заявки в ИС СДЭК, по которому необходима информация
Ответ на получение информации о заявке
Ответ возвращается в формате JSON:
№ | Название поля | Описание | Тип поля | Обяз. для заполн. |
---|---|---|---|---|
1 | entity | Информация о заявке | entity | нет |
1.1 | uuid | Идентификатор заявки в ИС СДЭК | UUID | да |
1.2 | intake_number | Номер заявки СДЭК на вызов курьера | long | нет |
1.3 | cdek_number | Номер заказа СДЭК | long | нет |
1.4 | order_uuid | Идентификатор заказа в ИС СДЭК | UUID | нет |
1.5 | intake_date | Дата ожидания курьера | date (yyyy-MM-dd) | да |
1.6 | intake_time_from | Время начала ожидания курьера | time | да |
1.7 | intake_time_to | Время окончания ожидания курьера | time | да |
1.8 | lunch_time_from | Время начала обеда, должно входить в диапозон [intake_time_from; intake_time_to] | time | нет |
1.9 | lunch_time_to | Время окончания обеда, должно входить в диапозон [intake_time_from; intake_time_to] | time | нет |
1.10 | name | Описание груза | string | нет |
1.11 | weight | Общий вес (в граммах) | integer | нет |
1.12 | length | Габариты упаковки. Длина (в сантиметрах) | integer | нет |
1.13 | width | Габариты упаковки. Ширина (в сантиметрах) | integer | нет |
1.14 | height | Габариты упаковки. Высота (в сантиметрах) | integer | нет |
1.15 | comment | Комментарий к заявке для курьера | string(255) | нет |
1.16 | sender | Отправитель | contact | нет |
1.16.1 | company | Название компании отправителя | string(255) | нет |
1.16.2 | name | ФИО контактного лица | string(255) | да |
1.16.3 | phones | Список телефонов Не более 10 номеров | phone[] | да |
1.16.3.1 | number | Номер телефона | string(24) | да |
1.16.3.2 | additional | Дополнительная информация (добавочный номер) | string(255) | нет |
1.17 | from_location | Адрес отправителя (забора) | location | да |
1.17.1 | code | Код населенного пункта СДЭК (метод "Список населенных пунктов") | integer | да |
1.17.2 | fias_guid | Уникальный идентификатор ФИАС | UUID | нет |
1.17.3 | postal_code | Почтовый индекс | string(255) | нет |
1.17.4 | longitude | Долгота | float | нет |
1.17.5 | latitude | Широта | float | нет |
1.17.6 | country_code | Код страны (двухбуквенный из международного справочника) | string(2) | да |
1.17.7 | region | Название региона | string(255) | нет |
1.17.8 | region_code | Код региона (справочник СДЭК) | integer | нет |
1.17.9 | sub_region | Название района региона | string(255) | нет |
1.17.10 | city | Название города | string(255) | да |
1.17.11 | kladr_code | Код КЛАДР Устаревшее поле | string(255) | нет |
1.17.12 | address | Строка адреса | string(255) | да |
1.18 | need_call | Необходим прозвон отправителя (по умолчанию - false) | boolean | нет |
1.19 | statuses | Статус по заявке | status[] | да |
1.19.1 | code | Код статуса (подробнее см. приложение 1) | string() | да |
1.19.2 | name | Название статуса | string() | да |
1.19.3 | date_time | Дата и время установки статуса (формат yyyy-MM-dd'T'HH:mm:ssZ) | datetime | да |
1.20 | courier_power_of_attorney | Курьеру необходима доверенность (по умолчанию - false) | boolean | нет |
1.21 | courier_identity_card | Курьеру необходим документ удостоверяющий личность (по умолчанию - false) | boolean | нет |
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() | да |
https://api.cdek.ru/v2/intakes/72753031-0525-4aa4-9629-d6ae52e825f5 |
{ "entity": { "uuid": "72753031-157e-4fad-8a96-c36742ba4f15", "intake_date": "2020-02-07", "intake_number": "13271458", "intake_time_from": "10:00", "intake_time_to": "17:00", "lunch_time_from": "14:00", "lunch_time_to": "15:00", "name": "Покемоны", "weight": 1000, "length": 10, "width": 10, "height": 10, "comment": "Hello, World", "sender": { "company": "", "name": "Князев Олег Борисович", "phones": [ { "number": "+79589441654" } ], "tin": "1234567890" }, "from_location": { "code": "44", "postal_code": "109004", "country_code": "RU", "fias_guid": "0c5b2444-70a0-4932-980c-b4dc0d3f02b5", "kladr_code": "7700000000000", "country": "Россия", "region": "Москва", "region_code": "81", "sub_region": "Москва", "city": "Москва", "address": "ул. Блюхера, 32", "longitude": 37.6204, "latitude": 55.754 }, "need_call": false, "statuses": [ { "code": "ACCEPTED", "name": "Принят", "date_time": "2020-02-06T12:02:28+0700" }, { "code": "CREATED", "name": "Создан", "date_time": "2020-02-06T12:02:28+0700" } ] }, "requests": [ { "request_uuid": "72753031-cd57-47ad-a3a6-9efd153fcc4c", "type": "CREATE", "state": "SUCCESSFUL", "date_time": "2020-02-06T12:02:27+0700", "errors": [], "warnings": [] } ] } |
Приложение 1. Статусы заявок
Код | Название статуса | Комментарий |
---|---|---|
ACCEPTED | Принят | Заявка создана в информационной системе СДЭК, но требуются дополнительные валидации |
CREATED | Создан | Заявка создана в информационной системе СДЭК и прошла необходимые валидации |
REMOVED | Отменена | Заявка отменена ИМ после регистрации в системе |
READY_FOR_APPOINTMENT | Готова к назначению | Заявка готова к назначению |
APPOINTED_COURIER | Назначен курьер | По заявке назначен курьер |
DONE | Выполнена | Заявка выполнена |
PROBLEM_DETECTED | Выявлена проблема | По заявке выявлена проблема |
PROCESSING_REQUIRED | Требует обработки | Заявка создана в информационной системе СДЭК, но требуется дополнительная обработка |
INVALID | Некорректная заявка | Заявка содержит некорректные данные |
© 2000—2024, Курьерская компания СДЭК