Вебхуки (Webhooks)


 

Предназначены для отправки на URL клиента событий о:

  • изменении статуса заказа;
  • готовности печатной формы.

Таймаут на подключение по URL клиента для отправки сообщения - 3 сек. Повторная отправка в случае неудачи не предусмотрена.

Подписка на получение вебхуков

Для получения вебхуков необходимо подключить подписку. Подробнее об управлении подпиской: Подписка на вебхуки (Webhooks)

Структура вебхуков

На указанный клиентом URL приходит событие в формате JSON:

Название поляОписаниеТип поляОбяз. для заполн.
1typeТип события:
ORDER_STATUS - событие по статусам
PRINT_FORM - готовность печатной формы
DOWNLOAD_PHOTO  - получение фото документов по заказам
PREALERT_CLOSED - получение информации о закрытии преалерта

stringда
2date_timeДата и время события в формате ISO 8601:
для ORDER_STATUS  - дата установки нового статуса
для PRINT_FORM - дата формирования URL с pdf-файлом
для DOWNLOAD_PHOTO  - дата формирования фото документов
для PREALERT_CLOSED - дата получения преалерта
datetimeда
3uuidИдентификатор сущности:
для ORDER_STATUS  - заказа
для PRINT_FORM - печатной формы (квитанции или ШК)
для DOWNLOAD_PHOTO  - фото документов
для PREALERT_CLOSED - UUID преалерта
UUIDда
4attributesАтрибуты события
да

Для типа события ORDER_STATUS attributes содержит:

Название поляОписаниеТип поляОбяз. для заполн.
4.1is_returnПризнак возвратного заказа:
true - является возвратной
false - является прямой
booleanда
4.2cdek_numberНомер заказа СДЭКstring()да
4.3numberНомер заказа в ИС Клиента string()нет
4.4status_codeКод статуса (устаревшее поле)string()да
4.5status_reason_codeКод дополнительного статуса (подробнее см. приложение 2)string()нет
4.6status_date_timeДата и время установки статусаdatetimeда
4.7city_nameНаименование города возникновения статусаstring()да
4.8city_codeКод города возникновения статуса (не возвращается для статуса "Создан")string()нет
4.9codeКод статуса (подробнее см. приложение 1)string()да

Для типа события PRINT_FORM attributes содержит:

Название поляОписаниеТип поляОбяз. для заполн.
4.1typeТип печатной формы:
waybill, receipt (устаревшее) - квитанция к заказу
barcode - ШК места к заказу
string()да
4.2urlСсылка на скачивание файла:
Формат: https://api.cdek.ru/v2/print/orders/{uuid}.pdf для квитанции
https://api.cdek.ru/v2/print/barcodes/{uuid}.pdf для ШК места
string()да

Для типа события DOWNLOAD_PHOTO attributes содержит:

Название поляОписаниеТип поляОбяз. для заполн.
4.1cdek_numberНомер заказа СДЭКstring()да
4.2linkСсылка на скачивание файла:
Формат: https://api.cdek.ru/v2/print/barcodes/{uuid}.pdf
string()да


Для типа события PREALERT_CLOSED attributes содержит:

Название поляОписаниеТип поляОбяз. для заполн.
4.1prealert_numberНомер СДЭК закрытого преалертаstring()да
4.2closed_dateДата закрытияdateTimeда
4.3fact_shipment_pointФактический ПВЗ, в который были переданы заказыstring()да


{
  "type": "ORDER_STATUS",
  "date_time": "2020-08-10T21:32:14+0700",
  "uuid": "72753031-2801-4186-a091-0be58cedfee7",
  "attributes": {
    "is_return": false,
    "cdek_number": "1106321645",
	"code": "RECEIVED_AT_SHIPMENT_WAREHOUSE ",
    "status_code": "3",
    "status_date_time": "2020-08-10T21:32:12+0700",
    "city_name": "Новосибирск",
    "city_code": "270"
  }
}


{
  "type": "PRINT_FORM",
  "date_time": "2019-07-11T13:07:34+0700",
  "uuid": "72753031-8347-40c0-ab0f-1a49c7a262c1",
  "attributes": {
    "type": "barcode",
    "url": "https://api.cdek.ru/v2/print/barcodes/{uuid}.pdf"
  }
}


{
  "type": "DOWNLOAD_PHOTO",
  "date_time": "2022-03-21T15:14:32+0700",
  "uuid": "72753031-6417-44d2-8c0d-649a1d4b4721",
  "attributes": {
    "cdek_number": "1107807766",
    "link": "https://photo-docs.production.cdek.ru/archives/uyDZmEEh"
  }
}


{
  "type": "PREALERT_CLOSED",
  "date_time": "2023-01-23T10:20:02+0000",
  "uuid": "72753031-a1d3-4266-bc9f-8052f0fc3b2c",
  "attributes": {
    "prealert_number": "PA/7/583",
    "closed_date": "2023-01-17T07:59:18+0000",
    "fact_shipment_point": "NSK1"
  }
}


