Вебхуки (Webhooks)
Предназначены для отправки на URL клиента событий:
- изменении статуса заказа
- готовности печатной формы
- получение фото документов по заказам
- получение информации о закрытии преалерта
Таймаут на подключение по URL клиента для отправки сообщения - 15 сек. При неуспешной отправке вебхук отправляется повторно, если указан параметр "retryable". |
Подписка на получение вебхуков
Для получения вебхуков необходимо подключить подписку. Подробнее об управлении подпиской: Подписка на вебхуки (Webhooks)
Структура вебхуков
На указанный клиентом URL приходит событие в формате JSON:
№ | Название поля | Описание | Тип поля | Обяз. для заполн. |
---|---|---|---|---|
1 | type | Тип события: ORDER_STATUS - событие по статусам PRINT_FORM - готовность печатной формы DOWNLOAD_PHOTO - получение фото документов по заказам PREALERT_CLOSED - получение информации о закрытии преалерта | string | да |
2 | date_time | Дата и время события в формате ISO 8601: для ORDER_STATUS - дата установки нового статуса для PRINT_FORM - дата формирования URL с pdf-файлом для DOWNLOAD_PHOTO - дата формирования фото документов для PREALERT_CLOSED - дата получения преалерта | datetime | да |
3 | uuid | Идентификатор сущности: для ORDER_STATUS - заказа для PRINT_FORM - печатной формы (квитанции или ШК) для DOWNLOAD_PHOTO - фото документов для PREALERT_CLOSED - UUID преалерта | UUID | да |
4 | attributes | Атрибуты события | да |
Для типа события ORDER_STATUS attributes содержит:
№ | Название поля | Описание | Тип поля | Обяз. для заполн. |
---|---|---|---|---|
4.1 | is_return | Признак возвратного заказа: true - является возвратной false - является прямой | boolean | да |
4.2 | cdek_number | Номер заказа СДЭК | string() | да |
4.3 | number | Номер заказа в ИС Клиента | string() | нет |
4.4 | status_code | Код статуса (устаревшее поле) | string() | да |
4.5 | status_reason_code | Код дополнительного статуса (подробнее см. приложение 2) | string() | нет |
4.6 | status_date_time | Дата и время установки статуса | datetime | да |
4.7 | city_name | Наименование города возникновения статуса | string() | нет |
4.8 | city_code | Код города возникновения статуса (не возвращается для статуса "Создан") | string() | нет |
4.9 | code | Код статуса (подробнее см. приложение 1) | string() | да |
4.10 | is_reverse | Признак возвратного заказа | boolean | да |
4.11 | is_client_return | Признак клиентского возврата | boolean | да |
4.12 | related_entities | Связанные сущности, массив объектов | [ ] | нет |
4.12.1 | type | Тип связанной сущности, может принимать значения: direct_order - прямой заказ client_direct_order - прямой заказ, по которому оформлен клиентский возврат | string() | да |
4.12.2 | cdek_number | Номер заказа СДЭК | string() | да |
4.12.3 | uuid | Идентификатор связанной сущности | UUID | да |
Для типа события PRINT_FORM attributes содержит:
№ | Название поля | Описание | Тип поля | Обяз. для заполн. |
---|---|---|---|---|
4.1 | type | Тип печатной формы: WAYBILL - квитанция к заказу BARCODE - ШК места к заказу | string() | да |
4.2 | url | Ссылка на скачивание файла: Формат: https://api.cdek.ru/v2/print/orders/{uuid}.pdf для квитанции https://api.cdek.ru/v2/print/barcodes/{uuid}.pdf для ШК места | string() | да |
Для типа события DOWNLOAD_PHOTO attributes содержит:
№ | Название поля | Описание | Тип поля | Обяз. для заполн. |
---|---|---|---|---|
4.1 | cdek_number | Номер заказа СДЭК | string() | да |
4.2 | link | Ссылка на скачивание файла: Формат: https://photo-docs.production.cdek.ru/archives/qWErtY | string() | да |
Для типа события PREALERT_CLOSED attributes содержит:
№ | Название поля | Описание | Тип поля | Обяз. для заполн. |
---|---|---|---|---|
4.1 | prealert_number | Номер СДЭК закрытого преалерта | string() | да |
4.2 | closed_date | Дата закрытия | dateTime | да |
4.3 | fact_shipment_point | Фактический ПВЗ, в который были переданы заказы | string() | да |
{ "type": "ORDER_STATUS", "date_time": "2023-11-28T07:44:45+0000", "uuid": "72753031-1820-4f99-9240-aab139f05ca5", "attributes": { "is_return": false, "is_reverse": false, "is_client_return": false, "cdek_number": "1100285492", "number": "17011574744791", "related_entities": [], "code": "RECEIVED_AT_SHIPMENT_WAREHOUSE", "status_code": "3", "status_date_time": "2023-11-28T07:44:45+0000", "city_name": "Новосибирск", "city_code": "270" } } |
{ "type": "PRINT_FORM", "date_time": "2023-11-28T09:03:31+0000", "uuid": "72753031-e1f1-4fc8-97ee-d58a010b6a67", "attributes": { "type": "BARCODE", "url": "http://api.cdek.ru/v2/print/barcodes/72753031-e1f1-4fc8-97ee-d58a010b6a67.pdf" } } |
{ "type": "DOWNLOAD_PHOTO", "date_time": "2023-11-29T05:00:01+0000", "uuid": "72753031-7288-4d57-a893-29451197aa01", "attributes": { "cdek_number": 1100239959, "link": "https://photo-docs.production.cdek.ru/archives/qWErtY" } } |
{ "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 или READY_FOR_SHIPMENT_IN_TRANSIT_CITY | Выдан на отправку в г. отправителе | Оформлен расход со склада СДЭК в городе-отправителе. Груз подготовлен к отправке (консолидирован с другими посылками) |
16 | RETURNED_TO_SENDER_CITY_WAREHOUSE | Возвращен на склад отправителя | Повторно оформлен приход в городе-отправителе (не удалось передать перевозчику по какой-либо причине). Примечание: этот статус не означает возврат груза отправителю. |
7 | PASSED_TO_CARRIER_AT_SENDING_OFFICE | Сдан перевозчику в г. отправителе | Зарегистрирована отправка в городе-отправителе. Консолидированный груз передан на доставку (в аэропорт/загружен машину) |
21 | SEND_TO_TRANSIT_OFFICE | Отправлен в г. транзит | Зарегистрирована отправка в город-транзит. Проставлены дата и время отправления у перевозчика |
22 | MET_AT_TRANSIT_OFFICE | Встречен в г. транзите | Зарегистрирована встреча в городе-транзите |
13 | ACCEPTED_AT_TRANSIT_WAREHOUSE | Принят на склад транзита | Оформлен приход в городе-транзите |
17 | RETURNED_TO_TRANSIT_WAREHOUSE | Возвращен на склад транзита | Повторно оформлен приход в городе-транзите (груз возвращен на склад). Примечание: этот статус не означает возврат груза отправителю. |
19 | READY_TO_SHIP_IN_TRANSIT_OFFICE | Выдан на отправку в г. транзите | Оформлен расход в городе-транзите |
20 | PASSED_TO_CARRIER_AT_TRANSIT_OFFICE | Сдан перевозчику в г. транзите | Зарегистрирована отправка у перевозчика в городе-транзите |
27 | SENT_TO_SENDER_CITY | Отправлен в г. отправитель | Зарегистрирована отправка в город-отправитель, груз в пути. |
28 | MET_AT_SENDING_OFFICE | Встречен в г. отправителе | Зарегистрирована встреча груза в городе-отправителе |
9 | MET_AT_RECIPIENT_OFFICE | Встречен в г. получателе | Зарегистрирована встреча груза в городе-получателе |
10 | ACCEPTED_AT_RECIPIENT_CITY_WAREHOUSE | Принят на склад доставки | Оформлен приход на склад города-получателя, ожидает доставки до двери |
12 | ACCEPTED_AT_PICK_UP_POINT | Принят на склад до востребования | Оформлен приход на склад города-получателя. Доставка до склада, посылка ожидает забора клиентом - покупателем ИМ |
11 | TAKEN_BY_COURIER | Выдан на доставку | Добавлен в курьерскую карту, выдан курьеру на доставку |
18 | RETURNED_TO_RECIPIENT_CITY_WAREHOUSE | Возвращен на склад доставки | Оформлен повторный приход на склад в городе-получателе. Доставка не удалась по какой-либо причине, ожидается очередная попытка доставки. Примечание: этот статус не означает возврат груза отправителю |
4 | DELIVERED | Вручен | Успешно доставлен и вручен адресату (конечный статус) |
5 | NOT_DELIVERED | Не вручен | Покупатель отказался от покупки, возврат в ИМ (конечный статус) |
1000 | ENTERED_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 | Изъят из постамата клиентом | Успешно изъят из постамата клиентом - покупателем ИМ | |
6 | READY_FOR_SHIPMENT_IN_SENDER_CITY | Готов к отправке в городе отправителе | Оформлен расход со склада СДЭК в городе отправителя. Груз подготовлен к отправке (консолидирован с другими заказами) |
7 | TAKEN_BY_TRANSPORTER_FROM_SENDER_CITY | Сдан перевозчику в городе отправителе | Зарегистрирована отправка в городе отправителе. Консолидированный груз передан на доставку (в аэропорт/загружен машину) |
21 | SENT_TO_TRANSIT_CITY | Отправлен в город-транзит | Зарегистрирована отправка в город-транзит. Проставлены дата и время отправления у перевозчика |
22 | ACCEPTED_IN_TRANSIT_CITY | Встречен в городе-транзите | Зарегистрирована встреча в городе-транзите |
20 | TAKEN_BY_TRANSPORTER_FROM_TRANSIT_CITY | Сдан перевозчику в городе-транзите | Зарегистрирована отправка у перевозчика в городе-транзите |
8 | SENT_TO_RECIPIENT_CITY | Отправлен в город-получатель | Зарегистрирована отправка в город получателя, заказ в пути |
9 | ACCEPTED_IN_RECIPIENT_CITY | Встречен в городе- получателе | Зарегистрирована встреча заказа в городе получателя |
Приложение 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 | Не вручен |
31 | Возврат, по запросу отправителя | 0 | Не вручен |
32 | Возврат, по запросу плательщика | 0 | Не вручен |
© 2000—2024, Курьерская компания СДЭК