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

Метод предназначен для регистрации преалерта (реестра заказов, которые клиент собирается передать на склад СДЭК для дальнейшей доставки).

Запрос на регистрацию преалерта

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

Тело запроса 

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

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

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

Описание

Тип поля

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

1planned_dateПланируемая дата передачи заказов в СДЭКdateTimeда
2shipment_pointКод ПВЗ, в который планируется передать заказыstring()да
3ordersСписок заказов, которые планируется передать в СДЭК[ ]да
3.1order_uuidИдентификатор заказа в ИС СДЭКUUIDда, если не указаны cdek_number и im_number
3.2cdek_numberНомер заказа СДЭКlongда, если не указаны order_uuid и im_number
3.3im_numberНомер заказа в ИС клиентаstring(40)да, если не указаны order_uuid и cdek_number

Ответ на регистрацию преалерта

Ответ возвращается в формате 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 необходимо использовать в методе "Информация по преалерту" для получения номера преалерта в ИС СДЭК

Пример запроса
{
    "planned_date": "2021-08-03T13:08:49+0000",
    "shipment_point": "NSK27",
    "orders": [
        {
            "order_uuid": "72753031-924c-4db8-b158-9a5148fc3e83",
            "cdek_number": "1107487669",
            "im_number": "1627452531640"
        },
        {
            "order_uuid": "72753031-bce5-4f06-801a-45c047f94269",
            "cdek_number": "1107487670",
            "im_number": "1627452533178"
        },
        {
            "order_uuid": "72753031-7657-4d64-81a8-ff00c0870d25",
            "cdek_number": "1107487671",
            "im_number": "1627452534559"
        }
    ]
}
Пример ответа
{
    "entity": {
        "uuid": "72753031-8bc2-446f-9ed5-0a5fb62f61e9"
    },
    "requests": [
        {
            "request_uuid": "c8417197-0ea5-47ab-849e-0c37756ebe34",
            "type": "CREATE",
            "date_time": "2021-08-03T11:12:44+0700",
            "state": "ACCEPTED"
        }
    ]
}
  • No labels