Регистрация договоренности о доставке
Метод позволяет фиксировать оговоренные с клиентом дату и время доставки (приезда курьера), а так же изменять адрес доставки.
Запрос на регистрацию договоренности о доставке
Для использования необходимо отправить POST-запрос на URL:
Среда | URL |
|---|---|
| тестовая | https://api.edu.cdek.ru/v2/delivery |
| боевая | https://api.cdek.ru/v2/delivery |
Тело запроса
Необходимо передавать в формате JSON (Content-Type: application/json).
Поддерживаются следующие поля:
№ | Тэг/Атрибут | Описание | Тип поля | Обяз. для заполн. |
|---|---|---|---|---|
1 | cdek_number | Номер заказа СДЭК | string | да, если не передан order_uuid |
| 2 | order_uuid | Идентификатор заказа в ИС СДЭК | UUID | да, если не передан cdek_number |
| 3 | date | Дата доставки, согласованная с получателем (Если заказ "До склада", эта дата не влияет на сроки доставки и может быть произвольной) | date | да |
| 4 | time_from | Время доставки С, согласованное с получателем | time | да, если заказ "до двери" |
| 5 | time_to | Время доставки ПО, согласованное с получателем | time | да, если заказ "до двери" |
| 6 | comment | Комментарий | string | нет |
| 7 | delivery_point | Буквенно-цифровой код ПВЗ СДЭК, на который будет доставлена посылка, например "MSK93". Не может быть заполнен одновременно с to_location | string() | да, если заказ "до склада" |
8 | to_location | Новый адрес доставки (если требуется изменить) | location | нет |
8.1 | code | Код населенного пункта СДЭК (метод "Список населенных пунктов") | integer | нет |
8.2 | fias_guid | Уникальный идентификатор ФИАС | UUID | нет |
8.3 | postal_code | Почтовый индекс | string(255) | нет |
8.4 | longitude | Долгота | float | нет |
| 8.5 | latitude | Широта | float | нет |
| 8.6 | country_code | Код страны в формате ISO_3166-1_alpha-2 (по умолчанию RU) | string(2) | нет |
8.7 | region | Название региона | string(255) | нет |
| 8.8 | region_code | Код региона (справочник СДЭК) | integer | нет |
| 8.9 | sub_region | Название района региона | string(255) | нет |
| 8.10 | city | Название города | string(255) | нет |
| 8.11 | kladr_code | Код КЛАДР Устаревшее поле | string(255) | нет |
| 8.12 | address | Строка адреса | string(255) | нет |
Ответ на регистрацию договоренности о доставке
Ответ возвращается в формате 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() | да |
{
"cdek_number" : "1106207236",
"order_uuid" : "72753031-df04-44a4-bc60-11e8b5253b1d",
"date" : "2020-02-27",
"time_from": "10:00",
"time_to": "15:00",
"comment" : "Офис группы компаний Ланит ?",
"delivery_point" : "",
"to_location" : {
"code" : "137",
"fias_guid" : "c2deb16a-0330-4f05-821f-1d09c93331e6",
"postal_code" : "190000",
"longitude" : "30.3159",
"latitude" : "59.9391",
"country_code" : "RU",
"region" : "Санкт-Петербург",
"region_code" : "82",
"sub_region" : "Санкт-Петербург",
"city" : "Санкт-Петербург",
"kladr_code" : "78",
"address" : "г.Бердск ул.Ленина 16"
}
} |
{
"entity": {
"uuid": "72753031-3d4b-42c4-8a87-53ecae1881e3"
},
"requests": [
{
"request_uuid": "72753031-8ab1-4ed2-ab9c-363cce859817",
"type": "CREATE",
"state": "ACCEPTED",
"date_time": "2020-02-26T14:46:17+0700",
"errors": [],
"warnings": []
}
]
} |
© 2000—2024, Курьерская компания СДЭК