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

Событие обновления номера заказа (ORDER_NUMBER_UPDATE) #

Событие срабатывает при обновлении данных вашего заказа. При неудаче происходит повторная попытка отправки данных о событии на адрес вебхука.

Параметры вебхука: #

  • Количество попыток отправки запроса: 3
  • Таймаут запроса: 30 секунд
  • Критерии неудачной попытки: HTTP-код ответа >= 500, либо истечение таймаута
  • Тип запроса: POST

Тело запроса #

Описание: #

ПолеТипОписание
eventTypestringТип события
orderInfoobjectОбъект заказа
orderIdstring | numberИдентификатор заказа ApiShip
providerNumberstring | nullТрек-номер заказа в СД
clientNumberstringКлиентский номер заказа

Пример: #

1
2
3
4
5
6
7
8
{
  "eventType": "ORDER_NUMBER_UPDATE",
  "orderInfo": {
        "orderId": "f6ee7e9d-0baa-40e9-9e26-d571b71129a5",
        "providerNumber": "ABC-123456-789012",
        "clientNumber": "MY-ORDER-123"
    }
}