Регистрация преалерта
Метод предназначен для регистрации преалерта (реестра заказов, которые клиент собирается передать на склад СДЭК для дальнейшей доставки).
Запрос на регистрацию преалерта
Для использования необходимо отправить POST-запрос на URL:
Среда | URL |
---|---|
тестовая | https://api.edu.cdek.ru/v2/prealert |
боевая | https://api.cdek.ru/v2/prealert |
Тело запроса
Необходимо передавать в формате JSON (Content-Type: application/json).
Поддерживаются следующие поля:
№ | Название поля | Описание | Тип поля | Обяз. для заполн. |
---|---|---|---|---|
1 | planned_date | Планируемая дата передачи заказов в СДЭК | dateTime | да |
2 | shipment_point | Код ПВЗ, в который планируется передать заказы | string() | да |
3 | orders | Список заказов, которые планируется передать в СДЭК | [ ] | да |
3.1 | order_uuid | Идентификатор заказа в ИС СДЭК | UUID | да, если не указаны cdek_number и im_number |
3.2 | cdek_number | Номер заказа СДЭК | long | да, если не указаны order_uuid и im_number |
3.3 | im_number | Номер заказа в ИС клиента | string(40) | да, если не указаны order_uuid и cdek_number |
Ответ на регистрацию преалерта
Ответ возвращается в формате JSON:
№ | Название поля | Описание | Тип поля | Обяз. для заполн. |
---|---|---|---|---|
1 | entity | Информация о преалерте | entity | нет |
1.1 | uuid | Идентификатор преалерта в ИС СДЭК | UUID | нет |
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() | да |
Полученный 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" } ] } |
© 2000—2022, Курьерская компания СДЭК