Изменение даты доставки по инициативе Золотого Яблока
В случае, если становится известно, что заказ не может быть принят клиентом в обозначенную при создании заказа дату, или в любом другом случае, требующем изменения даты доставки, ИС Золотого Яблока может отправить запрос на изменение даты доставки в созданное отправление. Заказ на доставку, созданный на стороне ИС КС, изменяется автоматически (если это допустимо при актуальном статусе доставки), а факт принятия запроса фиксируется (логируется) ИС КС. Эндпоинт должен быть опубликован по защищенному протоколу HTTPS.
Основная информация
| Тип метода запроса | PATCH |
|---|---|
| Путь/URL | /api/v1/orders/{orderNumber} |
| Описание | Метод для изменения плановой даты доставки заказа по инициативе Золотого Яблока |
| Направление | Запрос выполняет ИС Золотого Яблока. Ответ предоставляется курьерской службой. |
Запрос
Параметры заголовка
| Параметр | Тип данных | Обязательность | Описание | Комментарий |
|---|---|---|---|---|
| Authorization | string | 1 | Access token, полученный при авторизации. Передаётся в формате Bearer <access_token> | Формат передаёт курьерская служба (см. Авторизация в сервисе ВКС) |
| content-type | string | 1 | Тип содержимого запроса | Заполняется "application/json" |
Параметры пути
| Параметр | Тип данных | Обязательность | Описание | Комментарий |
|---|---|---|---|---|
| orderNumber | string | 1 | Номер заказа ЗЯ | Внутренний номер заказа в ИС Золотого Яблока. Трек-номер. |
Параметры запроса
| Параметр | Тип данных | Обязательность | Описание | Комментарий |
|---|---|---|---|---|
| deliveryDate | date | 1 | Дата доставки | Согласно стандарту "ISO 8601", UTC0. Формат: YYYY-MM-DDTHH:mm:ssZ |
| deliveryTimeIntervalFrom | date | 1 | Начало интервала доставки | Согласно стандарту "ISO 8601", UTC0. Формат: HH:mm |
| deliveryTimeIntervalTo | date | 1 | Конец интервала доставки | Согласно стандарту "ISO 8601", UTC0. Формат: HH:mm |
Пример запроса
{
"deliveryDate": "2026-03-05T00:00:00Z",
"deliveryTimeIntervalFrom": "10:00",
"deliveryTimeIntervalTo": "12:00"
}
Ответ
Коды ответов и сообщений
| Код | Статус | Сообщение | Причина |
|---|---|---|---|
| 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 | Сервер недоступен |
Параметры неуспешного ответа
| Параметр | Тип данных | Обязательность | Описание | Комментарий |
|---|---|---|---|---|
| error | string | 1 | Человекочитаемое описание ошибки | см. п. "Коды ответов и сообщений" |
Пример неуспешного ответа
Неуспешный ответ
{
"error": "Token is invalid"
}