Изменение даты доставки по инициативе курьерской службы
В случае, если становится известно, что заказ не может быть доставлен клиенту в обозначенную дату, принятую ИС КС при создании заказа на доставку, ИС КС может отправить запрос на изменение даты доставки в ИС Золотого Яблока. Заказ на доставку, зафиксированный на стороне ИС Золотого Яблока при создании отправления, изменяется автоматически (если это допустимо при актуальном статусе доставки), а факт принятия запроса фиксируется (логируется) ИС Золотого Яблока.
К случаям, требущим отправки запроса, относятся:
- перенос даты доставки по причине логистических ограничений или задержек;
- изменение сроков доставки заказа в пункт выдачи заказов (ПВЗ);
- появление возможности выполнить доставку раньше ранее согласованной даты;
- любые иные изменения, влияющие на планируемую дату доставки заказа.
Запрос должен быть отправлен как при переносе даты доставки на более поздний срок, так и при переносе на более ранний срок.
Основная информация
| Тип метода запроса | PATCH |
|---|---|
| Путь/URL | /api/v1/orders/{orderNumber} |
| Описание | Метод для изменения информации о дате доставки заказа по инициативе Курьерской службы |
| Направление | Запрос выполняется курьерской службой. Ответ предоставляется ИС Золотого Яблока. |
Запрос
Параметры заголовка
| Параметр | Тип данных | Обязательность | Описание | Комментарий |
|---|---|---|---|---|
| Authorization | string | 1 | Access-token, выданнный сервисом | см. метод Авторизация в сервисе |
| content-type | string | 1 | Тип содержимого запроса | Заполняется "application/json" |
Параметры пути запроса
| Параметр | Тип данных | Обязательность | Описание | Комментарий |
|---|---|---|---|---|
| orderNumber | string | 1 | Номер заказа в ИС Золотого Яблока | Внутренний номер заказа в ИС Золотого Яблока. Трек-номер |
Параметры запроса
| Параметр | Тип данных | Обязательность | Описание | Комментарий |
|---|---|---|---|---|
| deliveryServiceCode | string | 1 | Код курьерской службы | Оговаривается при интеграции с системой |
| deliveryDate | date | 1 | Дата доставки | Согласно стандарту "ISO 8601". Формат: YYYY-MM-DDTHH:mm:ssZ |
| deliveryTimeIntervalFrom | date | 1 | Начало интервала доставки | Согласно стандарту "ISO 8601". Формат: HH:mm |
| deliveryTimeIntervalTo | date | 1 | Конец интервала доставки | Согласно стандарту "ISO 8601". Формат: HH:mm |
| dateChangeReason | string | 1 | Причина переноса даты доставки | Причина переноса даты доставки в свободной строковой форме |
Пример запроса
{
"deliveryServiceCode": "CDEK",
"deliveryDate": "2026-03-05T00:00:00Z",
"deliveryTimeIntervalFrom": "10:00",
"deliveryTimeIntervalTo": "12:00",
"dateChangeReason": "Клиент попросил перенести на другой день, его не будет в городе"
}
Ответ
Коды ответов и сообщений
| Код | Статус | Сообщение | Причина |
|---|---|---|---|
| 200 | ОК | Delivery date has been updated | Все прошло успешно. Дата доставки обновлена в ИС Золотого Яблока |
| 400 | Bad Request | Missing or inappropriate required parameters | Не переданы или некорретно заполнены обязательные поля |
| 401 | Unauthorized | Token is invalid | Ошибка аутентификации в КС |
| 403 | Forbidden | Has no permission | Запрещено в текущем контексте |
| 500 | Internal Server Error | Server unavailable | Сервер недоступен |
Параметры успешного ответа
200 ОК
Параметры неуспешного ответа
| Параметр | Тип данных | Обязательность | Описание | Комментарий |
|---|---|---|---|---|
| error | string | 1 | Человекочитаемое описание ошибки | см. п. "Коды ответов и сообщений" |
Пример неуспешного ответа
Неуспешный ответ
{
"error": "Missing or inappropriate required parameters"
}