Приложение 1. Статусы заказов

Status code

Code

Статус

Комментарий

1

СREATED

Создан

Заказ зарегистрирован в базе данных СДЭК

2

REMOVED

Удален

Заказ отменен ИМ после регистрации в системе до прихода груза на склад СДЭК в городе-отправителе

3

RECEIVED_AT_SHIPMENT_WAREHOUSE

Принят на склад отправителя

Оформлен приход на склад СДЭК в городе-отправителе

6

READY_TO_SHIP_AT_SENDING_OFFICE

Выдан на отправку в г. отправителе

Оформлен расход со склада СДЭК в городе-отправителе. Груз подготовлен к отправке (консолидирован с другими посылками)

16

RETURNED_TO_SENDER_WAREHOUSE

Возвращен на склад отправителя

Повторно оформлен приход в городе-отправителе (не удалось передать перевозчику по какой-либо причине).

Примечание: этот статус не означает возврат груза отправителю.

7

PASSED_TO_CARRIER_AT_SENDING_OFFICE

Сдан перевозчику в г. отправителе

Зарегистрирована отправка в городе-отправителе. Консолидированный груз передан на доставку (в аэропорт/загружен машину)

21

SEND_TO_TRANSIT_OFFICE

Отправлен в г. транзит

Зарегистрирована отправка в город-транзит. Проставлены дата и время отправления у перевозчика

22

MET_AT_TRANSIT_OFFICE

Встречен в г. транзите

Зарегистрирована встреча в городе-транзите

13

ACCEPTED_TO_OFFICE_TRANSIT_WAREHOUSE

Принят на склад транзита

Оформлен приход в городе-транзите

17

RETURNED_TO_TRANSIT_WAREHOUSE

Возвращен на склад транзита

Повторно оформлен приход в городе-транзите (груз возвращен на склад).

Примечание: этот статус не означает возврат груза отправителю.

19

READY_TO_SHIP_IN_TRANSIT_OFFICE

Выдан на отправку в г. транзите

Оформлен расход в городе-транзите

20

PASSED_TO_CARRIER_AT_TRANSIT_OFFICE

Сдан перевозчику в г. транзите

Зарегистрирована отправка у перевозчика в городе-транзите

27SEND_TO_SENDING_OFFICEОтправлен в г. отправительЗарегистрирована отправка в город-отправитель, груз в пути.

8

SEND_TO_RECIPIENT_OFFICE

Отправлен в г. получатель

Зарегистрирована отправка в город-получатель, груз в пути.

28MET_AT_SENDING_OFFICEВстречен в г. отправителеЗарегистрирована встреча груза в городе-отправителе

9

MET_AT_RECIPIENT_OFFICE

Встречен в г. получателе

Зарегистрирована встреча груза в городе-получателе

10

ACCEPTED_AT_DELIVERY_WAREHOUSE

Принят на склад доставки

Оформлен приход на склад города-получателя, ожидает доставки до двери

12

ACCEPTED_AT_WAREHOUSE_ON_DEMAND

Принят на склад до востребования

Оформлен приход на склад города-получателя. Доставка до склада, посылка ожидает забора клиентом - покупателем ИМ

11

ISSUED_FOR_DELIVERY

Выдан на доставку

Добавлен в курьерскую карту, выдан курьеру на доставку

18

RETURNED_TO_DELIVERY_WAREHOUSE

Возвращен на склад доставки

Оформлен повторный приход на склад в городе-получателе. Доставка не удалась по какой-либо причине, ожидается очередная попытка доставки.

Примечание: этот статус не означает возврат груза отправителю

4

DELIVERED

Вручен

Успешно доставлен и вручен адресату (конечный статус)

5

NOT_DELIVERED

Не вручен

Покупатель отказался от покупки, возврат в ИМ (конечный статус)

1000ENTERED_TO_OFFICE_TRANSIT_WAREHOUSEПоступил в г. транзитаОформлена приемка в городе-транзите
ENTERED_TO_DELIVERY_WAREHOUSEПоступил на склад доставкиОформлена приемка на складе города получателя по заказу до двери
ENTERED_TO_WAREHOUSE_ON_DEMANDПоступил на склад до востребования Оформлена приемка на складе города получателя по заказу до склада
IN_CUSTOMS_INTERNATIONALТаможенное оформление в стране отправленияВ процессе таможенного оформления в стране отправителя (для международных заказов)
SHIPPED_TO_DESTINATIONОтправлено в страну назначенияОтправлен в страну назначения, заказ в пути (для международных заказов)
PASSED_TO_TRANSIT_CARRIERПередано транзитному перевозчикуПередано транзитному перевозчику
IN_CUSTOMS_LOCALТаможенное оформление в стране назначенияТаможенное оформление в стране назначения
CUSTOMS_COMPLETEТаможенное оформление завершеноЗавершено таможенное оформление заказа (для международных заказов).
POSTOMAT_POSTEDЗаложен в постаматЗаложен в постамат, заказ ожидает забора клиентом - покупателем ИМ
POSTOMAT_SEIZEDИзъят из постамата курьеромИстек срок хранения заказа в постамате, возврат в ИМ
POSTOMAT_RECEIVEDИзъят из постамата клиентомУспешно изъят из постамата клиентом - покупателем ИМ
6READY_FOR_SHIPMENT_IN_SENDER_CITYГотов к отправке в городе отправителеОформлен расход со склада СДЭК в городе отправителя. Груз подготовлен к отправке (консолидирован с другими заказами)
7

