Page tree
Skip to end of metadata
Go to start of metadata

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

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

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

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

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

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

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

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

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

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

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

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


Пример события (ORDER_STATUS)
{
  "type": "ORDER_STATUS",
  "date_time": "2020-08-10T21:32:14+0700",
  "uuid": "72753031-2801-4186-a091-0be58cedfee7",
  "attributes": {
    "is_return": false,
    "cdek_number": "1106321645",
    "status_code": "3",
    "status_date_time": "2020-08-10T21:32:12+0700",
    "city_name": "Новосибирск",
    "city_code": "270"
  }
}
Пример события (PRINT_FORM)
{
  "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"
  }
}

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

Код

Статус

Комментарий

1

Создан

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

2

Удален

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

3

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

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

6

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

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

16

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

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

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

7

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

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

21

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

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

22

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

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

13

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

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

17

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

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

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

19

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

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

20

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

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

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

8

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

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

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

9

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

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

10

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

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

12

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

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

11

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

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

18

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

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

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

4

Вручен

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

5

Не вручен

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

Приложение 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

Не вручен



  • No labels