Событие обновления плановой даты доставки (PLANNED_DELIVERY_DATE_UPDATE) #
Событие срабатывает на каждую новую запись в истории плановых дат заказа: на первую дату от службы доставки и на каждый перенос даты или смену окна времени, в том числе без смены статуса заказа. Если два переноса случились подряд, придут два события, каждое со своей датой. Если ваш сервер ответил кодом 5xx, отправка повторяется.
Подписка на это событие отдельная: её можно включить без подписки на ORDER_STATUS и ORDER_NUMBER_UPDATE.
Тело события того же вида, что у ORDER_NUMBER_UPDATE. Если оба типа подписаны на один адрес, различайте их по полю eventType.
Полная история дат заказа — в поле plannedDeliveryDates карточки заказа. Там же описаны словарь причин и службы доставки, которые передают дату.
Параметры вебхука: #
- Тип запроса: POST,
Content-Type: application/json - Таймаут запроса: 30 секунд
- Повторная отправка: только при HTTP-коде ответа >= 500 — до 3 повторов с паузой 40 секунд (всего до 4 отправок)
- Другие коды ответа и истечение таймаута повторов не вызывают
Тело запроса #
Пустые поля в тело не попадают: отсутствие поля означает null.
Описание: #
| Поле | Тип | Описание | ||
|---|---|---|---|---|
| eventType | string | Тип события: PLANNED_DELIVERY_DATE_UPDATE | ||
| orderInfo | object | Объект заказа | ||
| orderId | string | number | Идентификатор заказа ApiShip | ||
| providerNumber | string | null | Трек-номер заказа в СД | ||
| clientNumber | string | Клиентский номер заказа | ||
| plannedDelivery | object | Плановая дата доставки, которая вызвала событие | ||
| date | string | Плановая дата доставки, YYYY-MM-DD | ||
| timeStart | string | null | Начало окна доставки, HH:MM, местное время получателя | ||
| timeEnd | string | null | Конец окна доставки, HH:MM | ||
| source | string | Кто назначил дату: provider — служба доставки | ||
| created | string | Когда ApiShip получил эту дату | ||
| createdProvider | string | null | Когда дату назначила служба доставки | ||
| reason | object | null | Причина переноса: key, name, providerCode, providerName. Отсутствует — служба доставки причину не сообщила. Словарь причин |
Пример: #
| |