TAKEN_BY_TRANSPORTER_FROM_SENDER_CITY

Сдан перевозчику в городе отправителеЗарегистрирована отправка в городе отправителе. Консолидированный груз передан на доставку (в аэропорт/загружен машину)
21

SENT_TO_TRANSIT_CITY

Отправлен в город-транзитЗарегистрирована отправка в город-транзит. Проставлены дата и время отправления у перевозчика
22

ACCEPTED_IN_TRANSIT_CITY

Встречен в городе-транзите Зарегистрирована встреча в городе-транзите
13

ACCEPTED_AT_TRANSIT_WAREHOUSE

Принят на склад транзитаОформлен приход в городе-транзите
20TAKEN_BY_TRANSPORTER_FROM_TRANSIT_CITYСдан перевозчику в городе-транзитеЗарегистрирована отправка у перевозчика в городе-транзите
8 SENT_TO_RECIPIENT_CITYОтправлен в город-получательЗарегистрирована отправка в город получателя, заказ в пути
9ACCEPTED_IN_RECIPIENT_CITYВстречен в городе- получателеЗарегистрирована встреча заказа в городе получателя
12ACCEPTED_AT_PICK_UP_POINTПринят на склад до востребованияОформлен приход на склад города получателя. Доставка до склада, заказ ожидает забора клиентом - покупателем ИМ
11TAKEN_BY_COURIERВыдан на доставку  Добавлен в курьерскую карту, выдан курьеру на доставку
18 RETURNED_TO_RECIPIENT_CITY_WAREHOUSEВозвращен на склад доставкиОформлен повторный приход на склад в городе получателя. Доставка не удалась по какой-либо причине, ожидается очередная попытка доставки.
Примечание: этот статус не означает возврат заказа отправителю.

Приложение 2. Дополнительные статусы заказов

Код

Доп. статус

Услуга доставки оказана

(0-нет, 1- да)

Соответствующий статус

1

Возврат, неверный адрес

0

Не вручен

2

Возврат, не дозвонились

0

Не вручен

3

Возврат, адресат не проживает

0

Не вручен

4

Возврат, не должен выполняться: вес отличается от заявленного более, чем на X г.

0

Не вручен

5

Возврат, не должен выполняться: фактически нет отправления (на бумаге есть)

0

Не вручен

6

Возврат, не должен выполняться: дубль номера заказа в одном акте приема-передачи

0

Не вручен

7

Возврат, не должен выполняться: не доставляем в данный город/регион

0

Не вручен

8

Возврат, повреждение упаковки, при приемке от отправителя

0

Не вручен

9

Возврат, повреждение упаковки, у перевозчика

0

Не вручен

10

Возврат, повреждение упаковки, на нашем складе/доставке у курьера

0

Не вручен

11

Возврат, отказ от получения: Без объяснения

1

Не вручен

12

Возврат, отказ от получения: Претензия к качеству товара

1

Не вручен

13

Возврат, отказ от получения: Недовложение

1

Не вручен

14

Возврат, отказ от получения: Пересорт

1

Не вручен

15

Возврат, отказ от получения: Не устроили сроки

1

Не вручен

16

Возврат, отказ от получения: Уже купил

1

Не вручен

17

Возврат, отказ от получения: Передумал

1

Не вручен

18

Возврат, отказ от получения: Ошибка оформления

1

Не вручен

19

Возврат, отказ от получения: Повреждение упаковки, у получателя

1

Не вручен

20

Частичная доставка

1

Вручен

21

Возврат, отказ от получения: Нет денег

1

Не вручен

22

Возврат, отказ от получения: Товар не подошел/не понравился

1

Не вручен

23

Возврат, истек срок хранения

0

Не вручен

24

Возврат, не прошел таможню

0

Не вручен

25

Возврат, не должен выполняться: является коммерческим грузом

0

Не вручен

26

Утерян

0

Не вручен

27

Не востребован, утилизация

0

Не вручен



 

© 2000—2022, Курьерская компания СДЭК