Мы запустили доставку посылок в постаматы СДЭК! Уже сейчас вы можете формировать отправления до постаматов. Детали расширения протокола здесь.
Выдача посылок работает как с предоплатой, так и с наложенным платежом, с безналичной оплатой на месте.
Для отчета "Статусы заказов" вводится ограничение на период выгрузки изменений. Период будет ограничен 31 днем. Т.е. DateLast - DateFirst = 31 день. При попытке ввести больший период, будет возвращена ошибка.
Рекомендуем использовать списки заказов (StatusReport.Order) т.к. в скором времени планируется отказаться от метода выдачи статусов по периоду.
История изменений
Версия | Дата изменения | Описание изменений |
---|---|---|
1.5 | 13.08.2018 | Создание документации |
1.5 | 03.09.2018 | Добавлен новый метод "Список субъектов РФ" Добавлен новый метод "Список городов" В отчет "Информация по заказам" добавлена детальная информация по упаковкам и товарам Актуализирован перечень дополнительных услуг |
1.5 | 17.09.2018 | В ответе метода "Список ПВЗ" добавлено новое поле "Почтовый индекс" (PostalCode) |
1.5 | 19.09.2018 | Актуализирован алгоритм идентификации города, используемый в методах регистрации заказа, вызова курьера |
1.5 | 12.10.2018 | В запросе метода "Создание преалерта" добавлено новое поле "Дата планируемой передачи" (PlannedMeetingDate) |
1.5 | 17.10.2018 | Актуализирован запрос регистрации заказа на доставку: в разделе "Упаковка" добавлено поле "Описание" (Comment) |
1.5 | 25.10.2018 | В метод "Регистрация заказа от интернет магазина" добавлен новый блок "Доп. сбор за доставку, в зависимости от суммы заказа" (DeliveryRecipientCostAdv) |
1.5 | 10.01.2019 | Актуализирован метод "Регистрация информации о результате прозвона": поле RecipientName, поле Phone, блок Package не поддерживаются Актуализирован перечень причин задержки доставки |
1.5 | 04.02.2019 | В метод "Регистрация заказа от интернет магазина" добавлены новые поля для регистрации международного заказа Через метод "Изменение заказов" добавлена возможность обновлять в заказе: поле RecipientName, поле Phone, блок Address, блок DeliveryRecipientCostAdv Описан формат, в котором необходимо передавать телефонные номера |
1.5 | 19.02.2019 | Добавлено описание API калькулятора |
1.5 | 13.03.2019 | Дополнительная услуга "Страхование" разрешена для заказов типа "доставка" |
1.5 | 19.03.2019 | Добавлены тестовые учетные записи, пути к методам API на тестовой среде, способы отправки сообщений API |
1.5 | 22.03.2019 | Добавлена схема взаимодействия |
1.5 | 25.03.2019 | Добавлена возможность идентифицировать:
В метод изменения заказов добавлена возможность обновлять поля международного заказа |
1.5 | 27.03.2019 | Дополнительная услуга "Упаковка 1" доступна для подключения |
1.5 | 08.04.2019 | Добавлено описание нового метода калькулятора "Расчет стоимости по тарифам без приоритета" В метод "Получение списка ПВЗ" добавлено поле кода страны в формате ISO_3166-1_alpha-2 |
1.5 | 24.04.2019 | В метод "Список городов" добавлена возможность указывать в запросе cityName, postcode и regionFiasGuid |
1.5 | 13.05.2019 | В метод "Регистрация заказа от интернет-магазина" добавлена возможность указывать реквизиты истинного продавца в блоке Seller для дальнейшей печати реквизитов на чеках: Name, Address, Phone, INN, OwnershipForm Убраны отдельные элементы SellerName и SellerAddress |
1.5 | 17.06.2019 | В ближайшее время появится возможность передавать маркировку товаров. В документации описан формат передачи маркировки товаров в методах "Регистрация заказа от интернет-магазина", "Изменение заказов", а также формат вывода маркировки товаров в методах "Статусы заказов", "Информация по заказам". |
1.5 | 26.08.2019 | Изменена обязательность полей блока Sender метода "Регистрация заказа на доставку" |
1.5 | 17.09.2019 | Добавлена возможность обновлять электронный адрес получателя заказа (поле RecipientEmail) через метод "Изменение заказов" |
1.5 | 29.09.2019 | В ответ метода "Список городов" добавлено новое поле timezone |
1.5 | 28.10.2019 | В метод "Получение списка ПВЗ" добавлен новый фильтр по минимальному весу, который принимает ПВЗ (поле weightmin) В методы калькулятора добавлены новые поля, которые используются для идентификации городов (поля senderCountryCode, receiverCountryCode, senderCity, receiverCity, senderLongitude, receiverLongitude, senderLatitude, receiverLatitude |
1.5 | 19.01.2020 | В методе "Регистрация заявки на вызов курьера" поле Comment стало обязательным |
1.5 | 23.03.2020 | В метод "Получение списка ПВЗ" добавлены поля: В метод "Получение списка ПВЗ" добавлен фильтр "HaveCash", позволяющий выбрать офисы, в которых есть оплата наличными. |
1.5 | 27.03.2020 | Из API калькулятора исключено поле "Объём упаковки (в м³)" |
1.5 | 17.04.2020 | Добавлены статусы "Отправлен в г.-отправитель" и "Встречен в г.-отправителе" |
1.5 | 08.06.2020 | Изменены ключи для тестовой учетной записи (типа "интернет-магазин") |
1.5 | 10.07.2020 | Обновлен список причин задержки доставки |
1.5 | 13.07.2020 | Из метода "Регистрация информации о результате прозвона" удалены поля: "DeliveryRecipientCost" - Доп. сбор за доставку, которую ИМ берет с получателя (в валюте страны получателя). "DeliveryRecipientVATRate" - Ставка НДС, включенная в доп. сбор за доставку (подробнее см. приложение 4). Если значение не передано, то берется значение по умолчанию "Без НДС" "DeliveryRecipientVATSum" - Сумма НДС, включенная в доп. сбор за доставку. |
1.5 | 14.07.2020 | Из метода "Регистрация заказа на доставку" удалено поле "ClientSide" |
1.5 | 22.07.2020 |
|
1.5 | 03.09.2020 | Тарифы с кодами 178, 179, 180, 181, 182, 183, 231, 232,376 стали недоступны. |
1.5 | 24.09.2020 | Удален метод "Создание преалерта" |
1.5 | 05.10.2020 | Для методов "Создание заказа" и "Редактирование заказа" добавлено условие обязательности полей "Длина", "Ширина", "Высота". |
1.5 | 11.11.2020 | В метод "Список ПВЗ" добавлено поле isHandout |
1.5 | 15.12.2020 | В метод "Список ПВЗ" добавлено поле IsReception |
1.5 | 15.01.2021 | Для отчета "Статусы заказов" введено ограничение на период выгрузки изменений. Период ограничен 31 днем. |
Введение
Общее описание
В документе представлен порядок и формат обмена данными между Компанией «СДЭК» и клиентом Интернет-Магазином (далее ИМ) или партнером, представляющим интернет-магазины.
Ответы на часто задаваемые вопросы можно увидеть тут: http://www.cdek.ru/faq/
Запросы на генерацию учетной записи, вопросы и пожелания клиентов принимаем на e-mail: integrator@cdek.ru.
Условные обозначения
Информация, выделенная таким знаком, является важной и требует обязательного прочтения и/или выполнения.
Информация, выделенная таким знаком, носит ознакомительный и/или рекомендательный характер.
Информация, выделенная таким знаком, является примером использования настройки или механизма работы.
Термины и определения
ИС — любая информационная система: программное обеспечение, ERP – решение, сайт ИМ.
Интеграция — передача данных, находящихся в различных источниках (ИС) и предоставление данных пользователям в унифицированном виде.
API (англ. Application Programming Interface) – интерфейс прикладного программирования, интерфейс программирования приложений. Это набор готовых функций, структур и констант, предоставляемых приложением (библиотекой, сервисом) для использования во внешних программных продуктах (ИС).
HTTP (англ. Hyper Text Transfer Protocol) – протокол передачи гипертекста. Это протокол прикладного уровня передачи данных (изначально – в виде гипертекстовых документов в формате HTML).
HTTPS (англ. Hyper Text Transfer Protocol Secure) – расширение протокола HTTP, поддерживающее шифрование. Данные, передаваемые по протоколу HTTP, «упаковываются» в криптографический протокол SSL или TLS. В отличие от HTTP для HTTPS по умолчанию используется ТСР-порт 443.
ИМ — интернет-магазин, далее по тексту ИМ – клиент или партнер СДЭК с договором интернет-магазина.
Место (грузоместо, упаковка) — неделимая единица груза, отправляемая ИМ (может быть несколько в одном заказе).
Отправление (заказ) — сумма всех мест, единовременно отправляемых ИМ по одному направлению.
Объемный вес — расчетное значение веса, измеряется в кг. Расчет может быть произведен из указанных габаритов места по формуле длина * высота * ширина/5000. Это общепринятый у транспортных компаний алгоритм пересчета.
Физический вес – определяется взвешиванием погрузочного места на весах. Существуют вес груза нетто и брутто. Нетто — это чистый вес груза без упаковки, а брутто — вес груза в упакованном виде.
Расчетный вес – вес, максимальный среди объемного и физического. Расчет стоимости услуг производится исходя из расчетного веса.
ПВЗ – пункт выдачи заказов получателю. Место, где получатель может самостоятельно забрать свой груз. ПВЗ могут быть как собственные склады СДЭК, так и терминалы выдачи грузов партнеров – почтоматы.
СД – курьерская служба доставки СДЭК.
Международный заказ - заказ, у которого страна отправителя не равна стране получателя и хотя бы одна страна не входит в Таможенный союз.
Что нужно, чтобы осуществить интеграцию
1 шаг: Интеграция возможна только при наличии согласованного договора со СДЭК.
2 шаг: Представителю ИМ необходимо изучить документацию и часто задаваемые вопросы, представленные на сайте www.cdek.ru/clients/integrator.html
3 шаг: Выбрать подходящий для себя вариант интеграции:
Готовые модули партнеров, представленные на сайте компании.
Собственная реализация, если готовые решения по какой-либо причине не подходят.
4 шаг: С помощью тестовой учетной записи протестировать и настроить интеграцию.
- Если выбран готовый модуль партнеров, то за консультацией по настройке необходимо обращаться к разработчику или в службу поддержки данного модуля.
Если реализуется собственное решение, то все предварительные настройки делаем под тестовой учетной записью.
5 шаг: После того как все проверено (протестировано, все вопросы решены), необходимо сделать запрос на формирование «боевой» учетной записи (Account и Secure password) для интеграции на e-mail: integrator@cdek.ru с указанием номера договора со СДЭК.
6 шаг: Перейти на использование «боевой» учетной записи и работать далее в штатном режиме.
Пример запроса учетных данных (рекомендуемый):
Договор №
Платформа/ИС клиента
e-mail – для уведомлений об удачных/неудачных запросах, изменений по интеграции.
1. Общие положения
XML API компании является решением, позволяющим взаимодействовать с сервисом в режиме онлайн с помощью стандартных протоколов и форматов НТТР/ НТТРS и XML.
XML API позволяет реализовать следующую функциональность:
1. Список ПВЗ - используется для получения актуального списка ПВЗ с подробной информацией о нем для дальнейшего использования в ИС ИМ.
2. Регистрация заказа - позволяет на основании документов, содержащих данные по заказам Клиента в акте приема-передачи/ТТН (товарно-транспортная накладная), создать в базе СДЭК накладные, по которым производится вся транспортировка.
3. Обновление заказа - используется для изменения созданной накладной. Возможно изменять следующие данные в накладной: сумму наложенного платежа, данные о получателе, все данные мест и позиций товаров.
4. Удаление заказа - предоставляет возможность удалить из базы СДЭК заказы в случае их ошибочного импорта или существенных изменений их характеристик. Условием возможности удаления заказа является отсутствие движения груза на складе СДЭК (статус заказа «Создан»).
5. Печатная форма квитанции к заказу - используется для формирования печатной формы квитанции к заказу в формате pdf.
6. Заявка на вызов курьера - документ, содержащий информацию по вызову курьера, если необходимо забрать груз со склада ИМ. Груз доставляется до склада СДЭК.
Условия формирования заявки:
на один день возможно не более одного вызова курьера на один адрес;
диапазон времени для приезда курьера не должен быть меньше 3 часов.
Предварительно осуществляется прозвон ИМ по указанному контактному телефону для подтверждения вызова курьера, уточнения информации.
7. Информация о результате прозвона - документ, содержащий данные по прозвону получателя о договоренности доставки до двери или забора (приема груза) со склада в зависимости от режима доставки.
Документ используется в следующих случаях:
ИМ самостоятельно предоставляет в СДЭК расписание получателя для доставки/забора;
изменения в заказе реквизитов получателя (контактное лицо, адрес доставки, телефон);
изменения суммы по оплате за товар.
Данные передаются по уже существующим в базе СДЭК заказам. Также в документе «Список заказов на доставку» возможна передача данных «Прозвон получателя» по новым заказам. Расписание доставки может быть передано только на один день.
Если попытка доставки по расписанию была неудачной, ИМ снова отправляет расписание доставки. Отчет о неудачных попытках доставки предоставляется ИМ в документе «Статусы заказов» (Причины задержки).
8. Печать ШК места - используется для формирования печатной формы этикетки для упаковки в формате pdf.
9. Отчет "Статусы заказов" - позволяет отслеживать следующую информацию по заказам:
- последний статус заказа на доставку и возврата в указанном периоде;
- полную историю статусов заказа на доставку и возврата;
- последний статус «возвратного» заказа («возвратной накладной»);
- полную историю статусов «возвратного» заказа («возвратной накладной»);
- данные о вручении посылки (когда, кому);
- неудавшиеся попытки доставки в разрезе расписания доставки, предоставленного ИМ.
Запрос можно формировать как за определенный период, в который произошли изменения статусов, так и по конкретному списку посылок.
10. Отчет "Информация по заказам" - позволяет отслеживать следующую информацию по заказам:
- код тарифа, по которому был доставлен заказ;
- стоимость выставленных услуг СДЭК по заказу (т.е. сумму на которую будет выставлен счет);
- дата последнего изменения суммы заказа;
- способ передачи заказа получателю (курьер, самозабор);
- тип оплаты наложенного платежа.
11. Калькулятор - позволяет рассчитывать стоимость доставки одного отправления по заданным входным параметрам.
1.1. Идентификаторы посылок и информация на ярлыке
Предпочтительным для компании СДЭК является использование ее собственных ярлыков (квитанций накладных), которые можно получить в виде файла PDF, используя XML API. В случае использования собственного ярлыка, он обязательно должен содержать информацию о получателе (ФИО, адрес, телефон) и любой из идентификаторов:
Идентификатор посылки СДЭК. Рекомендуется в штрих-коде указывать номер накладной СДЭК (в формате обмена данными это атрибут «DispatchNumber»).
Идентификатор заказа ИМ – номер заказа (атрибут «Order. Number»).
Идентификатор грузоместа (упаковки) – штрих-код упаковки (атрибут «Package.BarCode»).
Все штрих-коды должны иметь расшифровку закодированного текста под или над штрих-кодом, чтобы иметь возможность вводить вручную закодированную информацию. Рекомендуется для печати использовать стандарт Code 128.
1.2. Ограничение срока хранения информации в системе
Данные о посылках без движения груза (в статусе «Создан») хранятся в системе СДЭК в течение 30 дней от даты акта. Удаление производится автоматически каждый день в 23-00 NSK. Поэтому отправку запроса на создание заказов на доставку необходимо осуществлять перед реальной отправкой товара (груза).
1.3. Форматы данных и их кодировка
Размерности:
Название | Единица | Обозначение | Разрядность (обязательно) |
---|---|---|---|
Вес | килограмм | Кг | Три знака |
Вес | грамм | Гр | |
Длина сторон | сантиметр | См | |
Валюта | Два знака | ||
Количество | штука | Шт | |
Широта, долгота | десятичные градусы | º | Четыре знака |
Типы данных:
Float – число с плавающей точкой. В качестве разделителя используется именно точка, а не запятая.
String – строка символов заданной длины. Длина строки указывается в скобках.
Integer – целое число.
Boolean – (булевы значения) – принимает значения 0 или 1.
Во всех модулях дата/время передается в формате UTC (YYYY-MM-DDТhh:mm:ss), если иное не указано в описании.
Date Time – дата и время в формате ISO 8601:2004:YYYY-MM-DDThh:mm:ss+hh:mm.
ПРИМЕР: Для даты 21 декабря 2012 года 11 часов 49 минут 49 секунд, время московское: 2012-12-21Т11:49:49+03:00
Может содержать неполную информацию. Например, только часы и минуты (15:30), в таком случае используется часовой пояс UTC+00:00.
Date – дата в формате ISO 8601:2004:YYYY-MM-DD.
Time – время в формате hh:mm:ss.
Email – адрес электронной почты в формате RFC 2822, строка длиной 255 символов.
Внимание! Кириллические адреса (например: пример@пример.рф) не допустимы.
Phone – телефонный номер. Примерный формат для РФ: +7 (ХХХ) ХХХ-ХХ-ХХ, строковый тип данных
Номер телефона рекомендуется передавать в следующем формате:
- номер должен быть написан в международном формате: код страны (для России +7) и сам номер (10 и более цифр);
- номер не должен содержать никаких букв и символов, кроме специальных символов:
- "," (запятая), ";" (точка с запятой), "/" (косая черта), которые служат разделителями между номерами
- ":" (двоеточие), "#" (решетка), которые являются признаком добавочного номера
Данные передаются в формате XML в кодировке UTF-8, при этом необходимо учитывать, что в значениях полей нельзя использовать символы разметки XML (< > & " ').
Будьте внимательны! Если в названии получателя или продавца встречаются двойные, одинарные кавычки, то их надо заменять, например, на символ пробела.
1.4. Авторизация клиентов
Все вызовы функций, кроме справочных данных, требуют авторизации путем указания учетных данных, назначаемых при регистрации в системе СДЭК. Регистрация производится с помощью запроса учетных данных представителей ИМ или менеджера СДЭК.
Идентификация ИМ осуществляется двумя параметрами:
Параметр | Описание |
---|---|
Account | Идентификатор контрагента (логин) |
Secure | Ключ, полученный путем шифрования по алгоритму описанному ниже |
Для обеспечения безопасности при передаче/запросе данных ИМ должен передавать значение поля secure, вычисляемое по алгоритму:
secure = md5(date.'&'. secure password), где
secure password – пароль, выданный компанией СДЭК по запросу;
date – дата документа.
Пример
По запросу ИМ получил учетные данные:
account=f62dcb094cc91617def72d9c260b4483
secure_password=6bd3937dcebd15beb25278bc0657014c
для Date=2016-10-31 secure будет= 9e38e10f9d5394a033a5609c359ecaf2
для Date=2016-09-25T12:45:10 secure будет= 81ad561784277fa864bf644d755fb164
В случае, когда вы передаете запрос на https, в качестве Secure можно использовать Secure password.
Учетная запись для интеграции не совпадает с учетной записью доступа в Личный кабинет СДЭК lk.cdek.ru.
Все запросы необходимо производить под одной учетной записью. Например, если запрос на создание заказа послан с использованием тестовой учетной записи, то формирование печатной формы и отслеживание производится с использованием тестовой учетной записи.
Если ИМ имеет несколько юридических лиц или же производится замена юридических лиц, то это все будут разные договоры со СДЭК, а следовательно и разные учетные данные.
Рекомендуем заранее закладывать возможность работы с несколькими учетными записями, чтобы можно было безболезненно работать в случае нескольких или смены договоров.
1.5. Тестовые учетные записи и их ограничения
Для облегчения процесса интеграции компанией СДЭК предоставляются отдельные тестовые учетные записи:
Тип | Параметр | Значение |
---|---|---|
Интернет-магазин | Account | EMscd6r9JnFiQ3bLoyjJY6eM78JrJceI |
Secure password | PjLZkKBHEiLK3YsjtNrt3TGNG0ahs3kG | |
Доставка | Account | 7JM7K5twfzEV1ssCRklthcIPbbVZrZrZ |
Secure password | t8XBoL1rUofIK9dKoXVB3Tji2F2hPHSk |
При тестировании заказы клиента не отображаются в личном кабинете клиента на сайте www.lk.cdek.ru.
Посылки для тестовых учетных записей не будут обрабатываться и доставляться.
Тестовая учетная запись имеет привязку к тестовому договору, следовательно, для нее не работают скидки и наценки, установленные в Вашем договоре со СДЭК.
После реализации АPI проводится тестирование интеграции. Тестирование состоит из нескольких этапов:
- Тестирование обмена запросами подразумевает собой проверку структуры передаваемых данных на корректность, а также проверку типов данных и значений, передаваемых в параметрах тестируемых методов.
Тестовые отправки проводятся по факту окончания тестирования обмена запросами. Данный этап тестирования подразумевает отправку нескольких реальных заказов ИМ. Проверяется весь функционал от загрузки заказов до доставки их тестовым получателям. Данный этап выполнять не обязательно. Производится по согласованию с менеджером СДЭК.
По завершению отладки ИМ сообщает о готовности переключиться на боевую учетную запись. При этом у клиента обязательно должен быть договор со СДЭК. Для этого необходимо сделать запрос на integrator@cdek.ru с просьбой представить боевые учетные данные.
1.6. Уведомления
ИМ имеет возможность получать уведомления о результате отправки данных на электронную почту. Уведомления содержат информацию как об удачной загрузке заказов, так и об ошибках передачи данных. Список e-mail адресов передается СДЭКу вместе с запросом на учетную запись. От данных уведомлений можно отписаться, но следует помнить, что все рассылки о проведении технических работ и изменениях в протоколе также высылаются на данный адрес.
Все уведомления приходят с электронного адреса: noreply@cdek.ru в формате UTF-8.
1.7. Обратная связь
Контактная информация ГК «СДЭК»:
Основной сайт: http://cdek.ru
Телефон единой справочной службы: 8-800-550-1409 (звонок бесплатный).
Главный офис: 630007, Россия, г. Новосибирск, ул. Большевистская, д. 101
Если у вас возникли вопросы, или Вы нашли ошибку, вы можете обратиться в службу технической поддержки СДЭК по электронной почте integrator@cdek.ru. Рекомендуем в теме письма указывать «Интеграция СДЭК, клиент Название Вашей Компании, Номер Договора, если есть».
2. Алгоритм работы ИМ с интеграцией СДЭК
Рекомендованный алгоритм работы:
1. В ИС ИМ производится подготовка информации о заказах. Заказы можно группировать в единый реестр по любым характеристикам, например, по дате передачи груза на доставку, или передавать каждый отдельно сразу как появился.
2. Из ИС производится регистрация заказов в СД с тарифом от склада.
3. В ИС необходимо осуществить проверку, что СД приняла информацию о заказе:
- если хотя бы один заказ был принят, то можно готовить груз для передачи в СД;
- просмотреть список ошибок, внести изменения в заказы в соответствии с рекомендациями по списку ошибок и повторить отправку запроса.
4. При необходимости можно сохранить в своей ИС список номеров накладных СД (можно получить в ответ на запрос регистрации заказов).
5. Распечатать штрих-коды мест и наклеить на грузоместа.
6. Распечатать квитанции к заказу и приложить их к грузу.
7. Распечатать акт приема-передачи, если осуществляется передача консолидированного груза в СД. Акт приема-передачи можно найти в договоре или использовать свой.
8. При необходимости можно осуществить вызов курьера для забора консолидированного груза. Данная процедура не обязательна при условии, что ИМ сам доставит груз в СД. Для осуществления вызова курьера рекомендуем использовать запрос на «Вызов курьера» . Курьер приедет по указанному адресу в соответствии с заявкой и произведет забор груза по акту и отвезет его на склад СД для дальнейшей транспортировки.
9. СД после приемки груза на склад произведет расконсолидацию груза и будет осуществлять доставку каждого груза отдельно в соответствии с местом назначения и выбранной услугой (тарифом) доставки.
10. ИС может в соответствии с внутренним распорядком запросить «Статус заказа» и отобразить статус СД в своей ИС или же сопоставить статус СД с аналогичным статусом ИС и отобразить уже свой статус для дальнейшего информирования сотрудников ИМ и получателя.
11.В случае изменения позиций товара или суммы наложенного платежа, заказ можно актуализировать, отправив запрос на обновление.
12. При необходимости отменить заказ, по которому еще не была осуществлена работа (статус заказа «Создан»), нужно отправить запрос на удаление.
13. Если по условиям договора ИМ самостоятельно прозванивает (информирует) получателя, необходимо передать СДЭК информацию о договоренности доставки с помощью метода «Прозвон получателя» .
14. При получении конечного статуса «Не вручен» ожидается возврат груза отправителю. Отслеживать возврат груза можно точно также, как описано в п.9.
15. При получении конечного статуса «Вручен» можно прекратить отслеживание состояния доставки груза.
Рекомендуем поместить логотип СДЭК в хорошо просматриваемой части сайта, чтобы получатели видели, какая СД осуществляет доставку. Последнюю версию логотипа можно получить по ссылке https://classic.cdek.ru/website/edostavka/template/images/logo.png
Изменения в базе СДЭК происходят сразу после удачной обработки запроса. То есть, другие необходимые запросы по загруженным заказам можно осуществлять сразу после получения положительного ответа.
Ограничений на количество запросов в сутки нет.
При работе боевого аккаунта накладные в статусе «Создан», по которым нет изменений в течение 30 дней с момента формирования заказа, удаляются автоматически по истечении этого срока. Поэтому отправку запроса на создание заказов на доставку необходимо осуществлять перед реальной отправкой товара.
2.1. Схема взаимодействия
Ниже представлен процесс взаимодействия и соответствующие статусы заказов в ИС СДЭК:
3. Общее описание API
Для взаимодействия с API необходимо отправить POST-запрос на URL: <базовый url интерфейса>/method.
Содержимое запроса (XML-файл) передается в переменной POST-запроса, либо в теле POST-запроса для некоторых методов.
Пример curl команды для одного и другого варианта запроса:
curl -X POST --header 'Content-Type: application/x-www-form-urlencoded' 'http://integration.cdek.ru/integration/add' -d ‘xml_request=<?xml ...’'
curl -X POST --header 'Content-Type: application/xml' 'http://integration.cdek.ru/integration/addRaw' -d ‘<?xml ...’'
Для второго варианта (передачи в теле запроса) путь к методу аналогичен первому варианту, но содержит в конце пути суффикс Raw
3.1. Базовый URL интерфейса
Адрес | Тип сервера |
---|---|
https://integration.cdek.ru | основной |
http://integration.cdek.ru | основной |
http://integration.edu.cdek.ru | тестовый |
https://integration.edu.cdek.ru | тестовый |
3.2. Перечень методов API
3.3. Перевод ошибок интеграции
Для клиента, отправляющего запрос в API интеграции, определяется и устанавливается язык контрагента. Язык определяется по коду языка страны, к которой принадлежит контрагент:
- если язык определен, то вывод ошибок API интеграции осуществляется на языке контрагента;
- если код языка не определен, то для вывода ошибок используется язык по умолчанию.
4. Методы XML API
4.1. Получение списка ПВЗ
Метод используется для получения списка действующих ПВЗ, откуда клиент самостоятельно может забрать заказ.
Список ПВЗ может быть ограничен характеристиками, задаваемыми пользователем.
4.1.1. Описание передаваемых параметров запроса
Для получения списка ПВЗ необходимо отправить GET запрос с параметрами, перечисленными ниже:
№ | Тэг/Атрибут | Описание | Тип поля | Обяз. для заполн. |
---|---|---|---|---|
1 | citypostcode1 | Почтовый индекс города, для которого необходим список ПВЗ | integer | нет |
2 | cityid1 | Код города по базе СДЭК (https://cdek.ru/storage/source/document/1/CDEK_city.zip) | integer | нет |
3 | type | Тип пункта выдачи, может принимать значения: «PVZ» - для отображения только складов СДЭК; При отсутствии параметра принимается значение по умолчанию «ALL». | string(8) | нет |
4 | countryid | Код страны по базе СДЭК | integer | нет |
5 | countryiso | Код страны в формате ISO_3166-1_alpha-2 (см. “Общероссийский классификатор стран мира”) | string (2) | нет |
6 | regionid | Код региона по базе СДЭК | integer | нет |
7 | havecashless | Наличие терминала оплаты, может принимать значения: «1», «true» - есть; | boolean | нет |
8 | havecash | Наличие оплаты наличными, может принимать значения: «1», «true» - есть; | boolean | нет |
9 | allowedcod | Разрешен наложенный платеж, может принимать значения: «1», «true» - да; | boolean | нет |
10 | isdressingroom | Наличие примерочной, может принимать значения: «1», «true» - есть; | boolean | нет |
11 | weightmax | Максимальный вес в кг, который может принять ПВЗ (значения больше 0 - передаются ПВЗ, которые принимают этот вес; 0 - ПВЗ с нулевым весом не передаются; значение не указано - все ПВЗ). | integer | нет |
12 | weightmin | Минимальный вес в кг, который принимает ПВЗ (при переданном значении будут выводиться ПВЗ с минимальным весом до указанного значения) | integer | нет |
13 | lang | Локализация ПВЗ. По умолчанию "rus". | string(3) | нет |
14 | takeonly | Является ли ПВЗ только пунктом выдачи, может принимать значения: «1», «true» - да; | boolean | нет |
15 | isHandout | Является пунктом выдачи, может принимать значения: «1», «true» - да; | boolean | нет |
16 | IsReception | Является пунктом приёма, может принимать значения: «1», «true» - да; | boolean | нет |
1 Если одновременно указаны параметры cityid и citypostcode, то для определения города всех стран присутствия СДЭК приоритет отдается cityid.
4.1.2. Формат ответа
Сервер СДЭК вернет результат в виде XML :
№ | Тэг/Атрибут | Описание | Тип поля | Обяз. |
---|---|---|---|---|
1 | PvzList | Заголовок документа | да | |
1.1 | Pvz | ПВЗ | да | |
1.1.1 | Code | Код | string(10) | да |
1.1.2 | PostalCode | Почтовый индекс | string (6) | да |
1.1.3 | Name | Название | string(50) | да |
1.1.4 | CountryCode | Код страны | integer(9) | да |
1.1.5 | countryCodeIso | Код страны в формате ISO_3166-1_alpha-2 (см. “Общероссийский классификатор стран мира”) | integer(2) | да |
1.1.6 | CountryName | Название страны | string(50) | да |
1.1.7 | RegionCode | Код региона | integer(9) | да |
1.1.8 | RegionName | Название региона | string(50) | да |
1.1.9 | CityCode | Код города по базе СДЭК (https://cdek.ru/storage/source/document/1/CDEK_city.zip ) | integer | да |
1.1.10 | City | Название города | string(50) | да |
1.1.11 | WorkTime | Режим работы, строка вида «пн-пт 9-18, сб 9-16» | string(100) | да |
1.1.12 | Address | Адрес (улица, дом, офис) в указанном городе | string(255) | да |
1.1.13 | FullAddress | Полный адрес с указанием страны, региона, города, и т.д. | string(255) | да |
1.1.14 | AddressComment | Описание местоположения | string(255) | да |
1.1.15 | Phone | Телефон | phone | да |
1.1.16 | PhoneDetailList | Перечень всех номеров телефонов офиса | [0].number | да |
1.1.17 | Адрес электронной почты | string(255) | да | |
1.1.18 | Note | Примечание по ПВЗ | string(255) | да |
1.1.19 | coordX | Координаты местоположения (долгота) в градусах | float | да |
1.1.20 | coordY | Координаты местоположения (широта) в градусах | float | да |
1.1.21 | Type | Тип ПВЗ: | string(8) | да |
1.1.22 | ownerCode | Принадлежность ПВЗ компании: CDEK — ПВЗ принадлежит компании СДЭК, InPost — ПВЗ принадлежит компании InPost. | string(6) | да |
1.1.23 | IsDressingRoom | Есть ли примерочная | string(4) | да |
1.1.24 | HaveCashless | Есть терминал оплаты | string(4) | да |
1.1.25 | HaveCash | Есть приём наличных | string(4) | да |
1.1.26 | AllowedCod | Разрешен наложенный платеж в ПВЗ | string(4) | да |
1.1.27 | TakeOnly | Является ли ПВЗ только пунктом выдачи или также осуществляет приём грузов | string(4) | да |
1.1.28 | NearestStation | Ближайшая станция/остановка транспорта | string(50) | да |
1.1.29 | MetroStation | Ближайшая станция метро | string(50) | да |
1.1.30 | Site | Ссылка на данный ПВЗ на сайте СДЭК | string(255) | нет |
1.1.31 | OfficeImage | Все фото офиса (кроме фото как доехать). | ||
1.1.31.1 | url | Все фотографии отдельным тегом с атрибутом url. Отображается ссылка на картинку. <OfficeImage url="http://dfdfdf/images/22/47_1_SUR2"/> | string(255) | да |
1.1.32 | WorkTimeY | График работы на неделю. Вложенный тег с атрибутами day и period. | да | |
1.1.32.1 | day | Порядковый номер дня начиная с единицы. Понедельник = 1, воскресенье = 7. | integer (1) | да |
1.1.32.2 | periods | Период работы в эти дни. Если в этот день не работают, то не отображать. | string(20) | да |
1.1.33 | WorkTimeExceptions | Исключения в графике работы офиса | да | |
1.1.33.1 | Date | Дата | datetime | да |
1.1.33.2 | Time | Период работы в указанную дату. Если в этот день не работают, то не отображается. | string(20) | да |
1.1.33.3 | IsWorking | Признак рабочего/нерабочего дня в указанную дату | string(4) | да |
1.1.34 | WeightLimit | Ограничения по весу для выдачи в ПВЗ (тэг существует только при наличии ограничений) | нет | |
1.1.34.1. | WeightMin | Минимальный вес (в кг.), принимаемый в ПВЗ (> WeightMin) | float | нет |
1.1.34.2. | WeightMax | Максимальный вес (в кг.), принимаемый в ПВЗ (<=WeightMax) | float | нет |
1.1.35 | Dimensions | Перечень максимальных размеров ячеек постамата | [ ] | |
1.1.35.1 | width | Ширина (см) | float | да, если Type= POSTAMAT или ALL |
1.1.35.2 | height | Высота (см) | float | да, если Type= POSTAMAT или ALL |
1.1.35.3 | depth | Глубина (см) | float | да, если Type= POSTAMAT или ALL |
1.1.36 | Fulfillment | Наличие зоны фулфилмента | string(4) | нет |
1.1.37 | isHandout | Является пунктом выдачи | boolean | да |
1.1.38 | IsReception | Является пунктом приёма | boolean | да |
Пример. Список ПВЗ
Запрос списка ПВЗ в городе Новосибирске, в которых разрешен прием наложенного платежа http://integration.cdek.ru/pvzlist/v1/xml?weightmax=50&cityid=270&allowedcod=1
<PvzList> <Pvz Code="NSK71" PostalCode="630001" Name="На Холодильной" CountryCode="1" countryCodeIso="RU" CountryName="Россия" RegionCode="23" RegionName="Новосибирская обл." CityCode="270" City="Новосибирск" WorkTime="Сб-Вс 10:00-16:00, Пн-Пт 10:00-20:00" Address="ул. Холодильная, 13" FullAddress="Россия, Новосибирская обл., Новосибирск, ул. Холодильная, 13" AddressComment="Рядом с остановкой «Холодильная» ( по стороне нечетных домов Дуси Ковальчук) стоит дом , от дороги второе офисное помещение." Phone="+79913770310"Email="Bibikova.m@cdek.ru" qqId="" Note="" coordX="82.885359" coordY="55.049586" Type="PVZ" ownerCode="cdek" IsDressingRoom="true" IsHandout="true" IsReception="true" HaveCashless="true" AllowedCod="true" NearestStation="Холодильная" MetroStation="Заельцовская" Site=""> <PhoneDetail number="+79913770310"/> <WorkTimeY day="1" periods="10:00/20:00"/> <WorkTimeY day="2" periods="10:00/20:00"/> <WorkTimeY day="3" periods="10:00/20:00"/> <WorkTimeY day="4" periods="10:00/20:00"/> <WorkTimeY day="5" periods="10:00/20:00"/> <WorkTimeY day="6" periods="10:00/16:00"/> <WorkTimeY day="7" periods="10:00/16:00"/> </Pvz> <Pvz Code="NSK33" PostalCode="630049" Name="На Дуси Ковальчук" CountryCode="1" countryCodeIso="RU" CountryName="Россия" RegionCode="23" RegionName="Новосибирская обл." CityCode="270" City="Новосибирск" WorkTime="Вс 10:00-16:00, Сб 10:00-16:00, Пн-Пт 10:00-20:00" Address="ул. Дуси Ковальчук, 179а, 3" FullAddress="Россия, Новосибирская обл., Новосибирск, ул. Дуси Ковальчук, 179а, 3" AddressComment="От метро по ул. Дуси Ковальчук в сторону Университета путей сообщения. Здание рядом с БЦ Колибри, вход с правой стороны." Phone="+79607857869" Email="e.arestova@cdek.ru" qqId="" Note="" coordX="82.916109" coordY="55.06141" Type="PVZ" ownerCode="cdek" IsDressingRoom="true" IsHandout="true" IsReception="true" HaveCashless="true" AllowedCod="true" NearestStation="Ст. м. Заельцовская, пл.Калинина"MetroStation="Ст. м. Заельцовская" Site=""> <PhoneDetail number="+79607857869"/> <OfficeImage number="1" url="https://pvzimage.cdek.ru/images/1368/230_1_NSK33"/> <OfficeImage number="2" url="https://pvzimage.cdek.ru/images/1368/231_2_NSK33"/> <OfficeImage number="3" url="https://pvzimage.cdek.ru/images/1368/232_3_NSK33"/> <OfficeImage number="4" url="https://pvzimage.cdek.ru/images/1368/233_4_NSK33"/> <OfficeImage number="5" url="https://pvzimage.cdek.ru/images/1368/234_5_NSK33"/> <WorkTimeY day="1" periods="10:00/20:00"/> <WorkTimeY day="2" periods="10:00/20:00"/> <WorkTimeY day="3" periods="10:00/20:00"/> <WorkTimeY day="4" periods="10:00/20:00"/> <WorkTimeY day="5" periods="10:00/20:00"/> <WorkTimeY day="6" periods="10:00/16:00"/> <WorkTimeY day="7" periods="10:00/16:00"/> </Pvz> </PvzList>
4.2. Регистрация заказа
Метод используется для регистрации заказов доставки товаров до клиентов.
Выделяется 2 типа заказов:
- “интернет-магазин” - может быть только у клиента с типом договора “Интернет-магазин”;
- “доставка” может быть создан любым клиентом с договором (доступны только тарифы для обычной доставки).
Форматы данных для типов заказа “интернет-магазин” и “доставка” описаны отдельно.
4.2.1. Описание передаваемых полей запроса
Регистрация заказа от интернет-магазина
№ | Тэг/Атрибут | Описание | Тип поля | Обяз. для заполн. |
---|---|---|---|---|
1 | DeliveryRequest | Заголовок документа | да | |
1.1 | Number | Номер акта приема-передачи/ТТН (сопроводительного документа при передаче груза СДЭК, формируется в системе ИМ). Идентификатор реестра грузов в ИС клиента СДЭК. По умолчанию можно использовать 1. | string(30) | да |
1.2 | Date | Дата документа (дата заказа) | Date | да |
1.3 | Account | Идентификатор ИМ (логин) | string(255) | да |
1.4 | Secure | Ключ | string(255) | да |
1.5 | OrderCount | Общее количество заказов в документе | integer | да |
1.6 | Order | Отправление (заказ) | да | |
1.6.1 | Number | Номер отправления клиента (уникален в пределах заказов одного клиента). Идентификатор заказа в ИС Клиента. | string(40) | да |
1.6.2 | SendCityCode1 | Код города отправителя из базы СДЭК (https://cdek.ru/storage/source/document/1/CDEK_city.zip ) | integer | да |
1.6.3 | RecCityCode1 | Код города получателя из базы СДЭК (https://cdek.ru/storage/source/document/1/CDEK_city.zip ) | integer | да |
1.6.4 | SendCityPostCode1 | Почтовый индекс города отправителя | string(6) | да |
1.6.5 | RecCityPostCode1 | Почтовый индекс города получателя | string(6) | да |
1.6.6 | SendCountryCode1 | Код страны отправителя для идентификации страны в формате ISO_3166-1_alpha-2 (см. “Общероссийский классификатор стран мира”). По умолчанию - RU. | string(2) | нет |
1.6.7 | RecCountryCode1 | Код страны получателя для идентификации страны в формате ISO_3166-1_alpha-2 (см. “Общероссийский классификатор стран мира”). По умолчанию - RU. | string(2) | нет |
1.6.8 | SendCityName1 | Наименование города отправителя | string(255) | нет |
1.6.9 | RecCityName1 | Наименование города получателя | string(255) | нет |
1.6.10 | RecipientINN | ИНН получателя. Используется для международных заказов | string(12) | нет |
1.6.11 | DateInvoice | Дата инвойса. Используется для международных заказов | Date time/date | да, если заказ - международный |
1.6.12 | ShipperName | Грузоотправитель. Используется при печати накладной. Используется для международных заказов | string (255) | да, если заказ - международный |
1.6.13 | ShipperAddress | Адрес грузоотправителя. Используется при печати накладной. Используется для международных заказов | string (255) | да, если заказ - международный |
1.6.14 | Passport | Данные паспорта получателя. Используется для международных заказов | нет | |
1.6.14.1 | Series | Серия паспорта получателя | string (255) | нет |
1.6.14.2 | Number | Номер паспорта получателя | string (255) | нет |
1.6.14.3 | IssueDate | Дата выдачи паспорта получателя | date | нет |
1.6.14.4 | IssuedBy | Кем выдан паспорт получателя | string (255) | нет |
1.6.14.5 | DateBirth | Дата рождения получателя | date | нет |
1.6.15 | Sender | Отправитель. Обязательно указывать, если отличается от Клиента ИМ. Если ИМ является отправителем, тэг Sender - отсутствует. | нет | |
1.6.15.1 | Company | Наименование компании отправителя | string(128) | нет |
1.6.15.2 | Name | Контактное лицо отправителя | string(128) | нет |
1.6.15.3 | Address1 | Адрес отправителя | нет | |
1.6.15.3.1 | Street | Улица | string(50) | да |
1.6.15.3.2 | House | Дом | string(30) | нет |
1.6.15.3.3 | Flat | Квартира/офис | string(10) | нет |
1.6.15.4 | Phone | Телефон отправителя (передается отдельным тегом) | phone | нет |
1.6.16 | RecipientName | Получатель (ФИО). Минимум 3 символа. | string(128) | да |
1.6.17 | RecipientEmail | E-mail получателя для рассылки уведомлений о движении заказа, для связи в случае недозвона. | еmail | нет |
1.6.18 | Phone | Телефон получателя | phone | да |
1.6.19 | TariffTypeCode7 | Код типа тарифа (подробнее см. приложение 1) | integer | да |
1.6.20 | DeliveryRecipientCost2 | Доп. сбор за доставку, которую ИМ берет с получателя (в валюте страны получателя). Если доп. сбор зависит от стоимости заказа, то данную информацию необходимо передавать в блоке DeliveryRecipientCostAdv. В этом случае в данном теге (DeliveryRecipientCost) передается стоимость доставки, когда сумма заказа превысила максимальный порог. | float | нет |
1.6.21 | DeliveryRecipientVATRate | Ставка НДС, включенная в доп. сбор за доставку (подробнее см. приложение 4). Если значение не передано, то берется значение по умолчанию "Без НДС" | string(10) | нет |
1.6.22 | DeliveryRecipientVATSum | Сумма НДС, включенная в доп. сбор за доставку. | float | нет |
1.6.23 | Seller | Реквизиты истинного продавца | нет | |
1.6.23.1 | Address | Адрес истинного продавца. Используется при печати инвойсов для отображения адреса настоящего продавца товара, либо торгового названия. Используется для международных заказов | string (255) | да, если заказ - международный |
1.6.23.2 | Name | Наименование истинного продавца | string (255) | да, если указан ИНН |
1.6.23.3 | INN | ИНН истинного продавца | string (20) | нет |
1.6.23.4 | Phone | Телефон истинного продавца | phone | да, если указан ИНН |
1.6.23.5 | OwnershipForm | Код формы собственности (подробнее см. приложение 10) | integer | да, если указан ИНН |
1.6.24 | Comment3 | Комментарий особые отметки по заказу | string(255) | нет |
1.6.25 | Address1 | Адрес доставки. В зависимости от режима доставки необходимо указывать либо атрибуты «Street», «House», «Flat» - доставка до адресата получателя, либо «PvzCode» - самозабор | да | |
1.6.25.1 | Street | Улица получателя. Рекомендуем по возможности не указывать префиксы значений, вроде «ул.» | string(50) | да |
1.6.25.2 | House | Дом, корпус, строение получателя. Рекомендуем по возможности не указывать префиксы значений, вроде «дом» | string(30) | нет |
1.6.25.3 | Flat | Квартира/Офис получателя. Рекомендуем по возможности не указывать префиксы значений, вроде «кв.» | string(10) | нет |
1.6.25.4 | PvzCode | Код ПВЗ. Атрибут необходим для заказов с режимом доставки «до склада» и при условии, что не заказана дополнительная услуга "Доставка в городе получателе"(AddService="17", подробнее см. приложение 2), и для заказов с режимом "до постамата" | string(10) | да, если режим доставки "до склада" или "до постамата" |
1.6.26 | Package | Упаковка (все упаковки передаются в разных тэгах Package) | да | |
1.6.26.1 | Number | Номер упаковки (можно использовать порядковый номер упаковки заказа или номер заказа), уникален в пределах заказа. Идентификатор заказа в ИС Клиента. | string(20) | нет |
1.6.26.2 | BarCode | Штрих-код упаковки, идентификатор грузоместа (если есть, иначе передавать значение номера упаковки Packege.Number). Параметр используется для оперирования грузом на складах СДЭК), уникален в пределах заказа. Идентификатор грузоместа в ИС Клиента. | string(20) | да |
1.6.26.3 | Weight7 | Общий вес (в граммах) | integer | да |
1.6.26.4 | SizeA4 | Габариты упаковки. Длина (в сантиметрах) | integer | да, если указаны остальные габариты, в пределах от 1 до 1500 |
1.6.26.5 | SizeB4 | Габариты упаковки. Ширина (в сантиметрах) | integer | да, если указаны остальные габариты, в пределах от 1 до 1500 |
1.6.26.6 | SizeC4 | Габариты упаковки. Высота (в сантиметрах) | integer | да, если указаны остальные габариты, в пределах от 1 до 1500 |
1.6.26.7 | Item | Вложение (товар) | да | |
1.6.26.7.1 | Amount | Количество единиц одноименного товара (в штуках). Максимальное количество - 999. | integer | да |
1.6.26.7.2 | WareKey | Идентификатор/артикул товара/вложения. | string(50) | да |
1.6.26.7.3 | Marking8 | Маркировка товара/вложения. Если для товара/вложения указана маркировка, Amount не может быть больше 1. | string | нет |
1.6.26.7.4 | Cost | Объявленная стоимость товара (за единицу товара в валюте взаиморасчетов, значение >=0). С данного значения рассчитывается страховка. | float | да |
1.6.26.7.5 | Payment | Оплата за товар при получении (за единицу товара в валюте страны получателя, значение >=0) — наложенный платеж, в случае предоплаты значение = 0. | float | да |
1.6.26.7.6 | PaymentVATRate | Ставка НДС, включенная в стоимость товара (подробнее см. приложение 4). Если значение не передано, то берется значение по умолчанию "Без НДС" | string(10) | нет |
1.6.26.7.7 | PaymentVATSum | Сумма НДС, включенного в стоимость (payment) товара. | float | нет |
1.6.26.7.8 | Weight | Вес (за единицу товара, в граммах) | integer | да |
1.6.26.7.9 | Comment | Наименование товара (может также содержать описание товара: размер, цвет) | string(255) | да |
1.6.26.7.10 | WeightBrutto | Вес брутто (за единицу товара, в граммах). Используется для международных заказов | integer | да, если заказ - международный |
1.6.26.7.11 | CommentEx | Наименование товара на английском (может также содержать описание товара: размер, цвет). Используется для международных заказов | string(255) | нет |
1.6.26.7.12 | Link | Ссылка на сайт интернет-магазина с описанием товара. Используется для международных заказов | string(255) | нет |
1.6.27 | DeliveryRecipientCostAdv | Доп. сбор за доставку (которую ИМ берет с получателя), в зависимости от суммы заказа | нет | |
1.6.27.1 | Threshold | Порог стоимости товара (действует по условию меньше или равно), в целых единицах валюты | integer | да |
1.6.27.2 | Sum | Доп. сбор за доставку товаров, общая стоимость которых попадает в интервал | float | да |
1.6.27.3 | VATRate | Ставка НДС, включенная в доп. сбор за доставку (подробнее см. приложение 4). Если значение не передано, то берется значение по умолчанию "Без НДС" | string(10) | нет |
1.6.27.4 | VATSum | Сумма НДС, включенная в доп. сбор за доставку. | float | нет |
1.6.28 | AddService | Дополнительные услуги | нет | |
1.6.28.1 | ServiceCode | Тип дополнительной услуги (подробнее см. приложение 2) | integer | да |
1.6.28.2 | Count | Количество упаковок. Используется и является обязательным только для дополнительной услуги "Упаковка 1". | integer | нет |
1.6.29 | Schedule5 | Расписание времени доставки (deprecated, рекомендуется использовать отдельный метод new_schedule) | нет | |
1.6.29.1 | Attempt | Время доставки (в один день возможен один временной интервал не менее 3 часов) | да | |
1.6.29.1.1 | ID | Идентификационный номер расписания по базе ИМ. По умолчанию можно использовать 1 | integer | да |
1.6.29.1.2 | Date | Дата доставки (только дата, в формате «YYYY-MM-DD», без времени) согласованная с получателем | date | да |
1.6.29.1.3 | Comment | Комментарий | string(255) | нет |
1.6.29.1.4 | TimeBeg | Начало временного диапазона доставки (время получателя) | time | да |
1.6.29.1.5 | TimeEnd | Окончание временного диапазона доставки (время получателя) | time | да |
1.6.29.1.6 | Address | Новый адрес доставки (если требуется изменить). В зависимости от режима доставки необходимо указывать либо атрибуты «Street», «House», «Flat» - доставка до адресата получателя, либо «PvzCode» - самозабор | нет | |
1.6.29.1.6.1 | Street | Улица получателя. Рекомендуем по возможности не указывать префиксы значений вроде «ул.» | string(50) | да |
1.6.29.1.6.2 | House | Дом, корпус, строение получателя. Рекомендуем по возможности не указывать префиксы значений вроде «дом» | string(30) | да |
1.6.29.1.6.3 | Flat | Квартира/Офис получателя. Рекомендуем по возможности не указывать префиксы значений вроде «кв.» | string(10) | нет |
1.6.29.1.6.4 | PvzCode | Код ПВЗ, необходим только для заказов с режимом доставки «до склада» и при условии, что не заказана дополнительная услуга "Доставка в городе получателе". | string(10) | да |
1.7 | CallCourier6 | Вызов курьера | нет | |
1.7.1 | Call | Ожидание курьера | да | |
1.7.1.1 | Date | Дата ожидания курьера | date | да |
1.7.1.2 | TimeBeg | Время начала ожидания курьера | time | да |
1.7.1.3 | TimeEnd | Время окончания ожидания курьера | time | да |
1.7.1.4 | LunchBeg | Время начала обеда, если входит во временной диапазон [TimeBeg; TimeEnd] | time | нет |
1.7.1.5 | LunchEnd | Время окончания обеда, если входит во временной диапазон [TimeBeg; TimeEnd] | time | нет |
1.7.1.6 | SendCityCode1 | Код города отправителя из базы СДЭК (https://cdek.ru/storage/source/document/1/CDEK_city.zip ) | integer | да |
1.7.1.7 | SendCityPostCode1 | Почтовый индекс города отправителя | string(6) | да |
1.7.1.8 | SendCountryCode1 | Код страны отправителя для идентификации страны в формате ISO_3166-1_alpha-2 (см. “Общероссийский классификатор стран мира”) | string(2) | нет |
1.7.1.9 | SendCityName1 | Наименование города отправителя | string(255) | нет |
1.7.1.10 | SendPhone | Контактный телефон отправителя | phone | да |
1.7.1.11 | SenderName | Отправитель (ФИО) | string(255) | да |
1.7.1.12 | Comment | Комментарий для курьера | string(255) | нет |
1.7.1.13 | SendAddress1 | Адрес отправителя | да | |
1.7.1.13.1 | Street | Улица отправителя. Рекомендуем по возможности не указывать префиксы значений, вроде «ул.» | string(50) | да |
1.7.1.13.2 | House | Дом, корпус, строение отправителя. Рекомендуем по возможности не указывать префиксы значений, вроде «дом» | string(30) | да |
1.7.1.13.3 | Flat | Квартира/Офис отправителя. Рекомендуем по возможности не указывать префиксы значений, вроде «кв.» | string(10) | да |
Регистрация заказа на доставку
№ | Тэг/Атрибут | Описание | Тип поля | Обяз. для заполн. |
---|---|---|---|---|
1 | DeliveryRequest | Заголовок документа | да | |
1.1 | Number | Номер акта приема-передачи/ТТН. Идентификатор реестра грузов в ИС клиента СДЭК. По умолчанию можно использовать 1. | string(30) | да |
1.2 | Date | Дата документа (дата заказа) | Date | да |
1.3 | Account | Идентификатор Клиента (логин) | string(255) | да |
1.4 | Secure | Ключ | string(255) | да |
1.5 | OrderCount | Общее количество заказов в документе | integer | да |
1.6 | Order | Отправление (заказ) | да | |
1.6.1 | SendCityCode1 | Код города отправителя из базы СДЭК (https://cdek.ru/storage/source/document/1/CDEK_city.zip ) | integer | да |
1.6.2 | RecCityCode1 | Код города получателя из базы СДЭК (https://cdek.ru/storage/source/document/1/CDEK_city.zip ) | integer | да |
1.6.3 | SendCityPostCode1 | Почтовый индекс города отправителя | string(6) | да |
1.6.4 | RecCityPostCode1 | Почтовый индекс города получателя | string(6) | да |
1.6.5 | SendCountryCode1 | Код страны отправителя для идентификации страны в формате ISO_3166-1_alpha-2 (см. “Общероссийский классификатор стран мира”). По умолчанию - RU. | string(2) | нет |
1.6.6 | RecCountryCode1 | Код страны получателя для идентификации страны в формате ISO_3166-1_alpha-2 (см. “Общероссийский классификатор стран мира”). По умолчанию - RU. | string(2) | нет |
1.6.7 | SendCityName1 | Наименование города отправителя | string(255) | нет |
1.6.8 | RecCityName1 | Наименование города получателя | string(255) | нет |
1.6.9 | Sender | Отправитель | да | |
1.6.91 | Company | Наименование компании отправителя | string(128) | нет |
1.6.9.2 | Name | Контактное лицо отправителя | string(128) | да |
1.6.9.3 | Address1 | Адрес забора груза | да | |
1.6.9.3.1 | Street | Улица | string(50) | да |
1.6.9.3.2 | House | Дом | string(30) | нет |
1.6.9.3.3 | Flat | Квартира/офис | string(10) | нет |
1.6.9.4 | Phone | Телефон отправителя (передается отдельным тегом) | phone | да |
1.6.10 | RecipientCompany | Наименование компании получателя | string(128) | да |
1.6.11 | RecipientName | Получатель (ФИО). Минимум 3 символа. | string(128) | да |
1.6.12 | RecipientEmail | E-mail получателя для рассылки уведомлений о движении заказа, для связи в случае недозвона. | еmail | нет |
1.6.13 | Phone | Телефон получателя | phone | да |
1.6.14 | TariffTypeCode7 | Код типа тарифа (подробнее см. приложение 1) | integer | да |
1.6.15 | Comment3 | Комментарий особые отметки по заказу | string(255) | нет |
1.6.16 | Address1 | Адрес доставки. В зависимости от режима доставки необходимо указывать либо атрибуты «Street», «House», «Flat» - доставка до адресата получателя, либо «PvzCode» - самозабор | да | |
1.6.16.1 | Street | Улица получателя. Рекомендуем по возможности не указывать префиксы значений, вроде «ул.» | string(50) | да |
1.6.16.2 | House | Дом, корпус, строение получателя. Рекомендуем по возможности не указывать префиксы значений, вроде «дом» | string(30) | нет |
1.6.16.3 | Flat | Квартира/Офис получателя. Рекомендуем по возможности не указывать префиксы значений, вроде «кв.» | string(10) | нет |
1.6.16.4 | PvzCode | Код ПВЗ. Атрибут необходим для заказов с режимом доставки «до склада» и при условии, что не заказана дополнительная услуга "Доставка в городе получателе"(AddService="17", подробнее см. приложение 2), и для заказов с режимом "до постамата" | string(10) | да, если режим доставки "до склада" иди "до постамата" |
1.6.17 | Package | Упаковка (все упаковки передаются в разных тэгах Package) | да | |
1.6.17.1 | Number | Номер упаковки (можно использовать порядковый номер упаковки заказа или номер заказа), уникален в пределах заказа. Идентификатор заказа в ИС Клиента. | string(20) | нет |
1.6.17.2 | BarCode | Штрих-код упаковки, идентификатор грузоместа (если есть, иначе передавать значение номера упаковки Packege.Number). Параметр используется для оперирования грузом на складах СДЭК), уникален в пределах заказа. Идентификатор грузоместа в ИС Клиента. | string(20) | да |
1.6.17.3 | Weight7 | Общий вес (в граммах) | integer | нет |
1.6.17.4 | SizeA4 | Габариты упаковки. Длина (в сантиметрах) | integer | да, если указаны остальные габариты, в пределах от 1 до 1500 |
1.6.17.5 | SizeB4 | Габариты упаковки. Ширина (в сантиметрах) | integer | да, если указаны остальные габариты, в пределах от 1 до 1500 |
1.6.17.6 | SizeC4 | Габариты упаковки. Высота (в сантиметрах) | integer | да, если указаны остальные габариты, в пределах от 1 до 1500 |
1.6.17.7 | Comment | Описание | string(255) | да |
1.6.18 | AddService | Дополнительные услуги | нет | |
1.6.18.1 | ServiceCode | Тип дополнительной услуги (подробнее см. приложение 2) | integer | да |
1.6.18.2 | Cost | Объявленная стоимость отправления (заказа). Используется и является обязательным только для дополнительной услуги "Страхование". | float | нет |
1.6.18.3 | Count | Количество упаковок. Используется и является обязательным только для дополнительной услуги "Упаковка 1". | integer | нет |
1 Идентификация города отправителя и города получателя (в случае режима "до двери") производится по следующему алгоритму в порядке приоритетности:
По уникальному коду города базы СДЭК (ID города). Коды городов базы СДЭК можно найти в реестрах городов в пакете документации (https://cdek.ru/storage/source/document/1/CDEK_city.zip ). Значения передаются в атрибутах SendCityCode, RecCityCode.
По почтовому индексу города. Значения передаются в атрибутах SendCityPostCode, RecCityPostCode. В паре с почтовым индексом в качестве уточняющих параметров могут быть использованы код страны (атрибуты SendCountryCode, RecCountryCode) и/или наименование города (атрибуты SendCityName, RecCityName): код страны искомого города должен совпадать с указанным в соответствующем атрибуте, а переданное название города должно входить в название искомого. Наименование города можно указывать на языке клиента (поиск будет произведен по всем локализациям).
- По строке адреса, которая формируется путем конкатенации следующих полей: SendCityName/RecCityName + Address.Street + Address.House
Идентификация города получателя (в случае режима "до склада") производится по следующему алгоритму в порядке приоритетности:
- По уникальному коду города базы СДЭК (ID города). Коды городов базы СДЭК можно найти в реестрах городов в пакете документации (https://cdek.ru/storage/source/document/1/CDEK_city.zip). Значение передается в атрибуте RecCityCode.
- По переданному коду ПВЗ (атрибут PvzCode).
- По почтовому индексу города. Значение передается в атрибуте RecCityPostCode. В паре с почтовым индексом в качестве уточняющих параметров могут быть использованы код страны (атрибут RecCountryCode) и/или наименование города (атрибут RecCityName): код страны искомого города должен совпадать с указанным в соответствующем атрибуте, а переданное название города должно входить в название искомого. Наименование города можно указывать на языке клиента (поиск будет произведен по всем локализациям).
Чаще всего город отправления фиксируют кодом города, а для определения города получателя используется почтовый индекс.
Нужно принимать во внимание, что база почтовых индексов в ИС СДЭК может содержат неполную и иногда не точную информацию по почтовым индексам, поэтому пользователь должен иметь возможность скорректировать параметр почтового индекса, если это необходимо.
2 В случае, если услуги доставки СДЭК оплачивает не получатель, а ИМ, в стоимость заказа может быть включена стоимость доставки, которую ИМ берет с получателя, например, в качестве компенсации своих расходов. Эта сумма может отличаться от стоимости доставки по тарифам СДЭК. Значение параметра отображается в квитанции к заказу в поле «Стоимость доставки», но при этом входит в сумму наложенного платежа и обрабатывается как наложенный платеж.
3 В поле комментарий можно писать любые примечания по доставке груза, например если вы разрешаете частичную выдачу груза можно указывать “Частичная доставка разрешена», если запрещаете вскрытие посылки можно указывать «Запрет вскрытия».
4 Габариты упаковки необходимо указывать, если упаковка представляет собой коробку или если заказа "до постамата". С учетом габаритов вычисляется объемный вес по формуле SizeА * SizeВ * SizeС/5000 и определяется подходящая ячейка постамата. Расчет стоимости доставки идет из максимального значения между фактическим и объемным весом.
5 В договоре с ИМ определяется условие, кто именно, ИМ или СДЭК, запрашивает у получателя расписание для доставки отправления. В случае, если ИМ самостоятельно запрашивает расписание, данные передаются в тэге <Schedule>. Расписание может быть передано позже, при необходимости (см. метод «Регистрация информации о результате прозвона» ).
На одну дату по одному заказу может быть только одно расписание. Расписание может иметь несколько дней доставки.
6 Вызов курьера для забора груза по указанному адресу является не обязательным параметром. Но в запросе на создание заказа может быть размещен только один вызов курьера. На один адрес может быть не более одного вызова курьера в день.
7 По тарифам с кодами 1, 10, 11, 12. 136, 137, 138, 139 действует правило: если вес по заказу превышает максимально возможный по выбранному тарифу, то тариф автоматически меняется на тариф "Экспресс тяжеловесы" с соответствующим режимом.
8 Значение необходимо формировать согласно инструкции на сайте https://честныйзнак.рф
4.2.2. Формат ответа
Сервер СДЭК вернет результат в виде XML :
№ | Тэг/Атрибут | Описание | Тип поля | Обяз. для заполн. |
---|---|---|---|---|
1 | Response | Заголовок документа | да | |
1.1 | Order | Заказ | да | |
1.1.1 | DispatchNumber | Номер заказа СДЭК Возвращается в случае успешного создания заказа или при возникновении ошибки | integer | нет |
1.1.2 | Number | Номер заказа ИМ | string(40) | да |
1.1.3 | ErrorCode | Код ошибки | string(255) | нет |
1.1.4 | Msg | Фиксированный текст "Добавлено заказов" Описание ошибки (при ее возникновении) | string(255) | да |
1.2 | Call | Вызов курьера | нет | |
1.2.1 | Number | Номер заявки | string(30) | да |
1.2.2 | ErrorCode | Код ошибки | string(255) | нет |
1.2.3 | Msg | Фиксированный текст "Добавлено заказов" Описание ошибки (при ее возникновении) | string(255) | да |
Пример 1. Регистрация заказа типа “интернет-магазин”
<?xml version="1.0" encoding="UTF-8"?> <deliveryrequest account="716b2c7e8f2e1a46ff8fd126adaef97d" date="2017-05-05 11:20:45" number="soOEl" ordercount="1" secure="928324323f570dd1ee567e71f32a78e7"> <callcourier> <call comment="comment_soOEl1" date="2017-05-06" lunchbeg="14:00" lunchend="14:30" sendcitycode="44" sendername="name_soOEl1" sendphone="+79138739944" timebeg="10:00" timeend="17:00" weight="20"> <sendaddress flat="flat_soOEl1" house="house_soOEl1" street="street_soOEl1"/> </call> </callcourier> <order comment="comment-soOEl0" deliveryrecipientcost="0.0" deliveryrecipientvatrate="VATX" deliveryrecipientvatsum="0.0" number="number-soOEl0" phone="+79138739944" reccitycode="44" recipientemail="no-reply@cdek.ru" recipientname="name-soOEl0" sendcitycode="44" tarifftypecode="139"> <address flat="flat-soOEl0" house="house-soOEl0" street="street-soOEl0"/> <sender company="company-soOEl0" name="Отправителев"> <address flat="flat-soOEl0" house="house-soOEl0" street="street-soOEl0"/> <phone>+79999999999</phone> <phone>+79888888888</phone> </sender> <seller address="street_soOEl0 1" name="seller-soOEl0" INN="11111111111111111111" Phone="+79777777777" OwnershipForm="249"/> <package barcode="barcode-soOEl00" number="soOEl00" sizea="2.0" sizeb="3.0" sizec="4.0" weight="100.0"> <item amount="2" comment="comment-soOEl000" cost="8.0" payment="10.0" paymentvatrate="VATX" paymentvatsum="0.0" warekey="warekey-soOEl000" weight="1.0"/> </package> <DeliveryRecipientCostAdv Threshold="2000" Sum="150" VATRate="vat10" VATSum="45.906"/> <AddService ServiceCode="30"/> <schedule> <attempt date="2017-05-05" id="soOEl00" timebeg="11:00:00" timeend="13:00:00"> <address flat="flat-prozvon_adr" house="house-prozvon_adr" street="street-prozvon_adr"/> </attempt> </schedule> </order> </deliveryrequest>
<?xml version="1.0" encoding="UTF-8"?> <response> <Call Number="5296808"/> <Call Msg="Добавлено заказов 1"/> <Order DispatchNumber="1039548075" Number="number-Eotvl0"/> <Order Msg="Добавлено заказов 1"/> </response>
Пример 2. Регистрация заказа типа “доставка”
<?xml version="1.0" encoding="UTF-8"?> <deliveryrequest account="716b2c7e8f2e1a46ff8fd126adaef97d" date="2017-03-15 10:17:07" number="test_request" ordercount="2" secure="4180a7f32c5f605db27f15e26eec03d7"> <order comment="test_comment" number="number2017_6344227223" phone="+79888888888" reccitycode="44" recipientcompany="company-6344227223" recipientcurrency="rub" recipientemail="email_1_G4Akh0@test.ru" recipientname="Получатель Получателев" sendcitycode="44" tarifftypecode="1"> <address flat="flat-G4Akh0" house="house-G4Akh0" street="street-G4Akh0"/> <sender name="Отправ Отправителев"> <address flat="flat-G4Akh0" house="house-G4Akh0" street="street-G4Akh0"/> <phone>+79138739876</phone> <phone>+79132873910</phone> </sender> <package barcode="test_package" comment="test_comment" sizea="10.0" sizeb="20.0" sizec="30.0" weight="1000.0"/> </order> <order comment="test_comment" number="number2017_6344227225" phone="+79788888888" reccitycode="44" recipientcompany="company-6344227225" recipientcurrency="rub" recipientemail="email_1_G4Akh1@test.ru" recipientname="Получатель Получателев" sendcitycode="44" tarifftypecode="1"> <address flat="flat-G4Akh1" house="house-G4Akh1" street="street-G4Akh1"/> <sender name="Отправ Отправителев"> <address flat="flat-G4Akh1" house="house-G4Akh1" street="street-G4Akh1"/> <phone>+79133309944</phone> <phone>+79138092416</phone> </sender> <package barcode="test_package" comment="test_comment" sizea="10.0" sizeb="20.0" sizec="30.0" weight="1000.0"/> </order> </deliveryrequest>
<?xml version="1.0" encoding="UTF-8"?> <response> <Order DispatchNumber="1048179946" Number="number2017_6344227223"/> <Order DispatchNumber="1048179941" Number="number2017_6344227225"/> <Order Msg="Добавлено заказов 2"/> </response>
4.3. Метод изменения заказов
Метод используется для изменения созданной накладной. Возможно изменять следующие данные в накладной:
- сумму наложенного платежа;
- данные получателя (имя получателя, телефон, адрес, пункт выдачи заказа);
- данные по международным заказам (если передан блок с паспортными данными получателя, то старые данные будут удалены и сохранены новые);
- дополнительные сборы за доставку;
- все данные мест и позиций товаров (т.е. старые данные будут удалены и сохранены новые).
Условием возможности изменения заказа является отсутствие движения груза на складе СДЭК (т.е. статус заказа «Создан»).
4.3.1. Описание передаваемых полей запроса
№ | Тэг/Атрибут | Описание | Тип поля | Обязательность для заполнения |
---|---|---|---|---|
1 | UpdateRequest | Заголовок документа | да | |
1.1 | Number | Номер акта приема-передачи. Идентификатор заказа в ИС клиента СДЭК. | string(30) | да |
1.2 | Date | Дата документа (дата заказа) | Date | да |
1.3 | Account | Идентификатор ИМ (логин) | string(255) | да |
1.4 | Secure | Ключ | string(255) | да |
1.5 | OrderCount | Общее количество заказов в документе | integer | да |
1.6 | Order | Отправление (заказ) | да | |
1.6.1 | Number1 | Номер отправления клиента (уникален в пределах заказов одного клиента). Идентификатор заказа в ИС Клиента. | string(40) | да |
1.6.2 | DispatchNumber1 | Номер заказа СДЭК | integer | да |
1.6.3 | DeliveryRecipientCost | Доп. сбор за доставку, которую ИМ берет с получателя (в валюте страны получателя) | float | нет |
1.6.4 | DeliveryRecipientVATRate | Ставка НДС, включенная в доп. сбор за доставку (подробнее см. приложение 4) | string(10) | нет |
1.6.5 | DeliveryRecipientVATSum | Сумма НДС, включенная в доп. сбор за доставку. | float | нет |
1.6.6 | RecipientName | Получатель (ФИО). Минимум 3 символа. | string(128) | нет |
1.6.7 | Phone | Телефон получателя | phone | нет |
1.6.8 | RecipientINN | ИНН получателя. Только для международных заказов | string(12) | нет |
1.6.9 | RecipientEmail | E-mail получателя для рассылки уведомлений о движении заказа, для связи в случае недозвона. | еmail | нет |
1.6.10. | DateInvoice | Дата инвойса. Только для международных заказов | Date | нет |
1.6.11 | Passport | Данные паспорта получателя. Только для международных заказов (необязательно) | нет | |
1.6.11.1 | Series | Серия паспорта получателя | string(255) | нет |
1.6.11.2 | Number | Номер паспорта получателя | string(255) | нет |
1.6.11.3 | IssueDate | Дата выдачи паспорта получателя | Date | нет |
1.6.11.4 | IssuedBy | Кем выдан паспорт получателя | string(255) | нет |
1.6.11.5 | DateBirth | Дата рождения получателя | Date | нет |
1.6.12 | Address | Адрес доставки. В зависимости от режима доставки необходимо указывать либо атрибуты «Street», «House», «Flat» - доставка до адресата получателя, либо «PvzCode» - самозабор | нет | |
1.6.12.1 | Street | Улица получателя. Рекомендуем по возможности не указывать префиксы значений, вроде «ул.» | string(50) | да |
1.6.12.2 | House | Дом, корпус, строение получателя. Рекомендуем по возможности не указывать префиксы значений, вроде «дом» | string(30) | да |
1.6.12.3 | Flat | Квартира/Офис получателя. Рекомендуем по возможности не указывать префиксы значений, вроде «кв.» | string(10) | нет |
1.6.12.4 | PvzCode | Код ПВЗ. Атрибут необходим для заказов с режимом доставки «до склада» и при условии, что не заказана дополнительная услуга "Доставка в городе получателе"(AddService="17", подробнее см. приложение 2), и для заказов с режимом "до постамата" Если указанный ПВЗ в момент создания заказа закрыт, то заказ будет принят на другой открытый ПВЗ, находящийся рядом с выбранным. Если указанный постамат в момент создания заказа закрыт, то заказ будет принят на другой открытый постамат или ПВЗ, находящийся рядом с выбранным.Получателю при этом уйдет СМС оповещение о замене ПВЗ/постамата. Если в городе все ПВЗ/постаматы в соответствии с выбранной услугой и тарифом закрыты, то регистрация заказа невозможна, будет возвращено соответствующее сообщение об ошибке. | string(10) | да, если режим доставки "до склада" или "до постамата" |
1.6.13 | DeliveryRecipientCostAdv | Доп. сбор за доставку (которую ИМ берет с получателя), в зависимости от суммы заказа | нет | |
1.6.13.1 | Threshold | Порог стоимости товара (действует по условию меньше или равно), в целых единицах валюты | integer | да |
1.6.13.2 | Sum | Доп. сбор за доставку товаров, общая стоимость которых попадает в интервал | float | да |
1.6.13.3 | VATRate | Ставка НДС, включенная в доп. сбор за доставку (подробнее см. приложение 4). Если значение не передано, то берется значение по умолчанию "Без НДС" | string(10) | нет |
1.6.13.4 | VATSum | Сумма НДС, включенная в доп. сбор за доставку. | float | нет |
1.6.14 | Package | Упаковка (все упаковки передаются в разных тэгах Package) | нет | |
1.6.14.1 | Number | Номер упаковки (можно использовать порядковый номер упаковки заказа или номер заказа), уникален в пределах заказа. Идентификатор заказа в ИС Клиента. | string(20) | да |
1.6.14.2 | BarCode | Штрих-код упаковки, идентификатор грузоместа (если есть, иначе передавать значение номера упаковки Package.Number). Параметр используется для оперирования грузом на складах СДЭК), уникален в пределах заказа. Идентификатор грузоместа в ИС Клиента. | string(20) | да |
1.6.14.3 | Weight | Общий вес (в граммах) | integer | да |
1.6.14.4 | SizeA | Габариты упаковки. Длина (в сантиметрах) | integer | да, если указаны остальные габариты, в пределах от 1 до 1500 |
1.6.14.5 | SizeB | Габариты упаковки. Ширина (в сантиметрах) | integer | да, если указаны остальные габариты, в пределах от 1 до 1500 |
1.6.14.6 | SizeC | Габариты упаковки. Высота (в сантиметрах) | integer | да, если указаны остальные габариты, в пределах от 1 до 1500 |
1.6.14.7 | Item | Вложение (товар) | да | |
1.6.14.7.1 | Amount | Количество единиц одноименного товара (в штуках) | integer | да |
1.6.14.7.2 | WareKey | Идентификатор/артикул товара/вложения. | string(50) | да |
1.6.14.7.3 | Marking | Маркировка товара/вложения. Если для товара/вложения указана маркировка, Amount не может быть больше 1. | string | нет |
1.6.14.7.4 | Cost | Объявленная стоимость товара (за единицу товара в валюте взаиморасчетов, значение >=0). С данного значения рассчитывается страховка. | float | да |
1.6.14.7.5 | Payment | Оплата за товар при получении (за единицу товара в валюте страны получателя, значение >=0) — наложенный платеж, в случае предоплаты значение = 0. | float | да |
1.6.14.7.6 | PaymentVATRate | Ставка НДС, включенная в стоимость товара (подробнее см. приложение 4) | string(10) | да |
1.6.14.7.7 | PaymentVATSum | Сумма НДС, включенного в стоимость (payment) товара. | float | да |
1.6.14.7.8 | Weight | Вес (за единицу товара, в граммах) | integer | да |
1.6.14.7.9 | Comment | Наименование товара (может также содержать описание товара: размер, цвет) | string(255) | да |
1.6.14.7.10 | WeightBrutto | Вес брутто (за единицу товара, в граммах). Только для международных заказов | integer | нет |
1.6.14.7.11 | CommentEx | Наименование товара на английском (может также содержать описание товара: размер, цвет). Только для международных заказов | string(255) | нет |
1.6.14.7.12 | Link | Ссылка на сайт интернет-магазина с описанием товара. Только для международных заказов | string(255) | нет |
1 Идентификация заказа осуществляется либо по «DispatchNumber», либо по «Number».
4.3.2. Форма ответа
Сервер СДЭК вернет результат в виде XML :
№ | Тэг/Атрибут | Описание | Тип поля | Обяз. для заполн. |
---|---|---|---|---|
1 | Response | Заголовок документа | да | |
1.1 | Order | Заказ | да | |
1.1.1 | DispatchNumber | Номер заказа СДЭК | integer | да |
1.1.2 | Number | Номер заказа ИМ | string(40) | да |
1.1.3 | ErrorCode | Код ошибки | string(255) | нет |
1.1.4 | Msg | Фиксированный текст "Изменено заказов" Описание ошибки (при ее возникновении) | string(255) | да |
Пример. Изменение заказа
<?xml version="1.0" encoding="UTF-8"?> <updaterequest account="716b2c7e8f2e1a46ff8fd126adaef97d" date="2017-05-05 11:20:45" number="soOEl" ordercount="1" secure="928324323f570dd1ee567e71f32a78e7"> <order deliveryrecipientcost="10.02" deliveryrecipientvatrate="VATX" deliveryrecipientvatsum="0.0" number="177875705"> <package barcode="barcode-soOEl00" number="soOEl00" sizea="2.0" sizeb="3.0" sizec="4.0" weight="100.0"> <item amount="2" comment="comment-soOEl000" cost="8.0" payment="10.0" paymentvatrate="VATX" paymentvatsum="0.0" warekey="warekey-soOEl000" weight="1.0"/> </package> </order> </updaterequest>
<?xml version="1.0" encoding="UTF-8" standalone="yes"?> <response> <Order DispatchNumber="1043190804" Number="177875705"/> <Order Msg="Изменено заказов: 1"/> </response>
4.4. Удаление заказа
Метод предназначен для отмены (удаления) заказа по инициативе клиента. Условием возможности удаления заказа является отсутствие движения груза на складе СДЭК (статус заказа «Создан»).
4.4.1. Описание передаваемых полей запроса
№ | Тэг/Атрибут | Описание | Тип поля | Обяз. для заполн. |
---|---|---|---|---|
1 | DeleteRequest | Заголовок документа | да | |
1.1 | Number | Номер акта приема-передачи. Идентификатор заказа в ИС клиента СДЭК. | string(30) | да |
1.2 | Date | Дата документа (дата заказа) | date | да |
1.3 | Account | Идентификатор ИМ (логин) | string(255) | да |
1.4 | Secure | Ключ | string(255) | да |
1.5 | OrderCount | Общее количество заказов для удаления в документе | integer | да |
2 | Order | Отправление (заказ) | да | |
2.1 | Number1 | Номер отправления клиента. Идентификатор заказа в ИС клиента СДЭК. | string(40) | да |
2.2 | DispatchNumber1 | Номер заказа СДЭК | integer | да |
1 Идентификация заказа осуществляется либо по «DispatchNumber», либо по «Number».
4.4.2. Формат ответа
Сервер СДЭК вернет результат в виде XML :
№ | Тэг/Атрибут | Описание | Тип поля | Обяз. для заполн. |
---|---|---|---|---|
1 | Response | Заголовок документа | да | |
1.1 | Order | Заказ | integer | да |
1.1.1 | DispatchNumber | Номер заказа СДЭК | integer | да |
1.1.2 | Number | Номер акта приема-передачи. Идентификатор заказа в ИС клиента СДЭК. | string(40) | да |
1.1.3 | ErrorCode | Код ошибки | string(255) | нет |
1.1.4 | Msg | Фиксированный текст "Удалено заказов X", где Х - количество удаленных заказов Описание ошибки (при ее возникновении) | string(255) | да |
Пример. Удаление заказа
<?xml version="1.0" encoding="UTF-8" standalone="yes"?> <deleterequest number="123" ordercount="1" account="716b2c7e8f2e1a46ff8fd126adaef97d" date="2017-04-18 13:41:51" secure="ddb5b74a058c60bef584d797b1e4d167"> <order number="number-8ZSO90"/> </deleterequest>
<?xml version="1.0" encoding="UTF-8"?> <response> <Order DispatchNumber="1104345018" Number="number-8ZSO90"/> <Order Msg="Удалено заказов 1"/> </response>
4.5. Печать квитанции к заказу
Метод позволяет получить файл в формате pdf, содержащий печатные формы квитанций к заказу.
Во избежание перегрузки платформы нельзя передавать более 100 номеров заказов в одном запросе.
4.5.1. Описание передаваемых полей запроса
№ | Тэг/Атрибут | Описание | Тип поля | Обяз. для заполн. |
---|---|---|---|---|
1 | OrdersPrint | Заголовок документа | да | |
1.1 | Date | Дата документа (дата вызова) | date | да |
1.2 | Account | Идентификатор ИМ (логин) | string(255) | да |
1.3 | Secure | Ключ | string(255) | да |
1.4 | OrderCount | Общее количество передаваемых в документе заказов | integer | да |
1.5 | CopyCount | Число копий одной квитанции на листе. Рекомендовано указывать не менее 2, одна приклеивается на груз, вторая остается у отправителя. | integer | нет |
1.6 | Order | Отправление (заказ) | да | |
1.6.1 | DispatchNumber1 | Номер отправления СДЭК (присваивается при импорте заказов). Идентификатор заказа в ИС клиента СДЭК. | integer | да |
1.6.2 | Number1 | Номер отправления клиента. Идентификатор заказа в ИС клиента СДЭК. | string(30) | да |
1.6.3 | Date1 | Дата акта приема-передачи, в котором был передан заказ | date | да |
1 Идентификация заказа осуществляется либо по «DispatchNumber», либо по двум параметрам «Number», «Date». Если в запросе есть значение атрибута «DispatchNumber», то атрибуты «Number», «Date» игнорируются.
Метод печати квитанции к заказу и метод регистрации заказа обращаются к разным модулям системы, синхронизация между которыми может занимать от нескольких секунд до нескольких минут. Рекомендуем запрос на печать квитанции к заказу вызывать спустя некоторое время после создания заказа.
4.5.2. Формат ответа
В ответ сервер СДЭК вернет pdf-файл.
В случае ошибки результат вернется в виде XML :
№ | Тэг/Атрибут | Описание | Тип поля | Обяз. для заполн. |
---|---|---|---|---|
1 | Response | Заголовок документа | да | |
1.1 | Order | Заказ | да | |
1.1.1 | ErrorCode | Код ошибки | string(255) | нет |
1.1.2 | Msg | Описание ошибки | string(255) | да |
Пример. Печать квитанции к заказу
<?xml version="1.0" encoding="UTF-8" ?> <OrdersPrint Date="2018-08-10" Account="716b2c7e8f2e1a46ff8fd126adaef97d" Secure="3ccc65b08c716393378a2e9c4ccbbf18" OrderCount="1" CopyCount="1"> <Order DispatchNumber="1088986275" /> </OrdersPrint>
Response (success) |
---|
<?xml version="1.0" encoding="UTF-8" standalone="yes"?> <response> <Order ErrorCode="ERROR_ORDERS_NOT_FOUND" Msg="Отправления клиентов не найдены"/> </response>
4.6. Регистрация заявки на вызов курьера
Данный метод позволяет осуществить вызов курьера для доставки груза.
На один адрес может быть не более одного вызова курьера в день. В случае повторного запроса вернется ошибка.
Курьер может быть вызван в диапазоне с 9:00 до 22:00
4.6.1 Описание передаваемых данных
№ | Тэг/Атрибут | Описание | Тип поля | Обяз. для заполн. |
---|---|---|---|---|
1 | CallCourier | Заголовок документа | да | |
1.2 | Date | Дата документа (дата вызова) | date | да |
1.3 | Account | Идентификатор ИМ (логин) | string(255) | да |
1.4 | Secure | Ключ | string(255) | да |
1.5 | CallCount | Общее количество заявок для вызова курьера в документе | integer | да |
1.6 | Call | Ожидание курьера | да | |
1.6.1 | Date | Дата ожидания курьера | date | да |
1.6.2 | TimeBeg | Время начала ожидания курьера | time | да |
1.6.3 | TimeEnd | Время окончания ожидания курьера | time | да |
1.6.4 | LunchBeg | Время начала обеда, если входит во временной диапазон [TimeBeg; TimeEnd] | time | нет |
1.6.5 | LunchEnd | Время окончания обеда, если входит во временной диапазон [TimeBeg; TimeEnd] | time | нет |
1.6.6 | SendCityCode1 | Код города отправителя из базы СДЭК (https://cdek.ru/storage/source/document/1/CDEK_city.zip ) | integer | да, если не задан DispatchNumber |
1.6.7 | SendCityPostCode1 | Почтовый индекс города отправителя | string(6) | да |
1.6.8 | SendCountryCode1 | Код страны отправителя для идентификации страны в формате ISO_3166-1_alpha-2 (см. “Общероссийский классификатор стран мира”) | string(2) | нет |
1.6.9 | SendCityName1 | Наименование города отправителя | string(255) | нет |
1.6.10 | SendPhone | Контактный телефон отправителя | phone | да, если
2. DispatchNumber задан и номер телефона не указан в накладной |
1.6.11 | SenderName | Отправитель (ФИО) | string(255) | да, если
2. DispatchNumber задан и ФИО не указаны в накладной |
1.6.12 | Weight | Общий вес, в граммах. Целое число, однако клиенты могут передать число с точкой, в этом случае произойдет округление, если передано не число - в накладную запишется дефолтное значение - 0.49 кг | string | да, если не задан DispatchNumber |
1.6.13 | Comment | Описание груза | string(255) | да, если не задан DispatchNumber |
1.6.14 | DispatchNumber2 | Номер привязанного заказа | string(10) | нет |
1.6.15 | Address1 | Адрес отправителя | да | |
1.6.15.1 | Street | Улица отправителя (рекомендуется по возможности не указывать префиксы значений, вроде «ул.») | string(50) | да |
1.6.15.2 | House | Дом, корпус, строение отправителя (рекомендуется по возможности не указывать префиксы значений, вроде «дом») | string(30) | да |
1.6.15.3 | Flat | Квартира/Офис отправителя (рекомендуется по возможности не указывать префиксы значений, вроде «кв.») | string(10) | да |
1 Идентификация города отправителя и города получателя (в случае режима "до двери") производится по следующему алгоритму в порядке приоритетности:
По уникальному коду города базы СДЭК (ID города). Коды городов базы СДЭК можно найти в реестрах городов в пакете документации (https://cdek.ru/storage/source/document/1/CDEK_city.zip ). Значения передаются в атрибутах SendCityCode, RecCityCode.
По почтовому индексу города. Значения передаются в атрибутах SendCityPostCode, RecCityPostCode. В паре с почтовым индексом в качестве уточняющих параметров могут быть использованы код страны (атрибуты SendCountryCode, RecCountryCode) и/или наименование города (атрибуты SendCityName, RecCityName): код страны искомого города должен совпадать с указанным в соответствующем атрибуте, а переданное название города должно входить в название искомого. Наименование города можно указывать на языке клиента (поиск будет произведен по всем локализациям).
- По строке адреса, которая формируется путем конкатенации следующих полей: SendCityName/RecCityName + Address.Street + Address.House.
Нужно принимать во внимание, что база почтовых индексов в ИС СДЭК может содержат неполную и иногда не точную информацию по почтовым индексам, поэтому пользователь должен иметь возможность скорректировать параметр почтового индекса, если это необходимо.
2 Если в запросе не передан DispatchNumber, то формируется заявка на вызов курьера для забора консоли (сразу нескольких заказов с одного адреса отправителя).
4.6.2. Формат ответа
Сервер СДЭК вернет результат в виде XML :
№ | Тэг/Атрибут | Описание | Тип поля | Обяз. для заполн. |
---|---|---|---|---|
1 | Response | Заголовок документа | да | |
1.1 | Call | Ожидание курьера | да | |
1.1.1 | Number | Номер заявки | string(30) | да |
1.1.2 | ErrorCode | Код ошибки | string(255) | нет |
1.1.3 | Msg | Фиксированный текст "Добавлено заказов" Описание ошибки (при ее возникновении) | string(255) | да |
Пример. Регистрация заявки на вызов курьера
<?xml version="1.0" encoding="UTF-8"?> <callcourier account="716b2c7e8f2e1a46ff8fd126adaef97d" callcount="1" date="2017-03-13" secure="7ba5875c5c14cd1a344b83fdd8df74b3"> <call comment="comment_QF6aD1" date="2017-03-14" dispatchnumber="1039547805" lunchbeg="14:00" lunchend="14:30" sendcitycode="44" sendername="name_QF6aD1" sendphone="+79138739944" timebeg="10:00" timeend="17:00" weight="20"> <address flat="flat_QF6aD1" house="house_QF6aD1" street="street_QF6aD1"/> </call> </callcourier>
<?xml version="1.0" encoding="UTF-8"?> <response> <Call Number="5296692"/> <Call Msg="Добавлено заявок 1"/> </response>
4.7. Регистрация информации о результате прозвона
Метод предназначен для передачи от клиента информации, содержащий данные по прозвону получателя заказа типа “интернет-магазин” о договоренности доставки до двери.
Метод используется в следующих случаях:
- ИМ самостоятельно предоставляет в СДЭК расписание получателя для доставки/забора;
- изменения в заказе адреса доставки;
- изменения суммы по оплате за товар.
Изменение данных заказа по результатам прозвона происходит в отложенном режиме с помощью автоматического задания (робота). Робот запускается по расписанию с периодом, указанном в конфигурационном файле.
4.7.1. Описание входных параметров
№ | Тэг/Атрибут | Описание | Тип поля | Обяз. для заполн. |
---|---|---|---|---|
1 | ScheduleRequest | Заголовок документа. | да | |
1.1 | Date | Дата документа (дата вызова) | date/datetime | да |
1.2 | Account | Идентификатор ИМ (логин) | string(255) | да |
1.3 | Number | Номер акта приема-передачи/ТТН. Идентификатор реестра грузов в ИС клиента СДЭК. По умолчанию можно использовать 1 | string(30) | да |
1.4 | Secure | Ключ | string(255) | да |
1.5 | OrderCount | Общее количество заявок для прозвона | integer | да |
1.6 | Order | Отправление (заказ) | да | |
1.6.1 | DispatchNumber1 | Номер отправления СДЭК (присваивается при импорте заказов). Идентификатор заказа в ИС клиента СДЭК | integer | да |
1.6.2 | Number1 | Номер отправления клиента (уникален в пределах заказов одного клиента). Идентификатор заказа в ИС Клиента | string(40) | да |
1.6.3 | Date1 | Дата документа (дата заказа) | date/datetime | да |
1.6.4 | Attempt | Время доставки. | да | |
1.6.4.1 | ID | Идентификационный номер расписания по базе ИМ. По умолчанию можно использовать 1 | integer | да |
1.6.4.2 | Date | Дата доставки (только дата, в формате «YYYY-MM-DD», без времени) согласованная с получателем | date | да |
1.6.4.3 | Comment | Комментарий | string(255) | нет |
1.6.4.4 | TimeBeg | Начало временного диапазона доставки (время получателя) | time | да |
1.6.4.5 | TimeEnd | Окончание временного диапазона доставки (время получателя) | time | да |
1.6.4.6 | Address | Новый адрес доставки (если требуется изменить). В зависимости от режима доставки необходимо указывать либо атрибуты «Street», «House», «Flat» - доставка до адресата получателя, либо «PvzCode» - самозабор | нет | |
1.6.4.6.1 | Street | Улица получателя. Рекомендуем по возможности не указывать префиксы значений вроде «ул.» | string(50) | да |
1.6.4.6.2 | House | Дом, корпус, строение получателя. Рекомендуем по возможности не указывать префиксы значений вроде «дом» | string(30) | да |
1.6.4.6.3 | Flat | Квартира/Офис получателя. Рекомендуем по возможности не указывать префиксы значений вроде «кв.» | string(10) | нет |
1.6.4.6.4 | PvzCode | Код ПВЗ, необходим только для заказов с режимом доставки «до склада» и при условии, что не заказана дополнительная услуга "Доставка в городе получателе". | string(10) | да, если режим доставки "до склада" |
1 Идентификация заказа осуществляется либо по «DispatchNumber», либо по двум параметрам «Number», «Date». Если в запросе есть значение атрибута «DispatchNumber», то атрибуты «Number», «Date» игнорируются.
4.7.2. Формат ответа
Сервер СДЭК вернет результат в виде XML :
№ | Тэг/Атрибут | Описание | Тип поля | Обяз. для заполн. |
---|---|---|---|---|
1 | Response | Заголовок документа | да | |
1.1 | ScheduleRequest | Ожидание курьера | да | |
1.1.1 | Number | Номер заявки | string(40) | нет |
1.1.2 | DispatchNumber | Номер заказа СДЭК | integer | да |
1.1.3 | ErrorCode | Код ошибки | string(255) | нет |
1.1.4 | Msg | Фиксированный текст либо Описание ошибки (при ее возникновении) | string(255) | да |
Пример. Регистрация информации о результате прозвона
<?xml version="1.0" encoding="UTF-8"?> <schedulerequest account="716b2c7e8f2e1a46ff8fd126adaef97d" date="2017-03-13 14:51:06" ordercount="1" secure="8782854c781886ca60dc0f9f1ee57d7a"> <order date="2017-03-13T00:00:00+07:00" dispatchnumber="1080841537" number="3452346456735"> <attempt comment="comment_0" date="2017-03-13" id="test" timebeg="9:00:00" timeend="15:00:00"> <address flat="flat_0" house="fhouse_0" street="street_0"/> </attempt> </order> </schedulerequest>
<?xml version="1.0" encoding="UTF-8" standalone="yes"?> <response> <ScheduleRequest Msg="Добавлено 1 прозвонов"/> </response>
4.8. Печать ШК-места
Метод используется для формирования печатной формы этикетки для упаковки в формате pdf.
Во избежание перегрузки платформы нельзя передавать более 100 номеров заказов в одном запросе.
4.8.1. Описание передаваемых данных
№ | Тэг/Атрибут | Описание | Тип поля | Обяз. для заполн. |
---|---|---|---|---|
1 | OrdersPackagesPrint | Заголовок документа | да | |
1.1 | Date | Дата документа | date | да |
1.2 | Account | Идентификатор ИМ (логин) | string(255) | да |
1.3 | Secure | Ключ | string(255) | да |
1.4 | OrderCount | Общее количество передаваемых в документе заказов | integer | да |
1.5 | CopyCount | Число копий. По умолчанию 1 | integer | нет |
1.6 | PrintFormat | Формат печати, допустимые значения: A4, A5, A6 (A - буква латинского алфавита). По умолчанию A4 | string(2) | нет |
1.7 | Order | Отправление (заказ) | да | |
1.7.1 | DispatchNumber1 | Номер отправления СДЭК (присваивается при импорте заказов). Идентификатор заказа в ИС клиента СДЭК | integer | да |
1.7.2 | Number1 | Номер отправления клиента. Идентификатор заказа в ИС клиента СДЭК | string(40) | да |
1.7.3 | Date1 | Дата акта приема-передачи, в котором был передан заказ | date | да |
1 Идентификация заказа осуществляется либо по «DispatchNumber», либо по двум параметрам «Number», «Date». Если в запросе есть значение атрибута «DispatchNumber», то атрибуты «Number», «Date» игнорируются.
Метод печати ШК-мест и метод регистрации заказа обращаются к разным модулям системы, синхронизация между которыми может занимать от нескольких секунд до нескольких минут. Рекомендуем запрос на печать ШК-мест вызывать спустя некоторое время после создания заказа.
4.8.2. Формат ответа
В ответ сервер СДЭК вернет pdf-файл.
В случае ошибки результат вернется в виде XML:
№ | Тэг/Атрибут | Описание | Тип поля | Обяз. для заполн. |
---|---|---|---|---|
1 | Response | Заголовок документа | да | |
1.1 | Order | Заказ | да | |
1.1.1 | ErrorCode | Код ошибки | string(255) | нет |
1.1.2 | Msg | Описание ошибки | string(255) | да |
Пример. Печать ШК-места
<?xml version="1.0" encoding="UTF-8"?> <OrdersPackagesPrint Account="60cacd45b1b2820ad7a233b60b6adec4" Date="2017-09-29" Number="2017.09.29S-7KL" OrderCount="1" Secure="secure" printFormat="A6"> <Order Number="43459667" Date="2017-09-29"/> </OrdersPackagesPrint>
Response (success) |
---|
<?xml version="1.0" encoding="UTF-8" standalone="yes"?> <response> <Order ErrorCode="ERROR_ORDERS_NOT_FOUND" Msg="Отправления клиентов не найдены"/> </response>
4.9. Отчет "Статусы заказов"
Метод используется для получения отчета по статусам заказов, включая историю изменения статусов.
4.9.1. Описание передаваемых данных
№ | Тэг/Атрибут | Описание | Тип поля | Обяз. для заполн. |
---|---|---|---|---|
1 | StatusReport | Заголовок документа | да | |
1.1 | Date | Дата запроса | datetime/date | да |
1.2 | Account | Идентификатор Клиента (логин) | string(255) | да |
1.3 | Secure | Ключ | string(255) | да |
1.4 | ShowHistory | Атрибут, указывающий на необходимость загружать историю заказов (1-да, 0-нет) | boolean | нет |
1.5 | ShowReturnOrder | Атрибут, указывающий на необходимость загружать список возвратных заказов (1-да, 0-нет) | boolean | нет |
1.6 | ShowReturnOrderHistory | Атрибут, указывающий на необходимость загружать историю возвратных заказов (1-да, 0-нет) | boolean | нет |
1.7 | ChangePeriod1 | Период, за который произошло изменение статуса заказа. | нет | |
1.7.1 | DateFirst3 | Дата начала запрашиваемого периода | datetime/date | да |
1.7.2 | DateLast3 | Дата окончания запрашиваемого периода | datetime/date | нет |
1.8 | Order1 | Отправление (заказ) | нет | |
1.8.1 | DispatchNumber2 | Номер отправления СДЭК (присваивается при импорте заказов). Идентификатор заказа в ИС СДЭК. | integer | да |
1.8.2 | Number2 | Номер отправления клиента. Идентификатор заказа в ИС клиента СДЭК. | string(40) | да |
1.8.3 | Date2 | Дата акта приема-передачи, в котором был передан заказ | date | да |
1 Запрос должен содержать хотя бы один из тэгов ChangePeriod или Order:
- если указан тэг ChangePeriod и список заказов в тэге Order, то результат будет содержать информацию по заказам, которые изменили статус в указанный период;
- если указан тэг ChangePeriod и отсутствует список Order, то результат будет содержать информацию по всем заказам, которые изменили статус в указанный период;
- если тэг ChangePeriod не передан, присутствует только Order, передается информация по всему списку запрашиваемых заказов.
2 Идентификация заказа осуществляется либо по «DispatchNumber», либо по двум параметрам «Number», Date. Если в запросе есть значение атрибута «DispatchNumber», то атрибуты «Number», «Date» игнорируются.
3 Максимальный период выгрузки изменений - 31 день. Т.е. DateLast - DateFirst =< 31 день.
Метод "Статусы заказов" и метод регистрации заказа обращаются к разным модулям системы, синхронизация между которыми может занимать от нескольких секунд до нескольких минут. Рекомендуем запрос на получение статусов по заказу вызывать спустя некоторое время после создания заказа.
4.9.2. Формат ответа
Сервер СДЭК вернет результат в виде XML :
№ | Тэг/Атрибут | Описание | Тип поля | Обяз. для заполн. |
---|---|---|---|---|
1 | StatusReport | Заголовок документа | да | |
1.1 | DateFirst | Дата и время начала периода изменений по статусам заказа | datetime/date | да |
1.2 | DateLast | Дата и время окончания периода изменений по статусам заказа | datetime/date | да |
2 | Order | Отправление (Заказ) | да | |
2.1 | ActNumber | Номер акта приема-передачи | string(30) | да |
2.2 | Number | Номер отправления клиента. Идентификатор заказа в ИС клиента СДЭК. | string(30) | да |
2.3 | DispatchNumber | Номер отправления СДЭК (присваивается при импорте заказов). Идентификатор заказа в ИС СДЭК. | integer | да |
2.4 | DeliveryDate | Дата доставки | datetime | нет |
2.5 | RecipientName | Получатель при доставке (заполнено только в статусе заказа "Вручен") | string(50) | нет |
2.6 | ReturnDispatchNumber | Номер возвратного отправления (номер накладной, в которой возвращается товар ИМ в случае статусов «Не вручен», «Вручен» - «Частичная доставка») | integer | нет |
2.7 | ReverseDispatchNumber | Номер реверсной накладной (номер накладной, в которой возвращается груз при наличии доп.услуги №48 "РЕВЕРС") | integer | нет |
2.8 | Status | Текущий статус заказа | да | |
2.8.1 | Date | Дата статуса. Указано среднее время по Гринвичу. | datetime | да |
2.8.2 | Code | Код статуса (подробнее см. приложение 5) | integer | да |
2.8.3 | Description | Название статуса | string(100) | да |
2.8.4 | CityCode | Город изменения статуса, код города по базе СДЭК (https://cdek.ru/storage/source/document/1/CDEK_city.zip ) | integer | да |
2.8.5 | CityName | Наименование города изменения статуса | string(100) | да |
2.8.6 | State1 | История изменений статусов | да | |
2.8.6.1 | Date | Дата статуса | datetime | да |
2.8.6.2 | Code | Код статуса (подробнее см. приложение 5) | integer | да |
2.8.6.3 | Description | Название статуса | string(100) | да |
2.8.6.4 | CityCode | Город изменения статуса, код города по базе СДЭК (https://cdek.ru/storage/source/document/1/CDEK_city.zip ) | integer | да |
2.8.6.5 | CityName | Наименование города изменения статуса | string(100) | да |
2.9 | Reason | Текущий дополнительный статус | да | |
2.9.1 | Date | Дата дополнительного статуса | datetime | да |
2.9.2 | Code | Код дополнительного статуса (подробнее см. приложение 6) | integer | нет |
2.9.3 | Description | Название дополнительного статуса | string(100) | нет |
2.10 | DelayReason | Текущая причина задержки | да | |
2.10.1 | Date | Дата причины задержки | datetime | да |
2.10.2 | Code | Код причины задержки (подробнее см. приложение 7) | integer | нет |
2.10.3 | Description | Причина задержки | string(50) | нет |
2.10.4 | State1 | История причин задержек | да | |
2.10.4.1 | Date | Дата причины задержки | datetime | да |
2.10.4.2 | Code | Код причины задержки (подробнее см. приложение 7) | integer | нет |
2.10.4.3 | Description | Причина задержки | string(50) | нет |
2.11 | Package2 | Упаковка | нет | |
2.11.1 | Number | Номер упаковки. Идентификатор заказа в ИС клиента СДЭК. | string(20) | да |
2.11.2 | BarCode | Штрих-код упаковки, идентификатор грузоместа | string(20) | да |
2.11.3 | Item2 | Вложение | да | |
2.11.3.1 | WareKey | Идентификатор/артикул товара/вложения. | string(20) | да |
2.11.3.2 | Marking | Маркировка товара/вложения. | string | нет |
2.11.3.3 | DelivAmount | Количество доставленных единиц вложения. По умолчанию равно количеству переданного на доставку товара. | integer | да |
2.11.3.4 | Amount | Количество переданных а доставку единиц товара | integer | да |
2.12 | Attempt3 | Время доставки из расписания на доставку | нет | |
2.12.1 | ID | Идентификационный номер расписания по базе ИМ | integer | да |
2.12.2 | ScheduleCode | Код причины задержки (подробнее см. приложение 7) | integer | да |
2.12.3 | ScheduleDescription | Причина задержки | string(50) | да |
2.13 | Call | История прозвонов получателя | нет | |
2.13.1 | CallGood | История удачных прозвонов | нет | |
2.13.1.1 | Good | Удачный прозвон | да | |
2.13.1.1.1 | Date | Дата удачного прозвона | date | да |
2.13.1.1.2 | DateDeliv | Дата, на которую договорились о доставке/самозаборе | date | да |
2.13.2 | CallFail | История неудачных прозвонов | нет | |
2.13.2.1 | Fail | Неудачный прозвон | да | |
2.13.2.1.1 | Date | Дата прозвона | date | да |
2.13.2.1.2 | ReasonCode | Код причины неудачного прозвона (подробнее см. приложение 8) | integer | да |
2.13.2.1.3 | ReasonDescription | Причина неудачного прозвона | string(255) | да |
2.13.3 | CallDelay | История переносов прозвона | нет | |
2.13.3.1 | Delay | Перенос прозвона | да | |
2.13.3.1.1 | Date | Дата прозвона | date | да |
2.13.3.1.2 | DateNext | Дата, на которую перенесен прозвон | date | да |
3 | ReturnOrder | Возвратное отправление | нет | |
3.1 | ActNumber | Номер акта приема-передачи | string(30) | да |
3.2 | Number | Номер отправления клиента. Идентификатор заказа в ИС клиента СДЭК. | string(30) | да |
3.3 | DispatchNumber | Номер возвратной накладной СДЭК (присваивается при согласовании возвратной ведомости). Идентификатор заказа в ИС СДЭК. | integer | да |
3.4 | DeliveryDate | Дата доставки | datetime | нет |
3.5 | RecipientName | Получатель при доставке | string(50) | нет |
3.6 | Status | Текущий статус заказа | да | |
3.6.1 | Date | Дата статуса | datetime | да |
3.6.2 | Code | Код статуса (подробнее см. приложение 5) | integer | да |
3.6.3 | Description | Название статуса | string(100) | да |
3.6.4 | CityCode | Город изменения статуса, код города по базе СДЭК (https://cdek.ru/storage/source/document/1/CDEK_city.zip ) | integer | да |
3.6.5 | CityName | Наименование города изменения статуса | string(100) | да |
3.6.6 | State1 | История изменений статусов | да | |
3.6.6.1 | Date | Дата статуса | datetime | да |
3.6.6.2 | Code | Код статуса (подробнее см. приложение 5) | integer | да |
3.6.6.3 | Description | Название статуса | string(100) | да |
3.6.6.4 | CityCode | Город изменения статуса | integer | да |
3.6.6.5 | CityName | Наименование города изменения статуса | string(100) | да |
3.7 | Reason | Текущий дополнительный статус | да | |
3.7.1 | Date | Дата дополнительного статуса | datetime | да |
3.7.2 | Code | Код дополнительного статуса (подробнее см. приложение 6) | integer | нет |
3.7.3 | Description | Название дополнительного статуса | string(100) | нет |
3.8 | DelayReason | Текущая причина задержки | да | |
3.8.1 | Date | Дата причины задержки | datetime | да |
3.8.2 | Code | Код причины задержки (подробнее см. приложение 7) | integer | нет |
3.8.3 | Description | Причина задержки | string(50) | нет |
1 Тэг «State» присутствует только при значении параметра «ShowHistory = 1 (см. описание передаваемых данных).
2 Тэги «Package», «Item» присутствуют только при частичной доставке (в конечном статусе «Вручен» и дополнительном статусе «Частичная доставка»).
3 Тэг Attempt присутствует только в случае, если по условиям договора, ИМ самостоятельно предоставляет расписание доставки для СДЭК. Тэг содержит данные по неудачным попыткам доставки в разрезе предоставленного ИМ расписания доставки.
Пример. Отчет "Статусы заказов"
<?xml version="1.0" encoding="UTF-8" standalone="yes"?> <StatusReport Account="account" Date="2018-08-08T20:23:54" Secure="secure" ShowHistory="1"> <Order DispatchNumber="1000028000"/> <Order DispatchNumber="1000356200"/> </StatusReport>
<?xml version="1.0" encoding="UTF-8"?> <StatusReport DateFirst="2000-12-31T17:00:00+00:00" DateLast="2018-08-10T08:55:52+00:00" > <Order ActNumber="" Number="2080965069" DispatchNumber="1000028000" DeliveryDate="2018-04-06T13:33:27+03:00" RecipientName="Руслан Альбертович" > <Status Date="2018-04-06T10:33:42+00:00" Code="4" Description="Вручен" CityCode="1081" CityName="Нальчик"> <State Date="2018-03-21T14:54:13+00:00" Code="1" Description="Создан" CityCode="44" CityName="Москва" /> <State Date="2018-03-21T17:32:32+00:00" Code="3" Description="Принят на склад отправителя" CityCode="44" CityName="Москва" /> <State Date="2018-03-21T17:35:12+00:00" Code="6" Description="Выдан на отправку в г.-отправителе" CityCode="44" CityName="Москва" /> <State Date="2018-03-21T23:00:12+00:00" Code="7" Description="Сдан перевозчику в г.-отправителе" CityCode="44" CityName="Москва" /> <State Date="2018-03-21T23:36:53+00:00" Code="21" Description="Отправлен в г.-транзит" CityCode="44" CityName="Москва" /> <State Date="2018-03-22T19:01:19+00:00" Code="22" Description="Встречен в г.-транзите" CityCode="438" CityName="Ростов-на-Дону" /> <State Date="2018-03-22T22:18:47+00:00" Code="13" Description="Принят на склад транзита" CityCode="438" CityName="Ростов-на-Дону" /> <State Date="2018-03-22T22:18:47+00:00" Code="19" Description="Выдан на отправку в г.-транзите" CityCode="438" CityName="Ростов-на-Дону" /> <State Date="2018-03-22T22:19:44+00:00" Code="20" Description="Сдан перевозчику в г.-транзите" CityCode="438" CityName="Ростов-на-Дону" /> <State Date="2018-03-22T22:59:19+00:00" Code="8" Description="Отправлен в г.-получатель" CityCode="438" CityName="Ростов-на-Дону" /> <State Date="2018-03-24T15:11:53+00:00" Code="17" Description="Возвращен на склад транзита" CityCode="438" CityName="Ростов-на-Дону" /> <State Date="2018-03-24T15:11:53+00:00" Code="19" Description="Выдан на отправку в г.-транзите" CityCode="438" CityName="Ростов-на-Дону" /> <State Date="2018-03-25T21:25:02+00:00" Code="20" Description="Сдан перевозчику в г.-транзите" CityCode="438" CityName="Ростов-на-Дону" /> <State Date="2018-03-25T22:32:47+00:00" Code="8" Description="Отправлен в г.-получатель" CityCode="438" CityName="Ростов-на-Дону" /> <State Date="2018-03-26T11:13:27+00:00" Code="10" Description="Принят на склад доставки" CityCode="1081" CityName="Нальчик" /> <State Date="2018-04-06T05:28:09+00:00" Code="11" Description="Выдан на доставку" CityCode="1081" CityName="Нальчик" /> <State Date="2018-04-06T10:33:42+00:00" Code="4" Description="Вручен" CityCode="1081" CityName="Нальчик" /> </Status> <Reason Code="" Description="" Date=""></Reason> <DelayReason Code="" Description="" Date="" ></DelayReason> <Call> <CallGood> <Good Date="2018-03-26T12:50:31+00:00" DateDeliv="2018-04-06" /> <Good Date="2018-03-26T12:50:37+00:00" DateDeliv="2018-04-06" /> </CallGood> </Call> </Order> <Order ActNumber="" Number="2066479243" DispatchNumber="1000356200" DeliveryDate="2018-04-07T15:29:32+03:00" RecipientName="Аркадий Якубович" > <Status Date="2018-04-07T12:29:39+00:00" Code="4" Description="Вручен" CityCode="44" CityName="Москва"> <State Date="2018-04-01T14:15:20+00:00" Code="1" Description="Создан" CityCode="44" CityName="Москва" /> <State Date="2018-04-01T18:03:43+00:00" Code="10" Description="Принят на склад доставки" CityCode="44" CityName="Москва" /> <State Date="2018-04-02T09:04:38+00:00" Code="11" Description="Выдан на доставку" CityCode="44" CityName="Москва" /> <State Date="2018-04-02T09:13:41+00:00" Code="18" Description="Возвращен на склад доставки" CityCode="44" CityName="Москва" /> <State Date="2018-04-02T09:13:41+00:00" Code="11" Description="Выдан на доставку" CityCode="44" CityName="Москва" /> <State Date="2018-04-03T07:56:08+00:00" Code="18" Description="Возвращен на склад доставки" CityCode="44" CityName="Москва" /> <State Date="2018-04-07T06:14:36+00:00" Code="11" Description="Выдан на доставку" CityCode="44" CityName="Москва" /> <State Date="2018-04-07T12:29:39+00:00" Code="4" Description="Вручен" CityCode="44" CityName="Москва" /> </Status> <Reason Code="20" Description="Частичная доставка" Date="2018-04-07T12:29:39+00:00"></Reason> <DelayReason Code="" Description="" Date="" > <State Date="2018-04-03T16:56:41+00:00" Code="47" Description="Адрес не существует" /> </DelayReason> <Package Number="2066479243" BarCode="2066479243"> <Item WareKey="2201073352678" Amount="1" DelivAmount="0" /> <Item WareKey="2201084246850" Amount="1" DelivAmount="1" /> <Item WareKey="654321" Amount="1" DelivAmount="0" /> </Package> <Call> <CallGood> <Good Date="2018-04-01T14:15:46+00:00" DateDeliv="2018-04-02" /> <Good Date="2018-04-03T16:56:41+00:00" DateDeliv="2018-04-07" /> </CallGood> <CallFail> <Fail Date="2018-04-02T15:35:47+00:00" ReasonCode="3" ReasonDescription="Абонент недоступен" /> </CallFail> </Call> </Order> </StatusReport>
4.10. Отчет "Информация по заказам"
Метод используется для получения детальной информации по заказам.
4.10.1. Описание передаваемых данных
№ | Тэг/Атрибут | Описание | Тип поля | Обяз. для заполн. |
---|---|---|---|---|
1 | InfoRequest | Заголовок документа | да | |
1.1 | Date | Дата запроса | datetime/date | да |
1.2 | Account | Идентификатор Клиента (логин) | string(255) | да |
1.3 | Secure | Ключ | string(255) | да |
1.4 | ChangePeriod | Период, за который произошло изменение стоимости услуги доставки | нет | |
1.4.1 | DateBeg | Дата начала запрашиваемого периода | date | нет |
1.4.2 | DateEnd | Дата окончания запрашиваемого периода | date | нет |
1.5 | Order | Отправление (заказ) | нет | |
1.5.1 | DispatchNumber1 | Номер отправления СДЭК (присваивается при импорте заказов). Идентификатор заказа в ИС СДЭК. | Integer | да |
1.5.2 | Number1 | Номер отправления клиента. Идентификатор заказа в ИС клиента СДЭК. | string(30) | да |
1.5.3 | Date1 | Дата акта приема-передачи, в котором был передан заказ | date | да |
1 Идентификация заказа осуществляется либо по «DispatchNumber», либо по двум параметрам «Number», «Date». Если в запросе есть значение атрибута «DispatchNumber», то атрибуты «Number», «Date» игнорируются.
Метод "Информация по заказам" и метод регистрации заказа обращаются к разным модулям системы, синхронизация между которыми может занимать от нескольких секунд до нескольких минут. Рекомендуем запрос на получение информации по заказу вызывать спустя некоторое время после создания заказа.
4.10.2. Формат ответа
Сервер СДЭК вернет результат в виде XML :
№ | Тэг/Атрибут | Описание | Тип поля | Обяз. для заполн. |
---|---|---|---|---|
1 | InfoReport | Заголовок документа | да | |
1.1 | Order | Отправление (Заказ) | да | |
1.1.1 | Number | Номер отправления клиента. Идентификатор заказа в ИС клиента СДЭК. | string(30) | да |
1.1.2 | Date | Дата, в которую был передан заказ в базу СДЭК | date | да |
1.1.3 | DispatchNumber | Номер отправления СДЭК (присваивается при импорте заказов). Идентификатор заказа в ИС СДЭК. | integer | да |
1.1.4 | TariffTypeCode | Код тарифа (подробнее см. приложение 1) | integer | да |
1.1.5 | Weight | Расчетный вес (в килограммах) Обращаем внимание, что единица измерения значения данного поля (кг) отличается от единицы измерения веса (гр) в методах создания и обновления заказа. | float | да |
1.1.6 | DeliverySum | Стоимость услуги доставки, в валюте взаиморасчетов, по умолчанию руб. | float | да |
1.1.7 | DateLastChange | Дата последнего изменения суммы по услуге доставки | date | нет |
1.1.8 | CashOnDeliv | Сумма наложенного платежа, которую необходимо было взять с получателя в валюте страны получателя, по умолчанию руб. | float | нет |
1.1.9 | CashOnDelivFact | Сумма наложенного платежа, которую взяли с получателя, в валюте страны получателя, по умолчанию руб. с учетом частичной доставки. Доступно только для накладных в статусе «Вручен» | float | нет |
1.1.10 | CashOnDelivType | Тип оплаты наложенного платежа. Принимает значения: cash - наличный расчет, cashless - безналичный расчет. Тэг отсутствует, если информация о платеже еще не поступила | string(10) | нет |
1.1.11 | deliveryMode | Код режима доставки (подробнее см. приложение 1) | integer | да |
1.1.12 | PvzCode | Код ПВЗ, указанный в заказе на момент запроса при режиме доставке «до склада» | string(10) | нет |
1.1.13 | deliveryVariant | Вариант доставки (COURIER – курьером, PVZCDEK – ПВЗ СДЭК, PVZCLIENT – ПВЗ партнера, POSTAMAT - постамат СДЭК) | string(10) | да |
1.1.14 | SendCity | Город отправителя | да | |
1.1.14.1 | Code | Код города по базе СДЭК (https://cdek.ru/storage/source/document/1/CDEK_city.zip ) | integer | да |
1.1.14.2 | PostCode | Почтовый индекс города | string(6) | да |
1.1.14.3 | Name | Название города | string(50) | да |
1.1.15 | RecCity | Город получателя | да | |
1.1.15.1 | Code | Код города по базе СДЭК (https://cdek.ru/storage/source/document/1/CDEK_city.zip ) | integer | да |
1.1.15.2 | PostCode | Почтовый индекс города | string(6) | да |
1.1.15.3 | Name | Название города | string(50) | да |
1.1.16 | AddedService | Дополнительные услуги к заказам | нет | |
1.1.16.1 | ServiceCode | Код дополнительной услуги (подробнее см. приложение 2) | integer | да |
1.1.16.2 | Sum | Сумма услуги в валюте взаиморасчетов, по умолчанию руб. | float | да |
1.1.17 | Package | Упаковка (все упаковки передаются в разных тэгах Package) | да | |
1.1.17.1 | Number | Номер упаковки | string(20) | да |
1.1.17.2 | BarCode | Штрих-код упаковки, идентификатор грузоместа | string(20) | да |
1.1.17.3 | Weight | Общий вес (в килограммах) Обращаем внимание, что единица измерения значения данного поля (кг) отличается от единицы измерения веса (гр) в методах создания и обновления заказа. | integer | да |
1.1.17.4 | VolumeWeight | Объемный вес (в килограммах), рассчитанный по формуле SizeA*SizeB*SizeC/5000 | integer | да |
1.1.17.5 | SizeA | Габариты упаковки. Длина (в сантиметрах) | integer | да |
1.1.17.6 | SizeB | Габариты упаковки. Ширина (в сантиметрах) | integer | да |
1.1.17.7 | SizeC | Габариты упаковки. Высота (в сантиметрах) | integer | да |
1.1.17.8 | Item | Вложение (товар) | да | |
1.1.17.8.1 | WareKey | Идентификатор/артикул товара/вложения | string(50) | да |
1.1.17.8.2 | Marking | Маркировка товара/вложения | string | нет |
1.1.17.8.3 | Comment | Наименование товара (может также содержать описание товара: размер, цвет) | string(255) | да |
1.1.17.8.4 | Amount | Количество переданного на доставку товара | integer | да |
1.1.17.8.5 | DelivAmount | Количество врученных единиц одноименного товара (в штуках) | integer | да |
1.1.17.8.6 | Cost | Объявленная стоимость товара (за единицу товара в валюте договора) | float | да |
1.1.17.8.7 | Payment | Оплата за товар при получении (за единицу товара в валюте страны получателя) | float | да |
1.1.17.8.8 | VATRate | Ставка НДС, включенная в стоимость товара (подробнее см. приложение 4) | string(10) | нет |
1.1.17.8.9 | VATSum | Сумма НДС, включенного в стоимость товара | float | нет |
1.1.17.8.10 | Weight | Вес (за единицу товара, в килограммах) Обращаем внимание, что единица измерения значения данного поля (кг) отличается от единицы измерения веса (гр) в методах создания и обновления заказа. | integer | да |
Пример. Отчет "Информация по заказам"
<?xml version="1.0" encoding="utf-8"?> <InfoRequest Date="2018-08-10T00:00:00" Account="account" Secure="secure" ShowHistory="1" ShowReturnOrder="1"> <Order DispatchNumber="1000000000"/> </InfoRequest>
<?xml version="1.0" encoding="UTF-8"?> <InfoReport> <Order Number="1214733" Date="2018-08-08" DispatchNumber="1000000000" TariffTypeCode="137" Weight="3.805" DeliverySum="135" DateLastChange="2000-01-01 00:00:00" CashOnDeliv="2231" CashOnDelivFact="2231" CashOnDelivType="cashless" deliveryMode="3" deliveryVariant="COURIER"> <SendCity Code="137" PostCode="190000" Name="Санкт-Петербург"/> <RecCity Code="137" PostCode="190000" Name="Санкт-Петербург"/> <Package Number="_" BarCode="1214733" Weight="1.150" VolumeWeight="2.433" SizeA="23" SizeB="23" SizeC="23"> <Item WareKey="Ботинки40, размер 40" Comment="Мокасины мужские" Cost="665" Payment="665" VATRate="VAT18" VATSum="101.44" Weight="0.590" Amount="1" DelivAmount="1" /> <Item WareKey="Ботинки60, размер 40" Comment="Кроссовки мужские" Cost="832" Payment="832" VATRate="VAT18" VATSum="126.92" Weight="0.560" Amount="1" DelivAmount="1" /> </Package> <Package Number="_" BarCode="134519516" Weight="0.500" VolumeWeight="1.372" SizeA="19" SizeB="19" SizeC="19"> <Item WareKey="Ботинки10, размер 42" Comment="Кеды мужские" Cost="599" Payment="599" VATRate="VAT18" VATSum="91.37" Weight="0.500" Amount="1" DelivAmount="1" /> </Package> <AddedService ServiceCode="2" Sum="0.01" /> </Order> </InfoReport>
4.11. Список регионов
Метод используется для получения детальной информации о регионах.
Список регионов может быть ограничен характеристиками, задаваемыми пользователем.
4.11.1. Описание передаваемых параметров запроса
Для получения списка регионов необходимо отправить GET запрос с параметрами, перечисленными ниже:
№ | Тэг/Атрибут | Описание | Тип поля | Обяз. для заполн. |
---|---|---|---|---|
1 | regionCodeExt | Код региона | string(10) | нет |
2 | regionCode | Код региона в ИС СДЭК | integer | нет |
3 | regionFiasGuid | Код региона по ФИАС | UUID | нет |
4 | countryCode | Код страны в формате ISO 3166-1 alpha-2 | string(2) | нет |
5 | countryCodeExt | Код ОКСМ | integer | нет |
6 | page | Номер страницы выборки результата. По умолчанию 0 | integer | нет |
7 | size | Ограничение выборки результата. По умолчанию 1000 | integer | да, если указан page |
8 | lang | Локализация. По умолчанию "rus". | string(3) | нет |
4.11.2. Формат ответа
Обратите внимание! Если в запросе не были переданы значения "page" и "size", то в ответе будет получено не более 1000 регионов
Сервер СДЭК вернет результат с полями:
№ | Тэг/Атрибут | Описание | Тип поля | Обяз. для заполн. |
---|---|---|---|---|
1 | regionUuid | Идентификатор сущности в ИС СДЭК | UUID | да |
2 | regionName | Название региона | string(255) | да |
3 | prefix | Префикс (возможные значения: обл, край, респ, АО, Аобл, г) | string(20) | нет |
4 | regionCodeEx | Код региона | String(10) | нет |
5 | regionCode | Код региона в ИС СДЭК | String(10) | нет |
6 | regionFiasGuid | Код региона по ФИАС | UUID | нет |
7 | countryName | Название страны | string(255) | да |
8 | countryCode | Код страны | string | нет |
9 | countryCodeExt | Код ОКСМ | string | нет |
Пример 1. Список субъектов РФ в JSON
Ограничение выборки результата = 5, страница вывода = 0 http://integration.cdek.ru/v1/location/regions/json?size=5&page=0
[ { "regionUuid": "18aff43f-58b8-4608-ade7-92fdab7fc39f", "regionName": "Тверская", "prefix": "обл", "regionCode": "50", "regionCodeExt": "69", "regionFiasGuid": "61723327-1c20-42fe-8dfa-402638d9b396", "countryName": "РОССИЯ", "countryCode": "1", "countryCodeExt": "643" }, { "regionUuid": "2f644011-2c18-411e-b85c-3491117caa54", "regionName": "Архангельская", "prefix": "обл", "regionCode": "66", "regionCodeExt": "29", "regionFiasGuid": "294277aa-e25d-428c-95ad-46719c4ddb44", "countryName": "РОССИЯ", "countryCode": "1", "countryCodeExt": "643" }, { "regionUuid": "3cfe3bff-25bf-4ccb-9014-85fff75e3a05", "regionName": "Калининградская", "prefix": "обл", "regionCode": "38", "regionCodeExt": "39", "regionFiasGuid": "90c7181e-724f-41b3-b6c6-bd3ec7ae3f30", "countryName": "РОССИЯ", "countryCode": "1", "countryCodeExt": "643" }, { "regionUuid": "4a3de27c-86eb-4f67-b717-ef0cdbc73088", "regionName": "Магаданская", "prefix": "обл", "regionCode": "59", "regionCodeExt": "49", "regionFiasGuid": "9c05e812-8679-4710-b8cb-5e8bd43cdf48", "countryName": "РОССИЯ", "countryCode": "1", "countryCodeExt": "643" }, { "regionUuid": "58384c03-3481-44d1-9cb3-f527da387c96", "regionName": "Чукотский", "prefix": "АО", "regionCode": "83", "regionCodeExt": "87", "regionFiasGuid": "f136159b-404a-4f1f-8d8d-d169e1374d5c", "countryName": "РОССИЯ", "countryCode": "1", "countryCodeExt": "643" } ]
Пример 2. Список субъектов РФ в XML
Ограничение выборки результата = 5, страница вывода = 0 http://integration.cdek.ru/v1/location/regions?size=5&page=0 или http://integration.cdek.ru/v1/location/regions/xml?size=5&page=0
<?xml version="1.0" encoding="UTF-8" standalone="yes"?> <Regions> <Region regionName="Тверская" regionCode="50" regionUuid="18aff43f-58b8-4608-ade7-92fdab7fc39f" prefix="обл" regionCodeExt="69" regionFiasGuid="61723327-1c20-42fe-8dfa-402638d9b396" countryName="РОССИЯ" countryCode="1" countryCodeExt="643"/> <Region regionName="Архангельская" regionCode="66" regionUuid="2f644011-2c18-411e-b85c-3491117caa54" prefix="обл" regionCodeExt="29" regionFiasGuid="294277aa-e25d-428c-95ad-46719c4ddb44" countryName="РОССИЯ" countryCode="1" countryCodeExt="643"/> <Region regionName="Калининградская" regionCode="38" regionUuid="3cfe3bff-25bf-4ccb-9014-85fff75e3a05" prefix="обл" regionCodeExt="39" regionFiasGuid="90c7181e-724f-41b3-b6c6-bd3ec7ae3f30" countryName="РОССИЯ" countryCode="1" countryCodeExt="643"/> <Region regionName="Магаданская" regionCode="59" regionUuid="4a3de27c-86eb-4f67-b717-ef0cdbc73088" prefix="обл" regionCodeExt="49" regionFiasGuid="9c05e812-8679-4710-b8cb-5e8bd43cdf48" countryName="РОССИЯ" countryCode="1" countryCodeExt="643"/> <Region regionName="Чукотский" regionCode="83" regionUuid="58384c03-3481-44d1-9cb3-f527da387c96" prefix="АО" regionCodeExt="87" regionFiasGuid="f136159b-404a-4f1f-8d8d-d169e1374d5c" countryName="РОССИЯ" countryCode="1" countryCodeExt="643"/> </Regions>
4.12. Список городов
Метод используется для получения детальной информации о городах.
Список городов может быть ограничен характеристиками, задаваемыми пользователем.
4.12.1. Описание передаваемых параметров запроса
Для получения списка городов необходимо отправить GET запрос с параметрами, перечисленными ниже:
№ | Тэг/Атрибут | Описание | Тип поля | Обяз. для заполн. |
---|---|---|---|---|
1 | regionCodeExt | Код региона | integer | нет |
2 | regionCode | Код региона в ИС СДЭК | integer | нет |
3 | regionFiasGuid | Код региона из ФИАС | UUID | нет |
4 | page | Номер страницы выборки результата. По умолчанию 0 | integer | нет |
5 | size | Ограничение выборки результата. По умолчанию 1000 | integer | да, если указан page |
6 | countryCode | Код страны в формате ISO 3166-1 alpha-2 | string(2) | нет |
7 | cityName | Название города | string | нет |
8 | cityCode | Код города по базе СДЭК (https://cdek.ru/storage/source/document/1/CDEK_city.zip) | integer | нет |
9 | postcode | Почтовый индекс | string | нет |
10 | lang | Локализация. По-умолчанию "rus". | string(3) | нет |
4.12.2. Формат ответа
Обратите внимание! Если в запросе не были переданы значения "page" и "size", то в ответе будет получено не более 1000 городов
Сервер СДЭК вернет результат с полями:
№ | Тэг/Атрибут | Описание | Тип поля | Обяз. для заполн. |
---|---|---|---|---|
1 | cityUuid | Идентификатор сущности в ИС СДЭК | UUID | да |
2 | cityName | Название города | string(255) | да |
3 | cityCode | Код города по базе СДЭК (https://cdek.ru/storage/source/document/1/CDEK_city.zip) | integer | да |
4 | region | Название региона | string(255) | да |
6 | regionCodeExt | Код региона | integer | нет |
7 | regionCode | Код региона в ИС СДЭК | integer | нет |
8 | subRegion | Название района региона | string(255) | нет |
9 | country | Название страны | string(255) | да |
10 | countryCode | Код страны | integer | да |
11 | latitude | Широта | float | нет |
12 | longitude | Долгота | float | нет |
13 | kladr | Код города по КЛАДР | string(20) | нет |
14 | fiasGuid | Код адресного объекта в ФИАС | UUID | нет |
15 | regionFiasGuid | Код региона из ФИАС | UUID | нет |
16 | paymentLimit | Ограничение на сумму наложенного платежа, возможные значения:
| float | да |
17 | timezone | Часовой пояс города | string | нет |
Пример 1. Список городов в JSON
Код региона по базе СДЭК = 23, ограничение выборки результата = 5, страница вывода = 0 http://integration.cdek.ru/v1/location/cities/json?size=5&page=0®ionCode=23
[ { "cityName":"Сокур-1", "cityCode":"13801", "cityUuid":"f5c636b7-9efe-4f8a-bac3-473cdb8593bd", "country":"Россия", "countryCode":"RU", "region":"Новосибирская обл.", "regionCode":"23", "subRegion":" Мошковский р-н", "latitude":0.0, "longitude":0.0, "paymentLimit":-1.0 }, { "cityName":"Воздвиженский", "cityCode":"76794", "cityUuid":"c8481368-34c3-4edc-b2f6-5832765cdf13", "country":"Россия", "countryCode":"RU", "region":"Новосибирская обл.", "regionCode":"23", "subRegion":" Чулымский р-н", "paymentLimit":0.0 }, { "cityName":"Станционно-Ояшинский", "cityCode":"1999", "cityUuid":"11188cd0-2035-45e5-9aa5-c995297f755b", "country":"Россия", "countryCode":"RU", "region":"Новосибирская", "regionCode":"23", "regionCodeExt":"54", "regionFiasGuid":"1ac46b49-3209-4814-b7bf-a509ea1aecd9", "subRegion":"Мошковский", "latitude":55.4652, "longitude":83.8223, "kladr":"5401900003400", "fiasGuid":"5f2921df-c791-4312-8c3a-7ba319344752", "paymentLimit":-1.0, "timezone":"Asia/Novosibirsk" }, { "cityName":"Новопокровский", "cityCode":"49876", "cityUuid":"228fcc02-be09-411b-8d88-aaab86c79a8f", "country":"Россия", "countryCode":"RU", "region":"Новосибирская", "regionCode":"23", "regionCodeExt":"54", "regionFiasGuid":"1ac46b49-3209-4814-b7bf-a509ea1aecd9", "subRegion":"Краснозерский", "latitude":54.23, "longitude":78.6929, "kladr":"5401400004900", "fiasGuid":"33836940-2211-4335-ae2e-7244fa88fe9e", "paymentLimit":0.0, "timezone":"Asia/Novosibirsk" }, { "cityName":"Пеньково", "cityCode":"60397", "cityUuid":"22c852cd-2132-49c0-960d-fa881bb743e3", "country":"Россия", "countryCode":"RU", "region":"Новосибирская", "regionCode":"23", "regionCodeExt":"54", "regionFiasGuid":"1ac46b49-3209-4814-b7bf-a509ea1aecd9", "subRegion":"Маслянинский", "latitude":54.3355, "longitude":83.9874, "kladr":"5401800002200", "fiasGuid":"83682104-f71f-40e1-beca-0feee5b756aa", "paymentLimit":0, "timezone":"Asia/Novosibirsk" } ]
Пример 2. Список городов в XML
Код региона по базе СДЭК = 23, ограничение выборки результата = 5, страница вывода = 0 http://integration.cdek.ru/v1/location/cities?size=5&page=0®ionCode=23 или http://integration.cdek.ru/v1/location/cities/xml?size=5&page=0®ionCode=23
<?xml version="1.0" encoding="UTF-8" standalone="yes"?> <Locations> <Location cityName="Лебедевка" cityCode="37960" cityUuid="1ef4f958-43c9-4a80-9fd6-e414231c3e55" country="РОССИЯ" countryCode="1" region="Новосибирская" regionCode="23" regionCodeExt="54" subRegion="Искитимский" latitude="54.6711" longitude="83.2337" kladr="5400800007900" fiasGuid="873b2cc6-cf4e-4001-aca7-eb0380951bfc" paymentLimit="-1"/> <Location cityName="Новопокровский" cityCode="49876" cityUuid="228fcc02-be09-411b-8d88-aaab86c79a8f" country="РОССИЯ" countryCode="1" region="Новосибирская" regionCode="23" regionCodeExt="54" subRegion="Краснозерский" latitude="54.23" longitude="78.6929" kladr="5401400004900" fiasGuid="33836940-2211-4335-ae2e-7244fa88fe9e" paymentLimit="-1"/> <Location cityName="Александро-Невский" cityCode="1961" cityUuid="22f58510-3b97-42b4-bd86-6e21a0e74ba9" country="РОССИЯ" countryCode="1" region="Новосибирская" regionCode="23" regionCodeExt="54" subRegion="Баганский" latitude="54.0212" longitude="77.3931" kladr="5400200002500" fiasGuid="34cbaf34-7ab2-42a4-b21a-c3d4b3a492e5" paymentLimit="-1"/> <Location cityName="Маршанское" cityCode="39646" cityUuid="23f5dc61-43b0-4566-9413-344de99e1b11" country="РОССИЯ" countryCode="1" region="Новосибирская" regionCode="23" regionCodeExt="54" subRegion="Каргатский" latitude="55.0366" longitude="79.8615" kladr="5401000001200" fiasGuid="9d27abd6-049c-47ef-9f58-51b7a1c07a58" paymentLimit="-1"/> <Location cityName="Чистоозерное" cityCode="752" cityUuid="574033d7-bfed-45b1-8745-d9917a58e8e4" country="РОССИЯ" countryCode="1" region="Новосибирская" regionCode="23" regionCodeExt="54" subRegion="Чистоозерный" latitude="54.7074" longitude="76.5818" kladr="5402900000100" fiasGuid="6c5bea6d-2211-49e4-ae75-192fc5e88b20" paymentLimit="-1"/> </Locations>
4.13 Калькулятор
4.13.1. Расчет стоимости по тарифам с приоритетом
Для получения стоимости и сроков доставки необходимо отправить json-объект серверу СДЭК. При передаче json-объекта в заголовке нужно указать соответствующий Content-Type.
url | type |
---|---|
Content-Type: application/json | |
dataType : "jsonp" (из js) | |
http://api.cdek.ru/calculator/calculate_price_by_json_request.php | Content-Type: application/x-www-form-urlencoded |
4.14.1.1. Описание передаваемых данных
№ | Параметр | Описание | Тип поля | Обяз. для заполнения |
1 | version | Версия используемого API - “1.0” | string | да |
2 | authLogin1 | Идентификатор ИМ (логин) | string | нет |
3 | secure1 | Ключ | string | нет |
4 | dateExecute2 | Планируемая дата отправки заказа в формате “ГГГГ-ММ-ДД” | date | нет |
5 | lang | Локализация названий городов. По умолчанию "rus" | string(3) | нет |
6 | senderCountryCode3 | Код страны отправителя в формате ISO_3166-1_alpha-2 (см. “Общероссийский классификатор стран мира”). По умолчанию - ru. | string(2) | нет |
7 | receiverCountryCode3 | Код страны получателя в формате ISO_3166-1_alpha-2 (см. “Общероссийский классификатор стран мира”). По умолчанию - ru. | string(2) | нет |
8 | senderCityId3 | Код города отправителя из базы СДЭК (https://cdek.ru/storage/source/document/1/CDEK_city.zip) | integer | да |
9 | senderCity3 | Наименование города отправителя | string | нет |
10 | senderCityPostCode3 | Индекс города отправителя из базы СДЭК (https://cdek.ru/storage/source/document/1/CDEK_city.zip) | integer | да |
11 | receiverCityId3 | Код города получателя из базы СДЭК (https://cdek.ru/storage/source/document/1/CDEK_city.zip) | integer | да |
12 | receiverCityPostCode3 | Индекс города получателя из базы СДЭК (https://cdek.ru/storage/source/document/1/CDEK_city.zip) | integer | да |
13 | receiverCity3 | Наименование города получателя | string | нет |
14 | senderLongitude3 | Долгота города отправителя | float | нет |
15 | receiverLongitude3 | Долгота города получателя | float | нет |
16 | senderLatitude3 | Широта города отправителя | float | нет |
17 | receiverLatitude3 | Широта города получателя | float | нет |
18 | tariffId4 | Код выбранного тарифа (подробнее см. приложение 1) | integer | да |
19 | tariffList4 | Список тарифов | да | |
19.1 | priority | Заданный приоритет | integer | да |
19.2 | id | Код тарифа (подробнее см. приложение 1) | integer | да |
20 | modeId | Режим доставки (подробнее см. приложение 1) | integer | нет |
21 | goods | Габаритные характеристики упаковки | да | |
21.1 | weight | Вес упаковки (в килограммах) | float | да |
21.2 | length | Длина упаковки (в сантиметрах) | integer | да |
21.3 | width | Ширина упаковки (в сантиметрах) | integer | да |
21.4 | height | Высота упаковки (в сантиметрах) | integer | да |
22 | services | Список передаваемых дополнительных услуг (подробнее см. приложение 2) | нет | |
22.1 | id | Идентификатор номера дополнительной услуги | integer | да |
22.2 | param5 | Параметр дополнительной услуги, если необходимо | integer | нет |
1 При использовании тарифов для обычной доставки авторизация не обязательна и параметры authLogin и secure можно не передавать.
2 Дата планируемой отправки dateExecute не обязательна (в этом случае принимается текущая дата). Но, если вы работаете с авторизацией, она должна быть передана, так как дата учитывается при шифровании/дешифровке пароля .
3 Идентификация города возможна двумя способами на выбор:
- по уникальному коду города базы СДЭК (ID города). Значения передаются в атрибутах senderCityId, receiverCityId;
- по почтовому индексу города. Значения передаются в атрибутах senderCityPostCode, receiverCityPostCode. В качестве уточняющих параметров могут быть использованы код страны (атрибуты senderCountryCode, receiverCountryCode) и/или наименование города (атрибуты senderCity, receiverCity), широта и долгота города (атрибуты senderLongitude, receiverLongitude, senderLatitude, receiverLatitude).
Если указан атрибут Код города и Почтовый индекс, то приоритет для определения города имеет Код города, это относится к определению, как города отправителя, так и города получателя. Нужно принимать во внимание, что база почтовых индекс в ИС СДЭК может содержать неполную и иногда не точную информацию по почтовым индексам, поэтому пользователь должен иметь возможность скорректировать параметр почтового индекса, если это необходимо.
Для идентификации городов других стран рекомендуем использовать код города по БД СДЭК. Коды городов базы СДЭК можно найти в реестрах городов в пакете документации (https://cdek.ru/storage/source/document/1/CDEK_city.zip), где xxx– трехбуквенный код страны, yyyymmdd – дата формирования файла.
4 При задании тарифа нужно задавать либо один выбранный тариф, либо список тарифов с приоритетами. Если задаётся и tariffId, и tariffList – принимается tariffId, а список игнорируется.
Список тарифов с приоритетами tariffList, как правило, используется в том случае, если на выбранном направлении у СДЭК может не быть наиболее выгодного для вас какого-то конкретного тарифа по доставке.
В случае задания списка тарифов этот список проверяется на возможность доставки по заданному направлению с заданным весом груза последовательно (начиная с priority:1, затем priority:2 и т.д) и проверка возможности доставки будет проходить до тех пор, пока по очередному тарифу не появится такая возможность. Тогда стоимость будет рассчитана по этому тарифу. В ответе сервера будет возвращен «tariffId» из заданного списка tariffList, по которому была посчитана сумма доставки.
Указывать режим доставки modeId имеет смысл только при выборе списка тарифов. В этом случае заданный список дополнительно фильтруется по режиму доставки, в противном случае – игнорируется.
5 Для дополнительных услуг 2, 24, 25 и 32 значение параметра является обязательным и должно быть передано в запросе. Для услуги 2 - страховка в param необходимо передать сумму, с которой будет рассчитана страховка (необходимо передавать в валюте взаиморасчетов). Услуга 30 доступна только для договора ИМ, поэтому в запросе должны быть переданы значения authLogin и secure. Для услуг 24,25 и 32 в param передается значение количества.
4.13.1.2. Формат ответа
Сервер СДЭК вернет результат с полями:
№ | Параметр | Описание | Тип поля |
1 | error | Массив ошибок при их возникновении (подробнее см. приложение 9) | |
1.1 | code | Код ошибки | integer |
1.2 | text | Текст ошибки | string |
2 | price | Сумма за доставку в рублях | double |
3 | deliveryPeriodMin | Минимальное время доставки в днях | integer |
4 | deliveryPeriodMax | Максимальное время доставки в днях | integer |
5 | deliveryDateMin | Минимальная дата доставки, формате 'ГГГГ-ММ-ДД', например “2018-07-29” | string |
6 | deliveryDateMax | Максимальная дата доставки, формате 'ГГГГ-ММ-ДД', например “2018-07-30” | string |
7 | tariffId | Код тарифа, по которому рассчитана сумма доставки | integer |
8 | cashOnDelivery | Ограничение оплаты наличными, появляется только если оно есть | float |
9 | priceByCurrency | Цена в валюте взаиморасчетов. Валюта определяется по authLogin и secure. | float |
10 | currency | Валюта интернет-магазина (подробнее см. приложение 3) | string |
11 | percentVAT | Размер ставки НДС для данного клиента. Появляется в случае, если переданы authLogin и secure, по ним же определяется ставка ИМ. Если ставка НДС не предусмотрена условиями договора, данный параметр не будет отображен. | integer |
12 | services | Список передаваемых дополнительных услуг (подробнее см. приложение 2) | |
12.1 | id | Идентификатор переданной услуги | integer |
12.2 | title | Заголовок услуги | string |
12.3 | price | Стоимость услуги без учета НДС в рублях | float |
12.4 | rate | Процент для расчета дополнительной услуги | float |
Пример. Расчет стоимости доставки
{ "version":"1.0", "dateExecute":"2019-07-19", "senderCityId":"44", "receiverCityId":"44", "tariffId":"1", "goods": [ { "weight":"0.3", "length":"5", "width":"20", "height":"10" } ], "services": [ { "id": "7" } ] }
{ "result": { "price": "450", "deliveryPeriodMin": 1, "deliveryPeriodMax": 1, "deliveryDateMin": "2019-07-19", "deliveryDateMax": "2019-07-19", "tariffId": "1", "priceByCurrency": 450, "currency": "RUB", "services": [ { "id": 7, "title": "Опасный груз", "price": 150 } ] } }
4.13.2. Расчет стоимости по тарифам без приоритета
Для получения стоимости и сроков доставки необходимо отправить json-объект серверу СДЭК. При передаче json-объекта в заголовке нужно указать соответствующий Content-Type.
url | type |
---|---|
Content-Type: application/json |
4.13.2.1. Описание передаваемых данных
№ | Параметр | Описание | Тип поля | Обяз. для заполнения |
1 | version | Версия используемого API - “1.0” | string | да |
2 | authLogin1 | Идентификатор ИМ (логин) | string | нет |
3 | secure1 | Ключ | string | нет |
4 | dateExecute2 | Планируемая дата отправки заказа в формате “ГГГГ-ММ-ДД” | date | нет |
5 | lang | Локализация названий городов. По умолчанию "rus" | string(3) | нет |
6 | senderCountryCode3 | Код страны отправителя в формате ISO_3166-1_alpha-2 (см. “Общероссийский классификатор стран мира”). По умолчанию - ru. | string(2) | нет |
7 | receiverCountryCode3 | Код страны получателя в формате ISO_3166-1_alpha-2 (см. “Общероссийский классификатор стран мира”). По умолчанию - ru. | string(2) | нет |
8 | senderCityId3 | Код города отправителя из базы СДЭК (https://cdek.ru/storage/source/document/1/CDEK_city.zip) | integer | да |
9 | senderCity3 | Наименование города отправителя | string | нет |
10 | senderCityPostCode3 | Индекс города отправителя из базы СДЭК (https://cdek.ru/storage/source/document/1/CDEK_city.zip) | integer | да |
11 | receiverCityId3 | Код города получателя из базы СДЭК (https://cdek.ru/storage/source/document/1/CDEK_city.zip) | integer | да |
12 | receiverCity3 | Наименование города получателя | string | нет |
13 | receiverCityPostCode3 | Индекс города получателя из базы СДЭК (https://cdek.ru/storage/source/document/1/CDEK_city.zip) | integer | да |
14 | senderLongitude3 | Долгота города отправителя | float | нет |
15 | receiverLongitude3 | Долгота города получателя | float | нет |
16 | senderLatitude3 | Широта города отправителя | float | нет |
17 | receiverLatitude3 | Широта города получателя | float | нет |
18 | currency | Валюта, в которой необходимо рассчитать стоимость доставки. По умолчанию - RUB | string | нет |
19 | tariffId4 | Код выбранного тарифа (подробнее см. приложение 1) | integer | да, если не указан tariffList |
20 | tariffList4 | Список тарифов | да, если не указан tariffId | |
20.1 | id | Код тарифа (подробнее см. приложение 1) | integer | нет |
21 | goods | Габаритные характеристики упаковки | да | |
21.1 | weight | Вес упаковки (в килограммах) | float | да |
21.2 | length | Длина упаковки (в сантиметрах) | integer | да |
21.3 | width | Ширина упаковки (в сантиметрах) | integer | да |
21.4 | height | Высота упаковки (в сантиметрах) | integer | да |
22 | services | Список передаваемых дополнительных услуг (подробнее см. приложение 2) | нет | |
22.1 | id | Идентификатор номера дополнительной услуги | integer | да |
22.2 | param5 | Параметр дополнительной услуги, если необходимо | integer | нет |
1 При использовании тарифов для обычной доставки авторизация не обязательна и параметры authLogin и secure можно не передавать.
2 Дата планируемой отправки dateExecute не обязательна (в этом случае принимается текущая дата). Но, если вы работаете с авторизацией, она должна быть передана, так как дата учитывается при шифровании/дешифровке пароля .
3 Идентификация города возможна двумя способами на выбор:
- по уникальному коду города базы СДЭК (ID города). Значения передаются в атрибутах senderCityId, receiverCityId;
- по почтовому индексу города. Значения передаются в атрибутах senderCityPostCode, receiverCityPostCode. В качестве уточняющих параметров могут быть использованы код страны (атрибуты senderCountryCode, receiverCountryCode) и/или наименование города (атрибуты senderCity, receiverCity), широта и долгота города (атрибуты senderLongitude, receiverLongitude, senderLatitude, receiverLatitude).
Если указан атрибут Код города и Почтовый индекс, то приоритет для определения города имеет Код города, это относится к определению, как города отправителя, так и города получателя. Нужно принимать во внимание, что база почтовых индекс в ИС СДЭК может содержать неполную и иногда не точную информацию по почтовым индексам, поэтому пользователь должен иметь возможность скорректировать параметр почтового индекса, если это необходимо..
Для идентификации городов других стран рекомендуем использовать код города по БД СДЭК. Коды городов базы СДЭК можно найти в реестрах городов в пакете документации (https://cdek.ru/storage/source/document/1/CDEK_city.zip), где xxx– трехбуквенный код страны, yyyymmdd – дата формирования файла.
4 При задании тарифа нужно задавать либо один выбранный тариф, либо список тарифов. Если задаётся и tariffId, и tariffList – принимается tariffId, а список игнорируется.
5 Для дополнительных услуг 2, 24, 25 и 32 значение параметра является обязательным и должно быть передано в запросе. Для услуги 2 - страховка в param необходимо передать сумму, с которой будет рассчитана страховка (необходимо передавать в валюте взаиморасчетов). Услуга 30 доступна только для договора ИМ, поэтому в запросе должны быть переданы значения authLogin и secure. Для услуг 24,25 и 32 в param передается значение количества.
4.13.2.2. Формат ответа
Если в запросе был передан tariffId, то ответ соответствует описанному в п.4.14.1.2.
Иначе сервер СДЭК вернет результат с полями:
№ | Параметр | Описание | Тип поля |
1 | tariffId | Код тарифа, по которому рассчитана сумма доставки | integer |
2 | status | Статус ответа (true - успешный, false - не успешный) | string |
3 | result | Стоимость и время доставки по тарифу | |
3.1 | error | Массив ошибок при их возникновении (подробнее см. приложение 9) | |
3.1.1 | code | Код ошибки | integer |
3.1.2 | text | Текст ошибки | string |
3.2 | price | Сумма за доставку в рублях | double |
3.3 | deliveryPeriodMin | Минимальное время доставки в днях | integer |
3.4 | deliveryPeriodMax | Максимальное время доставки в днях | integer |
3.5 | cashOnDelivery | Ограничение оплаты наличными, появляется только если оно есть | float |
3.6 | priceByCurrency | Цена в валюте, которая была передана в запросе. | float |
3.7 | currency | Валюта, переданная в запросе. | string |
3.8 | percentVAT | Размер ставки НДС для данного клиента. Появляется в случае, если переданы authLogin и secure, по ним же определяется ставка ИМ. Если ставка НДС не предусмотрена условиями договора, данный параметр не будет отображен. | integer |
3.9 | services | Список передаваемых дополнительных услуг (подробнее см. приложение 9) | |
3.9.1 | id | Идентификатор переданной услуги | integer |
3.9.2 | title | Заголовок услуги | string |
3.9.3 | price | Стоимость услуги без учета НДС в рублях | float |
3.9.4 | rate | Процент для расчета дополнительной услуги | float |
Пример. Расчет стоимости доставки
{ "version":"1.0", "dateExecute":"2019-04-01", "senderCityId":"44", "receiverCityId":"269", "currency":"RUB", "tariffList": [ { "id":1 }, { "id":8 } ], "goods": [ { "weight":"1", "length":"1", "width":"2", "height":"7" } ], "services": [ { "id":2, "param":1000 } ] }
{ "result": [ { "tariffId":1, "status":true, "result": { "price":"1077", "deliveryPeriodMin":2, "deliveryPeriodMax":3, "tariffId":1, "priceByCurrency":1077, "currency":"RUB", "percentVAT":20, "services": [ { "id":2, "title":"Страхование", "price":7.5, "rate":0.75 } ] } }, { "tariffId":8, "status":false, "result": { "errors": { "code":3, "text":"Невозможно осуществить доставку по этому направлению при заданных условиях" } } } ] }
Приложения
Приложение 1. Услуги (тарифы) и режимы доставки СДЭК
Тарифы для ИМ
Код | Название тарифа | Режим доставки | Ограничение по весу | Услуга | Описание |
---|---|---|---|---|---|
7 | Международный экспресс документы дверь-дверь | дверь-дверь (Д-Д) | до 5 кг | Международный экспресс | Экспресс-доставка за/из-за границы документов и писем. |
8 | Международный экспресс грузы дверь-дверь | дверь-дверь (Д-Д) | до 30 кг | Международный экспресс | Экспресс-доставка за/из-за границы грузов и посылок до 30 кг. |
136 | Посылка склад-склад | склад-склад (С-С) | до 30 кг | Посылка | Услуга экономичной доставки товаров по России для компаний, осуществляющих дистанционную торговлю. |
137 | Посылка склад-дверь | склад-дверь (С-Д) | |||
138 | Посылка дверь-склад | дверь-склад (Д-С) | |||
139 | Посылка дверь-дверь | дверь-дверь (Д-Д) | |||
366 | Посылка дверь-постамат | дверь-постамат (Д-П) | |||
368 | Посылка склад-постамат | склад-постамат (С-П) | |||
до 50 кг | Экономичная посылка | Услуга экономичной наземной доставки товаров по России для компаний, осуществляющих дистанционную торговлю. Услуга действует по направлениям из Москвы в подразделения СДЭК, находящиеся за Уралом и в Крым. | |||
233 | Экономичная посылка склад-дверь | склад-дверь (С-Д) | |||
234 | Экономичная посылка склад-склад | склад-склад (С-С) | |||
378 | Экономичная посылка склад-постамат | склад-постамат (С-П) | |||
291 | CDEK Express склад-склад | склад-склад (С-С) | CDEK Express | Сервис по доставке товаров из-за рубежа в Россию, Украину, Казахстан, Киргизию, Узбекистан с услугами по таможенному оформлению. Предлагается 2 схемы работы: 1) клиент доставляет заказ на таможенный пост в России. Мы встречаем, помогаем с таможней и доставляем адресату; 2) клиент привозит посылки на один из наших складов за рубежом. Мы перевозим их на таможенный пост в Россию, проводим очистку и доставляем получателю. | |
293 | CDEK Express дверь-дверь | дверь-дверь (Д-Д) | |||
294 | CDEK Express склад-дверь | склад-дверь (С-Д) | |||
295 | CDEK Express дверь-склад | дверь-склад (Д-С) |
Тарифы Китайский экспресс
Доступны для заказов с типом "интернет-магазин" и для заказов с типом "доставка".
Код | Название тарифа | Режим доставки | Ограничение по весу | Услуга | Описание | |
---|---|---|---|---|---|---|
243 | Китайский экспресс | склад-склад (С-С) | Китайский Экспресс | Услуга по доставке из Китая в Россию, Белоруссию и Казахстан. Стоимость разбита по интервалам: | ||
245 | Китайский экспресс | дверь-дверь (Д-Д) | ||||
246 | Китайский экспресс | склад-дверь (С-Д) | ||||
247 | Китайский экспресс | дверь-склад (Д-С) |
Тарифы для обычной доставки
Код | Название тарифа | Режим доставки | Ограничение по весу | Услуга | Описание |
---|---|---|---|---|---|
1 | Экспресс лайт дверь-дверь | дверь-дверь (Д-Д) | до 30 кг | Экспресс | Классическая экспресс-доставка по России документов и грузов до 30 кг. |
361 | Экспресс лайт дверь-постамат | дверь-постамат (Д-П) | |||
363 | Экспресс лайт склад-постамат | склад-постамат (С-П) | |||
3 | Супер-экспресс до 18 | дверь-дверь (Д-Д) | до 30 кг | Срочная доставка | Срочная доставка документов и грузов «из рук в руки» по России к определенному часу. |
5 | Экономичный экспресс склад-склад | склад-склад (С-С) | Экономичная доставка | Недорогая доставка грузов по России ЖД и автотранспортом (доставка грузов с увеличением сроков). | |
10 | Экспресс лайт склад-склад | склад-склад (С-С) | до 30 кг | Экспресс | Классическая экспресс-доставка документов и грузов внутри РФ, Белоруссии, Казахстана, Армении, Киргизии и между этим странами. |
11 | Экспресс лайт склад-дверь | склад-дверь (С-Д) | |||
12 | Экспресс лайт дверь-склад | дверь-склад (Д-С) | |||
15 | Экспресс тяжеловесы склад-склад | склад-склад (С-С) | от 30 кг | Экспресс | Классическая экспресс-доставка внутри РФ, Белоруссии, Казахстана, Армении, Киргизии и между этим странами. |
16 | Экспресс тяжеловесы склад-дверь | склад-дверь (С-Д) | |||
17 | Экспресс тяжеловесы дверь-склад | дверь-склад (Д-С) | |||
18 | Экспресс тяжеловесы дверь-дверь | дверь-дверь (Д-Д) | |||
57 | Супер-экспресс до 9 | дверь-дверь (Д-Д) | до 30 кг | Срочная доставка | Срочная доставка документов и грузов «из рук в руки» по России к определенному часу (доставка за 1-2 суток). |
58 | Супер-экспресс до 10 | дверь-дверь (Д-Д) | |||
59 | Супер-экспресс до 12 | дверь-дверь (Д-Д) | |||
60 | Супер-экспресс до 14 | дверь-дверь (Д-Д) | |||
61 | Супер-экспресс до 16 | дверь-дверь (Д-Д) | |||
62 | Магистральный экспресс склад-склад | склад-склад (С-С) | Экономичная доставка | Быстрая экономичная доставка грузов по России | |
63 | Магистральный супер-экспресс склад-склад | склад-склад (С-С) | Экономичная доставка | Быстрая экономичная доставка грузов к определенному часу | |
118 | Экономичный экспресс дверь-дверь | дверь-дверь (Д-Д) | Экономичная доставка | Недорогая доставка грузов внутри РФ, Белоруссии, Казахстана, Армении, Киргизии и между этим странами, ЖД и автотранспортом (доставка грузов с увеличением сроков). | |
119 | Экономичный экспресс склад-дверь | склад-дверь (С-Д) | |||
120 | Экономичный экспресс дверь-склад | дверь-склад (Д-С) | |||
121 | Магистральный экспресс дверь-дверь | дверь-дверь (Д-Д) | Экономичная доставка | Быстрая экономичная доставка грузов по России | |
122 | Магистральный экспресс склад-дверь | склад-дверь (С-Д) | |||
123 | Магистральный экспресс дверь-склад | дверь-склад (Д-С) | |||
124 | Магистральный супер-экспресс дверь-дверь | дверь-дверь (Д-Д) | Экономичная доставка | Быстрая экономичная доставка грузов к определенному часу | |
125 | Магистральный супер-экспресс склад-дверь | склад-дверь (С-Д) | |||
126 | Магистральный супер-экспресс дверь-склад | дверь-склад (Д-С) |
Режимы доставки
Код | Название режима | Сокращение | Описание |
---|---|---|---|
1 | дверь-дверь | Д – Д | Курьер забирает груз у отправителя и доставляет получателю на указанный адрес. |
2 | дверь-склад | Д – С | Курьер забирает груз у отправителя и довозит до склада, получатель забирает груз самостоятельно в ПВЗ (самозабор). |
3 | склад-дверь | С – Д | Отправитель доставляет груз самостоятельно до склада, курьер доставляет получателю на указанный адрес. |
4 | склад-склад | С – С | Отправитель доставляет груз самостоятельно до склада, получатель забирает груз самостоятельно в ПВЗ (самозабор). |
6 | дверь-постамат | Д - П | Курьер забирает груз у отправителя и доставляет в указанный постамат, получатель забирает груз самостоятельно из постамата |
7 | склад-постамат | С - П | Отправитель доставляет груз самостоятельно до склада, курьер доставляет в указанный постамат, получатель забирает груз самостоятельно из постамата |
Приложение 2. Дополнительные услуги*
В калькуляторе при расчете стоимости есть возможность указать все перечисленные ниже дополнительные услуги, кроме следующих: ожидание более 15 мин. у отправителя, хранение на складе, прочее, забор в городе отправителе, доставка в городе получателе, пеня, обрешетка груза, аренда курьера, тепловой режим, агентское вознаграждение.
Код услуги | Добавление в заказе | Название | Описание | |
---|---|---|---|---|
2 | Разрешено (только для типа заказа "доставка" и заказам до постамата) | СТРАХОВАНИЕ | Обеспечение страховой защиты посылки. Размер дополнительного сбора страхования вычисляется от размера объявленной стоимости отправления. Услуга начисляется автоматически для всех заказов типа "интернет-магазин", не разрешена для самостоятельной передачи в тэге AddService. | |
3 | Разрешено (Исключение - заказы до постамата) | ДОСТАВКА В ВЫХОДНОЙ ДЕНЬ | Компания СДЭК осуществляет доставку и отправление документов и грузов в выходные и нерабочие дни. При доставке или отправлении документов или грузов в выходной день к базовому тарифу добавляется 300 руб. | |
5 | Запрещено, начисляется автоматически | ТЯЖЕЛЫЙ ГРУЗ | При отправке тяжелых грузов,
Также возможен индивидуальный расчет стоимости доставки тяжелых грузов. Тарифы на такие отправления будут рассчитаны индивидуально и в короткие сроки (не более 1 рабочего дня) и могут быть значительно дешевле наших базовых тарифов. | |
6 | Запрещено, начисляется автоматически | НЕГАБАРИТНЫЙ ГРУЗ | При доставке негабаритного отправления, размер одной из сторон которого превышает 1,5 м, тариф увеличивается на 60 % (если отправление рассчитывается не по объемному весу). | |
7 | Разрешено | ОПАСНЫЙ ГРУЗ | Кроме обычных документов и грузов, компания СДЭК готова доставить отправления, содержащие опасные грузы (кроме запрещенных к перевозке). В связи с определенным риском стоимость доставки грузов, относящихся к категории опасных, увеличивается в 1,5 раза. | |
8 | Запрещено, начисляется автоматически | ОЖИДАНИЕ БОЛЕЕ 15 МИН. У ОТПРАВИТЕЛЯ | К приезду курьера Отправление должно быть подготовлено. По правилам компании СДЭК курьер может ожидать передачи или получения отправления не более 15 минут. В случаях, когда курьер дожидается приема или передачи Отправления более 15 минут, взимается дополнительный сбор в размере 170 рублей. Не допускается на тарифах Посылка. | |
9 | Запрещено, начисляется автоматически | ОЖИДАНИЕ БОЛЕЕ 15 МИН. У ПОЛУЧАТЕЛЯ | ||
10 | Запрещено, начисляется автоматически | ХРАНЕНИЕ НА СКЛАДЕ | При необходимости наша компания предоставляет возможность хранения груза на складе, первые 7 дней — БЕСПЛАТНО. Начиная с восьмых суток, плата за хранение осуществляется по следующим тарифам:
| |
13 | Запрещено, начисляется сотрудником СДЭК | ПРОЧЕЕ | Дополнительный сбор от кредитного контроля СДЭК. | |
14 | Запрещено, начисляется автоматически | УДАЛЕННЫЙ РАЙОН | В случаях, когда забор или доставка груза курьером осуществляется из удаленного района города, взимается дополнительная плата. Установленный перечень удаленных районов Вы можете узнать по телефону единой справочной службы 8-800-250-04-05 (звонок бесплатный) или у менеджеров компании в офисе Вашего города. | |
15 | Запрещено, начисляется автоматически | ПОВТОРНАЯ ПОЕЗДКА | Когда требуется повторный вызов курьера по ранее аннулированному заказу либо доставка/забор не были осуществлены по вине клиента, начисляется дополнительный сбор. Размер сбора зависит от веса отправления и стоимости доставки по городу. | |
16 | Разрешено | ЗАБОР В ГОРОДЕ ОТПРАВИТЕЛЕ | Дополнительная услуга забора груза в городе отправителя, при условии, что тариф доставки с режимом «от склада» (не доступна для тарифов Посылка) | |
17 | Разрешено (Исключение - заказы до постамата) | ДОСТАВКА В ГОРОДЕ ПОЛУЧАТЕЛЕ | Дополнительная услуга доставки груза в городе получателя, при условии, что тариф доставки с режимом «до склада» (только для тарифов «Магистральный», «Магистральный супер-экспресс») | |
20 | Запрещено, начисляется сотрудником СДЭК | ПЕНЯ | Дополнительный сбор от кредитного контроля СДЭК. | |
23 | Запрещено, начисляется сотрудником СДЭК | ОБРЕШЕТКА ГРУЗА | Для большей сохранности Вашего Отправления компания СДЭК предлагает услуги по обрешетке груза. Стоимость обрешетки для каждого Отправления рассчитывается индивидуально. Т.е. это индивидуальная упаковка груза. | |
24 | Разрешено | УПАКОВКА 1 | Стоимость коробки размером 310*215*280мм — 30 руб. (для грузов до 10 кг). | |
25 | Доступно только в ЛК и при оформлении через Call-центр (Запрещено для заказов до постамата) | УПАКОВКА 2 | Стоимость коробки размером 430*310*280мм — 45 руб. (для грузов до 15 кг). | |
26 | Только при оформлении через Call-центр | АРЕНДА КУРЬЕРА | Когда необходимо доставить или принять документы в Федеральные службы, такие как: налоговые органы, министерства, посольства, суды, службы надзора и т.д., а также по заказам, требующим ожидания более часа, наша компания готова предоставить курьера. | |
27 | Доступно только в ЛК и при оформлении через Call-центр | СМС УВЕДОМЛЕНИЕ | Компания СДЭК предлагает каждому клиенту оформить услугу "смс-уведомление о доставке". Отправителю высылается сообщение с датой и временем доставки. Стоимость услуги 5 рублей. | |
30 | Разрешено (Исключение - заказы до постамата) | ПРИМЕРКА НА ДОМУ | Курьер доставляет покупателю несколько единиц товара (одежда, обувь и пр.) для примерки. | |
32 | Запрещено, начисляется автоматически в зависимости от условий договора | СКАН ДОКУМЕНТОВ | Для подтверждения факта доставки мы можем предоставить Вам скан документов с подписью получателя. Стоимость услуги 50 руб. | |
33 | Доступно только в ЛК и при оформлении через Call-центр | ПОДЪЕМ НА ЭТАЖ РУЧНОЙ | Услуга предоставляется при необходимости подъема на этаж крупногабаритных и тяжелых отправлений (весом от 10 кг). Разделяется на 2 вида: «Подъем на этаж ручной» и «Подъем на этаж лифтом». Стоимость услуги «Подъем на этаж ручной» (без лифта)
Стоимость услуги «Подъем на этаж лифтом»:
| |
34 | Доступно только в ЛК и при оформлении через Call-центр | ПОДЪЕМ НА ЭТАЖ ЛИФТОМ | ||
35 | Запрещено, начисляется автоматически | ПРОЗВОН | Услуга для ИМ "Прозвон" включает в себя предварительный прозвон получателей перед доставкой операторами call-центра. Стоимость услуги 15 руб. 1 заказ. | |
36 | Разрешено (Исключение - заказы до постамата) | ЧАСТИЧНАЯ ДОСТАВКА | Во время доставки товара покупатель может отказаться от одной или нескольких позиций, и выкупить только часть заказа Если в заказе указано одно вложение, услуга не подключается. | |
37 | Разрешено (Исключение - заказы до постамата) | ОСМОТР ВЛОЖЕНИЯ | Проверка покупателем содержимого заказа до его оплаты (вскрытие посылки). | |
40 | Запрещено, начисляется автоматически | ТЕПЛОВОЙ РЕЖИМ | Направления, по которым возможна доставка с тепловым режимом: Кемерово-Новокузнецк, Новосибирск-Красноярск, Новосибирск-Кемерово, Новосибирск-Томск, Новосибирск-Омск, Новосибирск-Барнаул, Барнаул-Горно-Алтайск И В ОБРАТНЫХ НАПРАВЛЕНИЯХ! | |
41 | Запрещено, начисляется автоматически | ВОЗВРАТ ДОКУМЕНТОВ | Служба доставки «СДЭК» предоставляет услугу обратной доставки сопроводительных документов с отметками получателя, а также возврат товаров для ИМ и других торговых предприятий. | |
42 | Запрещено, начисляется автоматически | АГЕНТСКОЕ ВОЗНАГРАЖДЕНИЕ | Наша компания оказывает услуги по приему денежных средств от клиента за товар и РКО | |
48 | Разрешено (Исключение - заказы до постамата) | РЕВЕРС | Обратный заказ на доставку от получателя до отправителя. Например, подписанные документы. |
* Стоимость услуг может быть не актуальной, поэтому рекомендуем смотреть актуальную информацию на сайте нашей компании.
Так же дополнительную информацию по услугам Вы можете узнать по телефону единой справочной службы 8-800-250-04-05 (звонок бесплатный) или у менеджеров компании в офисе Вашего города.
Приложение 3. Валюта
Код | Название | Страна получателя |
---|---|---|
RUB | Российский рубль | Россия |
USD | Доллар США | США |
EUR | Евро | Страны Европы |
KZT | Тенге | Казахстан |
GBP | Фунт стерлингов | Великобритания |
CNY | Юань | Китай |
BYN | Белорусский рубль | Белоруссия |
UAH | Гривна | Украина |
AMD | Армянский драм | Армения |
KGS | Киргизский сом | Киргизия |
TL | Турецкая лира | Турция |
THB | Тайский бат | Тайланд |
KRW | Южнокорейская вона | Южная Корея |
AED | Дирхам ОАЭ | ОАЭ |
UZS | Узбекский сум | Узбекистан |
MNT | Монгольский тугрик | Монголия |
Приложение 4. Ставки НДС
Идентификатор | Тип ставки НДС |
---|---|
VATX | БЕЗ НДС |
VAT0 | 0% |
VAT10 | 10% |
VAT20 | 20% |
Приложение 5. Статусы заказов*
Код | Статус | Комментарий |
---|---|---|
1 | Создан | Заказ зарегистрирован в базе данных СДЭК |
2 | Удален | Заказ отменен ИМ после регистрации в системе до прихода груза на склад СДЭК в городе-отправителе |
3 | Принят на склад отправителя | Оформлен приход на склад СДЭК в городе-отправителе. |
6 | Выдан на отправку в г. отправителе | Оформлен расход со склада СДЭК в городе-отправителе. Груз подготовлен к отправке (консолидирован с другими посылками) |
16 | Возвращен на склад отправителя | Повторно оформлен приход в городе-отправителе (не удалось передать перевозчику по какой-либо причине). Примечание: этот статус не означает возврат груза отправителю. |
7 | Сдан перевозчику в г. отправителе | Зарегистрирована отправка в городе-отправителе. Консолидированный груз передан на доставку (в аэропорт/загружен машину) |
21 | Отправлен в г. транзит | Зарегистрирована отправка в город-транзит. Проставлены дата и время отправления у перевозчика |
22 | Встречен в г. транзите | Зарегистрирована встреча в городе-транзите |
13 | Принят на склад транзита | Оформлен приход в городе-транзите |
17 | Возвращен на склад транзита | Повторно оформлен приход в городе-транзите (груз возвращен на склад). Примечание: этот статус не означает возврат груза отправителю. |
19 | Выдан на отправку в г. транзите | Оформлен расход в городе-транзите |
20 | Сдан перевозчику в г. транзите | Зарегистрирована отправка у перевозчика в городе-транзите |
27 | Отправлен в г. отправитель | Зарегистрирована отправка в город-отправитель, груз в пути. |
8 | Отправлен в г. получатель | Зарегистрирована отправка в город-получатель, груз в пути. |
28 | Встречен в г. отправителе | Зарегистрирована встреча груза в городе-отправителе |
9 | Встречен в г. получателе | Зарегистрирована встреча груза в городе-получателе |
10 | Принят на склад доставки | Оформлен приход на склад города-получателя, ожидает доставки до двери |
12 | Принят на склад до востребования | Оформлен приход на склад города-получателя. Доставка до склада, посылка ожидает забора клиентом - покупателем ИМ |
11 | Выдан на доставку | Добавлен в курьерскую карту, выдан курьеру на доставку |
18 | Возвращен на склад доставки | Оформлен повторный приход на склад в городе-получателе. Доставка не удалась по какой-либо причине, ожидается очередная попытка доставки. Примечание: этот статус не означает возврат груза отправителю. |
4 | Вручен | Успешно доставлен и вручен адресату (конечный статус). |
5 | Не вручен | Покупатель отказался от покупки, возврат в ИМ (конечный статус). |
* Данные статусы имеют как заказы прямого потока — доставка от отправителя к получателю, так и заказы обратного потока — доставка груза по не врученным заказам обратно отправителю.
Приложение 6. Дополнительные статусы заказов
Код | Доп. статус | Услуга доставки оказана (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 | Не вручен |
Приложение 7. Причины задержки доставки
*Пункты серого цвета - отключены
Код | Причины | |
---|---|---|
1 | Телефон неверный | |
2 | Тел. недоступен | |
3 | Не берут трубку | |
4 | Не успел | |
5 | Неисправность авто | |
6 | Неверный адрес | |
7 | Отказ от заявки | |
8 | Не знают что отправлять | |
9 | Груз не готов | |
10 | Отказ в получении | |
11 | Отказ от оплаты | |
12 | Контактное лицо в компании не работает | |
13 | Контактное лицо отсутствует | |
14 | Груз отправили через другую компанию | |
15 | Не дозвонился | |
16 | Частичная доставка | |
17 | Организация не работает | |
18 | Не могу найти адрес | |
19 | Смена адреса | |
20 | Требуется доп. информация для забора груза | |
21 | Отказ от получения/ от заявки | |
22 | Перенос даты | |
23 | Требуется пропуск/ограниченный доступ | |
24 | Нет паспорта/копии | |
25 | Нет купона | |
26 | Нужен чек | |
27 | Нет доверенности от получателя | |
28 | Нет доверенности от СДЭК | |
29 | Требуются документы | |
30 | Груз не вошел в авто | |
31 | Требуется курьер на авто/газель | |
32 | Отправитель требует расписаться в документах | |
33 | Очередь на выдачу груза | |
34 | Я жду звонка от оператора | |
35 | Не успеваю | |
36 | Самозабор | |
37 | Постомат переполнен | |
38 | Постомат не работает | |
39 | Груз не влез в ячейку постомата | |
40 | Отказ от получения | |
41 | Отказ от заявки | |
42 | Требуется пропуск | |
43 | Платный въезд | |
44 | Закрытая территория | |
45 | Нет документа удостоверяющего личность | |
46 | Смена города | |
47 | Адрес не существует | |
48 | Доставка в А/Я | |
49 | Опасный груз | |
52 | Отказ с адреса | |
53 | Изменение интервала по согласованию с клиентом | |
54 | Постаматное приложение не работает | |
55 | Груз не найден | |
56 | Передача на ПВЗ | |
57 | Не могу доставить на ПВЗ |
Приложение 8. Причины неудачных прозвонов
Код | Причины | |
---|---|---|
1 | Телефон занят | |
2 | Абонент не берет трубку | |
3 | Абонент недоступен | |
4 | Неверный номер | |
5 | Телефон не указан | |
6 | «Тишина» | |
7 | Сброс | |
8 | Бросил трубку |
Приложение 9. Возможные ошибки калькулятора
Код | Текст ошибки |
---|---|
0 | Внутренняя ошибка на сервере. Обратитесь к программистам компании СДЭК для исправления. |
1 | Указанная вами версия API не поддерживается |
2 | Ошибка авторизации |
3 | Невозможно осуществить доставку по этому направлению при заданных условиях |
4 | Ошибка при указании параметров места |
5 | Не задано ни одного места для отправления |
6 | Не задан тариф или список тарифов |
7 | Не задан город-отправитель |
8 | Не задан город-получатель |
9 | При авторизации не задана дата планируемой отправки |
10 | Ошибка задания режима доставки |
11 | Неправильно задан формат данных |
12 | Ошибка декодирования данных. Ожидается <json или jsop> |
13 | Почтовый индекс города-отправителя отсутствует в базе СДЭК |
14 | Невозможно однозначно идентифицировать город-отправитель по почтовому индексу |
15 | Почтовый индекс города-получателя отсутствует в базе СДЭК |
16 | Невозможно однозначно идентифицировать город-получатель по почтовому индексу |
Приложение 10. Формы собственности
Код | Форма собственности |
---|---|
9 | Акционерное общество |
61 | Закрытое акционерное общество |
63 | Индивидуальный предприниматель |
119 | Открытое акционерное общество |
137 | Общество с ограниченной ответственностью |
147 | Публичное акционерное общество |