Swagger API Личный кабинет Центр поддержки

Событие обновления плановой даты доставки (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.

Описание: #

ПолеТипОписание
eventTypestringТип события: PLANNED_DELIVERY_DATE_UPDATE
orderInfoobjectОбъект заказа
orderIdstring | numberИдентификатор заказа ApiShip
providerNumberstring | nullТрек-номер заказа в СД
clientNumberstringКлиентский номер заказа
plannedDeliveryobjectПлановая дата доставки, которая вызвала событие
datestringПлановая дата доставки, YYYY-MM-DD
timeStartstring | nullНачало окна доставки, HH:MM, местное время получателя
timeEndstring | nullКонец окна доставки, HH:MM
sourcestringКто назначил дату: provider — служба доставки
createdstringКогда ApiShip получил эту дату
createdProviderstring | nullКогда дату назначила служба доставки
reasonobject | nullПричина переноса: key, name, providerCode, providerName. Отсутствует — служба доставки причину не сообщила. Словарь причин

Пример: #

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
{
  "eventType": "PLANNED_DELIVERY_DATE_UPDATE",
  "orderInfo": {
    "orderId": 11000010,
    "providerNumber": "ABC-123456-789012",
    "clientNumber": "MY-ORDER-123",
    "plannedDelivery": {
      "date": "2026-09-25",
      "timeStart": "14:00",
      "timeEnd": "18:00",
      "source": "provider",
      "created": "2026-09-24T05:20:41+03:00",
      "createdProvider": "2026-09-24T05:20:31+03:00",
      "reason": {
        "key": "recipientUnavailable",
        "name": "Получатель недоступен",
        "providerCode": "13",
        "providerName": "Контактное лицо отсутствует"
      }
    }
  }
}