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

Метод предназначен для получения информации по заданной заявке.

Запрос на получение информации о заявке

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

{uuid} - идентификатор заявки в ИС СДЭК, по которому необходима информация

Ответ на получение информации о заявке

Ответ возвращается в формате JSON:

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

Описание

Тип поля

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

1entityИнформация о заявкеentityнет
1.1uuidИдентификатор заявки в ИС СДЭКUUIDда
1.2intake_numberНомер заявки СДЭК на вызов курьераlongнет

1.3

cdek_numberНомер заказа СДЭКlongнет
1.4order_uuidИдентификатор заказа в ИС СДЭКUUIDнет
1.5intake_dateДата ожидания курьераdate (yyyy-MM-dd)да
1.6intake_time_fromВремя начала ожидания курьераtimeда
1.7intake_time_toВремя окончания ожидания курьераtimeда
1.8lunch_time_fromВремя начала обеда, должно входить в диапозон [intake_time_to;intake_time_to]timeнет
1.9lunch_time_toВремя окончания обеда, должно входить в диапозон [intake_time_to;intake_time_to]timeнет
1.10nameОписание грузаstringнет
1.11weightОбщий вес (в граммах)integerнет
1.12lengthГабариты упаковки. Длина (в сантиметрах)integerнет
1.13widthГабариты упаковки. Ширина (в сантиметрах)integerнет
1.14heightГабариты упаковки. Высота (в сантиметрах)integerнет
1.15commentКомментарий к заявке для курьераstringнет
1.16senderОтправительcontactнет
1.16.1companyНазвание компании отправителяstring(255)нет
1.16.2nameФИО контактного лицаstring(255)да
1.16.3phonesСписок телефоновphone[]да
1.16.3.1numberНомер телефона string(255)да
1.16.3.2additionalДополнительная информация (добавочный номер)string(255)нет
1.17from_locationАдрес отправителя (забора)locationда
1.17.1codeКод локации (справочник СДЭК)integerда
1.17.2fias_guidУникальный идентификатор ФИАСUUIDнет
1.17.3postal_codeПочтовый индексstring(255)нет
1.17.4longitudeДолготаfloatнет
1.17.5latitudeШиротаfloatнет
1.17.6country_codeКод страны (двухбуквенный из международного справочника)string(2)да
1.17.7regionНазвание регионаstring(255)нет
1.17.8region_codeКод региона (справочник СДЭК)integerнет
1.17.9sub_regionНазвание района регионаstring(255)нет
1.17.10cityНазвание городаstring(255)да
1.17.11kladr_codeКод КЛАДРstring(255)нет
1.17.12addressСтрока адресаstring(255)да
1.18need_callНеобходим прозвон отправителя (по умолчанию - false)booleanнет
1.19statusesСтатус по заявкеstatus[]да
1.19.1codeКод статуса (подробнее см. приложение 1)string()да
1.19.2nameНазвание статусаstring()да
1.19.3date_timeДата и время установки статуса (формат yyyy-MM-dd'T'HH:mm:ssZ)datetimeда
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()да


Пример запроса
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 ОтмененаЗаявка отменена ИМ после регистрации в системе
INVALID Некорректная заявкаЗаявка содержит некорректные данные




  • No labels