Событие обновления статуса (ORDER_STATUS) #

Событие срабатывает при каждом новом полученном от СД статусе вашего заказа. Если у заказа есть плановая дата доставки, в orderInfo приходит и её текущая запись plannedDelivery — см. плановые даты доставки. При неудаче происходит повторная попытка отправки данных о событии на адрес вебхука.

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

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

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

Описание: #

Поле		Тип	Описание
orderInfo		object	Объект заказа
	orderId	string \| number	Идентификатор заказа ApiShip
	providerNumber	string \| null	Трек-номер заказа в СД
	barcode	string \| null	ШК заказа
	clientNumber	string	Клиентский номер заказа
	checkUrl	string \| null	Ссылка на чек
	returnProviderNumber	string \| null	Возвратный трек-номер
	additionalProviderNumber	string \| null	Дополнительный идентификатор заказа в СД
	trackingUrl	string \| null	Ссылка на отслеживание заказа в СД
	plannedDelivery	object	Текущая плановая дата доставки. Отсутствует, если у заказа её нет. Описание
status		object	Объект статуса
	key	string	Идентификатор статуса заказа
	name	string	Название
	description	string	Описание
	created	string	Дата и время получения статуса
	providerCode	string \| null	Код статуса в системе СД
	providerName	string \| null	Название статуса в системе СД
	providerDescription	string \| null	Описание статуса в системе СД
	createdProvider	string \| null	Дата создания статуса в системе СД
	errorCode	string \| null	Коды ошибок: 100 - ошибка в ApiShip; 200 - ошибка в СД; 300 - ошибка клиента (некорректные данные)

Пример: #

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
{
    "orderInfo": {
        "orderId": "f6ee7e9d-0baa-40e9-9e26-d571b71129a5",
        "providerKey": "cse",
        "providerNumber": "ABC-123456-789012",
        "additionalProviderNumber": "",
        "barcode": "aiosd98asjdiaoksdokpasd",
        "clientNumber": "MY-ORDER-123",
        "returnProviderNumber": "RET-123321-321123",
        "checkUrl": "https://example.com/receipt.pdf",
        "trackingUrl": "https://example.com/track/ABC-123456-789012"
    },
    "status": {
        "key": "delivered",
        "name": "Доставлен получателю",
        "description": "",
        "errorCode": "",
        "providerCode": "8e5ded66-a8f5-4fa8-b863-03e1e0406df5",
        "providerName": "Отправление доставлено получателю",
        "providerDescription": "В.А (16.10.2023 11:13:22)",
        "createdProvider": "2023-10-16T11:13:22+03:00",
        "created": "2023-10-17T12:19:44+03:00"
    }
}