459
правок
Изменения
API
,→Ограничения
<div style="font-size: 24px18px; color: #a92424; background-color: #ffdede; border: 1px solid #ebccd1; padding: 3px 10px 10px;">'''ВНИМАНИЕ! Изменения для 54-ФЗ!'''
Для передачи ставки НДС при оформлении заказа добавлен атрибут items -> item -> VATrate.
При использовании услуги кассового обслуживания необходимо в обязательном порядке передавать состав заказа со ставками НДС!.
'''ВНИМАНИЕ!'''
В ближайшем будущем, при подключенной услуге кассового обслуживания, система '''перестанет''' принимать заказы без состава вложений!.
</div>
<div style="font-size: 24px; color: #2424a9; background-color: #deffde; border: 1px solid #ebccd1; padding: 3px 10px 10px; text-align: center">
'''English version is [[API documentationDocumentation|HERE!]]'''
</div>
Если вы '''подрядчик''', вы можете забирать заказы, используя значение client=AGENT в запросе [[#Пример запроса статуса заказа|statusreq]], и передавать статусы заказов, используя метод [[#Изменение статуса агентом|setorderinfo]]. Также для интеграций с подрядчиками у Васнас есть специальная платформа, но добавлять подрядчиков в нее можно только на нашей стороне. Присылайте нам коммерческое предложение, описание вашего сервиса, и мы с радостью его рассмотрим. При написании этой документации мы предполагаем, что ее читатель обладает необходимой для понимания квалификацией программиста, владеет XML и средой разработки, в которой он делает интеграцию. Если вы не программист, вам необходимо привлечь к проекту профессионального программиста. Если у вас после прочтения данной документации остались вопросы, Вы можете задайте их задать по почте [mailto:support@courierexe.ru support@courierexe.ru]. Обязательно представьтесь, напишите Ваши ваши контактные данные (телефон, скайп) и название компании, с которой Вы вы хотите интегрироваться.
== Готовые интеграции ==
Для работы с популярными CMS и CRM-системами разработаны модули интеграции, перечисленные в таблице ниже.
'''Модули распространяются бесплатно, без гарантий со стороны разработчика''', и не являются средством полной автоматизации взаимодействия с курьерской службой. Модули — это помощь разработчикам интернет-магазинов в построении интеграции с курьерскими службами. '''Ответственность за корректность передачи данных лежит на интернет-магазине.'''
Модули сторонних разработчиков обслуживаются и разрабатываются сторонними компаниями. Все вопросы по их приобретению и поддержке необходимо задавать им.
{| class="wikitable" align="center" style="width: 80%; margin: auto; background-color: black#ffffff; borederborder: 1px solid #999999;" cellpadding="10" cellspacing="0"
!style="width: 35%;"|Система управления контентом (CMS)
!style="width: 15%;"|Ссылка
|-
|[[Файл:bitrix.png|center|x44px]]
|style="text-align: center;"|[httphttps://marketplace.1c-bitrix.ru/solutions/measoft.courier/ Установить] <!-- [httphttps://courierexe.ru/download/api/bitrixmeasoft.zip Скачать Unicode]<br>[http://courierexe.ru/download/api/bitrix_ansicourier.zip Скачать ANSI] -->|Поддерживает версии 1420.5 .0 и выше. Подробнее см. [[1C-Битрикс|описание]].
|-
|[[Файл:prestashop.png|center|x44pxx60px]]|style="text-align: center;"|[httphttps://courierexe.ru/download/api/prestashop.zip Скачать]|Поддерживает версии 1.5.2.0 и выше (2.x в том числе!)Подробнее см. [[PrestaShop|описание]].
|-
|[[Файл:OpencartOCStore.png|center|x44pxx60px]]|style="text-align: center;"|[httphttps://courierexe.ru/download/api/opencart.zip Скачатьдля версии 1.5.5.1]<br>[https://courierexe.ru/download/api/measoft_oc2.ocmod.zip Скачать для версии 2.0]<br>[httphttps://courierexe.ru/download/api/measoft_oc2.3.ocmod.zip Скачатьдля версии 2.3]<br><br>[httphttps://courierexe.ru/download/api/measoft_ос3measoft_oc3.ocmod.zip Скачатьдля версии 3.0]|Поддерживает версии с 1.5.5.1.<br>Версия 2.0.0 поддерживает Скачивайте модули для своей версии с 2OpenCart.0<br>Подробнее см. [[https://opencartforumOpenCart|описание]].com/files/file/2906-avtomatizaciya-otpravki-i-otslezhivanie-dostavok-courierexe-dlya-opencart-15x/ Альтернативный модуль сторонних разработчиков]
|-
|[[Файл:webasyst-shopscript.png|center|x44px]]
|style="text-align: center;"|[httphttps://www.webasyst.ru/store/plugin/shop/measoftcourier/ Установить модуль]<br>[https://www.webasyst.ru/store/plugin/shipping/measoftcourier/ Установить плагин]|Модуль предназначен для отправки заявок в КС, а плагин для расчета стоимости доставки при оформлении заказа. Инструкции есть в маркете, а также см. [[Webasyst|описание]].
|-
<!--|[[Файл:advantshop.png|center|x44px]]
|style="text-align: center;"|[https://promo-z.ru/ Сайт компании PROMO]
|Компания PROMO разработала этот модуль и настраивает интеграцию КС 2008 MeaSoft с ADVANTSHOP своим клиентам.|- -->|[[Файл:insales.png|center|x80px]]|style="text-align: center;"|Настраивается в [[Личный кабинет клиента|ЛК пользователя]]|[[InSales|Инструкция по настройке]]
|-
|[[Файл:insalesiiko.pngjpg|center|x44pxx80px]]|style="text-align: center;"|Настраивается в [[http://www.insales.ru/collection/all/product/kurierskaya-sluzhba-2008 УстановитьЛичный кабинет клиента|ЛК пользователя]]|[http://wiki.courierexe.ru/index.php?title=Интеграция_с_другими_системами#Insales Настраивается[Iiko|Инструкция по настройке]] в ЛК пользователя в системе
|-
|[[Файл:Leadvertex.png|center|x44px]]
|style="text-align: center;"|[[Файл:Leadvertex-howto.png|center|x44px]]|[httphttps://blog.leadvertex.ru/news/2110-integraciya-s-kurerkami-na-platforme-measoft/ Настраивается] в ЛК пользователя в системе [https://Leadvertex.ru Leadvertex]|[[LeadVertex|Инструкция по настройке]]<br>Модуль разработан и поддерживается компанией LeadVertex.
|-
|[[Файл:Retailcrm.png|center|x44pxx30px]]
|style="text-align: center;"|[https://www.retailcrm.ru/ RetailCRM]
|[http://wiki.courierexe.ru/index.php?title=Интеграция_с_другими_системами#[RetailCRM |Настраивается]] в ЛК пользователя в системе
|-
|[[Файл:1C.jpg|center|x44px]]
|style="text-align: center;"|-
|[https://infostart.ru/public/692790/ Альтернативный модуль сторонних разработчиков(1 версия)] [https://infostart.ru/public/1531484/ Альтернативный модуль сторонних разработчиков (2 версия)]
|-
|[[Файл:Joomla2.jpg|center|x44pxx60px]]|style="text-align: center;"|[httphttps://courierexe.ru/download/api/com_measoft.zip Скачать]|Работает только с компонентом Virtuemart. Внимание! Модуль новый, поэтому возможна некорректная передача данных. Проверяйте, если что - сообщайте, исправим!Инструкция в архиве
|-
|[[Файл:Amocrm.png|center|x44px]]
|style="text-align: center;"|[https://www.amocrm.ru/extensions/courier2008 Установитьmeasoft Описание на сайте amoCRM]|Внимание! Модуль новый, поэтому возможна некорректная передача данныхПодробное описание настроек читайте [[amoCRM|тут]]. Проверяйте, если что - сообщайте, исправим!
|-
|rowspan="2"|[[Файл:MoySclad.jpg|center|x44pxx30px]]|style="height:50px; text-align: center;"||[[МойСклад|Инструкция]]|-|style="height:50px; text-align: center;"|[https://home.courierexeitmdev.ru/moyskladms/shipping/step1 ПодключениеСкачать модуль сторонних разработчиков] [[|Интеграция МойСклад с другими системами#Мой Склад|Инструкция]]|курьерскими службами от сторонних разработчиков
|-
|[[Файл:wordpress.jpg|center|x80px]]
|style="text-align: center;"|[httphttps://courierexe.ru/download/apiwordpress/wordpress.zip php Скачать] |[[Интеграция с другими системами#Wordpress|Инструкция]]|Внимание! Модуль новый, поэтому возможна некорректная передача данных-|[[Файл:Cscart.png|center|x60px]]|style="text-align: center;"|[https://marketplace.cs-cart.com/measoft-en.html Установить]|Поддерживает версии 4.10 и выше.<br>[[CS-Cart|Инструкция]]|-|[[Файл:webhooks.jpg|center|x100px]]|style="text-align: center;"|Читайте описание [[Webhook|на этой странице]]|Передача информации о статусах и заказах в вашу систему|-|[[Файл:Logo_tilda_black. Проверяйте, если что png|center|x100px]]|style="text- сообщайте, исправим!align: center;"|Читайте описание [[Tilda|на этой странице]]|Работает только на платных тарифах
|-
|}
'''Обратите внимание!''' В модулях систем PrestaShop и Joomla для отправки заказа в курьерскую службу зайдите в карточку заказа. В карточке отображается специальная форма отправки заказа, а если заказ отправлен, она позволяет проверить его статус:[[Файл:Form.png|150 400 px|мини|Форма отправки заказа|none]] Для отображения списка пунктов выдачи есть [https://home.courierexe.ru/js/measoft_map.js JavaScript модуль]. Инструкция по использованию — внутри. Посмотреть пример работы можно [https://home.courierexe.ru/pvz_test.html здесь].
На вкладке '''Интеграция''' > '''Отладка''' вы можете пробовать выполнять запросы к API для отладки, а также видеть историю отправленных запросов. Созданные заказы появятся в пункте основного меню '''Отслеживание'''.
Для отображения списка пунктов выдачи есть '''готовый JavaScript модуль''': упрощения интеграции можно скачать [https://home.courierexe.ru/jsdownload/api/measoft_map.js Инструкция по использованию - внутриphp_sample. Посмотреть zip пример работы можно [https://homeобращения к сервису на PHP].courierexe.ru/pvz_test.html Здесь]
<source lang=xml><auth extra= Тестовый аккаунт "8" login="login" pass="pass"></auth></source>
== Рабочий аккаунт для подключения Авторизация курьерской службы ==Если курьерской службе требуется подключение под своими учетным данными, используйте строку вида:
Вы можете узнать код экстра, логин и пароль курьерской службы в офисном приложении MeaSoft в справочнике '''Дополнительные возможности'''. Подробнее см. раздел «[[Файл:extra1.pngЛичный кабинет курьерской службы#Подключение|750pxПодключение]]».
Наше API принципиально работает только по HTTPS, т.к. так как передает конфиденциальные данные. В некоторых системах с этим возникают проблемы. Если ваша система не может полноценно работать с шифрованием, мы рекомендуем развернуть http-сервер у себя локально, установить [http://courierexe.ru/download/api/proxy.zip прокси на PHP]. <spoiler text="Как запустить">Для теста можете запустить его на сервере следующей командой: php -S <IP>:8080 proxy.phpгде <IP> - — это адрес вашего сервера, а 8080 порт, на котором будут приниматься запросы.
Тогда для обмена данными с нашим АПИ необходимо будет использовать адрес <IP>:8080</spoiler>
Доступность функций, описанных в этом разделе, зависит от [[Личный кабинет курьерской службы#Функции личного кабинета|тарифа вашего личного кабинета]].
== Ограничения ==
С целью защиты от не целевого нецелевого использования сервисов, а так же от и DDoS-атак, действуют следующие ограничения:* 30 запросов tracking с одного IP-адреса за 1 минуту (используйте statusreq!);*150 запросов с одного IP-адреса /акаунта за 1 минуту;*1500 запросов с одного IP-адреса /акаунта за 20 минут;*3000 запросов с одного аккаунта за 1 час;*200 Мб скачанных текстовых данных за 3 часа.* Превышение количества запросов статусов несуществующих заказов над существующими
В случае превышения блокируется IP-адрес или аккаунт блокируется на время до 3-х часов.
Чтобы не происходило блокировок:
* Не не нужно "бомбить" «бомбить» наше API запросами статусов , последовательно перебирая номера всех ваших заказов, особенно - запросами "tracking"«tracking», они предназначены не для этого (смотрите описание). Особенно ровно в 0 00 минут каждого часа.;* Не не нужно каждые 5 минут делать запросы "Покажите «Покажите статусы всех заказов за последние 3 месяца".месяца»;* Для для проверки статусов заказов лучше всего использовать запросы [[#Передача только изменившихся статусов|измененных статусов changes=ONLY_LAST]].;* При при запросе измененных статусов ОБЯЗАТЕЛЬНО нужно подтверждать успешное получение запросом [[#Передача только изменившихся статусов|commitlaststatus]].* вы должны знать номера заказов, которые вы отправили. Не нужно перебирать номера всех заказов или брутфорсом перебирать все возможные номера.* нужно проверять с каким ответом возвращаются ваши АПИ-запросы. Если мы отвечаем ошибкой, то даже запрос на создание нового заказа учитывается в количестве запросов.
Точного регламента по времени ответа на запросы нет. Запросы имеют разное время выполнения, которое может отличаться:- Запросы режимов срочности или улиц отдаются за десятые доли секунды;- Запросы статусов или ПВЗ могут отдаваться до нескольких секунд;- Запрос оформления заказов может выполняться до нескольких минут. Все зависит от параметров запроса и загруженности сервера. Мы абсолютно уверены, что данные ограничения на порядки превосходят необходимые объемы предоставления сервиса для решения любых задач. Если у вас возникают проблемы, вы не знаете, как уложиться в эти рамки - рамки — спросите у нас, мы обязательно поможем!
== Оформление заказа ==
=== Пример оформления заказа ===
<source lang=xml>
<?xml version="1.0" encoding="UTF-8"?>
<time_min>09:00</time_min>
<time_max>14:00</time_max>
<deliveryPIN>1234</deliveryPIN>
<coords lat="55.680327" lon="37.604456"></coords>
</receiver>
<returnprice>NO387.5</returnprice> <weightinshprice>387.5.1</weightinshprice> <deliveryprice VATrate="20">150</deliveryprice> <discount>120</discount> <paytype>CASH</paytype> <return_weightweight>5.1</return_weightweight>
<quantity>2</quantity>
<service>2</service>
<type>3</type>
<return>NO</return>
<return_service>1</return_service>
<return_type>3</return_type>
<return_weight>5.1</return_weight>
<courier>22</courier>
<receiverpays>NO</receiverpays>
<enclosure>Детские игрушки</enclosure>
<instruction>Проверить при покупателе, подписать акт</instruction>
<acceptpartially>NO</acceptpartially>
<costcode>cc12345</costcode>
<respstore>4</respstore>
<uid>af11c7c6-6645-4a20-9604-be911a75722d</uid>
<items>
<item extcode="abc123" quantity="1" mass="0.2" retprice="37.5" VATrate="0" barcode="2345625213125" textArticle="1" article="1" volume="3" origincountry="AUT" GTD="321546654" excise="15.20" suppcompany="ООО "Рога и копыта"" suppphone="79161234567" suppINN="1112223334" govType="2" governmentCode="11223311" extraTags="">Мяч</item>
<item extcode="abc124" quantity="2" mass="2" retprice="100" inshprice="100" VATrate="10" barcode="4645625213138" article="2" length="10" width="20" height="30" origincountry="004">Обруч</item>
<item extcode="abc125" quantity="3" mass="0.3" retprice="50" inshprice="50" barcode="2345625213126" itemcode="44123" article="3" type="1">Погремушка желтая</item>
</items>
<packages>
<package strbarcode="ORD0000001" mass="1" message="" quantity="3"></package>
<package strbarcode="ORD0000002" mass="2.5" message="" length="10" width="20" height="30"></package>
</packages>
<deliveryset above_price="100" return_price="1000" VATrate="10">
<below below_sum="500" price="500" />
<below below_sum="2000" price="300" />
</advprice>
</advprices>
<extrafields>
<extrafield>
<name>courier_car</name>
<value>ВАЗ 2106, бежевый</value>
</extrafield>
</extrafields>
<overall_volume>81</overall_volume>
<userid>user123</userid>
<groupid>customer</groupid>
</order>
</neworder>
=== Описание элементов для оформления заказа ===
'''Обязательные поля'''
Обязательными на уровне системы являются только 3 поля: receiver->company или receiver->person, receiver->address и receiver->phone. Так же в настройках системы сама курьерская служба может назначить какие-то дополнительные поля обязательными, тогда, если вы их не укажете, получите сообщение об ошибке.<spoiler text="Пример минимально возможного заказа"><source lang="xml"><?xml version="1.0" encoding="UTF-8"?><neworder> <auth extra="8" login="login" pass="pass" /> <order> <receiver> <company>МВД</company> <phone>(495)123-45-67</phone> <address>Петровка, 38</address> </receiver> </order></neworder></source></spoiler> '''Описание полей''' *'''neworder''' - — Корневой контейнер, обязательный элемент. :* '''''newfolder''''' — Признак нового заказа YES/NO. Если стоит YES, то в системе курьерской службы для данной корреспонденции создастся новый заказ. Необязательный элемент.
:*'''order''orderno' - Контейнер для описания одного '''' — Номер заказа. Если присваивается клиентом — указывается здесь. Если не присваивается — можно оставить пустым, обязательный элементсистема сгенерирует свой номер, и вернет его в ответе. В одном контейнере Система проверяет '''у клиента''neworder'наличие заказов с указанным номером в '' может быть много контейнеров 'пределах текущего календарного года''order', которые '' 'не являются недоставленными''', и в случае их существования — заказ создан не будет, а в ответе вернется ошибка 17 «Such number exists».Если не указан штрихкод (поле barcode), и значение поля подходит для создания нескольких заказов одним запросомиспользования его в качестве штрихкода, данное значение будет скопировано в поле «Штрихкод». Это накладывает ограничения в частности, на длину указанного поля (25 знаков, чтобы работали стандартные печатные формы).
# Если шифр и ШК пустые - оба поля заполняются автоматически значением вида XXX#YYY, а после ШК проверяется на корректность (валидируется)# Если ШК пустой, а шифр заполнен - ШК заполняется значением из шифра и валидируется# Если шифр пустой, а ШК заполнен - шифр заполняется значением из ШК, после чего ШК валидируется# Если оба непустые - валидируется ШК, шифр не проверяется Корректный (валидный) ШК отвечает следующим требованиям:* длина не меньше 5 символов* значение не меньше значения переменной <mparam code="MinPrePrintedNum"/>* содержит символы, которые можно использовать для формирования штрих-код а формате Code128 (т.е.все печатные символы, кроме кириллицы) Если ШК не прошел проверку, то:* если переменная <mparam code="StoreInvLength"/> равна 0, ШК заполняются автоматически значением вида XXX#YYY (или приравнивается шифру в том же формате)* если переменная <mparam code="StoreInvLength"/> больше 0, ШК заполняются автоматически сквозным номером (если шифр в формате XXX#YYY, то шифр приравнивается ШК)</spoiler> В случае наличия нескольких мест и раздельной их маркировки в этом поле допустимы маски в виде символов подчеркивания, говорящие о позициях штрихкода, переменных для разных мест в рамках одного заказа.<br>''Например'': В заказе номер 123 имеется 20 товарных вложений, которые упакованы в 3 транспортных места. Клиент формирует 3 штрихкода на транспортные места: CLNT0012301, CLNT0012302, CLNT0012303, где CLNT — префикс клиента, 00123 — номер заказа, 01-03 — номер транспортного места в заказе. В поле barcode нужно указать CLNT00123__ (система поймет, что 2 последних символа могут быть любыми и будут отражать штрихкоды к одному заказу). Если вы не сами печатаете накладные с указанным штрихкодом, то указанный штрихкод не должен быть длиннее 25 знаков, иначе он не поместится на стандартных печатных формах. *'''sender''' - — Информация о отправителе заказа. Необязательный контейнер.<source lang="xml"> <sender>
<company>Название компании отправителя</company>
<person>Контактное лицо отправителя</person>
</source>
*'''receiver''' - — Информация о получателе заказа. Обязательный контейнер.
<source lang="xml">
<receiver>
<time_min>Желаемое время доставки в формате "HH:MM"</time_min>
<time_max>Желаемое время доставки в формате "HH:MM"</time_max>
<deliveryPIN>Пин-код для подтверждения получателем</deliveryPIN>
<coords lat="55.680327" lon="37.604456"></coords>
</receiver>
</source>
*'''company''' - — Компания-получатель.*'''person''' - — Контактное лицо. ''Должно быть заполнено хотя бы одно из полей - полей — company или person!''*'''phone''' - — Телефон. Можно указывать несколько телефонов, E-mail в этом поле.*'''town''' - — Город.* '''pvz''' — Код пункта самовывоза по справочнику. Кроме того, ПВЗ можно указать в строке '''''address''''' в виде::* код ПВЗ в нашей системе:* код ПВЗ в системе подрядчика:* наименование ПВЗ в виде строки "ПВЗ " + «Наименование ПВЗ». При указании ПВЗ в поле адреса необходимо проверять значение поля город получателя (он должен соответствовать данным ПВЗ) либо не передавать его вообще.
Для тега города '''town''' можно указать код региона в атрибуте '''''regioncode''''' из [[#Справочник регионов|справочника регионов]]. Поиск будет производиться в указанном регионе.
Также можно указать страну получателя в атрибуте '''''country''''' в соответствии с [https://ru.wikipedia.org/wiki/ISO_3166-1 стандартом ISO_3166-1], например, "RU"«RU», "RUS" «RUS» или "643" «643» для России.
Кроме того, поиск города осуществляется с учетом почтового индекса, указанного в теге '''zipcode'''.
:* код населенного пункта из [[#Справочник городов|справочника городов]]
:* 13-ти значный код адресного классификатора КЛАДР
:* 36-ти значный код адресной системы <rspoiler text="ФИАС">Федеральная информационная адресная система — система — единый российский государственный адресный реестр</rspoiler> (AOID)
:* название города (не рекомендуется!)
*'''coords''' - — Координаты получателя. Если не указаны, система будет геокодировать самостоятельно.
* '''zipcode''' — Почтовый индекс.* '''price''' — Сумма заказа (наложенный платеж) - денежные средства, которые курьер должен забрать у получателя в пользу заказчика. В случае наличия контейнера items значение этого параметра будет проигнорировано и рассчитано автоматически.* '''inshprice''' — Объявленная ценность. Если явно не указана сумма — автоматически считается как сумма по товарам.* '''deliveryprice''' — Стоимость доставки, которая устанавливается заказчиком и будет взиматься с получателя в пользу заказчика. Не имеет отношения к стоимости доставки самой курьерской службы, которая рассчитывается в соответствии с тарифамии, не указывается при оформлении заказа и добавляется в заказ автоматически при его обработке курьерской службой. В случае наличия контейнера items в него будет добавлено вложение «Доставка».:* '''''VATrate''''' — Ставка НДС — целое число процентов.* '''discount''' — Сумма скидки. Скидка «размазывается» по товарным вложениям, сумма НП уменьшается на сумму скидки. При этом вложение Скидка не создается. ВНИМАНИЕ, при использовании этого тега общая сумма может расходиться на копейки из-за округления! Старайтесь не использовать этот тег, а указывать цену товаров уже с учетом скидок.*'''paytype''' - — Тип оплаты заказа получателем. Принимает значения::* CASH - CASH — Наличными при получении (по-умолчанию):* CARD - CARD — Картой при получении:* NO - NO — Без оплаты. Этот тип оплаты передается, если заказ уже оплачен и не требует инкассации. API добавит к товарам строку предоплаты в сумму заказа, чтобы общая сумма была 0, однако в кассовом чеке будут все товары с ценами, и оплата предоплатой, как того требует 54-ФЗ.:* OTHER - OTHER — Прочее (Предусмотрен для того, чтобы оплата поступала непосредственно в курьерскую службу посредством прочих типов оплаты - оплаты — таких как: вебмани, яденьги, картой на сайте, прочие платежные системы и ти т.д д.):* OPTION - OPTION — На выбор получателя. Этот тип оплаты нельзя передавать с заказом. Он выставляется автоматически в зависимости от настройки клиента.* '''weight''' — Общий вес заказа в килограммах.* '''quantity''' — Количество мест.* '''service''' — Режим доставки (тип услуги) передается код из справочника «[[#Справочник Виды срочности|Виды срочности]]».* '''type''' — Тип корреспонденции (отправления) передается код из справочника «Типы корреспонденции».* '''return''' — Признак необходимости возврата. Принимает значения::* NO — Возврат не требуется:* YES — Требуется возврат, например, документов:* ONLY — Требуется забрать отправление у поставщика (см. раздел «[[Личный_кабинет_клиента#Привезти ко мне|Привезти ко мне]]»). * '''return_service''' — Режим возврата (тип услуги) передается код из справочника «Виды срочности».* '''return_type''' — Тип возвратной корреспонденции (отправления) передается код из справочника «Типы корреспонденции».* '''return_weight''' — Общий вес возврата заказа в килограммах.* '''enclosure''' — Вложение.* '''instruction''' — Поручение — Примечание.* '''courier''' — Запланированный курьер. Согласно коду курьера в КС2008.* '''receiverpays''' — Признак оплаты стоимости доставки — услуг службы доставки получателем, а не заказчиком YES/NO.* '''department''' — Подразделение, в котором оформляется заказ.* '''costcode''' — Кост-код сотрудника.* '''respstore''' — Код ответственного филиала. Для ответственного филиала в который передается заказ, требуется включение параметра "Разрешить клиенту передавать заказы в этот филиал"* '''pickup''' — Признак оформления забора YES/NO. Если стоит YES, то весь заказ считается заданием на забор груза, а не на доставку! Применяется для вызова курьера к отправителю для забора других отправлений. ''Внимание!'' при добавлении в забор складских товаров, их тип '''''type''''' всегда должен быть установлен как [7] Забор товара, если будет указан другой тип, то он будет исправлен в момент добавления заказа на [7] Забор товара* '''acceptpartially''' — Признак возможности частичного выкупа товаров отправления YES/NO.* '''uid''' - Универсальный идентификатор заказа на стороне отправителя. Не обязательный параметр, ограниченного по времени действия. Время хранения в системе, - сутки.
*'''zipcodeitems''' — Контейнер для описания вложений. <rspoiler text="Необязательный контейнер">Если для поставщика товара в системе MeaSoft не указаны полное наименование компании и ИНН в карточке клиента, заполните параметры <code>suppcompany</code> и <code>suppINN</code> в этом контейнере. Отсутствие информации о поставщике приведет к [[Настройка модуля печати кассовых чеков#Ошибка фискализации (ошибка программирования реквизита 1226)|ошибке фискализации]].</rspoiler>. Атрибуты::* '''''item''''' - Почтовый индекс — Название вложения.:* '''''quantity''''' — Количество единиц товара.:*'''weight''mass' - Общий вес заказа '''' — Масса единицы товара в килограммах.:*'''return_weight''volume''' - Общий '' — Объемный вес возврата заказа единицы товара в килограммах.При указании объемного веса значение подставляется вместо массы:*'''quantity''length''''' - Количество мест — Длина единицы товара (в сантиметрах).:*'''service''width' - Режим доставки '''' — Ширина единицы товара (тип услугив сантиметрах) передается код из справочника [[#Справочник Видов срочности|"Виды срочности"]].:*'''return_service''height''''' - Режим возврата — Высота единицы товара (тип услугив сантиметрах) передается код из справочника "Виды срочности".:*'''type''retprice''''' — Цена единицы товара. Округляется до копеек. Должна быть с учетом всех скидок и наценок. Для вложений типов 1, 2, 3 не может быть отрицательной. <!-- Тип корреспонденции (отправления) передается код из справочника "Типы корреспонденции", либо мы сами посчитаем скидку при указании тега order->discount -->:* '''''inshprice''''' — Объявленная ценность единицы товара. Округляется до копеек. Если не указана принимается равной '''''retprice'''''.:*'''return_type''VATrate''''' - Тип возвратной корреспонденции — Ставка НДС — целое число процентов. Если товар хранится в КС (отправлениясмотрите '''article''' ниже) передается код , значение берется из номенклатуры. Иначе, если значение указано, берется указанное значение, если нет - значение из справочника "Типы корреспонденции"настроек фирмы КС. Значение «0» означает ставку «Без НДС», ставка «0%» на данный момент не поддерживается.:*'''price''barcode' - Сумма заказа. В случае наличия контейнера items значение данного параметра будет проигнорировано, и рассчитано автоматически'''' — Штрихкод вложения.:*'''deliveryprice''article''''' — Артикул вложения. ''Внимание!' - Сумма ' Указание артикула используется только тогда, когда товар хранится на ответственном хранении в службе доставки, и необходима комплектация. В этом случае наличия контейнера itemsсистема пытается привязать товар к [[API#Справочник номенклатуры|справочнику номенклатуры]]. Если товар в справочнике не найден — система выдаст соответствующую ошибку. Если по артикулу найдено несколько товаров — система выберет один из них случайным образом, что может привести к ошибочной комплектации! Если товар НЕ на ответственном хранении — артикул указывать НЕ нужно. Позиция попадет в него будет добавлено вложение "Доставка"систему просто текстом.:*'''return''itemcode'' - Признак необходимости возврата.*'''return_service — Внутренний код товара, может использоваться вместо артикула. ''Внимание!' - Режим возврата (тип услуги) передается ' Указание кода товара используется только тогда, когда товар хранится на ответственном хранении в службе доставки, и необходима комплектация. В этом случае система пытается привязать товар к [[API#Справочник номенклатуры|справочнику номенклатуры]]. Если товар в справочнике не найден — система выдаст соответствующую ошибку. Если товар НЕ на ответственном хранении — код из справочника "Виды срочности"товара указывать НЕ нужно.:*'''discount''type''''' — Тип вложения. Принимает значения::: 1 — Товар. По-умолчанию.:: 2 — Доставка. Такое вложение добавится автоматически, если заполнить order- Сумма скидки>deliveryprice:: 3 — Услуга:: 4 — Предоплата. Указывается сумма. Скидка "размазывается" по товарным вложениямПоле quantity игнорируется, всегда «1». В заказе сумма НП уменьшается на сумму скидкибудет отрицательной независимо от знака в запросе. При этом Такое вложение Скидка не создаетсядобавится автоматически при указании order->paytype=NO.:: 6 — Оплата кредитом. Указывается сумма. ВНИМАНИЕПоле quantity игнорируется, при использовании этого тега общая всегда «1». В заказе сумма может расходиться на копейки будет отрицательной независимо от знака в запросе.:: 7 — Забор товара. Если товар нужно у получателя забрать, возможно — вернуть деньги, или его стоимость вычтется из-за округления! Старайтесь не использовать этот тегсуммы других товаров. У такого товара в заказе будет отрицательное количество независимо от знака в запросе.:: 9 — Код подтверждения. Используется для вложения, а указывать цену товаров уже с учетом скидокв котором сохраняется регулярное выражение для проверки кодов вложений. См.'''''extraTags''''':*'''enclosure''extcode' - Вложение'''' — Внешний код строки. Используется для идентификации строк заказов при получении статусов. Необязательное поле.:*'''inshprice''origincountry''''' — Код страны- Объявленная ценностьпроизводителя в соответствии со [https://ru.wikipedia. Если явно не указана сумма org/wiki/ISO_3166-1 стандартом ISO_3166- автоматически считается как сумма по товарам1], например, «RU», «RUS» или «643» для России.:*'''instruction''GTD' - Поручение - Примечание'''' — Номер ГТД.:*'''courier''excise''''' - Запланированный курьер — Сумма акциза. Согласно коду курьера в КС2008:* '''''suppcompany''''' — Наименование компании поставщика, если отличается от заказчика.:*'''receiverpays''suppphone' - Признак оплаты стоимости доставки - услуг службы доставки получателем'''' — Номер телефона компании поставщика, а не заказчиком YES/NOесли отличается от заказчика.:*'''department''suppINN''''' - Подразделение — ИНН компании поставщика, в котором оформляется заказесли отличается от заказчика.:*'''pickup''governmentCode''' '' — Код товарной номенклатуры. Используется для [[Маркировка|маркированных товаров, например («Честный знак»)]]. Для кода '''Честный знак''' Нужно указывать все данные из нанесенного QR- Признак оформления забора YES/NOкода кроме не читаемых символов (#29). Если стоит YESкод не известен — укажите знак вопроса «?», то весь заказ тогда курьер отсканирует код фактически передаваемого покупателю товара. Для некоторых процессов может использоваться значение «!» — в этом случае курьер сканирует серийный номер товара, но это не считается заданием на забор грузакодом маркировки. При этом, а не на доставкуесли указано значение «?» или «! Применяется для вызова курьера к отправителю для забора других отправлений» и quantity больше 1, то такое вложение растиражируется quantity раз.:*'''acceptpartially''govType' '''' — Тип маркировки товара. В данный момент существуют следующие типы маркировки::: 1 — Честный знак. По- Признак возможности частичного выкупа товаров отправления YES/NOумолчанию.:: 2 — ГИИС ДМДК.:: 3 — Серийный номер.:* '''''message''''' — Строка сообщения.:* '''''extraTags''''' — Строка в формате JSON для различных целей.
:: Маска валидации - регулярное выражение для проверки кодов вложений курьером. Указывается во вложении с типом 9 (см. атрибут вложения '''''type''''')
<source lang="json">"item_industry_props":{"tag1262":"020","tag1263":"14.12.2018","tag1264":"1556","tag1265":"tm=mdlp&sid= Примеры ответов ===00000000XXXXXX"},"tag1212": "1"При успешном выполнении запроса, создании заказа, возвращается ошибка 0. При не успешном "ValidationMask": "(A-Z0- номер ошибки и текст ее на английском языке в атрибуте errormsg9){6, для некоторых ошибок выводится перевод на русский в атрибуте errormsgru.8}"</source>
Для клиентов из '''Узбекистана''' необходимо указывать код ИКПУ и код упаковки в следующем формате:<source lang="xmljson"><?xml version="1.0ikpu" encoding=:"UTF-8123123123"?><neworder> <createorder orderno=,"AB23541packageCode" error=:"0123456" errormsg="success"></createorder> <createorder orderno="55_6542" error="0" errormsg="success"></createorder> <createorder orderno="AB23542" error="0" errormsg="success"></createorder></neworder>
</source>
* '''Пример ответа при ошибке авторизацииpackages''' — Контейнер для описания мест. Необязательный контейнер. Атрибуты::* '''''package''''' — Название места.:* '''''code''''' — Внутренний код строки.:* '''''strbarcode''''' — Штрихкод места.:* '''''mass''''' — Масса места в килограммах.:* '''''message''''' — Строка сообщения.:* '''''length''''' — Длина товарного места (в сантиметрах).:* '''''width''''' — Ширина товарного места (в сантиметрах).:* '''''height''''' — Высота товарного места (в сантиметрах).:* '''''quantity''''' — Количество мест с данным набором параметров. Действует ограничение на общее количество мест в заказе. Общее количество мест в заказе не может быть больше 1000. * '''deliveryset''' — настройка [[Дифференцированная стоимость доставки|дифференцированной стоимости доставки]]. Атрибуты::* '''''above_price''''' — стоимость в случае полного выкупа заказа (действует как «сумма от» последней границы, указанной в теге below_sum):* '''''return_price''''' — стоимость в случае возврата заказа:* '''''VATrate''''' — Ставка НДС — целое число процентов. * '''below''' — граница стоимости настроек:* '''''below_sum''''' — граница стоимости выкупаемого заказа:* '''''price''''' — стоимость выкупаемого заказа до соответствующей границы * '''advprices''' — Контейнер для описания дополнительных услуг. Необязательный элемент. <span style="color: red;>Для обработки в API включите дополнительные услуги в настройках полей [[Личный кабинет курьерской службы#Настройка личного кабинета клиента|заказов и заборов]]</span>:* '''''code''''' — код услуги.:* '''''value''''' — значение услуги. Если тип услуги bool, то в значении передаем true.
'''Пример успешного ответа при ошибке синтаксиса'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<requestneworder> <createorder orderno="AB23541" barcode="67567#114" error="0" errormsg="Success" errormsgru="Успешно" orderprice="5000" />column:1 line:11 message:expected ' <createorder orderno="AB23542" barcode="67567#115" error="0" errormsg="Success" errormsgru="Успешно" orderprice="6000" />' <createorder orderno="AB23543" barcode="67567#116" error="0" errormsg="Success" errormsgru="Успешно" orderprice="0" /error></requestneworder>
</source>
<source lang="xml">
<?xml version="1.0" encoding="UTF-8" ?><statusreqneworder> <auth extracreateorder orderno="AB23541" barcode="67567#114" error="867" loginerrormsg="loginOrder barcode already exists in the database." passerrormsgru="passТакой штрихкод заказа уже есть в базе."></auth> <client>CLIENT <createorder orderno="AB23542" barcode="67567#115" error="17" errormsg="Order number already exists in the database." errormsgru="Такой номер заказа уже есть в базе." /client> <createorder orderno>1234</orderno> <orderno2>5678</orderno2> <ordercode>34234</ordercode> <givencode>234534</givencode> <datefrom>2016-07-21</datefrom> <dateto>2016-07-21</dateto> <target>Автозавод</target> <done>ONLY_NOT_DONE</done> <changes>ONLY_LAST<="AB23543" barcode="67567#116" error="67" errormsg="Order barcode already exists in the database." errormsgru="Такой штрихкод заказа уже есть в базе." /changes></statusreqneworder>
</source>
<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<request>
<error>column:1 line:11 message:expected '>'</error>
</request>
</source>
== Запрос статуса заказов ==
=== Пример запроса статуса заказа ===
<source lang="xml">
<?xml version="1.0" encoding="utfUTF-8"?><statusreq count> <auth extra="8" login="login" pass="0pass"></auth> <client>CLIENT</client> <orderno>1234</orderno> <orderno2>5678</orderno2> <ordercode>34234</ordercode> <givencode>234534</givencode> <uid>af11c7c6-6645-4a20-9604-be911a75722d</uid> <datefrom>2016-07-21</datefrom> <dateto>2016-07-21</dateto> <target>Автозавод</target> <done>ONLY_NOT_DONE</done> <changes>ONLY_LAST</changes> <conditions> <namecontains/> <namestarts/> </conditions> <limit>500</limit></statusreq>
</source>
=== Описание полей запроса статуса ==='''Пример ответа statusreq''' — Корневой контейнер. Обязательный элемент.* '''auth''' — Авторизация. Обязательный элемент.* '''client''' — Признак клиента или агента. Необязательный элемент.:* CLIENT — Признак клиента, значение по умолчанию:* AGENT — Признак агента. В ответ отдается информация по заказам, переданным агенту на доставку* '''orderno''' — Идентификатор заказа у клиента (шифр). Необязательный элемент.* '''ordercode''' — Внутренний код заказа. Необязательный элемент.* '''orderno2''' — Номер заказа из срочных. Необязательный элемент. * '''uid''' — Уникальный идентификатор, если он был добавлен при ошибке авторизациисоздании заказа. Необязательный элемент. Запрос информации по uid возможен в течении суток после создания заказа* '''datefrom''' — Дата заказа «с». Необязательный элемент.* '''dateto''' — Дата заказа «по». Необязательный элемент.* '''target''' — Строка поиска. Позволяет указать текст, который содержится в названии компании или адресе получателя.* '''done''' — Может принимать значения::* ONLY_DONE — Только доставленные (имеются в виду успешные статусы, например, '''Доставлен''' или '''Частично доставлен'''):* ONLY_NOT_DONE — Только не доставленные (заказы, которые не являются доставленными, например, '''Не доставлен''' или '''Утерян'''):* ONLY_NEW — Только новые:* ONLY_DELIVERY — Только заказы в обработке — заказы, находящиеся в любом статусе, кроме конечных: Доставлено, Не доставлено, Отменён и т. д.:* ''Пусто'' — все корреспонденции * '''changes''' — может принимать значение только ONLY_LAST. Если указан этот параметр, все остальные игнорируются. Описание данного режима приведено здесь: [[#Передача только изменившихся статусов|Передача только изменившихся статусов]] * '''conditions''' — Задает условия фильтрации по «orderno». Все вложенные элементы одновременно накладывают условие «И». Минимум 5 символов!:* '''namecontains''' — Поиск по номеру заказа(шифр), который содержит «orderno».:* '''namestarts''' — Поиск по номеру заказа(шифр), который начинается с «orderno».
* '''limit''' — Необязательный параметр. Дает возможность получить не все измененные заказы, а только какое-то определенное количество. Помогает на случай, если у вас скопилось очень много измененных заказов и нужно их грузить лимитировано. После каждой итерации нужно вызывать commitlaststatus с контейнером списка обработанных кодов, [[#Лимитирование запросов|читать подробнее]] <source langdiv style="xmlcolor: #a94442; background-color: #f2dede; border: 1px solid #ebccd1; padding: 3px 10px 10px;"><?xml version="1'''Обратите внимание!'''# Периода запроса статусов (контейнеры '''datefrom''' и '''dateto''') ограничивается двумя месяцами — два месяца до даты '''«по»'''.# Если не указаны обе даты — '''dateto''' принимается равной текущей дате.# Если не указана дата '''dateto''' — она принимается равной '''datefrom''' плюс 2 месяца.0" encoding="utf-8"?><request># Если не указана дата '''datefrom''' — она принимается равной '''dateto''' минус 2 месяца.<error error="1" errormsg="authorization error"></error># Поиск по '''conditions''' работает только для «Номер заказа(шифр)» и только от 4 символов</requestdiv></sourcebr>
=== Примеры ответов ==='''Пример успешного ответа при ошибке синтаксиса'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<requeststatusreq count="23"> <order orderno="111111" awb="qwerty" orderno2="123123" ordercode="34534234" givencode="2345334"> <barcode>111111</barcode> <errorsender>column:1 line:11 message:expected ' <company>'МВД</errorcompany> <person>Иванов И.И.</requestperson> <phone>123-45-67</sourcephone> <contacts> <phone>+74951234567</phone> </contacts> <town code=== Описание полей ответа статусов ==="23432">Санкт-Петербург</town>Все поля ответа соответствуют структуре order при создании заказа, с некоторыми добавлениями: <address>Петровка 38 офис 35</address> <date>2014-03-22</date>* Атрибуты контейнера '''order''' <time_min>09:00</time_min> <time_max>14:* '''''awb''''' - Номер накладной в системе курьерской службы00</time_max> </sender> <receiver> <company>МВД</company> <person>Иванов И.И.</person>:* '''''orderno2''''' <phone>123-45-67 - Номер накладной в подсистеме срочной доставки курьерской службыИван (916)234.45.21 Петр,mvd@mail.ru</phone> <contacts> <phone>+74951234567</phone>:* '''''ordercode''''' - внутренний код заказа в системе, применяется для некоторых внутренних операций <phone>+79162344521</phone> <email>mvd@mail.ru</email>:* '''''givencode''''' </contacts> <inn>1112223335</inn> <zipcode>125480</zipcode> <town code="153361" regioncode="78" regionname="Санкт-Петербург город">Санкт- внутренний код заказа в системе, применяется для некоторых внутренних операций.Петербург город</town> <address>Петровка 38 офис 35</address> <area>Район 1</area> <pvz>* атрибут ''''' <code''''' контейнера '''item''' >126</code> <clientcode>QWERTY</clientcode> </pvz> <date>2014-03- внутренний код строки заказа в системе, применяется для некоторых внутренних операций.22</date> <time_min>09:* '''''returns''''' - количество данного товара, от которого отказался получатель00</time_min> <time_max>14:00</time_max> <coords lat="55. Не нулевое только в случае частичного отказа680327" lon="37.604456"></coords> <deliveryPIN>1234</deliveryPIN>* атрибут '''''got''''' контейнера '''package''' - признак принятого места YES </ NOreceiver> <price>387.5</price>:* '''''returns''''' - количество данного товара, от которого отказался получатель <inshprice>387. Не нулевое только в случае частичного отказа5</inshprice> <paytype code="1">CASH</paytype> <weight>5.1</weight> <quantity>2</quantity> <service>2</service> <type>3</type> <return>NO</return> <return_service>2</service>* '''''coords''''' <return_type>3</return_type> <return_weight>5.1</return_weight> <return_message>Доставлено в контейнере '''receiver''' целости</return_message> <return_date>2026-01- координаты получателя.19</return_date>* '''currcoords''' - текущие координаты заказа. Атрибуты <return_time>13:18:* '''''lat''''' - широта00</return_time>:* '''''lon''''' - долгота <pickup>NO</pickup>:* '''''accuracy''''' - точность в метрах <print_check>YES</print_check>:* '''''RequestDateTime''''' - дата <waittime>12</время последнего обновления координат.waittime> <enclosure>Детские игрушки</enclosure>* '''courier''' - Данные курьера <instruction>Проверить при покупателе, которому выдан заказподписать акт</instruction> <currcoords lat="55. Если заказ не выдан, то выводятся данные запланированного курьера680327" lon="37.* '''waittime ''' 604456" accuracy="50" RequestDateTime="2014- Время ожидания курьера.* '''deliveryprice''' 04- Стоимость услуг в валюте расчетов с клиентом. Атрибуты21 18:07:45"></currcoords> <courier>:* ''''' <code>26</code> <name>Иванов Владимир Петрович</name> <phone>+79161234567</phone> </courier> <deliveryprice total''''' - общая стоимость услуг:* '''''="158.6" delivery''''' - стоимость доставки ="Туда100.00":* '''''return''''' - стоимость доставки ="Обратно58.6" (если order->return <advprice code="1" price=YES)"150">База</advprice>Тэг '''deliveryprice''' включает список дополнительных услуг (только для тарифа <advprice code="2" price="Премиум0"):>% от объявленной стоимости</advprice>:* ''''' <advprice code="3" price="8.6">Топливный сбор</advprice''''' - наименование дополнительной услуги>:* ''''' <advprice code''''' - код дополнительной услуги="4" price="0">Округление</advprice>:* '''''price''''' - стоимость дополнительной услуги </deliveryprice> <receiverpays>NO</receiverpays>* ''' <acceptpartially>NO</acceptpartially> <status''' eventstore="филиал в Санкт-Петербурге" eventtime="2016- статус доставки (список статусов см. ниже). Атрибуты (заполняются начиная с версии системы 2008.0.0.670)06-02 17:22:* '''''eventstore''''' 00" createtimegmt="2016-06- филиал, к которому относится текущий статус03 16:* '''''eventtime''''' - время события по часовому поясу места его наступления.14:* '''''createtimegmt''''' 44" message="" title="Доставлен" eventtown="Санкт- время по GMT создания записи о смене статуса в БД. Используется для сортировки записей, чтобы соблюсти хронологическую последовательность. <spoiler textПетербург город" color="Подробнее16777215">Большинство событий фиксируются COMPLETE</status> <statushistory> <status eventstore="Офис в полях Москве" eventtime и createtimegmt на основании одного действия, тогда они отличаются только сдвигом от GMT. Однако, если курьер доставил отправление ="2016-05-30 10.10.2010 в :20:00, по какой" createtimegmt="2016-06-то причине не внес это в мобильное приложение, на следующий день сдал накладную, и в 9 утра оператор внесла, что он доставил вчера в 2003 16:14:00. Тогда в createtimegmt будет сегодня 6 утра (для Москвы), а 44" message="" title="Новый" eventtown="Москва город" country="RU">NEW</status> <status eventstore="Офис в Москве" eventtime ="2016- вчера в 2006-01 17:38:00. При этом оператор по каким" createtimegmt="2016-то причинам может внести время вручения раньше, чем какое06-то предыдущее событие, т.о. нарушится последовательность времени 03 16:14:44" message="филиал в eventtime, но при сортировке по createtimegmt всеСанкт-равно все будет правильно.Петербурге" title="Планируется отправка" eventtown="Москва город" country="RU">DEPARTURING</spoilerstatus>:* '''''message''''' <status eventstore="Офис в Москве" eventtime="2016- наименование филиала06-получателя, при передаче между филиалами01 19:53:* '''''title''''' 00" createtimegmt="2016- русское наименование статуса * '''statushistory''' 06- история статусов доставки. Содержит список контейнеров '''status'''. Заполняется только для тарифа 03 16:14:44"Премиум message=" начиная с версии системы 2008.0.0.670.* '''customstatecode''' филиал в Санкт- код внутреннего статуса курьерской службы. Значения уточняйте в курьерской службе. Назначаются курьерской службой в разделе Петербурге" title="СправочникиОтправлено со склада" - eventtown="СтатусыМосква город" - country="15 Статусы корреспонденцииRU". Справочник не передается через API клиенту по причине возможного наличия в нем внутренних технологических статусов курьерской службы.* '''clientstatecode''' - код статуса клиента. Используется, если клиент предлагает свои коды статусов доставки>DEPARTURE</причин недоставки.status>* '''deliveredto''' <status eventstore="филиал в Санкт- данные о вручении, либо причина недоставки.* '''delivereddate''' Петербурге" eventtime="2016- дата вручения.* '''deliveredtime''' 06- время вручения. В случае недоставки может быть пустым.* '''outstrbarcode''' - код у подрядчика (код заказа во внешней системе). Используется в интеграциях с внешними системами. Значения контейнеров '''status''' могут принимать следующие значения02 07:41: AWAITING_SYNC 00" createtimegmt="2016- Ожидает синхронизации. Данные заказа пока не появились в бэкофисе06-03 16: NEW - Новый14: PICKUP - Забран у отправителя44": ACCEPTED - message="" title="Получен складом" eventtown="Санкт-Петербург город" country="RU">ACCEPTED</status> <status eventstore="филиал в Санкт-Петербурге" eventtime="2016-06-02 09:17: INVENTORY 00" createtimegmt="2016- Инвентаризация06-03 16: DEPARTURING - Планируется отправка14: DEPARTURE - Отправлено со склада44": DELIVERY - message="" title="Выдан курьеру на доставку" eventtown="Санкт-Петербург город" country="RU">DELIVERY</status> <status eventstore="филиал в Санкт-Петербурге" eventtime="2016-06-02 17: COURIERDELIVERED 22:00" createtimegmt="2016-06- 03 16:14:44" message="" title="Доставлен (предварительно)" eventtown="Санкт-Петербург город" country="RU">COURIERDELIVERED</status>: COMPLETE <status eventstore="филиал в Санкт-Петербурге" eventtime="2016-06- Доставлен02 17: PARTIALLY - Доставлен частично22: COURIERRETURN 00" createtimegmt="2016- Возвращено курьером. Курьер не смог доставить до получателя, и вернул заказ обратно на склад. Это промежуточный статус, после которого менеджер выясняет, нужно ли пытаться заново доставить заказ, или это окончательная недоставка.: CANCELED 06- Не доставлен (Возврат/Отмена)03 16: RETURNING - Планируется возврат14: RETURNED - Возвращен44": WMSASSEMBLED message="" title="Доставлен" eventtown="Санкт- Скомплектован на складеПетербург город" country="RU">COMPLETE</status>: WMSDISASSEMBLED - Разукомплектован </statushistory>: CONFIRM - Согласована доставка <customstatecode>2<customstatecode>: DATECHANGE - Перенос <clientstatecode></clientstatecode>: NEWPICKUP - Создан забор <deliveredto>Иванова, секр.</deliveredto>: UNCONFIRM <delivereddate>2016- Не удалось согласовать доставку: PICKUPREADY 06- Готов к выдаче02</delivereddate> <deliveredtime>17: LOST - Утрачен22</утерянdeliveredtime>: COURIERPARTIALLY - Частично со слов курьера <department>Отдел</department>: COURIERCANCELED - Отказ со слов курьера <costcode>cc12345</costcode> <outstrbarcode>EXT123456</outstrbarcode>''Примечание:'' В будущем возможно расширение и изменение используемого набора статусов. <respstore>14</respstore> <partner>Офис на Ленина</partner> <div style="color: #a94442; backgroundarrival>2016-05-color02 23: #f2dede; border: 1px solid #ebccd1; padding: 3px 10px 10px;"21</arrival>'''Обратите внимание!''' # Атрибуты контейнера '''status''' заполняются для версий системы '''2008.0.0.670''' и новее.# Контейнер '''statushistory''' заполняется для тарифа <receipt fdNum="124555" fnSn="9289000100295555" kktNum="0001611984048555" inn="7722756555" fdValue="2899551555" summ="[[Личный_кабинет#387.D0.9F.D0.BE.D0.B4.D0.BA.D0.BB.D1.8E.D1.87.D0.B5.D0.BD.D0.B8.D0.B5|Премиум]]5" и версий системы '''2008.0.0.670''' и новее.# Контейнер '''deliveryprice''' заполняется для тарифа ofdUrl="[[Личный_кабинет#gate.D0ofd.9F.D0.BE.D0.B4.D0.BA.D0.BB.D1.8E.D1.87.D0.B5.D0.BD.D0.B8.D0.B5|Премиум]]ru">https://ofd.ru/rec/7722756555/0001611984048555/9289000100295555/124555/2899551555</divreceipt> <br /items> <item code="34533" extcode="abc123" quantity="1" mass= Передача только изменившихся статусов "0.2" retprice="37.5" VATrate="0" barcode=В нашем API предусмотрено очень удобное средство получения статусов всех заказов, без необходимости "бомбить2345625213125" article="1" returns="0" origincountry="040" GTD=" сервер запросами статусов по каждому заказу. Работает это так: раз в какое-то время, например, в 10 минут, вы посылаете запрос "А покажите все изменившиеся статусыexcise="0. Пример запроса ниже. Система вам отдает ВСЕ заказы, статусы (или некоторые другие поля, см ниже) которых изменились с момента последнего запроса. Вы разбираете полученный документ, по каждому заказу сохраняете его актуальный статус в своей системе, и если все хорошо, у вас все получилось, ваша система неожиданно не упала от наплыва информации, посылаете нам запрос подтверждения получения статусов (commitlaststatus). Мы у себя отмечаем, что эти статусы вами получены, и их не надо передавать повторно. Т.о. сколько бы заказов у вас не было, статусы по ним всем почти в реальном времени вы можете получать всего 2-мя запросами. Для получения только изменившихся статусов отправьте запрос<source lang00" governmentCode="xml11223311"><?xml versiongovType="1.0" encodingsuppcompany="Поставщик" suppINN="1112223334" suppphone="UTF-879161234567" ?>Мяч<statusreq/item> <auth extraitem code="834456" extcode="abc124" quantity="2" mass="2" retprice="100" VATrate="10" barcode="4645625213138" article="2" loginreturns="login0" passgovernmentCode="pass" govType="1">Обруч</authitem> <changesitem code="34421" extcode="abc125" quantity="3" mass="0.3" retprice="50" VATrate="18" barcode="2345625213126" itemcode="44123" article="3" returns="0" governmentCode="" govType="1">ONLY_LASTПогремушка желтая</changesitem> </statusreqitems> </source> Система выдает все заказы, в которых, с момента последнего запроса в этом режиме, изменилось хотя бы одно из полей: orderno status delivereddate deliveredtime deliveredto receiver->date receiver-packages>address price После успешной обработки ответа необходимо отметить полученные статусы успешно полученными, отправив запрос <source langpackage code="xml33331" strbarcode="><?xml versionORD0000001" mass="1.0" encodingmessage="UTF-8" ?got="YES"><commitlaststatus/package> <auth extrapackage code="833332" strbarcode="ORD0000002" mass="2.5" loginmessage="login" passgot="passNO"></authpackage> <client/packages>CLIENT </clientextrafields> </commitlaststatusextrafield> <name>courier_car</sourcename> '''Описание полей запроса''' *'''auth''' - Авторизация. Обязательный элемент.*'''client''' - Признак клиента или агента. Необязательный элемент.:* CLIENT - Признак клиента <value>ВАЗ 2106, значение по умолчанию:* AGENT - Признак агента. В ответ отдается информация по заказам, переданным агенту на доставку В случае успеха Вы получите ответ бежевый</value> <source lang="xml"/extrafield> <?xml version="1.0" encoding="UTF-8" ?/extrafields> <commitlaststatus error="0"/order>OK</commitlaststatusstatusreq></source>
<div stylesource lang="color: #a94442; backgroundxml"><?xml version="1.0" encoding="utf-color: #f2dede; border: 1px solid #ebccd1; padding: 3px 10px 10px;8"?><statusreq count="0">'''Обратите внимание!'''</statusreq> </source>
<source lang="xml">
<?xml version="1.0" encoding="utf-8"?>
<request>
<error error="1" errormsg="authorization error"></error>
</request>
</source>
<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<trackingrequest> <extraerror>8</extra> <ordernocolumn:1 line:11 message:expected '>1234'</ordernoerror></trackingrequest>
</source>
=== Описание полей ответа статусов ===Все поля ответа соответствуют структуре order при создании заказа, с некоторыми добавлениями: * Атрибуты контейнера '''Пример ответаorder'''::* '''''awb''''' — Номер накладной в системе курьерской службы.:* '''''orderno2''''' — Номер накладной в подсистеме срочной доставки курьерской службы.<source lang="xml">:* '''''ordercode''''' — внутренний код заказа в системе, применяется для некоторых внутренних операций.<?xml version="1:* '''''givencode''''' — внутренний код заказа в системе, применяется для некоторых внутренних операций.0" encoding="UTF *'''paytype''' -8"?>Тип оплаты заказа получателем. Принимает значения:<tracking>:: CASH - Наличными при получении (по-умолчанию) <order orderno="111111">:: CARD - Картой при получении <barcode>111111</barcode>:: NO - Без оплаты. <AWB>111111</AWB>:: OTHER - Прочее (Предусмотрен для того, чтобы оплата поступала непосредственно в курьерскую службу посредством прочих типов оплаты - таких как: вебмани, яденьги, картой на сайте, прочие платежные системы и т.д.) <sender>* Атрибуты контейнера '''paytype''': <town ** '''''code=''''' - (integer) внутренний код типа оплаты заказа в системном справочнике "1Типы оплаты корреспонденции" country="RU">Москва город</town>. Не обязательный элемент. <date>2014-03-22</date>* атрибут '''''code''''' контейнера '''item''' — внутренний код строки заказа в системе, применяется для некоторых внутренних операций. <time_min>09:00<* '''''returns''''' — количество данного товара, от которого отказался получатель. Не нулевое только в случае частичного отказа. * атрибут '''''got''''' контейнера '''package''' — признак принятого места YES /time_min>NO. <time_max>14:00<* '''''returns''''' — количество данного товара, от которого отказался получатель. Не нулевое только в случае частичного отказа. * '''''area''''' в контейнере '''receiver''' — район/time_max>метро получателя. </sender>* '''''coords''''' в контейнере '''receiver''' — координаты получателя. <* '''''deliveryPIN''''' в контейнере '''receiver>''' — Пин-код.* '''pickup''' — признак оформления забора, возможные значения: '''YES''', '''NO'''. Если указано '''YES''', то весь заказ считается заданием на забор груза, а не на доставку. <town code="1" country="RU">Москва город</town>* '''currcoords''' — текущие координаты заказа. Атрибуты: <zipcode>125480</zipcode>:* '''''lat''''' — широта <date>2014-03-22</date>:* '''''lon''''' — долгота <time_min>09:00</time_min>* '''''accuracy''''' — точность в метрах <time_max>14:00<* '''''RequestDateTime''''' — дата/time_max>время последнего обновления координат. </receiver> <price>387* '''courier''' — Данные курьера, которому выдан заказ. Если заказ не выдан, то выводятся данные запланированного курьера.5</price> <inshprice>387* '''waittime ''' — Время ожидания курьера.5</inshprice> <paytype>CASH</paytype> <weight>5* '''deliveryprice''' — Стоимость услуг в валюте расчетов с клиентом.1</weight>Атрибуты: <quantity>2</quantity>:* '''''total''''' — общая стоимость услуг <service>2</service>:* '''''delivery''''' — стоимость доставки «Туда» <type>3</type> <:* '''''return''''' — стоимость доставки «Обратно» (если order->NO</return>=YES) <return_service>2</service>Тэг '''deliveryprice''' включает список дополнительных услуг (только для тарифа «Премиум»): <return_date></return_date>:* '''''advprice''''' — наименование дополнительной услуги <return_time></return_time>:* '''''code''''' — код дополнительной услуги <return_message></return_message>:* '''''price''''' — стоимость дополнительной услуги <waittime>12</waittime> <enclosure>Детские игрушки</enclosure>* '''status''' — статус доставки (список статусов см. ниже). Атрибуты (заполняются начиная с версии системы 2008.0.0.670): <instruction>Проверить при покупателе:* '''''eventstore''''' — филиал, подписать акт</instruction>к которому относится текущий статус:* '''''eventtime''''' — время события по часовому поясу места его наступления. :* '''''createtimegmt''''' — время по GMT создания записи о смене статуса в БД. Используется для сортировки записей, чтобы соблюсти хронологическую последовательность. <deliveryprice totalspoiler text="158Подробнее">Большинство событий фиксируются в полях eventtime и createtimegmt на основании одного действия, тогда они отличаются только сдвигом от GMT. Однако, если курьер доставил отправление 10.6" delivery="10010.2010 в 20:00, по какой-то причине не внес это в мобильное приложение, на следующий день сдал накладную, и в 9 утра оператор внесла, что он доставил вчера в 20:00" return="58.Тогда в createtimegmt будет сегодня 6" утра (для Москвы), а в eventtime — вчера в 20:00. При этом оператор по каким-то причинам может внести время вручения раньше, чем какое-то предыдущее событие, т.о. нарушится последовательность времени в eventtime, но при сортировке по createtimegmt все-равно все будет правильно.</spoiler> <courier>:* '''''message''''' — наименование филиала-получателя, при передаче между филиалами:* '''''title''''' — русское наименование статуса * '''statushistory''' — история статусов доставки. Содержит список контейнеров '''status'''. Заполняется только для тарифа «Премиум» начиная с версии системы 2008.0.0.670. <code>26</code>* '''customstatecode''' — код внутреннего статуса курьерской службы. Значения уточняйте в курьерской службе. Назначаются курьерской службой в разделе «Справочники» — «Статусы» — «15 Статусы корреспонденции». Справочник не передается через API клиенту по причине возможного наличия в нем внутренних технологических статусов курьерской службы. <name>Иванов Владимир Петрович<* '''clientstatecode''' — код статуса клиента. Используется, если клиент предлагает свои коды статусов доставки/name>причин недоставки. <phone>+79161234567</phone>* '''deliveredto''' — данные из поля «Инфо. о доставке» (может быть информация о доставке, причина недоставки и т. п.). </courier>* '''delivereddate''' — дата вручения. <currcoords lat="55* '''deliveredtime''' — время вручения.680327" lon="37В случае недоставки может быть пустым.604456" accuracy="50" RequestDateTime="2014* '''arrival''' — плановая дата прибытия в формате гггг-04мм-21 18дд чч:07мм:45" сс. Заполняется только при использовании автоматических систем планирования (Максоптра, Яндекс доставка), во всех остальных случаях - пустое.* '''outstrbarcode''' — код у подрядчика (код заказа во внешней системе). Используется в интеграциях с внешними системами.* '''partner''' — текущий филиал/>подрядчик.* '''return_message''' — информация о возврате <status eventstore="филиал в Санкт* '''return_date''' -Петербурге" eventtime="2016дата возврата* '''return_time''' -06-02 17время возврата* '''department''' — Подразделение, в котором оформляется заказ. Контейнер '''status''' может принимать следующие значения:22:00" createtimegmt="2016-06-03 16AWAITING_SYNC — Ожидает синхронизации. Данные заказа пока не появились в службе доставки.:14'''NEW''' — Успешно создан, передан в службу доставки.:44" message="" title="Доставлен">COMPLETE</status>NEWPICKUP — Создан забор. <statushistory>: PICKUP — Забран у отправителя. <status eventstore="Офис в Москве" eventtime="2016-05-30 10:20WMSASSEMBLED — Скомплектован на складе фулфилмента.:00" createtimegmt="2016-06-03 16WMSDISASSEMBLED — Разукомплектован на склад фулфилмента.:14'''ACCEPTED''' — Получен складом.:44" message="" title="Новый">NEW</status>CUSTOMSPROCESS — Производится таможенный контроль. <status eventstore="Офис в Москве" eventtime="2016-06-01 17:38CUSTOMSFINISHED — Таможенный контроль произведен.:00" createtimegmt="2016-06-03 16CONFIRM — Согласована доставка.:14UNCONFIRM — Не удалось согласовать доставку.:44" message="филиал в Санкт-Петербурге" title="DEPARTURING — Планируется отправка">DEPARTURING</status>со склада на другой склад.: DEPARTURE — Отправлено со склада на другой склад. <status eventstore="Офис : INVENTORY — Инвентаризация. Убедились в Москве" eventtime="2016-06-01 19наличии отправления на складе.:53PICKUPREADY — Готов к выдаче в ПВЗ.:00" createtimegmt="2016-06-03 16'''DELIVERY''' — Выдан курьеру на доставку.:14COURIERDELIVERED — Доставлен (предварительно, ожидает подтверждения менеджером, чтобы перейти в статус COMPLETE).:44" message="филиал COURIERPARTIALLY — Частично доставлен (предварительно, ожидает подтверждения менеджером, чтобы перейти в Санкт-Петербурге" title="Отправлено со склада">DEPARTURE<статус PARTIALLY).: COURIERCANCELED — Отказ (предварительно, после этого ожидается COURIERRETURN).: COURIERRETURN — Возвращено курьером. Курьер не смог доставить до получателя и вернул заказ обратно на склад. Это промежуточный статус, после которого менеджер выясняет, нужно ли повторно доставлять (статусы DATECHANGE/status>DELIVERY) или это окончательная недоставка (CANCELED).: DATECHANGE — Перенос даты доставки. : '''COMPLETE''' — Доставлен.: '''PARTIALLY''' — Доставлен частично. <status eventstore="филиал в Санкт-Петербурге" eventtime="2016-06-02 07:41'''CANCELED''' — Не доставлен (Возврат/Отмена). После этого статуса отправление должны вернуть заказчику, будут статусы RETURNING и RETURNED :00" createtimegmt="2016-06-03 16RETURNING — Планируется возврат заказчику (после CANCELED).:14RETURNED — Возвращен заказчику.:44" message="" title="Получен складом">ACCEPTED<LOST — Утрачен/status>утерян. : PARTLYRETURNING — Планируется возврат остатков.: PARTLYRETURNED — Остаток возвращен.: TRANSACCEPTED — Прибыл на склад перевозчика.: PICKUPTRANS — Забран у перевозчика. <status eventstore="филиал в Санкт: WITHDRAWN_FROM_PICKUP_POINT -Петербурге" eventtime="2016Изъят.: CUSTOMSDELAY -06Задержка отправления таможенным органом.: DEPARTUREDELAY -02 09Задержка отправления перевозчиком.:17:00" createtimegmtSTORETAKE - Принят в работу на складе. '''Примечание.''' В будущем возможно дополнение используемого набора статусов. <div style="2016color: #a94442; background-06-03 16color: #f2dede; border:141px solid #ebccd1; padding:44" message="" title="Выдан курьеру на доставку3px 10px 10px;">DELIVERY'''Обратите внимание!''' # Контейнер '''statushistory''' и '''deliveryprice''' заполняется для тарифов [[Личный кабинет курьерской службы#Функции личного кабинета|Премиум и Максимум]].# Контейнер '''packages''' не возвращает более 1000 элементов.# Система никогда не гарантирует последовательность прохождения заказом набора статусов. То есть Вы можете получить статус «COMPLETE», а следующим запросом — «NEW» — такое может произойти, например, если оператор ошибочно отметил заказ выполненным, а затем исправил ошибку.</statusdiv> <status eventstorebr> === Передача только изменившихся статусов =="филиал в Санкт-Петербурге" eventtime="2016-06-02 17В нашем API предусмотрено удобное средство получения статусов всех заказов, без необходимости «бомбить» сервер запросами статусов по каждому заказу. Работает это так:22раз, например, в 10 минут, вы посылаете запрос «покажите все изменившиеся статусы». Пример запроса ниже. Система вам отдает ВСЕ заказы, статусы (или некоторые другие поля, см. ниже) которых изменились с момента последнего запроса. Вы разбираете полученный документ, по каждому заказу сохраняете его актуальный статус в своей системе, и если все хорошо, у вас все получилось, ваша система неожиданно не упала от наплыва информации, посылаете нам запрос подтверждения получения статусов (commitlaststatus). Мы у себя отмечаем, что эти статусы вами получены и их не надо передавать повторно. Таким образом, сколько бы заказов у вас ни было, статусы по ним всем почти в реальном времени вы можете получать всего двумя запросами. Для получения только изменившихся статусов отправьте запрос:00" createtimegmt<source lang="2016-06-03 16:14:44xml" message><?xml version="1.0" titleencoding="Доставлен (предварительно)UTF-8"?>COURIERDELIVERED</statusstatusreq> <status eventstoreauth extra="филиал в Санкт-Петербурге8" eventtimelogin="2016-06-02 17:22:00login" createtimegmtpass="2016-06-03 16:14:44" message="" title="Доставленpass">COMPLETE</statusauth> <changes>ONLY_LAST</statushistorychanges> <deliveredtostreamid>Иванова, секр.1234</deliveredtostreamid> <delivereddate/statusreq>2016-06-02</delivereddatesource> <deliveredtime>17Система выдает все заказы, в которых с момента последнего запроса в этом режиме изменилось хотя бы одно из полей:22</ orderno status delivereddate deliveredtime deliveredto receiver->date <outstrbarcode>EXT123456</outstrbarcode receiver->address price <items>После успешной обработки ответа необходимо отметить полученные статусы успешно полученными, отправив запрос: <item codesource lang="34533xml" extcode="abc123" quantity><?xml version="1" mass="0.2" retprice="37.5" VATrate="0" barcodeencoding="2345625213125" article="1" returns="0" origincountry="040" GTD="" excise="0.00" governmentCode="11223311" suppcompany="Поставщик" suppINN="1112223334" suppphone="79161234567UTF-8"?>Мяч</itemcommitlaststatus> <item codeauth extra="34456" extcode="abc124" quantity="2" mass="2" retprice="100" VATrate="10" barcode="46456252131388" articlelogin="2" returns="0login" governmentCodepass="pass">Обруч</itemauth> <item code="34421" extcode="abc125" quantity="3" mass="0.3" retprice="50" VATrate="18" barcode="2345625213126" article="3" returns="0" governmentCode=""client>Погремушка желтаяCLIENT</itemclient> </itemsstreamid> 1234</orderstreamid></trackingcommitlaststatus>
</source>
'''Описание полей запроса'''
* '''Получение информации auth''' — авторизация. Обязательный элемент.* '''streamid''' — идентификатор потока. Если у вас несколько интеграций и каждая нуждается в получении статусов, вы можете передавать данный параметр и тем самым разделять получение и отметку об успешном получении статусов по заказам. Значение должно входить в формате 17 TRACKпромежуток от 100 до 10000, включительно. Необязательный элемент.* '''client''' — признак клиента или агента. Необязательный элемент.:* CLIENT — признак клиента, значение по умолчанию:* AGENT — признак агента. В ответ отдается информация по заказам, переданным агенту на доставку
<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?><tracking17commitlaststatus error="0">OK</commitlaststatus></source> Такой способ передачи статусов гарантирует полную корректную передачу статусов, даже если в нашей системе статус изменился между запросом статусов и подтверждением их получения. Если система не получила подтверждение передачи статуса, она будет считать информацию непереданной и выдаст ее при повторном запросе. <div style="color: #a94442; background-color: #f2dede; border: 1px solid #ebccd1; padding: 3px 10px 10px;"># При этом способе передачи (<changes>ONLY_LAST</changes>) система просматривает заказы, оформленные за последние 3 месяца. Если заказ сделан ранее, изменение статуса по нему не попадет в результат выполнения запроса.# Система всегда выдает текущий статус. Вы можете одним запросом получить статус «NEW», а следующим — «COMPLETE». Между запросами отправление могло пройти через несколько промежуточных статусов. Если нужна гарантия получения всех промежуточных статусов, нужно анализировать блок statushistory (может не заполняться вследствие ограничений версии или тарифа конкретной службы доставки).# Система не гарантирует последовательность прохождения заказом набора статусов. Вы можете получить статус «COMPLETE», а следующим запросом «NEW» — такое может произойти, например, если оператор ошибочно отметил заказ выполненным, а затем исправил ошибку.</div><br> === Лимитирование запросов ===Дает возможность получить не все измененные заказы, а только какое-то определенное количество. Помогает на случай, если у вас скопилось очень много измененных заказов и нужно их грузить лимитировано. После успешной обработки получнных заказов, '''обязательно''' нужно вызвать commitlaststatus с кодами обработанных заказов. '''Пример''' Для получения ограниченного числа изменившихся заказов отправьте запрос:<source lang="xml"><?xml version="1.0" encoding="UTF-8" ?><statusreq> <auth extra="8" login="login" pass="pass"></auth> <changes>ONLY_LAST</changes> <limit>5</limit></statusreq></source> После успешной обработки ответа необходимо отметить полученные статусы успешно полученными, отправив запрос:<source lang="xml"><?xml version="1.0" encoding="UTF-8" ?><commitlaststatus> <auth extra="8" login="login" pass="pass"></extraauth> <ordernoacs>1234 <ac>11111</ac> <ac>22222</ac> <ac>33333</ac> <ac>44444</ac> <ac>55555</ac> </ordernoacs></tracking17commitlaststatus>
</source>
== Трекинг заказа по номеру ==Запрос трекинга по номеру предназначен для изменения заказоввыдачи минимальной обезличенной информации о конкретном заказе не авторизованному пользователю. Наша система имеет для этого интерфейс по адресу «home.courierexe.ru/{код экстра}/tracking». Вы можете либо сделать ссылку на такую страницу на своем сайте, находящихся в статусах "Ожидает синхронизации" или "Новый"либо разместить ее [[#Размещение страниц на своем сайте (iframe)|iframe’ом]] у себя, а также по которым не было произведено изменений - статуса корреспонденции, времени доставки - то есть либо сделать свою и пользоваться нашим API. Этот интерфейс создан специально для выдачи информации живому пользователю сайта. Для получения статусов заказовв свою информационную систему нужно использовать запрос «statusreq», которые ещё не находятся в работе.желательно с параметром changes=ONLY_LAST!
<source lang="xml">
<?xml version="1.0" encoding="UTF-8" ?><cancelordertracking> <auth extra=">8" login="login" pass="pass" </extra> <order orderno="" ordercode="123456" /> 1234<order /orderno="123aaa" ordercode="" /></cancelordertracking>
</source>
'''Пример ответа:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8" ?><cancelordertracking> <order orderno="123test111111" ordercode="12345612345" error> <barcode>111111</barcode> <AWB>111111</AWB> <sender> <town code="01" country="RU" errormsg>Москва город</town> <date>2014-03-22</date> <time_min>09:00</time_min> <time_max>14:00</time_max> </sender> <receiver> <town code="OK1" errormsgrucountry="УспешноRU" >Москва город</town> <zipcode>125480</zipcode> <date>2014-03-22</date> <time_min>09:00</time_min> <time_max>14:00</time_max> </receiver> <price>387.5</price> <inshprice>387.5</inshprice> <paytype>CASH</paytype> <weight>5.1</weight> <quantity>2</quantity> <service>2</service> <type>3</type> <return>NO</return> <return_service>2</return_service> <return_date></return_date> <return_time></return_time> <return_message></return_message> <waittime>12</waittime> <enclosure>Детские игрушки</enclosure> <instruction>Проверить при покупателе, подписать акт</instruction> <order ordernodeliveryprice total="158.6" delivery="123aaa100.00" return=" ordercode58.6" /> <courier> <code>26</code> <name>Иванов Владимир Петрович</name> <phone>+79161234567</phone> </courier> <currcoords lat="55.680327" errorlon="5237.604456" errormsgaccuracy="order not found50" errormsgruRequestDateTime="Заказ не найден2014-04-21 18:07:45" /> <status eventstore="филиал в Санкт-Петербурге" eventtime="2016-06-02 17:22:00" createtimegmt="2016-06-03 16:14:44" message="" title="Доставлен">COMPLETE</cancelorderstatus> <statushistory> <status eventstore="Офис в Москве" eventtime="2016-05-30 10:20:00" createtimegmt="2016-06-03 16:14:44" message="" title="Новый">NEW</sourcestatus> <status eventstore="Офис в Москве" eventtime="2016-06-01 17:38:00" createtimegmt="2016-06-03 16:14:44" message="филиал в Санкт-Петербурге" title="Планируется отправка">DEPARTURING</status> <status eventstore="Офис в Москве" eventtime= Добавление вложений к накладной "2016-06-01 19:53:00" createtimegmt="2016-06-03 16:14:44" message="филиал в Санкт-Петербурге" title="Отправлено со склада">DEPARTURE</status> '''Пример запроса <status eventstore="филиал в Санкт-Петербурге" eventtime="2016-06-02 07:41:00" createtimegmt="2016-06-03 16:14:'''44" message="" title="Получен складом">ACCEPTED</status> <source langstatus eventstore="филиал в Санкт-Петербурге" eventtime="2016-06-02 09:17:00" createtimegmt="2016-06-03 16:14:44" message="" title="xmlВыдан курьеру на доставку">DELIVERY</status> <?xml versionstatus eventstore="1.0филиал в Санкт-Петербурге" encodingeventtime="UTF2016-806-02 17:22:00" createtimegmt="2016-06-03 16:14:44" message="" title="Доставлен (предварительно)" ?>COURIERDELIVERED<addattachments/status> <auth extrastatus eventstore="филиал в Санкт-Петербурге" eventtime="2016-06-02 17:22:00" createtimegmt="82016-06-03 16:14:44" loginmessage="login" passtitle="passДоставлен" >COMPLETE</status> <orderno/statushistory> <deliveredto>Иванова, секр.</deliveredto> <delivereddate>2016-06-02</delivereddate> <deliveredtime>17:22</deliveredtime> <outstrbarcode>1234567EXT123456</ordernooutstrbarcode> <attachmentsitems> <item namecode="34533" extcode="abc123" quantity="1" mass="0.2" retprice="37.5" VATrate="0" barcode="2345625213125" article="1" returns="0" origincountry="040" GTD="" excise="photo10.jpg00" governmentCode="11223311"suppcompany="Поставщик" suppINN="1112223334" suppphone="79161234567">Мяч</item>JVBERi0xLjMN1wb25lbnQgMQ JUBQREYwMTIzNDU2Nzg5IDI NMyAwIG9iag08PA0vVHlwZSA U3VidHlwZSAvSW1hZ2UNL1d pZHRoIDE4MDgNL0hlaWdodCA ggNCAwIFINL0JpdHNQZXJDb 21wb25lbnQgMQ0vRGVjb2RlU ENL0NvbHVtbnMgMTgwOA0+P g0vSW1hZ2VNYXNrIHRydWUNL XhEZWNvZGUNPj4Nc3RyZWFt DQ <item code="34456" extcode="abc124" quantity="2" mass="2" retprice="100" VATrate="10" barcode="4645625213138" article="2" returns="0" governmentCode="">Обруч</item> <item namecode="34421" extcode="abc125" quantity="3" mass="photo20.jpg3"retprice="50" VATrate="18" barcode="2345625213126" article="3" returns="0" governmentCode="">Погремушка желтая</item>VBERi0xLjMNAwIG9iag0HRoJ JUBQREYwMTIzNDU2Nzg5IDI NMyAwIG9iag08PA0vVHlwZSA </items> vWE9iamVjdA0vU3VidHlwZS AvSW1hZ2UNL1dpZHRoIDEzNj <acquirers> gNL0hlaWdodCAxMzMzDS9MZ W5ndGggNCAwIFINL0JpdHNQZ <acquirer code="2" name="Ibox"/> XJDb21wb25lbnQgMQ0vRGVj b2RlUGFybXMgPDwNL0sgLTEN <acquirer code="5" name="Payme"/> L0NvbHVtbnMgMTM2OA0+Pg0 vSW <acquirer code="6" name="Click"/> </itemacquirers> </attachmentsorder></addattachmentstracking></source> где,* '''Описание полей:acquirers''' / '''addattachmentsacquirer''' - Корневой контейнер. Обязательный элемент.эквайринг, доступный для получения ссылки на оплату заказа**'''authacquirers''' - Авторизация. Обязательный элемент.*/ '''ordernoacquirer''' - Номер заказа. Обязательный элемент. Может использоваться тэг <ordercode> с указанием внутреннего кода заказа.*''/ 'attachments'code'' - Обязательный элемент, в котором перечисляются передаваемые данные файлов.внутренний код эквайринга**'''itemacquirers''' - Бинарные данные (файл), закодированные в base64. Обязательный элемент.***/ '''nameacquirer''' - Атрибут элемента / '''itemname''', в котором передается имя файла. Обязательный элемент.- наименование эквайринга
'''Получение информации в формате 17 TRACK'''
'''Пример ответазапроса:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<addattachmentstracking17> <attachmentsextra> 8<item name="photo1.jpg" error="0" errormsg="OK" errormsgru="Успешно" /extra> <item name="photo2.jpg" error="0" errormsg="OK" errormsgru="Успешно" /orderno> 1234</attachmentsorderno></addattachmentstracking17>
</source>
'''Пример ответа:'''
<source lang=pre>{ "number":"xmlExtNumber">,<?xml version= "1.0oriNumber" encoding=:"UTF-81234"?>,<attachments> "oriCountry":"RU", <item name= "doc1.docxdestCountry" size=:"35654RU">JVBERi0xLjMN, JUBQREYwMTIzNDU2Nzg5IDI NMyAwIG9iag08PA0vVHlwZSA "status":"Complete", U3VidHlwZSAvSW1hZ2UNL1d pZHRoIDE4MDgNL0hlaWdodCA "events":[ ggNCAwIFINL0JpdHNQZXJDb 21wb25lbnQgMQ0vRGVjb2RlU { ENL0NvbHVtbnMgMTgwOA0+P g0vSW1hZ2VNYXNrIHRydWUNL "time":"2016-06-02 17:22:00", XhEZWNvZGUNPj4Nc3RyZWFt DQ</item> "location":"RU", <item name= "photo2.jpgtown" size=:"74861Москва">VBERi0xLjMN , JUBQREYwMTIzNDU2Nzg5IDI NMyAwIG9iag08PA0vVHlwZSA "store":"Москва Главный", vWE9iamVjdA0vU3VidHlwZS AvSW1hZ2UNL1dpZHRoIDEzNj "content":"Complete" gNL0hlaWdodCAxMzMzDS9MZ W5ndGggNCAwIFINL0JpdHNQZ }, XJDb21wb25lbnQgMQ0vRGVj b2RlUGFybXMgPDwNL0sgLTEN { L0NvbHVtbnMgMTM2OA0+Pg0 vSW</item> "time":"2016-06-02 17:22:00",</attachments> "location":"RU",</source> "town":"Москва", В тегах item возвращаются бинарные данные (файлы) "store":"Москва Главный", закодированные в base64. "content":"Courierdelivered"== Изменение статуса агентом == }, {Запрос изменения статуса заказа позволяет установить окончательный статус заказа "time":"2016- 06-02 09:17:00"Доставлен, " или location"Не доставлен (Возврат/Отмена):"RU"., "town":"Москва",Кроме этого "store":"Москва Главный", устанавливается дата и время (при необходимости) изменения статуса, а также сообщение в поле ''Инфо о доставке''. "content":"Delivery"При необходимости к заказу можно прикрепить изображения. }, { "time":"2016-06-02 07:41:00",'''Пример запроса изменения статуса "location":'''<source lang="xmlRU">,<?xml version= "1.0town" encoding=:"UTF-8Москва" ?><setorderinfo>, <auth extra= "8store" login=:"loginМосква Главный" pass=, "passcontent" /> <order ordercode=:"123456Accepted"> <message>Получил Иванов</message> }, </order> { <order ordercode= "time"234567:"> <status>PICKUPREADY</status> <eventtime>2016-0506-30 1001 19:2053:00</eventtime>", <message>Клиент отказался от покупки</message> "location":"RU", <paytype>CASH</paytype> "town":"Горький", <items> "store":"Горький Автозавод", <item code= "34533content" quantity=:"1Departure" reason= }, { "time"0:" />2016-06-01 17:38:00", <item code= "location":"34456RU" quantity=, "0town" reason=:"0Горький" />, <item code= "store"34421:" quantity=Горький Автозавод"2, " reason=content"0:" />Departuring" }, </items> { <image filename= "time":"filename1.jpg2016-05-30 10:20:00"> /9j/4AAQSkZJRgA, BAQAAAQABAAD/2wBDAA0JCg sKCA0LCgsODg0PEyAVExISEy "location":"RU", ccHhcgLikxMC4pLSwzOko+M zZGNywtQFdBRkxOUlNSMj5aY "town":"Горький", VpQYEpRUk//2wBDAQ4ODhMR EyYVFSZPNS01T09PT09PT09P "store":"Горький Автозавод", T09PT09PT09PT09PT09PT09 PT09PT09PT09PT09PT09PT09 "content":"New" PT09PT0//wAARCAYACAADAS IA</image> </order> }</setorderinfo> ]}</sourcepre>
Функция ищет последний заказ по номеру среди заказов всех клиентов. Выдает неперсонализированную информацию о текущем состоянии заказа.<br>
Описание контейнеров ответа аналогично описанию [[API#.D0.97.D0.B0.D0.BF.D1.80.D0.BE.D1.81 .D1.81.D1.82.D0.B0.D1.82.D1.83.D1.81.D0.B0 .D0.B7.D0.B0.D0.BA.D0.B0.D0.B7.D0.BE.D0.B2|Запроса статусов заказов]].
'''Пример запроса:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<acqlink>
<extra>8</extra>
<acq>
<code>2</code>
</acq>
<order>
<code>12345</code>
</order>
</acqlink>
</source>
где
*'''extra''' - код экстраклиента в системе Measoft.
*acq.'''code''' - внутренний код платформы эквайринга в системе Measoft. (известен в МП из [https://wiki.courierexe.ru/index.php/API#.D0.A2.D1.80.D0.B5.D0.BA.D0.B8.D0.BD.D0.B3_.D0.B7.D0.B0.D0.BA.D0.B0.D0.B7.D0.B0_.D0.BF.D0.BE_.D0.BD.D0.BE.D0.BC.D0.B5.D1.80.D1.83 Трекинга])
*order.'''ordercode''' - внутренний код заказа, типа ''int'', уникальный в пределах экстраклиента
'''Пример ответа:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<setorderinfo> <order ordercode="123456" acqlink error="0" errormsgamount="OK2000" errormsgruextid="Успешно161083231" >https:/> <order ordercode/qr.nspk.ru/AD10001A7GLVGA9YDO2I0789SIOPV3?type=02&bank="234567" error1000011&sum="59" errormsg2000&cur="value [date_put] is already set" errormsgruRUB&crc="Значение [Дата доставки] уже указано" />7E9C</setorderinfoacqlink>
</source>
<source lang="xml">
<?xml version="1.0" encoding="UTF-8" ?><waybill> <auth extraacqlink error="82" loginmessage="loginОшибка авторизации: Invalid token" passamount="pass2000" /> <orders> <order orderno="1234567" ordercode="33331" /> <order orderno="1234568" ordercodeextid="33332" /> </orders> <form>1</form></waybill>
</source>
где*acqlink.'''Описание полейmessage''' - текст ошибки возвращаемой эквайрингом Возможные типы ошибок получения ссылки:* '''1''' - не настроен эквайринг, либо не найден заказ* '''2''' - ошибка на стороне эквайринга* '''3''' - запрещающий статус курьера (заказ доставлен, частично доставлен)* '''4'''- оплата заказа не разрешена
Изменять заказы могут курьерские службы с тарифами «Премиум» и «Максимум». Чтобы разрешить изменение заказов, в личном кабинете курьерской службы перейдите в '''Настройки''' > '''Заказы''' и в разделе '''Отмена и редактирование''' установите флажок '''Разрешить отмену и изменение заказов'''. Вы также можете пометить в списке '''Статусы для отмены и редактирования заказов''' галками статусы корреспонденции, для которых возможны отмена и изменение заказов. По умолчанию (когда в этом списке ничего не выбрано) редактирование и отмена разрешены для статуса «Новый»
<div style="color: #a94442; background-color: #f2dede; border: 1px solid #ebccd1; padding: 3px 10px 10px;">'''Пример ответа:Обратите внимание!'''<source lang="xml"># Данные запроса изменения указываются '''полностью''', как если бы заказ создавался впервые.<?xml version="1# При отсутствии вложения в запросе изменения данное вложение '''не удаляется''' из заказа, но его количество становится равным 0.0" encoding="UTF-8"?><waybill> <content>EODIcaI8KSBlwQ 4MnEOR7Px8U8EBAyGICBnwpw IZhQgz0ZxuPs8EBM/GcbjzB AwhBl8hwQYIO00GmEwg1CeEG mqYTChNU0wqf8l8nz4zgc+K fCno+zwU5GjOZmzXGcbEQYIM 4zkegRE40zWzONyoNNMIOIa cWnp6aDCGEGE9NQmoQd2mg00 79U4f3hPTwnfp6Sdrafeqpa JDpFw/1aYT077VNNNdO00G3q mqqvp9p2E7T0/wiFemv8uG6 OM</content></waybill># При одновременном изменении заказа в API и системе курьерской службы приоритет отдается данным системы курьерской службы. То есть изменения в API приняты не будут.</sourcediv>
При редактировании заказа может быть отменен запланированный курьер. Это зависит от значения переменной '''Справочники''' > '''Переменные''' > '''Корреспонденция''' > '''Автоматически устанавливать заплан. курьера по району''':
* '''Нет''' — при редактировании заказа по АПИ курьер не изменяется;
* '''Район''' — если изменен адрес доставки, курьер сбрасывается;
* '''Район или дата план. доставки''' — если изменен адрес доставки или плановая дата вручения, курьер сбрасывается.
* значение '''orderno''' данным методом изменить нельзя.
* значение '''barcode''' изменяется в случае явного его указания. В случае отсутствия или пустого значения - остается прежним.
* вместо корневого тэга '''neworder''' указывается '''editorder''';
* тэг курьера '''courier''' можно изменить только при включенной настройке '''Разрешить изменение курьера по АПИ''';
* для вложений '''item''' указывается внутренний код вложения в атрибуте '''code''', который можно получить при получении статуса заказа.
* для мест '''package''' указывается внутренний код вложения в атрибуте '''code''', который можно получить при получении статуса заказа.
Необходимо иметь в виду, что:
=== Описание полей ответа изменения ===Все поля ответа соответствуют ответу при создании заказа за исключением корневого тэга — вместо '''Пример запроса справочника городов:neworder''' возвращается '''editorder'''<source lang="xml"><?xml version="1.0" encoding="UTF-8"?><townlist> <auth extra="8" /> <codesearch> <zipcode>110000</zipcode> <kladrcode>0100000100800</kladrcode> <fiascode>bd21979d-46f8-49d0-9105-e8d65172a983</fiascode> <code>123</code> </codesearch> <conditions> <city>Краснодарский край</city> <namecontains>новгород</namecontains> <namestarts>Моск</namestarts> <name>Москва</name> <fullname>Москва город</fullname> <country>1</country> </conditions> <limit> <limitfrom>30</limitfrom> <limitcount>10</limitcount> <countall>YES</countall> </limit></townlist></source>
'''Пример ответа:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?><townlist countcancelorder> <order orderno="123test" ordercode="3123456" pageerror="10" totalcounterrormsg="3OK" totalpageserrormsgru="1Успешно"/> <townorder orderno="123aaa" ordercode="" error="52" errormsg="order not found" errormsgru="Заказ не найден" /> <code>26379</codecancelorder> <city/source> <code>23</code> <name>Краснодарский край</name>== Добавление вложений к накладной == </city> <name>Сочи город</name>Метод позволяет прикрепить файлы к корреспонденции. <fiascode>79da737a-603b-4c19-9b54-9114c96fb912</fiascode>Размер загружаемого файла не должен превышать 1 Мб. <kladrcode>2300000700000</kladrcode> <shortname /> (not yet supported)'''Пример запроса:''' <typename /source lang="xml"> (not yet supported) <coords lat?xml version="431.58550" lonencoding="39.7231UTF-8" /?> </townaddattachments> <town> <code>40331<auth extra="8" login="login" pass="pass" /code> <city> <codeorderno>321234567</codeorderno> <name>Брянская область </nameattachments> </cityitem name="photo1.jpg">JVBERi0xLjMN1wb25lbnQgMQ <name>Сочилов хутор</name>JUBQREYwMTIzNDU2Nzg5IDI NMyAwIG9iag08PA0vVHlwZSA <fiascode>c9c96c67-2cc9-4f10-afde-fd32417ea216</fiascode>U3VidHlwZSAvSW1hZ2UNL1d pZHRoIDE4MDgNL0hlaWdodCA <kladrcode>3201900011100</kladrcode>ggNCAwIFINL0JpdHNQZXJDb 21wb25lbnQgMQ0vRGVjb2RlU <shortname />ENL0NvbHVtbnMgMTgwOA0+P g0vSW1hZ2VNYXNrIHRydWUNL XhEZWNvZGUNPj4Nc3RyZWFt DQ<typename /item> <coords latitem name="52photo2.6407jpg" lon="33.1724" /> </town> <town>VBERi0xLjMNAwIG9iag0HRoJ <code>114016</code> <city> <code>60</code> <name>Псковская область</name>JUBQREYwMTIzNDU2Nzg5IDI NMyAwIG9iag08PA0vVHlwZSA </city>vWE9iamVjdA0vU3VidHlwZS AvSW1hZ2UNL1dpZHRoIDEzNj <name>Сочихино деревня</name>gNL0hlaWdodCAxMzMzDS9MZ W5ndGggNCAwIFINL0JpdHNQZ <fiascode>10df7588-19c1-49d1-a387-9de1cf3eb26f</fiascode>XJDb21wb25lbnQgMQ0vRGVj b2RlUGFybXMgPDwNL0sgLTEN <kladrcode>6001900015400L0NvbHVtbnMgMTM2OA0+Pg0 vSW</kladrcodeitem> <shortname /attachments> <typename /addattachments> <coords lat="56.6003" lon="29.3542" /source> </town></townlist></source>'''Описание полей:'''
'''Пример запроса справочникаответа:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<regionlistaddattachments> <codesearchattachments> <code>77<item name="photo1.jpg" error="0" errormsg="OK" errormsgru="Успешно" /code> <item name="photo2.jpg" error="0" errormsg="OK" errormsgru="Успешно" /codesearch> <conditions/attachments> <namecontains>край</namecontainsaddattachments> <namestarts>Моск</namestartssource> == Получение вложений к накладной =='''Пример запроса:'''<fullnamesource lang="xml">Московская область</fullname?xml version="1.0" encoding="UTF-8" ?> <countryattachments>1 <auth extra="8" login="login" pass="pass" /country> <orderno>1234567</conditionsorderno></regionlistattachments>
</source>
'''Описание полей:'''
'''attachments''' — Корневой контейнер. Обязательный элемент.
* '''auth''' — Авторизация. Обязательный элемент.
* '''orderno''' — Номер/код заказа. Обязательный элемент.
'''Пример ответа:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<regionlist countattachments> <item name="doc1.docx" timestamp="2025-01-01 12:00:00" size="235654">JVBERixLjMN <city>UwLJdLwIDKxTn+AScMjKqor7Xm3sp1yj1k6BzlPdX2Qsiit6yg3g1fCI4YVAgclUOIY5tDra2LvAcIS <code>80< 5/+8PsL/sXb0+aoper/9kL/4Ov/code>YE9QsHwyg7YZTtKICy0YVIYb4Nt7L1tPUMfaX9NpuTsvFCtBAvYG <country> eJVZoZ2tm6+fZVqAavZpeLizVLtct1a+xvG0+bTSkw3Ac8PhdNfL4smrT2hSgPJLfyaVGyA2ndyW22t <code>1< sFtTP5knktPNumSZ56QsFRPJkaU8ExDxAcMYMDIoBiIoR4/dDjHMbMW/code>EW4fiB1pvWmV2ONWIl1Xdub <name>Россия< Xg1ob0qWX9W4qagsqzGhjRLsEGeJGVXg9oVC+XkJa9esrhGUmC0tuKEla+AplVO/name>OtHwXcW0FWui1z7 6KHrtobuWV0xa9sCEiSvb91w3ePHOvfcveo5xt9o4ZevHF7ZOeKxV5qmVx2MI44a1L+Mhk5YuGT12xd <id>643< Ibsb7r+j9bff/unQlv0al6HBnoD5G89q4+tkjgDtvwwARmqm2aa2Jgvmth8mrXquTNtl2u467vbF/id>5r <ShortName1>RU< vnMt9uesu21Me1bjeNJGlVfAaCtw+/ShortName1> <ShortName2>RUS<jfenJ/ShortName2>fWjqa7ygExx+L0BcTGroxrKexQXIQ1ImfEW7ZRJZa+O < ip7xJmmNESMxrgu/country>dquBbGypjJpFDJVRH1rVPR1Ifl4aFS5IEdDWZFSdyBBWKWhVSVu517ZgzOCFAwp <name>Агинский Бурятский автономный округ< wwbFph29g4fTaxnvn/name>3X78x+Tt56ZNffArgULt+HByvy7+yz6U6XWMawCi3+6gJXN0S+jf4t+HT34wg <km7/city>HDp55YTSWMoCMgZsvZkBrXtIv4WA7xgkT4YpYpxjwLvnsWKkGE+pDbxER0UUWlpVFRY4oilTfM4 <city>MIzgCPgxjOlZ87ceA7ceRJrgpipFGyugPQ4OTI2S8lWJoqTpHJlJbNOeYM7zTcoVxSNyJXiYWSAMklT <code>1< q/xd+3fd3/code>USq2V1rJ7RyBLHsuDSiLwgaOFc5LUCRGI+QWuBAsIwPlZrgRpSMseJyTzD15PKiIRE7bc <country> Rggk5ijXAPpqISetD4wVm0AD2LHuBZdaxmK3HOKIZoG0QLmiZdVqspXnFIJwVyCKhWiDCI4bzH8Y76w <code>1</code> TAnwM67HIqMISOkmJXY8mlYhpiNa7g2oTBkKxo4wgnvETQIUUrlFOn9KdOreDiKQx071rN4N61yRAi1 <name>Россия< 7EGRhSOgoeLYv+k41+KZ1SVBXAuDjB+xuxnQmm8wJDcP5IRn+5penzbR/name>ivm7qleHK5o790w8ejXchI <id>643 vOHIPWtWwYhtAO34LdDXqFqWxZEBLNstMCwwITBTWirxk12zuUppp</iditem> <ShortName1>RU</ShortName1attachments> <ShortName2>RUS</ShortName2source> </country> <name>Адыгея республика</name>В тегах item возвращаются бинарные данные (файлы), закодированные в base64. </city></regionlist>== Изменение статуса агентом ==<Запрос изменения статуса заказа позволяет установить окончательный статус заказа — «Доставлен» или «Не доставлен (Возврат/source>Отмена)».
<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?><streetlist countsetorderinfo> <auth extra="18" pagelogin="1login" totalcountpass="3pass" totalpages/> <order ordercode="1123456"> <message>Получил Иванов</message> <outstrbarcode>7654312</outstrbarcode> </order> <streetorder ordercode="234567"> <namestatus>Академика Хохлова ул.PICKUPREADY</status> <eventtime>2016-05-30 10:20:00</eventtime> <message>Клиент отказался от покупки</message> <paytype>CASH</paytype> <storeprice>123</storeprice> <items> <item code="34533" quantity="1" reason="0" governmentCode="11223311" /> <item code="34456" quantity="0" reason="0" /name> <shortnameitem code="34421" quantity="2" reason="0" />Академика Хохлова </shortnameitems> <attachments> <attachment filename="filename1.jpg">/9j/4AAQSkZJRgA BAQAAAQABAAD/2wBDAA0JCg sKCA0LCgsODg0PEyAVExISEy ccHhcgLikxMC4pLSwzOko+M zZGNywtQFdBRkxOUlNSMj5aY VpQYEpRUk//2wBDAQ4ODhMR EyYVFSZPNS01T09PT09PT09P T09PT09PT09PT09PT09PT09 PT09PT09PT09PT09PT09PT09 PT09PT0//wAARCAYACAADAS IA<typename/attachment>ул <attachment filename="filename2.jpg"> /9j/4AAQSkZJRgA BAQAAAQABAAD/2wBDAA0JCg sKCA0LCgsODg0PEyAVExISEy ccHhcgLikxMC4pLSwzOko+M zZGNywtQFdBRkxOUlNSMj5aY VpQYEpRUk//2wBDAQ4ODhMR EyYVFSZPNS01T09PT09PT09P T09PT09PT09PT09PT09PT09 PT09PT09PT09PT09PT09PT09 PT09PT0//wAARCAYACAADAS IA</attachment> </typenameattachments> </streetorder></streetlistsetorderinfo>
</source>
'''Пример запроса справочника номенклатурыответа:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8" ?><itemlistsetorderinfo> <auth extraorder ordercode="8123456" error=" login0" errormsg="loginOK" passerrormsgru="passУспешно"></auth> <codesearch> <code>123456</code> <article>FD343</article> <barcode>2345625213125</barcode> </codesearch> <conditions> <namecontains>телевизор</namecontains> <namestarts>sony</namestarts> <name>Sony KDL-55W905 ЖК-телевизор</name> <quantity>EXISTING_ONLY</quantity> </conditions> <limit> <limitfrom>30</limitfrom> <limitcount>10</limitcount> <countall>YES</countall> <order ordercode="234567" error="59" errormsg="value [date_put] is already set" errormsgru="Значение [Дата доставки] уже указано" /limit></itemlistsetorderinfo>
</source>
'''Описание полей:''' '''waybill''' — Корневой контейнер. Обязательный элемент* '''auth''' — Авторизация. Обязательный элемент*'''conditionsclient''' - Задает условия поиска — Признак клиента или агента. Все вложенные элементы одновременно накладывают условие "И"Необязательный элемент.:* CLIENT — Признак клиента, значение по умолчанию:* AGENT — Признак агента. В ответ отдается информация по заказам, переданным агенту на доставку* '''namecontainsorders''' - Поиск товаров, название которых содержит указанный текст — Список заказов для получения печатных форм.Содержит тэги '''order''' с атрибутами::* '''namestarts''orderno'' - Поиск товаров, название которых начинается с указанного текста.''' — шифр заказа:* '''name''ordercode'' - Поиск товаров, название которых соответствует указанному тексту''' — внутренний код заказа. Указывать необходимо один из атрибутов для всех заказов.Приоритет имеет атрибут '''''ordercode''''':* '''quantityform''' - Наличие на складе — Формат накладной. Не обязательный элемент. Принимает значения EXISTING_ONLY ::* 1 — Подробная накладная (по- Только в наличии, NOT_EXISTING_ONLY умолчанию):* 2 — Наклейки Zebra:* 3 — Наклейки на страницу формата А4:* 4 — Акты приема- Только не в наличии, ALL - Всепередачи* '''start''' — Имеет смысл только для form = 3. Начальная позиция первой наклейки. Используется для пропуска наклеек на листе для их экономии. * ''Это поле может быть недоступным 'integration''' - Получение наклеек от подрядчика. Не обязательный элемент, имеет смысл при наличии кода подрядчика в некоторых установкахкарточке заказа.''Принимает значение::* 21 - подрядчик GTD
'''Пример ответа:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<itemlist count="3" totalcount="3" page="1" totalpages="1"waybill> <itemintegration code="21"> <order code>123456</code="33331"> <articlecontent>FD343</article> <barcode>2345625213125JVBERi0xLjYNJeLjz9MNC...</barcodecontent> <name>Sony KDL-55W905 ЖК-телевизор</nameorder> <retprice>65000</retpriceorder code="33332"> <purchpricecontent>50000</purchprice> <weight>5JVBERi0xLjYNJeLjz9MNC...1</weightcontent> <length>50</lengthorder> <width>30 </widthintegration> <height>40 </heightcontent>EODIcaI8KSBlwQ 4MnEOR7Px8U8EBAyGICBnwpw <CountInPallet>30< IZhQgz0ZxuPs8EBM/CountInPallet>GcbjzB AwhBl8hwQYIO00GmEwg1CeEG <HasSerials>1</HasSerials> mqYTChNU0wqf8l8nz4zgc+K fCno+zwU5GjOZmzXGcbEQYIM <CountryOfOrigin>Малайзия</CountryOfOrigin> (not yet supported) 4zkegRE40zWzONyoNNMIOIa cWnp6aDCGEGE9NQmoQd2mg00 <Message>Хороший телевизор< 79U4f3hPTwnfp6Sdrafeqpa JDpFw/Message>1aYT077VNNNdO00G3q <Message2>Снова хороший телевизор< mqqvp9p2E7T0/Message2> <quantity>12wiFemv8uG6 OM</quantitycontent> <reserved>3</reserved> <item> ...</itemlistwaybill>
</source>
'''Пример запроса движения номенклатуры:Обратите внимание'''<source lang="xml"><?xml version="1Лимит количества при единовременном получении печатных форм - 1000 штук.0" encoding="UTFЕсли нужно получить больше -8" ?>делайте это несколькими запросами.<itemmovements> <auth extra="8" login="login" pass="pass"></auth> <code>4259</code></itemmovements></source>'''Обратите внимание''' Печатные формы для заборов не формируются.
'''Пример ответа с ошибкой:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<waybill>
<error>Текст ошибки</error>
</waybill>
</source>
== Справочник городов =='''Пример ответа движения номенклатурызапроса справочника городов:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8" ?><itemmovements count="16"townlist> <itemmovement> <code>151500<auth extra="8" /code> <date>2017-05-26 </datecodesearch> <retpricezipcode>0110000</retpricezipcode> <quantitykladrcode>10100000100800</quantitykladrcode> <deliveredfiascode>0bd21979d-46f8-49d0-9105-e8d65172a983</deliveredfiascode> <item> <code>4259123</code> <name>Настольная игра Дженга </namecodesearch> </itemconditions> <statuscity> <code>5Краснодарский край</codecity> <namenamecontains>Возврат от покупателяновгород</namenamecontains> <namecontainsparts>молоково моск</statusnamecontainsparts> <storenamestarts> <code>1Моск</codenamestarts> <name>офис в МосквеМосква</name> </store> <order> <ordercodefullname>3374830Москва город</ordercodefullname> <number>123660-0</number> <date>2017-05-24</date> <orderno>14123</orderno> <barcodecountry>0000000670</barcode> <company>ТОВАР</company> <address>Кравченко ул., 1</addresscountry> <delivereddate>2017-05-29 </delivereddateconditions> <deliveredtime>12:00:00</deliveredtimelimit> <deliveredto /limitfrom> 30</orderlimitfrom> <documentlimitcount> <code>2199110</codelimitcount> <number>318 </numbercountall> <date>2017-05-26</date> <message></message> YES</documentcountall> </itemmovementslimit></itemlisttownlist>
</source>
*'''itemauth''' - контейнер товара:* '''code''' - внутренний код товара:* '''name''' - наименование товара — Авторизация, необязательный элемент. Используется в случае включенного и настроенного ограничения по населенным пунктам в конкретной курьерской службе.
*'''statuscodesearch''' — Поиск по кодам. В случае использования — контейнеры conditions и limit игнорируются.:* '''zipcode''' — Поиск по индексу. Обратите внимание на то, что один почтовый индекс может распространяться на несколько населенных пунктов. В этом случае система вернет несколько записей.:* '''kladrcode''' — Поиск по 13- контейнер статуса операциити значному коду КЛАДР.:* '''codefiascode''' - код статуса — Поиск по коду ФИАС (AOGUID).:* '''namecode''' - наименование — Поиск по коду в системе.
*'''storeconditions''' - контейнер филиала — Задает условия поиска. Все вложенные элементы одновременно накладывают условие «И».:* '''city''' — Поиск по всем населенным пунктам региона.:* '''namecontainsparts''' — Поиск населенных пунктов, название которых содержит все указанные слова, с разбиением поисковой фразы через пробел. Например "моск моло" найдет деревню "Молоково" в Московской области.:* '''namecontains''' — Поиск населенных пунктов, к которому относится операцияназвание которых содержит указанный текст.:* '''codenamestarts''' - код филиала — Поиск населенных пунктов, название которых начинается с указанного текста.:* '''name''' — Поиск населенных пунктов, название которых соответствует указанному тексту.:* '''fullname''' — Поиск населенных пунктов, название вместе с типом населенного пункта которых соответствует указанному тексту.:* '''country''' — Поиск только по стране с указанным внутренним кодом или текстовым кодом в соответствии [https://ru.wikipedia.org/wiki/ISO_3166- наименование филиала1 стандартом ISO_3166-1], например, «RU», «RUS» для России.
*'''orderlimit''' - контейнер корреспонденции — Ограничивает вывод результата.:* '''ordercode''' - внутренний код заказа:* 'limitfrom''number''' - — Задает номер заказа:* '''date''' записи результата, начиная с которой выдавать ответ. По- дата заказаумолчанию — 0.:* '''ordernolimitcount''' - шифр:* '''barcode''' Задает количество записей результата, которые нужно вернуть. По- штрих-кодумолчанию — 10000.:* '''companycountall''' - компания:* '''address''' - адрес:* '''delivereddate''' - дата вручения:* '''deliveredtime''' - время вручения:* '''deliveredto''' - данные о вручении, либо причина недоставки — YES указывает на необходимость подсчета общего количества найденных совпадений. Это может замедлять выполнение запроса. Если отключено — в ответе не указываются totalcount и totalpages.
<source lang="xml">
<?xml version="1.0" encoding="UTF-8" ?><pvzlist> <auth extratownlist count="3" page="81" logintotalcount="login3" passtotalpages="pass1"> </authtown> <code>123426379</code> <town>Нижний Тагил </towncity> <parentcodecode>623</parentcodecode> <acceptcashname>YESКраснодарский край</acceptcashname> <acceptcard>YES </acceptcardcity> <acceptfittingname>YESСочи город</acceptfittingname> <maxweightfiascode>3079da737a-603b-4c19-9b54-9114c96fb912</maxweightfiascode> <acceptindividualskladrcode>YES2300000700000</acceptindividualskladrcode> <lt>57.924737 <shortname /lt> <lg>59.940019</lg>(not yet supported) <rt>57.905682 <typename /rt> <rg>59.984669</rg>(not yet supported) <json>YES </json></pvzlist></source> *'''auth''' - Атрибут '''extra''' - обязателен, по нему определяется курьерская служба, '''login''' и '''pass''' позволяют авторизоваться под клиентом: для отдельного клиента могут быть ограничения по доступности некоторых ПВЗ, и в этом случае они будут учтены.*'''code''' - Внутренний код.*'''town''' - Город получателя.*'''parentcode''' - Фильтр по родительскому элементу*'''acceptcash''' - Фильтр по приему наличных YES/NO*'''acceptcard''' - Фильтр по приему банковских карт YES/NO*'''acceptfitting''' - Фильтр по наличию примерки YES/NO*'''maxweight''' - Фильтр по максимальному весу, с которым работает ПВЗ*'''acceptindividuals''' - Фильтр по доступности физическим лицам YES/NO*'''lt''' - Широта левого верхнего угла*'''lg''' - Долгота левого верхнего угла*'''rt''' - Широта правого нижнего угла*'''rg''' - Долгота правого нижнего угла*'''json''' - Признак вывода ответа в виде JSON YES/NO '''Пример ответа справочника пунктов самовывоза:'''<source langcoords lat="xml43.5855"><?xml versionlon="139.07231" encoding="UTF-8" ?/> <pvzlist count="2"/town> <pvztown> <code>12640331</code> <clientcode>3</clientcodecity> <namecode>Нижний Тагил32</namecode> <parentcodename>6Брянская область</parentcodename> <parentname>Интеграция</parentnamecity> <town code="124267" regioncode="66" regionname="Свердловская область"name>Нижний Тагил городСочилов хутор</townname> <addressfiascode>622036, г. Нижний Тагил, ул. Циолковского, д. 17c9c96c67-2cc9-4f10-afde-fd32417ea216</addressfiascode> <phonekladrcode>+73435417709, +734352549893201900011100</phonekladrcode> <comment>Новый пункт доставки<shortname /comment> <worktime>Вс 10:00-16:00, Сб 10:00-16:00, Пн-Пт 10:00-20:00<typename /worktime> <traveldescription>Жилое 5-ти этажное здание, торцом к дороге, второе здание от перекрестка Пархоменко-Циолковского<coords lat="52.6407" lon="33.1724" /traveldescription> <maxweight>10 </maxweighttown> <acceptcash>YES</acceptcashtown> <acceptcardcode>YES114016</acceptcardcode> <acceptfitting>YES</acceptfittingcity> <acceptindividualscode>YES60</acceptindividualscode> <latitudename>57.93457Псковская область</latitudename> <longitude>59.95131</longitude> </pvz> <pvzcity> <codename>245Сочихино деревня</codename> <clientcodefiascode>NTG110df7588-19c1-49d1-a387-9de1cf3eb26f</clientcodefiascode> <namekladrcode>На Красноармейской6001900015400</namekladrcode> <parentcode>6<shortname /parentcode> <parentname>Интеграция<typename /parentname> <town codecoords lat="12426756.6003" regioncodelon="66" regionname="Свердловская область29.3542"/>Нижний Тагил город </town> <address/townlist>КРАСНОАРМЕЙСКАЯ, д.79</addresssource> <phone>+7В ответе города сортируются по популярности, важности (3435районные центры и т. д.)379-044</phone>, и только затем — по алфавиту. == Справочник регионов =='''Пример запроса справочника:''' <comment>Возможность примерки отсутствует</commentsource lang="xml"> <worktime>Вс 10:00?xml version="1.0" encoding="UTF-16:00, Сб 10:00-16:00, Пн-Пт 10:00-20:00</worktime8"?> <traveldescriptionregionlist>Напротив ТЦ Пирамида </traveldescriptioncodesearch> <maxweightcode>2077</maxweightcode> <acceptcash>YES </acceptcashcodesearch> <acceptcard>YES </acceptcardconditions> <acceptfittingnamecontains>NOкрай</acceptfittingnamecontains> <acceptindividualsnamestarts>YESМоск</acceptindividualsnamestarts> <latitudefullname>57.93468Московская область</latitudefullname> <longitudecountry>60.55476RU</longitudecountry> </pvzconditions></pvzlistregionlist>
</source>
<source lang="xml">
<?xml version="1.0" encoding="UTF-8" ?><receiptdata> <auth extraregionlist count="8" login="test" pass=2"testm" /> <orderscity> <order orderno="123456" /code> 80<order orderno="890111C" /code> </orderscountry> </receiptdatacode>1</sourcecode> '''Пример ответа получения фискальных данных:''' <source lang="xml"><?xml version="1.0" encoding="UTF-8" ?><receipts count="1"> <receiptname> <fdDatetime>2020-06-07 12:14:00Россия</fdDatetimename> <fdValueid>123643</fdValueid> <fdNumShortName1>456RU</fdNumShortName1> <fnSnShortName2>789RUS</fnSnShortName2> <kktNum>100</kktNumcountry> <innname>222Агинский Бурятский автономный округ</innname> <ofdUrl>gate.ofd.ru </ofdUrlcity> <fullUrl>https://check.ofd.ru/123 </fullUrlcity> <summcode>123451</summcode> <lines count="2"country> <linecode> <item>11117641</itemcode> <name>СапогиРоссия</name> <qntid>1643</qntid> <priceShortName1>1000RU</priceShortName1> <VATrateShortName2>20RUS</VATrateShortName2> <ItemType>1 </ItemTypecountry> </linename> Адыгея республика</linesname> </receiptcity></receiptsregionlist>
</source>
<source lang="xml">
<?xml version="1.0" encoding="UTF-8" ?><servicesstreetlist> <auth extra="8"/conditions> </servicestown>Москва город</sourcetown> // ОБЯЗАТЕЛЬНОЕ ПОЛЕ! '''Пример ответа справочника Видов срочности:''' <source lang="xml"namecontains>Хохло<?xml version="1.0" encoding="UTF-8" ?/namecontains> <services count="2"namestarts> Академика Х<service/namestarts> <codename>1Академика Хохлова</codename> <namefullname>ЭкономАкадемика Хохлова ул.</namefullname> </serviceconditions> <servicelimit> <limitfrom>30</limitfrom> <codelimitcount>210</codelimitcount> <namecountall>СрочноYES</namecountall> </servicelimit></servicesstreetlist>
</source>
* '''conditions''' — Задает условия поиска. Все вложенные элементы одновременно накладывают условие «И».
:* '''town''' — Обязательное поле. Название или код населенного пункта.
:* '''namecontains''' — Поиск улиц, название которых содержит указанный текст.
:* '''namestarts''' — Поиск улиц, название которых начинается с указанного текста.
:* '''name''' — Поиск улиц, название которых соответствует указанному тексту.
:* '''fullname''' — Поиск улиц, для которых название вместе с типом соответствует указанному тексту.
'''Пример запроса дополнительных услугответа:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<advprices> <auth extrastreetlist count="1" page="81" logintotalcount="login3" passtotalpages="pass1" > <street> <code>124</code> <name>Академика Хохлова ул.</name> <shortname>Академика Хохлова</shortname> <typename>ул.</typename> </street></advpricesstreetlist>
</source>
В ответе улицы сортируются по алфавиту. == Справочник номенклатуры =='''Пример ответа запроса справочника дополнительных услугноменклатуры:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8" ?>
<advpricesitemlist> <advpriceauth extra="8" login="login" pass="pass"></auth> <codesearch> <code>1123456</code> <namearticle>Этажей в домеFD343</namearticle> <typebarcode>int2345625213125</typebarcode> </advpricecodesearch> <conditions> <advpricenamecontains>телевизор</namecontains> <codenamestarts>2sony</codenamestarts> <name>Коэффициент надбавкиSony KDL-55W905 ЖК-телевизор</name> <typequantity>floatEXISTING_ONLY</typequantity> <store>2</advpricestore> <advprice/conditions> <except> <code>3123478</code> </except> <namelimit> <limitfrom>30</limitfrom> <limitcount>Расписаться на упаковке10</namelimitcount> <typecountall>boolYES</typecountall> </advpricelimit></advpricesitemlist>
</source>
* '''Пример запроса стоимости доставки:limit'''<source lang="xml"><?xml version="1 — Ограничивает вывод результата.0" encoding="UTF-8" ?><calculator> <auth extra="8" login="login" pass="pass" /> <calc townfrom="Москва" addressfrom="Ленинский проспект:* '''limitfrom''' — Задает номер записи результата, 95"начиная с которой выдавать ответ. zipcode="664000" townto="3800000300000" addressto="Ленина ул.:* '''limitcount''' — Задает количество записей результата, 10" l="10" w="20" h="30" mass="3которые нужно вернуть.7" service="1" price="1200" inshprice="1200" paytype="CASH" /></calculator></source>
<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<calculatoritemlist count="3" totalcount="3" page="1" totalpages="1"> <calcitem> <townfrom code="1">Москва город123456</townfromcode> <townto code="56603"article>Иркутск городFD343</towntoarticle> <massbarcode>3.72345625213125</massbarcode> <service name="Экспресс">Sony KDL-55W905 ЖК-телевизор</name> <retprice>65000</retprice> <purchprice>50000</purchprice> <weight>5.1</serviceweight> <length>50</length> <width>30</width> <height>40</height> <VATrate>20</VATrate> <CountInPallet>30</CountInPallet> <zoneCountInBox>2</zoneCountInBox> <priceHasSerials>11631</priceHasSerials> <mindeliverydaysCountryOfOrigin>Малайзия</CountryOfOrigin>1 (not yet supported) <Message>Хороший телевизор</Message> <Message2>Снова хороший телевизор</mindeliverydaysMessage2> <maxdeliverydaysquantity>312</maxdeliverydaysquantity> <mindeliverydatereserved>2020-05-133</mindeliverydatereserved> </calcitem> ...</calculatoritemlist>
</source>
<source lang="xml">
<?xml version="1.0" encoding="UTF-8" ?>
<smalistitemmovements> <auth extra="8" login="login" pass="pass" ></auth> <code>4259</code> <datefrom>20162020-0210-1001</datefrom> <dateto>20162020-0310-1002</dateto></smalistitemmovements>
</source>
'''Пример ответа на запрос списка актов передачи денегдвижения номенклатуры:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?><smalist itemmovements count="116"> <smaitemmovement> <code>6278151500</code> <numberdate>39922017-05-26</numberdate> <actdateretprice>2016-02-120</actdateretprice> <datepayquantity>1</datepayquantity> <datetodelivered>2016-02-120</datetodelivered> <promiseddatepayitem> <code>4259</code> <name>Настольная игра Дженга</name> </promiseddatepayitem> <pricestatus> <code>5</code> <name>Возврат от покупателя</name>637.00 </pricestatus> <pricecorrstore> <code>1</code> <name>офис в Москве</name>113.00 </pricecorrstore> <rurorder> <ordercode>3374830</ordercode> <number>123660-0</number> <date>2017-05-24</date> <orderno>14123</orderno> <barcode>0000000670</barcode> <company>ТОВАР</company>13430 <address>Кравченко ул., 1</address> <delivereddate>2017-05-29</delivereddate> <deliveredtime>12:00:00</rurdeliveredtime> <pricekurdeliveredto />570.00 </pricekurorder> <priceagdocument> <code>67.0021991</priceagcode> <paynonumber>42423318</paynonumber> <paytypedate>12017-05-26</paytypedate> <message><paytypename/message>Безнал </paytypenamedocument> <signedcopyreceivedserials> <serial>NO123456789</serial> </signedcopyreceivedserials> </smaitemmovements></smalistitemlist>
</source>
* '''status''' — контейнер статуса операции:* '''code''' — код статуса:* '''name''' — наименование * '''store''' — контейнер филиала, к которому относится операция:* '''code''' — код филиала:* '''name''' — наименование филиала * '''order''' — контейнер корреспонденции:* '''ordercode''' — внутренний код заказа:* '''number''' — номер заказа:* '''date''' — дата заказа:* '''orderno''' — шифр:* '''barcode''' — штрихкод:* '''company''' — компания:* '''address''' — адрес:* '''delivereddate''' — дата вручения:* '''deliveredtime''' — время вручения:* '''deliveredto''' — данные о вручении, либо причина недоставки * '''document''' — контейнер документа операции:* '''code''' — внутренний код документа:* '''number''' — номер документа:* '''extnumber''' — внешний номер документа:* '''date''' — дата документа:* '''message''' — комментарий * '''serials''' — контейнер серийных номеров:* '''serial''' — серийный номер единицы номенклатуры, участвующей в движении == Серийные номера =='''Пример запроса детализации актов передачи денегдвижения номенклатуры с серийным номером:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8" ?>
<smadetailserialmovements> <auth extra="8" login="login" pass="pass" ></auth> <codeserial>6278123456789</codeserial></smadetailserialmovements>
</source>
'''Пример ответа на запрос детализации актов передачи денегдвижения номенклатуры с серийным номером:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?><smadetail serialmovements count="216"> <specialsmaserialmovement> <code>42494151500</code> <ordercodeserial>123456789</serial> <date>2017-05-26</date> <delivered>0</delivered> <item> <code>4259</code> <name>Настольная игра Дженга</name>14424 </ordercodeitem> <ordernostatus> <code>5</code> <name>Возврат от покупателя</name>11111 </ordernostatus> <orderdateorder> <ordercode>3374830</ordercode>2018 <number>123660-01-010</orderdatenumber> <delivereddatedate>20182017-1005-0124</delivereddatedate> <orderno>14123</orderno> <barcode>0000000670</barcode> <company>КомпанияТОВАР</company> <priceaddress>314Кравченко ул., 1</address> <delivereddate>2017-05-29</delivereddate> <deliveredtime>12:00:00</deliveredtime> <deliveredto /> </priceorder> <rurdocument>8800.00 <code>21991</code> <number>318</number> <date>2017-05-26</rurdate> <inshpricemessage>314.00</inshpricemessage> <pricekur/document>270.00 </pricekurserialmovement> <priceag/serialmovements>44.00</priceagsource> ''' Описание полей ответа ''' Описание аналогично описанию полей [[#Движение номенклатуры|движения номенклатуры]] == Серийные номера по заказу =='''Пример запроса движения серийных номеров заказа:'''<pricecalcsource lang="xml">8486<?xml version="1.000" encoding="UTF-8" ?></pricecalcorderserials> <paytypeauth extra="8" login="login" pass="pass">2</paytypeauth> <paytypenameordercode>наличными курьером123456789</paytypenameordercode> <statusorderno>Доставлено123456789</statusorderno> <barcode>123456789</specialsmabarcode></smadetailorderserials>
</source>
*'''codeordercode''' - Код записи — внутренний код заказа.*'''ordercodeorderno''' - Код — шифр заказа.*'''ordernobarcode''' — штрих- Шифр код заказа.*'''orderdate''' - Дата Указывать необходимо один из идентификаторов заказа.* '''delivereddateПример ответа движения серийных номеров заказа:''' - Дата доставки.*'''company''' - Получатель<source lang="xml"><?xml version="1.*'''price''' 0" encoding="UTF- Стоимость услуг.8" ?>*'''rur''' - Сумма заказа.<orderserials>*'''inshprice''' - Стоимость заказа. <order>*'''pricekur''' <code>3374830</code> <orderno>14123</orderno> <barcode>0000000670</barcode> <delivereddate>2024- Стоимость курьерской доставки.*'''priceag''' 07- Агентское вознаграждение.20</delivereddate>*'''pricecalc''' <deliveredtime>10:04:00</deliveredtime> <assemblydate>2024- Сумма для передачи агенту.*'''paytype''' 07- Тип оплаты19 07:05: 1 - безнал, 2 - наличными курьером, 3 - наличными в офисе, 4 - перевод на карту.34</assemblydate>*'''paytypename''' - Строковое представление типа оплаты </order>*'''status''' - Статус заказа. <items> <item>== Генерация коротких ссылок == <code>4259</code> <name>Настольная игра Дженга</name>В некоторых случаях, например, при использовании в СМС, может потребоваться использование коротких ссылок на ЛК. <article>123000</article> <state>Delivered</state> <serials>Для этого, необходимо отправить запрос с полной ссылкой, в ответ на который придёт хэш-код для ссылки. <serial>123456789</serial> </serials> </item> </items></orderserials></source> '''Пример запроса генерации коротких ссылок:Описание полей ответа '''<source lang="xml"><?xml version="1.0" encoding="UTF* '''order''' — блок заказа::* '''code''' — код:* '''orderno''' — шифр:* '''barcode''' — штрих-8" ?>код<shortlink>:* '''delivereddate''' — дата доставки факт <link short="0"> https://home.courierexe.ru/8/site/orders </link></shortlink></source> * '''shortlinkdeliveredtime''' - Корневой контейнер. Обязательный элемент. — время доставки факт:* '''assemblydate''' — дата сборки *'''linkitem''' - Полная ссылка, для которой необходимо получить код. Обязательный элемент. Если атрибут — блок товара::* '''shortcode''' равен 1, то ответ не будет содержать XML, а только хэш-код. — код:* '''name''' — наименование:* '''article''' — артикул:* '''state''Пример ответа на запрос генерации коротких ссылок' — статус Доставлено (Delivered) или Возвращено (Returned):* '''serials''' — блок серийных номеров по заказу == Получение справочника тарифов по городам == '''Пример запроса справочника тарифов по городам'''<source lang="xml"><?xml version="1.0" encoding="UTF-8"?><tariffs> <auth extra="8" login="login" pass="pass" /> <townfrom>Москва</townfrom> <service>1</service> <mainonly>1</mainonly> </tariffs></source> * '''auth''' — атрибут '''extra''' обязателен, по нему определяется курьерская служба.* '''townfrom''' — город-отправитель. Если не передан, то городом будет «Москва».* '''service''' — режим доставки. Обязательный элемент.* '''mainonly''' — необязательный элемент. Если передан, то в ответе будут данные только по городам из справочника '''Межгород''' > '''Зоны'''. Важно понимать, что в ответе отдаются только тарифы, указанные в разделе "Тарифы по зонам" раздела "Межгород" в офисной системе курьерской службы, т.е. считающихся междугородними. Доставка до городов, рассчитываемая по внутригородским тарифам, в ответе НЕ ОТДАЕТСЯ! '''Пример ответа справочника тарифов по городам'''<source lang="json">{ "townfrom": "0c5b2444-70a0-4932-980c-b4dc0d3f02b5", "service": 1, "tariffs": [ { "towntofias": "0c5b2444-70a0-4932-980c-b4dc0d3f02b5", "towntocode": 1, "towntoname": "Москва город", "townregion": "Город Москва", "distance": 0, "pricedistance": 0, "pricesnew": { "before": [ { "price": 100, "every": 0, "mass": 1 }, { "price": 150, "every": 0, "mass": 5 } ], "after": [ { "price": 0, "every": 1, "mass": 38.01 }, { "price": 15, "every": 1, "mass": 51.01 } ] }, "deliveryPeriodMin": 1, "deliveryPeriodMax": 2 } ]}</source> ''' Описание полей ответа '''* '''townfrom''' — код ФИАС города-отправителя.* '''service''' — режим доставки.* '''tariffs''' — cписок тарифов по городу.:* '''townregion''' — регион города-получателя.:* '''towntofias''' — код ФИАС города-получателя.:* '''towntocode''' — внутренний код города-получателя.:* '''towntoname''' — наименование города-получателя.:* '''distance''' — дистанция в км до города от МКАД, если в запросе townfrom — Москва.:* '''pricedistance''' — сумма за километраж до города от МКАД, если в запросе townfrom — Москва.:* '''pricesnew''' — ваши настройки тарифов из справочника '''Межгород''' > '''Тарифы по зонам'''.::* '''before/after''' — контейнеры ДО/ОТ.:::* '''price''' — цена. Если ответ идет по «before», то в цену также плюсуется сумма pricedistance:::* '''every''' — за каждые.:::* '''mass''' — масса.:* '''prices''' — устаревший элемент, не используется.:* '''deliveryPeriodMin''' — минимальный срок доставки.:* '''deliveryPeriodMax''' — максимальный срок доставки. == Номенклатура приходной накладной =='''Пример запроса номенклатуры приходной накладной:'''<source lang="xml"><?xml version="1.0" encoding="UTF-8" ?><itemdoc> <auth extra="8" login="login" pass="pass"></auth> <code>21991</code></itemdoc></source> * '''code''' — внутренний код документа приходной накладной (см. предыдущий запрос). '''Пример ответа движения номенклатуры:'''<source lang="xml"><?xml version="1.0" encoding="UTF-8" ?><itemdoc> <code>21991</code> <number>318</number> <date>2017-05-26</date> <message></message> <items> <item code="4259" quantity="1" barcode="200300" article="123555">Настольная игра Дженга</item> </items></itemdoc></source> ''' Описание полей ответа '''* '''code''' — внутренний код приходной накладной* '''number''' — номер документа* '''date''' — дата документа* '''message''' — комментарий * '''item''' — контейнер товара:* '''code''' — внутренний код товара:* '''barcode''' — штрихкод товара:* '''article''' — артикул товара:* '''quantity''' — количество поступившего товара == Справочник филиалов =='''Пример запроса списка филиалов:'''<source lang="xml"><?xml version="1.0" encoding="UTF-8" ?><storelist> <auth extra="8"></auth> <json>YES</json> <client_code>7890</client_code></storelist></source> * '''auth''' — Атрибут '''extra''' — обязателен, по нему определяется курьерская служба* '''json''' — Признак вывода ответа в виде JSON YES/NO* '''client_code''' — Код клиента курьерской службы '''Пример ответа:'''<source lang="xml"><?xml version="1.0" encoding="UTF-8" ?><storelist count="2"> <store> <code>123</code> <name>ABC</name> </store> <store> <code>456</code> <name>Филиал 2</name> </store></storelist></source> * '''code''' — Код филиала.* '''name''' — Наименование филиала. == Справочник пунктов самовывоза ==Для отображения списка пунктов выдачи (ПВЗ) есть '''готовый JavaScript модуль''': https://home.courierexe.ru/js/measoft_map.js Инструкция по использованию — внутри. Посмотреть пример работы можно [https://home.courierexe.ru/pvz_test.html Здесь] Уникальные запросы списка ПВЗ кешируются на стороне личного кабинета и хранятся до 7 часов утра по московскому времени следующего дня. Например, если уникальный запрос с массой 2 кг был отправлен сегодня в 10 часов, то завтра в 7 утра он сбросится. Если сегодня в 18 часов в этом же запросе вы укажете массу 2 кг, в ответе вернется тот же список ПВЗ. Если передадите массу 3 кг, список может быть другим. Обратите внимание, что если в выборке количество ПВЗ больше '''10000''' и не указаны параметры '''code''', '''json''' или '''limitcount''', то будет возвращаться ошибка. В этом случае необходимо использовать блок '''limit'''. '''Пример запроса пунктов самовывоза:'''<source lang="xml"><?xml version="1.0" encoding="UTF-8" ?><pvzlist> <auth extra="8" login="login" pass="pass"></auth> <code>1234</code> <client_code>7890</client_code> <city>Свердловская область</city> <town regioncode="66" country="RU">Нижний Тагил</town> <address>Щёлковское шоссе</address> <house>77</house> <advanced_search>Строка поиска</advanced_search> <parentcode>6</parentcode> <acceptcash>YES</acceptcash> <acceptcard>YES</acceptcard> <acceptfitting>YES</acceptfitting> <maxweight>30</maxweight> <acceptindividuals>YES</acceptindividuals> <respstores>YES</respstores> <lt>57.924737</lt> <lg>59.940019</lg> <rt>57.905682</rt> <rg>59.984669</rg> <json>YES</json> <with_coords>YES</with_coords> <limit> <limitfrom>30</limitfrom> <limitcount>2</limitcount> <countall>YES</countall> </limit></pvzlist></source> * '''auth''' — Атрибут '''extra''' — обязателен, по нему определяется курьерская служба, '''login''' и '''pass''' позволяют авторизоваться под клиентом: для отдельного клиента могут быть ограничения по доступности некоторых ПВЗ, и в этом случае они будут учтены.* '''code''' — Внутренний код, целое число.* '''client_code''' — Код клиента курьерской службы.* '''city''' — Регион получателя. Можно указать код региона или полное наименование региона из [[#Справочник регионов|справочника регионов]].* '''town''' — Город получателя.Для тега города '''town''' можно указать код региона в атрибуте '''''regioncode''''' из [[#Справочник регионов|справочника регионов]]. Поиск будет производиться в указанном регионе. Также можно указать страну получателя в атрибуте '''''country''''' в соответствии с [https://ru.wikipedia.org/wiki/ISO_3166-1 стандартом ISO_3166-1], например, «RU», «RUS» или «643» для России.Для формата запроса JSON фильтрация по городу работает только в связке с фильтром по адресу. * '''address''' — Фильтр по адресу, работает только в связке с фильтром по городу* '''house''' — Фильтр по номеру дома, работает только в связке с фильтрами по адресу и городу* '''advanced_search''' — Фильтр по коду агента, наименованию, телефону или комментарию* '''parentcode''' — Фильтр по родительскому [[#Справочник филиалов|филиалу]]* '''acceptcash''' — Фильтр по приему наличных YES/NO* '''acceptcard''' — Фильтр по приему банковских карт YES/NO* '''acceptfitting''' — Фильтр по наличию примерки YES/NO* '''maxweight''' — Фильтр по максимальному весу, с которым работает ПВЗ* '''acceptindividuals''' — Фильтр по доступности физическим лицам YES/NO* '''respstores''' - Признак вывода ответственных филиалов при значении YES* '''lt''' — Широта левого верхнего угла* '''lg''' — Долгота левого верхнего угла* '''rt''' — Широта правого нижнего угла* '''rg''' — Долгота правого нижнего угла* '''json''' — Признак вывода ответа в виде JSON YES/NO* '''with_coords''' — Признак вывода ПВЗ только с наличием координат YES/NO* '''limit''' — Ограничивает вывод результата.:* '''limitfrom''' — Задает номер записи результата, начиная с которой выдавать ответ. По-умолчанию — 0.:* '''limitcount'''- Задает количество записей результата, которые нужно вернуть. По-умолчанию — 100.:* '''countall''' — YES указывает на необходимость подсчета общего количества найденных совпадений. Это может замедлять выполнение запроса. Если отключено — в ответе не указываeтся totalcount. '''Пример ответа справочника пунктов самовывоза:'''<source lang="xml"><?xml version="1.0" encoding="UTF-8" ?><pvzlist count="2" totalcount="40465"> <pvz> <code>126</code> <clientcode>3</clientcode> <name>Нижний Тагил</name> <parentcode>6</parentcode> <parentname>Интеграция</parentname> <town code="124267" regioncode="66" regionname="Свердловская область">Нижний Тагил город</town> <address>622036, г. Нижний Тагил, ул. Циолковского, д. 17</address> <phone>+73435417709, +73435254989</phone> <comment>Новый пункт доставки</comment> <worktime>Вс 10:00-16:00, Сб 10:00-16:00, Пн-Пт 10:00-20:00</worktime> <traveldescription>Жилое 5-ти этажное здание, торцом к дороге, второе здание от перекрестка Пархоменко-Циолковского</traveldescription> <maxweight>10</maxweight> <acceptcash>YES</acceptcash> <acceptcard>YES</acceptcard> <acceptfitting>YES</acceptfitting> <acceptindividuals>YES</acceptindividuals> <latitude>57.93457</latitude> <longitude>59.95131</longitude> <uid>40606d00-9c51-11eb-b2c9-cfd6c1111392</uid> </pvz> <pvz> <code>245</code> <clientcode>NTG1</clientcode> <name>На Красноармейской</name> <parentcode>6</parentcode> <parentname>Интеграция</parentname> <town code="124267" regioncode="66" regionname="Свердловская область">Нижний Тагил город</town> <address>КРАСНОАРМЕЙСКАЯ, д.79</address> <phone>+7(3435)379-044</phone> <comment>Возможность примерки отсутствует</comment> <worktime>Вс 10:00-16:00, Сб 10:00-16:00, Пн-Пт 10:00-20:00</worktime> <traveldescription>Напротив ТЦ Пирамида</traveldescription> <maxweight>20</maxweight> <acceptcash>YES</acceptcash> <acceptcard>YES</acceptcard> <acceptfitting>NO</acceptfitting> <acceptindividuals>YES</acceptindividuals> <latitude>57.93468</latitude> <longitude>60.55476</longitude> <uid>41116853-9c51-11eb-b2c9-cfd6c1451392</uid> </pvz></pvzlist></source> * '''code''' — Код ПВЗ в системе. Используется в запросе [[API#Оформление заказа|оформления заказов]]* '''clientcode''' — Код ПВЗ используемый компанией-подрядчиком.* '''name''' — Наименование ПВЗ.* '''parentcode''' — Код родительского элемента.* '''parentname''' — Наименование родительского элемента.* '''town''' — Населенный пункт с кодом из [[#Справочник городов|справочника городов]], а также с кодом и наименованием региона.* '''address''' — Адрес ПВЗ.* '''phone''' — Телефоны ПВЗ.* '''comment''' — Дополнительная информация.* '''worktime''' — Режим работы ПВЗ.* '''traveldescription''' — Описание местонахождения ПВЗ или пути к нему.* '''maxweight''' — Максимальный вес, с которым работает ПВЗ.* '''acceptcash''' — Признак приема наличных* '''acceptcard''' — Признак приема банковских карт* '''acceptfitting''' — Наличие примерки* '''latitude''' — Широта* '''longitude''' — Долгота* '''uid''' — Уникальный идентификатор ПВЗ в системе Measoft. Создается автоматически при получении данных о ПВЗ от агентов.* '''count''' — Количество записей в ответе* '''totalcount''' — Общее количество записей, отвечающее параметрам запроса == Получение фискальных данных заказа =='''Пример запроса получения фискальных данных:'''<source lang="xml"><?xml version="1.0" encoding="UTF-8"?><receiptdata> <auth extra="8" login="login" pass="pass" /> <orders> <order orderno="123456" /> <order orderno="890111C" /> </orders></receiptdata> </source> '''Пример ответа получения фискальных данных:'''<source lang="xml"> <?xml version="1.0" encoding="UTF-8"?><receipts count="1"> <receipt> <orderno>123456</orderno> <fdDatetime>2020-06-07 12:14:00</fdDatetime> <fdValue>123</fdValue> <fdNum>456</fdNum> <fnSn>789</fnSn> <kktNum>100</kktNum> <inn>222</inn> <ofdUrl>gate.ofd.ru</ofdUrl> <fullUrl>https://check.ofd.ru/123</fullUrl> <price>12345</price> <payType>2</payType> <lines count="1"> <line> <item>1111764</item> <name>Сапоги</name> <extcode>27113415</extcode> <qty>1</qty> <price>1000</price> <vatRate>20</vatRate> <governmentCode>Z16513LK2</governmentCode> <itemType>1</itemType> </line> </lines> </receipt></receipts></source> Параметры ответа:* '''orderno''' — Номер заказа* '''fdDatetime''' — Дата и время пробития фискального чека* '''fdValue''' — ФПД (фискальный признак документа)* '''fdNum''' — ФИСКАЛЬНЫЙ ДОКУМЕНТ (фискальный номер чека)* '''fnSn''' — ФН (номер фискального накопителя)* '''kktNum''' — РН (регистрационный номер кассы)* '''inn''' — ИНН* '''ofdUrl''' — URL адрес (доменное имя) ОФД* '''price''' — Сумма чека* '''paytype''' — Тип оплаты чека. Принимает значения::* CASH — Наличными (по-умолчанию):* CARD — Безналичным способом* '''fullUrl''' — URL чека для просмотра онлайн* '''lines''' — Позиции чека:* '''item''' — код товара:* '''name''' — наименование товара:* '''extcode''' — код товара во внешних системах:* '''qty''' — количество товара:* '''price''' — цена товара:* '''governmentCode''' — считанная последовательность, которая в дальнейшем преобразуется по алгоритму тега 1162:* '''vatRate''' — НДС товара:* '''itemType''' — тип товара (товар, доставка и т. д.) == Справочник Виды срочности =='''Пример запроса видов срочности:'''<source lang="xml"><?xml version="1.0" encoding="UTF-8" ?><services><auth extra="8"/></services></source> '''Пример ответа справочника видов срочности:'''<source lang="xml"><?xml version="1.0" encoding="UTF-8" ?><services count="2"> <service> <code>1</code> <name>Эконом</name> </service> <service> <code>2</code> <name>Срочно</name> </service></services></source> == Справочник дополнительных услуг =='''Пример запроса дополнительных услуг:'''<source lang="xml"><?xml version="1.0" encoding="UTF-8"?><advprices> <auth extra="8" login="login" pass="pass" /></advprices></source> '''advprices''' — Корневой контейнер. Обязательный элемент. '''Пример ответа справочника дополнительных услуг:'''<source lang="xml"><?xml version="1.0" encoding="UTF-8" ?><advprices> <advprice> <code>1</code> <name>Этажей в доме</name> <type>int</type> </advprice> <advprice> <code>2</code> <name>Коэффициент надбавки</name> <type>float</type> </advprice> <advprice> <code>3</code> <name>Расписаться на упаковке</name> <type>bool</type> </advprice></advprices></source> Параметры:* '''code''' — внутренний код услуги* '''name''' — наименование услуги. Если поле «название в ЛК» в настройках услуги не пусто, то возвращает значение поля «название в ЛК».* '''hine''' — подсказка по доп услуге для пользователя* '''type''' — тип услуги. Может иметь значения::* '''bool''' — для услуг вида «чекбокс», «Да»:* '''float''' — для числа с плавающей точкой:* '''int''' — для целого числа == Расчет стоимости доставки =='''Пример запроса стоимости доставки:'''<source lang="xml"><?xml version="1.0" encoding="UTF-8" ?><calculator> <auth extra="8" login="login" pass="pass" /> <order> <pricetype>CUSTOMER</pricetype> <sender> <town>Санкт-Петербург</town> <address>Петровка 38 офис 35</address> <coords lat="55.680327" lon="37.604456"></coords> </sender> <receiver> <zipcode>125480</zipcode> <town regioncode="78" country="RU">Санкт-Петербург</town> <address>Петровка 38 офис 35</address> <pvz>124</pvz> <coords lat="55.680327" lon="37.604456"></coords> </receiver> <weight>5.1</weight> <service>2</service> <paytype>CASH</paytype> <price>387.5</price> <deliveryprice>150</deliveryprice> <inshprice>387.5</inshprice> <packages> <package mass="1" quantity="5"></package> <package mass="2.5" length="10" width="20" height="30"></package> </packages> <userid>user123</userid> <groupid>customer</groupid> </order></calculator></source> Параметры:Структура данных и заполнение полей аналогичны и совместимы с [[#Оформление заказа]]. Дополнительные поля:* '''pricetype''' — тип требуемой цены. Возможные значения: «CUSTOMER» (по-умолчанию) — [[Личный кабинет клиента#Цена доставки для получателя|цена для конечного получателя]], «CLIENT» — цена курьерской службы для клиента.* '''userid''' — Идентификатор пользователя, строковый или числовой тип. Виртуальное поле. Необязательное. Данное поле используется совместно с настройками «Цена доставки для получателя», определяя приоритет правила. Можно использовать в различных CMS/CRM системах, настраивая цены для определенного покупателя.* '''groupid''' — Идентификатор группы пользователя, строковый или числовой тип. Виртуальное поле. Необязательное. Данное поле используется совместно с настройками «Цена доставки для получателя», определяя приоритет правила. Можно использовать в различных CMS/CRM системах, настраивая цены для определенной группы покупателей. Суммы НП и ОЦ, а также тип оплаты CARD имеют значение при настроенных в тарифе на вкладке Прочее долях (в процентах) от данных сумм. В авторизации можно опустить параметры login и pass, тогда расчет будет производиться по стандартному тарифу курьерской службы, без учета возможных отличий для конкретного клиента.<br>Объемный вес будет учитываться только при условии указания всех габаритов: длины, ширины и высоты.<br>В полях город-отправитель и город-получатель можно указывать название города (не рекомендуется!), либо код города из нашего справочника, либо 13-ти значный код КЛАДР, либо 36-ти значный код адресной системы ФИАС (AOID). '''Пример ответа стоимости доставки:'''<source lang="xml"><?xml version="1.0" encoding="UTF-8"?><calculator> <calc> <townfrom code="1">Москва город</townfrom> <townto code="56603">Иркутск город</townto> <mass>3.7</mass> <service name="Экспресс">1</service> <zone>2</zone> <price>1113</price> <mindeliverydays>1</mindeliverydays> <maxdeliverydays>3</maxdeliverydays> <mindeliverydate>2020-05-13</mindeliverydate> <intervals> <workdays> <interval>10:00-16:00</interval> <interval>16:00-22:00</interval> </workdays> <holidays> <interval>12:00-16:00</interval> </holidays> </intervals> <deliveryprice> <advprice code="1" price="1000">База</advprice> <advprice code="4" price="100">Процент от суммы руб</advprice> <advprice code="5" price="63">Процент от объявленной стоимости</advprice> <advprice code="6" price="-50">Скидка при доставке</advprice> </deliveryprice> </calc></calculator></source> Параметры:* '''townfrom''' — Город-отправитель так, как система его распознала и привязала к справочнику. Атрибут '''code''' — код из справочника городов системы.* '''townto''' — Город-получатель так, как система его распознала и привязала к справочнику. Атрибут '''code''' — код из справочника городов системы.* '''mass''' — Масса в килограммах* '''service''' — Режим доставки — число, указывающее на запись в справочнике видов срочности (см описание на этой странице).* '''zone''' — номер тарифной зоны, по которой рассчиталась стоимость. В зависимости от зоны выбирается тарифная сетка. Так же к цене могут применяться повышающие или понижающие коэффициенты при доставке не из/в региональный центр.* '''price''' — рассчитанная стоимость доставки в валюте прайс-листа курьерской службы. Рекомендуется к использованию в отличие от одноименного атрибута родительского контейнера.* '''maxdeliverydays''' — максимальный срок доставки в рабочих днях.* '''mindeliverydate''' — минимальная дата доставки в учетом выходных дней.* '''intervals''' — список интервалов доставки для соответствующей зоны и режима срочности.* '''deliveryprice''' — Данные по составляющим ценам доставки '''''Обратите внимание:''''' В реальном ответе сервера в теге calc присутствует атрибут «price». Он оставлен для обратной совместимости, не используйте его. Пользуйтесь вложенным тегом price. === Коды и описание ошибок ==={|class=wikitable!Код ошибки!Английское описание!Русское описание!Примечание|-|15||tarif not found||Тариф не найден||Ошибка получения тарифов: для клиента не указан тариф|-|19||field [town to] cannot be empty||Поле [город получателя] не может быть пустым||Необходимо указать город получателя или ПВЗ|-|20||field [weight] is incorrect||Некорректное значение [масса]||Значение массы некорректное, например, не является числом. Его необходимо исправить|-|21||town from not found||Город отправителя не найден||Системе не удалось найти указанный населенный пункт отправителя|-|22||town to not found||Город получателя не найден||Системе не удалось найти указанный населенный пункт отправителя|-|23||field [weight] cannot be empty||Поле [масса] не может быть пустым||Необходимо указать значение массы отправления, поле [weight]|-|36||subtown not found||Город в регионе не найден||Не настроено направление доставки до города в регионе: не добавлен регион или указанный город отсутствует в списке региона|-|37||zoneprice not found||Тариф зоны не найден||Отсутствуют зоны тарификации или для них не указаны стоимости|-|38||tarif not found - 1||Тариф не найден 1||Результаты расчета отсутствуют: общая ошибка в случае, если других ошибок нет, но результат пустой |-|39||tarif not found - 2||Тариф не найден 2||Ошибка получения тарифов: для клиента не настроен тариф или тарификация от количества заказов|-|82||field [weight] exceeded limit PVZ||Значение [weight] превышает ограничение ПВЗ||Указанное значение массы больше, чем максимально допустимое для указанного ПВЗ|-|83||attribute [paytype] not allowed PVZ||Значение [paytype] не допустимо для ПВЗ||В ПВЗ не допустим указанный тип оплаты|-|} == Получение информации о клиенте =='''Пример запроса получения информации о клиенте:'''<source lang="xml"><?xml version="1.0" encoding="UTF-8" ?><client> <auth extra="8" login="login" pass="pass" /> </client></source> '''client''' — Корневой контейнер. Обязательный элемент.* '''auth''' — Авторизация. Обязательный элемент. '''Пример ответа на запрос получения информации о клиенте:'''<source lang="xml"><?xml version="1.0" encoding="UTF-8" ?><client> <code>1082</code></client></source> * '''code''' — Код клиента == Список актов передачи денег =='''Пример запроса списка актов передачи денег:'''<source lang="xml"><?xml version="1.0" encoding="UTF-8" ?><smalist> <auth extra="8" login="login" pass="pass" /> <datefrom>2016-02-10</datefrom> <dateto>2016-03-10</dateto></smalist></source> '''smalist''' — Корневой контейнер. Обязательный элемент.* '''auth''' — Авторизация. Обязательный элемент.* '''datefrom''' — Дата «с». Необязательный элемент.* '''dateto''' — Дата «по». Необязательный элемент.Если интервал дат не указан, то возвращаются акты передачи денег за последний месяц. '''Пример ответа на запрос списка актов передачи денег:'''<source lang="xml"><?xml version="1.0" encoding="UTF-8"?><smalist count="1"> <sma> <code>6278</code> <number>3992</number> <actdate>2016-02-12</actdate> <datepay></datepay> <dateto>2016-02-12</dateto> <promiseddatepay></promiseddatepay> <price>637.00</price> <pricecorr>113.00</pricecorr> <rur>13430.00</rur> <pricekur>570.00</pricekur> <priceag>67.00</priceag> <payno>42423</payno> <paytype>1</paytype> <paytypename>Безнал</paytypename> <signedcopyreceived>NO</signedcopyreceived> </sma></smalist></source> * '''code''' — Код акта* '''number''' — Номер акта в системе* '''actdate''' — Дата акта* '''datepay''' — Дата оплаты по акту* '''dateto''' — Дата конечного периода для формирования АПД* '''promiseddatepay''' — Плановая дата оплаты* '''price''' — Стоимость услуг* '''pricecorr''' — Сумма корректировки* '''rur''' — Сумма заказа* '''pricekur''' — Стоимость курьерской доставки* '''priceag''' — Агентское вознаграждение* '''payno''' — Номер платежного поручения* '''paytype''' — Тип оплаты: 1 — безнал, 2 — наличными курьером, 3 — наличными в офисе, 4 — перевод на карту* '''paytypename''' — Строковое представление типа оплаты* '''signedcopyreceived''' — Признак факта возврата акта YES/NO == Детализация актов передачи денег =='''Пример запроса детализации актов передачи денег:'''<source lang="xml"><?xml version="1.0" encoding="UTF-8" ?><smadetail> <auth extra="8" login="login" pass="pass" /> <code>6278</code></smadetail></source> '''smadetail''' — Корневой контейнер. Обязательный элемент.* '''auth''' — Авторизация. Обязательный элемент.* '''code''' — Код акта передачи денег (см. запрос списка АПД). Обязательный элемент. '''Пример ответа на запрос детализации актов передачи денег:'''<source lang="xml"><?xml version="1.0" encoding="UTF-8"?><smadetail count="2"> <specialsma> <code>42494</code> <ordercode>14424</ordercode> <orderno>11111</orderno> <orderdate>2018-01-01</orderdate> <delivereddate>2018-10-01</delivereddate> <company>Компания</company> <price>314.00</price> <rur>8800.00</rur> <inshprice>314.00</inshprice> <pricekur>270.00</pricekur> <priceag>44.00</priceag> <pricecalc>8486.00</pricecalc> <paytype>2</paytype> <paytypename>наличными курьером</paytypename> <weight>0.400</weight> <distance>0.0</distance> <status>Доставлено</status> </specialsma></smadetail></source> * '''code''' — Код записи.* '''ordercode''' — Код заказа.* '''orderno''' — Шифр заказа.* '''orderdate''' — Дата заказа.* '''delivereddate''' — Дата доставки.* '''company''' — Получатель.* '''price''' — Стоимость услуг.* '''rur''' — Сумма заказа.* '''inshprice''' — Стоимость заказа.* '''pricekur''' — Стоимость курьерской доставки.* '''priceag''' — Агентское вознаграждение.* '''pricecalc''' — Сумма для передачи агенту.* '''paytype''' — Тип оплаты: 1 — безнал, 2 — наличными курьером, 3 — наличными в офисе, 4 — перевод на карту.* '''paytypename''' — Строковое представление типа оплаты* '''weight''' — Вес заказа.* '''distance''' — Дистанция по заказу* '''status''' — Статус заказа. == Установка статуса согласования заказа ==Для возможности клиентом установки статуса согласования заказа необходимо включить переменную [[Личный кабинет курьерской службы#Заказы|Разрешить менять статус согласования]] '''Пример запроса установки статуса согласования заказа'''<source lang="xml"><?xml version="1.0" encoding="UTF-8"?><setapprovalstatus> <auth extra="8" login="login" pass="pass" /> <order ordercode="1234561"> <confirmstate>1</confirmstate> <message>Сообщение статуса</message> </order> <order ordercode="1234562"> <confirmstate>2</confirmstate> <message>Согласовано</message> </order> <order ordercode="1234563"> <confirmstate>3</confirmstate> <message>Не согласовано</message> </order></setapprovalstatus></source> * '''order''' — Контейнер заказа. Обязателен как минимум один элемент.:* '''ordercode''' — Внутренний код заказа.* '''confirmstate''' — Код статуса заказа. Все статусы с кодами можно получить запросом [[#Получение списка статусов согласования заказа|Получение списка статусов согласования заказа]]* '''message''' — Дополнительный комментарий, который отобразится в поле ''Инфо о доставке''. == Получение списка статусов согласования заказа =='''Пример запроса списка статусов согласования заказа'''<source lang="xml"><?xml version="1.0" encoding="UTF-8"?><approvalstatuses> <auth extra="8" login="login" pass="pass" /></approvalstatuses></source> '''Пример ответа списка статусов согласования заказа'''<source lang="xml"><?xml version="1.0" encoding="UTF-8" ?><approvalstatuses count="6"> <status> <code>1</code> <name>Неизвестно</name> </status> <status> <code>2</code> <name>Согласование запрошено</name> </status> <status> <code>3</code> <name>Доставка полностью согласована</name> </status> <status> <code>4</code> <name>Согласовано с изменением времени</name> </status> <status> <code>5</code> <name>Перенос на другую дату</name> </status> <status> <code>6</code> <name>Отказ</name> </status></approvalstatuses></source> == Генерация коротких ссылок ==В некоторых случаях, например, при использовании в СМС, может потребоваться использование коротких ссылок на ЛК.Для этого, необходимо отправить запрос с полной ссылкой, в ответ на который придёт хэш-код для ссылки. '''Пример запроса генерации коротких ссылок:'''<source lang="xml"><?xml version="1.0" encoding="UTF-8" ?><shortlink> <link short="0"> https://home.courierexe.ru/8/site/orders </link></shortlink></source> '''shortlink''' — Корневой контейнер. Обязательный элемент.* '''link''' — Полная ссылка, для которой необходимо получить код. Обязательный элемент. Если атрибут '''short''' равен 1, то ответ не будет содержать XML, а только хэш-код. '''Пример ответа на запрос генерации коротких ссылок:'''<source lang="xml"><?xml version="1.0" encoding="UTF-8"?><shortlink> <hash>35AF350C</hash></shortlink></source> * '''hash''' — Хэш-код ссылки. Далее, можно использовать ссылку на ЛК: <nowiki>https://home.courierexe.ru/35AF350C или curie.ru/35AF350C</nowiki> '''Примечание!''' Сервис коротких ссылок работает только для ресурсов компании MeaSoft. == Проверка надежности покупателя ==Проверка надежности работает только для тарифа «Максимум» личного кабинета. <source lang="xml"><?xml version="1.0" encoding="UTF-8" ?><mcheck> <auth extra="8" login="login" pass="pass" /> <phones> <phone>89161147992</phone> </phones></mcheck></source> Ответ: <source lang="xml"><?xml version="1.0" encoding="UTF-8" ?><mcheck> <phones> <phone rate="90">89161147992</phone> </phones></mcheck></source> == Размещение страниц на своем сайте (iframe) == В некоторых случаях имеет смысл разметить те или иные страницы на своем сайте. Например, чтобы клиенты могли рассчитать стоимость доставки не переходя по внешней ссылке, а там же, на сайте, калькулятор можно разместить прямо на странице такого сайта посредством так называемого фрейма — '''iframe'''. [https://ya.ru/search/?text=iframe Фрейм] — контейнер внутри обычной страницы, который позволяет загружать сторонние страницы. Пример загрузки калькулятора: <source lang="html"><iframe id="frame" src="https://home.courierexe.ru/8/calculator"> Здесь должен отобразиться калькулятор</iframe></source> Для удобства пользователей вашего сайта можно указать язык интерфейса (который переключается непосредственно на сайте) параметром '''lang''': <source lang="html"><iframe id="frame" src="https://home.courierexe.ru/8/calculator?lang=2"> Здесь должен отобразиться калькулятор</iframe></source> <div style="color: #a94442; background-color: #f2dede; border: 1px solid #ebccd1; padding: 3px 10px 10px;">'''Обратите внимание!'''# При использовании iFrame могут не работать некоторые функции, например, подписка на push-уведомления на странице трекинга или отслеживания.# Если язык не указать, то на страницах калькулятора и трекинга отображается свой переключатель языка. Если язык указан, то переключатель не отображается. Поддерживаемые языки и их коды::'''1''' — русский:'''2''' — английский:'''4''' — узбекский</div> == Оформление манифеста == '''Пример запроса на создание манифеста:'''<source lang="xml"><?xml version="1.0" encoding="UTF-8" ?><manifest> <auth extra="8" login="login" pass="pass" /> <store_from>1</store_from> <store_to>2</store_to> <trn_code>3</trn_code> <sentdate>2024-11-07</sentdate> <places> <place> <number>1</number> <seal>7890AABBB</seal> </place> <place> <number>2</number> <seal>123456ABC</seal> </place> </places> <addresses> <address> <code>12345</code> <place>1</place> </address> <address> <code>67890</code> <place>2</place> </address> </addresses></manifest></source> '''manifest''' - Корневой контейнер. Обязательный элемент.*'''auth''' - Авторизация. Обязательный элемент.*'''store_from''' - код филиала отправителя. Обязательный элемент.*'''store_to''' - код филиала получателя. Обязательный элемент.*'''trn_code''' - код перевозчика. Обязательный элемент.*'''sentdate''' - дата отправки манифеста. Не обязательный элемент.*'''addresses''' - корневой элемент для списка заказов.*:'''address''' - корневой элемент для заказа.*::'''code''' - наш внутренний номер заказа. Обязательный элемент.*::'''place''' - номер места заказа. Обязательный элемент, если переданы места.*'''places''' - корневой элемент для списка мест.*::'''place''' - корневой элемент для места.*::'''number''' - номер места. Обязательный элемент.*::'''seal''' - номер пломбы. Необязательный элемент. '''Пример успешного ответа'''<source lang="xml"><?xml version="1.0" encoding="UTF-8"?><manifest> <result>OK</result></manifest></source> '''Пример ответа с ошибкой'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<shortlinkmanifest> <hashresult error="Текст ошибки">35AF350CERROR</hashresult></shortlinkmanifest>
</source>
