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%;"|Ссылка
!style="width: 35%;"|Примечание
|-
|[[Файл:bitrix.png|center|x44px]]
|-
|[[Файл:prestashop.png|center|x44pxx60px]]|style="text-align: center;"|1.4.5 от 10.10.2018|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;"|[https://courierexe.ru/download/api/opencart.zip Скачать для версии 1.75.5 от 10.08.20181]<br>2.0.0 от 01.12.2018<br>3.1.1 от 28.02.2019|style="text-align: center;"|[httphttps://courierexe.ru/download/api/opencartmeasoft_oc2.ocmod.zip Скачатьдля версии 2.0]<br><br>[httphttps://courierexe.ru/download/api/opencart_2measoft_oc2.3.ocmod.zip Скачатьдля версии 2.3]<br><br>[httphttps://courierexe.ru/download/api/opencart_3measoft_oc3.ocmod.zip Скачатьдля версии 3.0]|Поддерживает версии с 1.5.5.1.<br>Версия 2.0.0 поддерживает Скачивайте модули для своей версии с 2OpenCart.0<br>Подробнее см. [https://opencartforum[OpenCart|описание]].com/files/file/2906-avtomatizaciya-otpravki-i-otslezhivanie-dostavok-courierexe-dlya-opencart-15x/ Альтернативный модуль сторонних разработчиков]
|-
|[[Файл:webasyst-shopscript.png|center|x44px]]
|-
<!--|[[Файл:insalesadvantshop.png|center|x44px]]|style="text-align: center;"|1[https://promo-z.2ru/ Сайт компании PROMO]|Компания PROMO разработала этот модуль и настраивает интеграцию MeaSoft с ADVANTSHOP своим клиентам.1 от 06|- -->|[[Файл:insales.09.2017png|center|x80px]]|style="text-align: center;"|Настраивается в [http://www.insales.ru/collection/all/product/kurierskaya-sluzhba[Личный кабинет клиента|ЛК пользователя]]|[[InSales|Инструкция по настройке]]|-2008 Установить]|[http[Файл://wikiiiko.courierexe.ru/index.php?titlejpg|center|x80px]]|style=Интеграция_с_другими_системами#Insales "text-align: center;"|Настраивается] в [[Личный кабинет клиента|ЛК пользователя в системе]]|[[Iiko|Инструкция по настройке]]
|-
|[[Файл:Leadvertex.png|center|x44px]]
|-
|[[Файл:Retailcrm.png|center|x44pxx30px]]|style="text-align: center;"|1.0 от 11.01.2018
|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;"|1.0.0 от 12.11.2018|style="text-align: center;"|[httphttps://courierexe.ru/download/api/com_measoft.zip Скачать]|Работает только с компонентом Virtuemart. Внимание! Модуль новый, поэтому возможна некорректная передача данных. Проверяйте, если что - сообщайте, исправим!Инструкция в архиве
|-
|[[Файл:Amocrm.png|center|x44px]]
|-
|-
|[[Файл:wordpress.jpg|center|x80px]]
|style="text-align: center;"|WordPress от 5 версии[https://courierexe.ru/wordpress/wordpress.php Скачать]|[[Wordpress|Инструкция]]|-WooCommerce от 3|[[Файл:Cscart.9 версииpng|center|x60px]]|style="text-align: center;"|[httphttps://courierexemarketplace.cs-cart.rucom/download/api/wordpressmeasoft-en.zip Скачатьhtml Установить] |Поддерживает версии 4.10 и выше.<br>[[Интеграция с другими системами#WordpressCS-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_mapphp_sample.js Инструкция по использованию - внутриzip пример обращения к сервису на PHP].
<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> <inshprice>387.5</inshprice> <deliveryprice VATrate="20">150</deliveryprice> <discount>120</discount> <paytype>CASH</paytype>
<weight>5.1</weight>
<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" />
</deliveryset>
<advprices>
<advprice>
<code>1</code>
<value>123</value>
</advprice>
<advprice>
<code>2</code>
<value>10.5</value>
</advprice>
<advprice>
<code>3</code>
<value>true</value>
</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>
=== Описание элементов для оформления заказа ===
'''Обязательные поля'''
*'''orderneworder''' - Контейнер для описания одного заказа — Корневой контейнер, обязательный элемент. В одном контейнере '''neworder''' может быть много контейнеров '''order''' для создания нескольких заказов одним запросом.
:* '''''ordernonewfolder''''' - Номер — Признак нового заказаYES/NO. Если присваивается клиентом - указывается здесь. Если не присваивается - можно оставить пустымстоит YES, система сгенерирует свой номер, и вернет его то в ответе. Система проверяет наличие заказов с указанным номером в пределах текущего календарного года, и в случае их существования - системе курьерской службы для данной корреспонденции создастся новый заказ создан не будет, а в ответе вернется ошибка 17 "Such number exists". Если не указан штрих-код (поле barcode), и значение поля подходит для использования его в качестве штрих-кода, данное значение будет скопировано в поле "Штрих-код". Это накладывает ограничения в частности, на длину указанного поля (25 знаков, чтобы работали стандартные печатные формы)Необязательный элемент.
*'''barcodeorder''' - Штрих-код — Контейнер для описания одного заказа. В случае, если клиент штрих-кодирует свои отправления, и штрих-код отличается от номера заказа, в этом поле указывается штрих-кодобязательный элемент. В случае наличия нескольких мест, и раздельной их маркировки, в этом поле допустимы маски в виде символов подчеркивания, говорящие о позициях штрих-кода, переменных для разных мест в рамках одного заказа.<br />одном контейнере '''neworder'Например'': В заказе номер 123 имеется 20 товарных вложений, которые упакованы в 3 транспортных места. Клиент формирует 3 штрих-кода на транспортные места: CLNT0012301, CLNT0012302, CLNT0012303, где CLNT - префикс клиента, 00123 - номер заказа, 01-03 - номер транспортного места в заказе. В поле barcode нужно указать CLNT00123__ (система поймет, что 2 последних символа могут может быть любыми, и будут отражать штрих-коды к одному заказу). Если вы не сами печатаете накладные с указанным штрих-кодом, то указанный штрих-код не должен быть длиннее 25 знаков, иначе он не поместится на стандартных печатных формахмного контейнеров '''order''' для создания нескольких заказов одним запросом.
:* '''''orderno''''' — Номер заказа. Если присваивается клиентом — указывается здесь. Если не присваивается — можно оставить пустым, система сгенерирует свой номер, и вернет его в ответе. Система проверяет '''у клиента''' наличие заказов с указанным номером в '''пределах текущего календарного года''', которые '''не являются недоставленными''', и в случае их существования — заказ создан не будет, а в ответе вернется ошибка 17 «Such number exists».Если не указан штрихкод (поле barcode), и значение поля подходит для использования его в качестве штрихкода, данное значение будет скопировано в поле «Штрихкод». Это накладывает ограничения в частности, на длину указанного поля (25 знаков, чтобы работали стандартные печатные формы). * '''barcode''' — Штрихкод заказа. Если клиент штрихкодирует свои отправления и штрихкод отличается от номера заказа, в этом поле указывается штрихкод. Если ШК содержит кириллицу или малое количество символов, то формируется ШК в формате EAN13. <spoiler text="Заполнение номера заказа (шифра) и штрих-кода">Шифр и штрих-код заполняются исходя из начальных значений: # Если шифр и ШК пустые - оба поля заполняются автоматически значением вида 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>
</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'''''.:* '''''VATrate''''' — Ставка НДС — целое число процентов. Если товар хранится в КС (отправлениясмотрите '''article''' ниже) передается код , значение берется из номенклатуры. Иначе, если значение указано, берется указанное значение, если нет - значение из справочника "Типы корреспонденции"настроек фирмы КС. Значение «0» означает ставку «Без НДС», ставка «0%» на данный момент не поддерживается.:*'''return_type''barcode' - Тип возвратной корреспонденции (отправления) передается код из справочника "Типы корреспонденции"'''' — Штрихкод вложения.:*'''price''article' - Сумма заказа'''' — Артикул вложения. ''Внимание!'' Указание артикула используется только тогда, когда товар хранится на ответственном хранении в службе доставки, и необходима комплектация. В этом случае наличия контейнера items значение данного параметра будет проигнорированосистема пытается привязать товар к [[API#Справочник номенклатуры|справочнику номенклатуры]]. Если товар в справочнике не найден — система выдаст соответствующую ошибку. Если по артикулу найдено несколько товаров — система выберет один из них случайным образом, и рассчитано автоматическичто может привести к ошибочной комплектации! Если товар НЕ на ответственном хранении — артикул указывать НЕ нужно. Позиция попадет в систему просто текстом.:*'''deliveryprice''itemcode''''' — Внутренний код товара, может использоваться вместо артикула. ''Внимание!'' - Сумма Указание кода товара используется только тогда, когда товар хранится на ответственном хранении в службе доставки, и необходима комплектация. В этом случае наличия контейнера items, система пытается привязать товар к [[API#Справочник номенклатуры|справочнику номенклатуры]]. Если товар в него будет добавлено вложение "Доставка"справочнике не найден — система выдаст соответствующую ошибку. Если товар НЕ на ответственном хранении — код товара указывать НЕ нужно.:*'''return''type'' ''' — Тип вложения. Принимает значения::: 1 — Товар. По- Признак необходимости возвратаумолчанию.:: 2 — Доставка. Такое вложение добавится автоматически, если заполнить order->deliveryprice:: 3 — Услуга:: 4 — Предоплата. Указывается сумма. Поле quantity игнорируется, всегда «1». В заказе сумма будет отрицательной независимо от знака в запросе. Такое вложение добавится автоматически при указании order->paytype=NO.:: 6 — Оплата кредитом. Указывается сумма. Поле quantity игнорируется, всегда «1». В заказе сумма будет отрицательной независимо от знака в запросе.:: 7 — Забор товара. Если товар нужно у получателя забрать, возможно — вернуть деньги, или его стоимость вычтется из суммы других товаров. У такого товара в заказе будет отрицательное количество независимо от знака в запросе.:: 9 — Код подтверждения. Используется для вложения, в котором сохраняется регулярное выражение для проверки кодов вложений. См. '''''extraTags''''':*'''return_service''extcode' - Режим возврата (тип услуги) передается '''' — Внешний код из справочника "Виды срочности"строки. Используется для идентификации строк заказов при получении статусов. Необязательное поле.:*'''discount''origincountry''''' — Код страны- Сумма скидкипроизводителя в соответствии со [https://ru.wikipedia. Скидка "размазывается" по товарным вложениямorg/wiki/ISO_3166-1 стандартом ISO_3166-1], например, «RU», сумма НП уменьшается на сумму скидки. При этом вложение Скидка не создается«RUS» или «643» для России.:*'''enclosure''GTD'' - Вложение''' — Номер ГТД.:*'''inshprice''excise''''' - Объявленная ценность — Сумма акциза.:*'''instruction''suppcompany' - Поручение - Примечание'''' — Наименование компании поставщика, если отличается от заказчика.:*'''courier''suppphone' - Запланированный курьер. Согласно коду курьера в КС2008'''' — Номер телефона компании поставщика, если отличается от заказчика.:*'''receiverpays''suppINN''''' - Признак оплаты стоимости доставки - услуг службы доставки получателем — ИНН компании поставщика, а не заказчиком YES/NOесли отличается от заказчика.:*'''department''governmentCode' - Подразделение'''' — Код товарной номенклатуры. Используется для [[Маркировка|маркированных товаров, в котором оформляется заказнапример («Честный знак»)]].*Для кода '''pickupЧестный знак''' Нужно указывать все данные из нанесенного QR- Признак оформления забора YES/NOкода кроме не читаемых символов (#29). Если стоит YESкод не известен — укажите знак вопроса «?», тогда курьер отсканирует код фактически передаваемого покупателю товара. Для некоторых процессов может использоваться значение «!» — в этом случае курьер сканирует серийный номер товара, то весь заказ но это не считается заданием на забор грузакодом маркировки. При этом, а не на доставкуесли указано значение «?» или «! Применяется для вызова курьера к отправителю для забора других отправлений» и quantity больше 1, то такое вложение растиражируется quantity раз.:*'''acceptpartially''govType' '''' — Тип маркировки товара. В данный момент существуют следующие типы маркировки::: 1 — Честный знак. По- Признак возможности частичного выкупа товаров отправления YES/NOумолчанию.:: 2 — ГИИС ДМДК.:: 3 — Серийный номер.:* '''''message''''' — Строка сообщения.:* '''''extraTags''''' — Строка в формате JSON для различных целей.
<source lang="xmljson"><?xml version="1.0item_industry_props":{"tag1262":" encoding=020"UTF-8,"?><neworder> <createorder orderno=tag1263"AB23541:" error=14.12.2018"0," errormsg=tag1264"success:"></createorder> <createorder orderno=1556"55_6542," error=tag1265"0:" errormsgtm=mdlp&sid=00000000XXXXXX"},"successtag1212"></createorder> <createorder orderno=: "AB235421" error="0ValidationMask" errormsg=: "success(A-Z0-9){6,8}"></createorder></neworder>
</source>
Для клиентов из '''Узбекистана''' необходимо указывать код ИКПУ и код упаковки в следующем формате:<source lang="xmljson"><?xml version="1.0ikpu" encoding=:"UTF-8123123123"?><neworder> <createorder orderno=,"AB23541packageCode" error=:"17123456" errormsg="Such number exists"></createorder> <createorder orderno="AB23542" error="13" errormsg="empty company"></createorder> <createorder orderno="AB23543" error="14" errormsg="empty person"></createorder></neworder>
</source>
* '''Пример ответа при ошибке синтаксисаpackages''' — Контейнер для описания мест. Необязательный контейнер. Атрибуты::* '''''package''''' — Название места.:* '''''code''''' — Внутренний код строки.:* '''''strbarcode''''' — Штрихкод места.:* '''''mass''''' — Масса места в килограммах.:* '''''message''''' — Строка сообщения.:* '''''length''''' — Длина товарного места (в сантиметрах).:* '''''width''''' — Ширина товарного места (в сантиметрах).:* '''''height''''' — Высота товарного места (в сантиметрах).:* '''''quantity''''' — Количество мест с данным набором параметров. Действует ограничение на общее количество мест в заказе. Общее количество мест в заказе не может быть больше 1000.
== Запрос статуса заказов = Коды и описание ошибок ==={|class=wikitable!Код ошибки=== Пример запроса статуса заказа ===!Английское описание!Русское описание<source lang="xml">|-<?xml version="1.|0" encoding="UTF||Success||Успешно|-8" ?><statusreq>|1||Wrong XML||Некорректный файл XML.|- <auth extra="8" login="login" pass="pass"></auth>|2||Lat is empty||Укажите широту. <client>CLIENT</client>|- <orderno>1234</orderno>|3||Specify a valid «Price» field value.||Укажите корректное значение поля «Сумма». <orderno2>5678</orderno2>|- <ordercode>34234</ordercode>|4||Specify a valid «Weight» field value.||Укажите корректное значение поля «Вес».|- <givencode>234534<|5||Recepient city/givencode>town not found.||Город назначения не найден. <datefrom>2016-07|-21</datefrom> <dateto>2016-07-21<|6||Sender city/dateto>town not found.||Город отправления не найден. <target>Автозавод</target>|- <done>ONLY_NOT_DONE</done>|7||Specify the «Recipient address» field value.||Укажите значение поля «Адрес получателя». <changes>ONLY_LAST</changes>|-|8||Specify the «Recipient phone» field value.||Укажите значение поля «Телефон получателя».</statusreq>|-</source>|9||Specify the «Recipient name» field value.||Укажите значение поля «ФИО получателя».|-=== Описание полей запроса статуса ===|10||Specify a valid «Quantity» field value.||Укажите корректное значение поля «Количество». '''statusreq''' |- Корневой контейнер. Обязательный элемент.*'''auth''' - Авторизация|11||Specify a valid «Declared value» field value. Обязательный элемент||Укажите корректное значение поля «Объявленная ценность».*'''client''' |- Признак клиента или агента|12||Supplier SKU ID not found. Необязательный элемент||Артикул не найден.:* CLIENT |- Признак клиента, значение по умолчанию:* AGENT - Признак агента|17||Order number already exists in the database. В ответ отдается информация по заказам, переданным агенту на доставку*'''orderno''' - Номер ||Такой номер заказа. Необязательный элементуже есть в базе.*'''ordercode''' - Внутренний |-|18||Order code already exists in the database.||Такой код заказа. Необязательный элементуже есть в базе.*'''orderno2''' |- Номер заказа из срочных. Необязательный элемент.*'''datefrom''' |19||The delivery date format is not valid. Specify a date in YYYY-MM- Дата заказа "с"DD format. Необязательный элемент||Укажите значение поля «Дата доставки» в формате гггг-мм-дд.*'''dateto''' |- Дата заказа "по"|20||Specify a valid «Delivery mode» field value. Необязательный элемент||Укажите корректное значение поля «Режим доставки».*'''target''' |- Строка поиска. Позволяет указать текст, который содержится в названии компании или адресе получателя|21||Specify a valid «Return trip mode» field value.||Укажите корректное значение поля «Режим возврата».*'''done''' |- Может принимать значения: :* ONLY_DONE - Только доставленные (имеются в виду успешные статусы, например, '''Доставлен''' или '''Частично доставлен''')|22||Specify a valid «Delivery type» field value.||Укажите корректное значение поля «Тип доставки».:* ONLY_NOT_DONE |- Только не доставленные (заказы, которые не являются доставленными, например, '''Не доставлен''' или '''Утерян'''):* ONLY_NEW |23||Specify a valid «Return shipment type» field value.||Укажите корректное значение поля «Тип возврата».|- Только новые:* ONLY_DELIVERY - Только заказы в обработке - заказы, находящиеся в любом статусе, кроме конечных: Доставлено, Не доставлено, Отменён и т|30||Specify the «Order number» field value.д||Укажите значение поля «Номер заказа».:* ''Пусто'' |- все корреспонденции *'''changes''' - может принимать |31||Specify the «Barcode» field value.||Укажите значение только ONLY_LASTполя «Штрихкод». Если указан этот параметр, все остальные игнорируются. Описание данного режима приведено здесь: [[#Передача только изменившихся статусов|Передача только изменившихся статусов]]-|32||Specify the «Sender company» field value.||Укажите значение поля «Компания-отправитель».|-<div style="color: #a94442; background|33||Specify the «Sender name» field value.||Укажите значение поля «ФИО отправителя».|-color: #f2dede; border: 1px solid #ebccd1; padding: 3px 10px 10px;">'''Обратите внимание!'''|34||Specify the «Sender phone» field value.||Укажите значение поля «Телефон отправителя».|-# Периода запроса статусов (контейнеры '''datefrom''' и '''dateto''') ограничивается двумя месяцами — два месяца до даты '''"по"'''|35||Specify the «Sender city/town» field value.||Укажите значение поля «Город отправителя».# Если не указаны обе даты — '''dateto''' принимается равной текущей дате|-|36||Specify the «Sender address» field value.# Если не указана дата '''dateto''' — она принимается равной '''datefrom''' плюс 2 месяца||Укажите значение поля «Адрес отправителя».# Если не указана дата '''datefrom''' — она принимается равной '''dateto''' минус 2 месяца|-|37||Specify the «Pickup date» field value.||Укажите значение поля «Дата забора».</div>|-<br />|38||Specify the «Pickup time from» field value.||Укажите значение поля «Время забора с».|-=== Примеры ответов === |39||Specify the «Pickup time to» field value.||Укажите значение поля «Время забора до».|-'''Пример успешного ответа'''|40||Specify the «Recipient company» field value.||Укажите значение поля «Компания-получатель».|-<source lang="xml"><?xml version="1|41||Specify the «Recipient name» field value.||Укажите значение поля «ФИО получателя».0" encoding="UTF|-8"?><statusreq count="23">|42||Specify the «Recipient phone» field value.||Укажите значение поля «Телефон получателя». <order orderno="111111" awb="qwerty" orderno2="123123" ordercode="34534234" givencode="2345334">|- <barcode>111111<|43||Specify the «Recipient city/barcode> <sender> <company>МВД</company> <person>Иванов Иtown» field value.И||Укажите значение поля «Город получателя».</person> <phone>123-45|-67</phone> <contacts>|44||Specify the «Recipient address» field value.||Укажите значение поля «Адрес получателя». <phone>+74951234567</phone>|- </contacts>|45||Specify the «Delivery date» field value.||Укажите значение поля «Дата доставки». <town code="23432">Санкт|-Петербург</town> <address>Петровка 38 офис 35</address>|46||Specify the «Delivery time from» field value.||Укажите значение поля «Время доставки с». <date>2014-03|-22</date> <time_min>09:00</time_min> <time_max>14:00</time_max> </sender> <receiver> <company>МВД</company> <person>Иванов И|47||Specify the «Delivery time to» field value.И||Укажите значение поля «Время доставки до».</person> <phone>123|-45-67 - Иван (916)234|48||Specify the «Recipient postcode» field value.45||Укажите значение поля «Индекс получателя».21 Петр,mvd@mail.ru</phone> <contacts>|- <phone>+74951234567</phone>|49||Specify the «Weight» field value.||Укажите значение поля «Вес». <phone>+79162344521</phone>|- <email>mvd@mail|50||Specify the «Payment type» field value.||Укажите значение поля «Тип оплаты».ru</email> </contacts>|- <inn>1112223335</inn> <zipcode>125480</zipcode>|51||Specify the «Quantity» field value.||Укажите значение поля «Количество». <town code="153361" regioncode="78" regionname="Санкт|-Петербург город">Санкт-Петербург город</town> <address>Петровка 38 офис 35</address>|52||Specify the «Amount» field value.||Укажите значение поля «Сумма». <pvz>|- <code>126</code>|53||Specify the «Declared value» field value.||Укажите значение поля «Объявленная стоимость». <clientcode>QWERTY</clientcode>|- </pvz> <date>2014|54||Specify the «Description» field value.||Укажите значение поля «Описание».|-03-22</date> <time_min>09:00</time_min> <time_max>14:00</time_max> <coords lat="|55||Specify the «Instruction» field value.680327" lon="37||Укажите значение поля «Поручение».604456"></coords> </receiver>|- <weight>5|56||Specify the «Delivery mode» field value.||Укажите значение поля «Режим доставки».1</weight> <return_weight>5.1</return_weight>|- <quantity>2</quantity>|57||Specify the «Shipment type» field value.||Укажите значение поля «Тип отправления». <paytype>CASH</paytype>|- <service>2</service> <return_service>2</service>|58||Specify whether return trip is required.||Укажите значение поля «Необходимость возврата». <type>3</type>|- <return_type>3</return_type>|59||Specify the «Return trip mode» field value.||Укажите значение поля «Режим возврата» <waittime>12</waittime>|- <price>387|60||Specify the «Return shipment type» field value.||Укажите значение поля «Тип возврата».5</price> <print_check>YES</print_check>|- <inshprice>387|61||Specify barcode.||Укажите штрихкод.5</inshprice> <enclosure>Детские игрушки</enclosure>|- <instruction>Проверить при покупателе, подписать акт</instruction> <currcoords lat="55|62||Specify item weight.680327" lon="37||Укажите массу единицы товара.604456" accuracy="50" RequestDateTime="2014|-04|63||Specify item quantity.||Укажите количество товара.|-21 18:07:45"></currcoords> <courier>|64||Specify item price.||Укажите цену единицы товара. <code>26</code>|- <|65||Specify item name>Иванов Владимир Петрович</name>.||Укажите название товара. <phone>+79161234567</phone>|- </courier>|66||Wrong XLS file||Некорректный файл XLS. <deliveryprice total="158|-|67||Order barcode already exists in the database.6" delivery="100||Такой штрихкод заказа уже есть в базе.00" return="58.6"> <advprice code="1" price="150">База</advprice>|- <advprice code="2" price="0">% от объявленной стоимости</advprice>|68||Select the «Payment by recipient» field value.||Укажите значение поля «Оплата получателем».|- <advprice code="3" price="8|69||Specify department.||Укажите отдел.6">Топливный сбор</advprice> <advprice |-|70||Specify service partner code="4" price="0">Округление</advprice>.||Укажите значение поля «Код подрядчика». </deliveryprice>|- <receiverpays>NO</receiverpays>|71||Date cannot be earlier than tomorrow.||Дата не может быть раньше чем завтра. <status eventstore="филиал в Санкт|-Петербурге" eventtime="2016-06-02 17:22:00" createtimegmt="2016|72||Date cannot be later than 15 days from now.||Дата не может быть позже чем через 15 дней.|-06-03 16:14:44" message="" title="Доставлен">COMPLETE</status> <statushistory>|73||Date cannot be earlier than today.||Дата не может быть раньше чем сегодня. <status eventstore="Офис в Москве" eventtime="2016|-05-30 10:20:00" createtimegmt="2016|74||Date cannot be later than {0} days from now.||Дата не может быть позже, чем через {0} дней.|-06|75||Specify a valid «Item weight» field value.||Укажите корректное значение поля «Масса единицы товара».|-03 16:14:44" message="" title="Новый">NEW</status> <status eventstore="Офис в Москве" eventtime="2016|76||Specify a valid «Quantity» field value.||Укажите корректное значение поля «Количество товара».|-06-01 17:38:00" createtimegmt="2016|77||Specify a valid «Item price» field value.||Укажите корректное значение поля «Цена единицы товара».|-06|78||Specify a valid «Delivery time from» field value.||Укажите корректное значение поля «Время доставки с».|-03 16:14:44" message="филиал в Санкт|79||Specify a valid «Delivery time to» field value.||Укажите корректное значение поля «Время доставки до».|-Петербурге" title="Планируется отправка">DEPARTURING</status> <status eventstore="Офис в Москве" eventtime="2016|80||Specify a valid «Pickup time from» field value.||Укажите корректное значение поля «Время забора с».|-06|81||Specify a valid «Pickup time to» field value.||Укажите корректное значение поля «Время забора до».|-01 19:53:00" createtimegmt="2016|82||Specify a valid «Pickup point» field value.||Укажите корректное значение поля «ПВЗ».|-06-03 16:14:44" message="филиал |83||Duplicate number in the registry.||Дублирование номера в Санктреестре.|-Петербурге" title="Отправлено со склада">DEPARTURE</status> <status eventstore="филиал в Санкт|84||Duplicate barcode in the registry.||Дублирование штрихкода в реестре.|-Петербурге" eventtime="2016-06|85||Specify a valid «Weight at return trip» field value.||Укажите корректное значение поля «Вес возврата».|-02 07:41:00" createtimegmt="2016-06-03 16:14:44" message="" title="Получен складом">ACCEPTED</status> <status eventstore="филиал в Санкт|86||Specify the «Weight at return trip» field value.||Укажите значение поля «Вес возврата».|-Петербурге" eventtime="2016|87||Order weight exceeds the allowed maximum for the pickup point.||Вес превышает допустимое значение для этого ПВЗ.|-06|88||Pickup date cannot be earlier than today.||Дата забора не может быть раньше чем сегодня.|-02 09:17:00" createtimegmt="2016-06-03 16:14:44" message="" title="Выдан курьеру на доставку">DELIVERY</status> <status eventstore="филиал в Санкт|89||Specify a later delivery date.||Укажите более позднюю дату доставки.|-Петербурге" eventtime="2016-06|90||Inappropriate «Weight» or «Pay type» field value for the selected city or town. Please review and correct the values.||Значение поля «Масса» или «Тип оплаты» для выбранного города указано некорректно или отсутствует. Проверьте значения и исправьте.|-02 17:22:00" createtimegmt="2016-06-03 16:14:44" message="" title="Доставлен (предварительно)">COURIERDELIVERED</status> <status eventstore="филиал в Санкт|91||{deliverytype} {deliverydate} is {holidaytype}. Select another date.||{deliverytype} {deliverydate} является {holidaytype}. Выберите другую дату.|-Петербурге" eventtime="2016|92||{deliverytype} {deliverydate} is {holidaytype}. Select another date.||{deliverytype} {deliverydate} является {holidaytype}. Выберите другую дату.|-06|93||Add items.||Добавьте товары.|-02 17:22:00" createtimegmt="2016|95||The selected pickup point only allows paid orders.||Выбранный ПВЗ выдает только предоплаченные заказы.|-06-03 16:14:44" message="" title="Доставлен">COMPLETE</status> </statushistory> <customstatecode>2<customstatecode>|96||Order barcode exceeds the allowed maximum (25) symbols.||Длина штрихкода заказа превышает максимально допустимую (25 символов). <clientstatecode></clientstatecode>|- <costcode>cc12345</costcode> <receipt fdNum="124555" fnSn="9289000100295555" kktNum="0001611984048555" inn="7722756555" fdValue="2899551555" summ="387|97||The pickup date format is not valid. Specify a date in YYYY-MM-DD format.5" ofdUrl="gate||Укажите значение поля «Дата забора» в формате гггг-мм-дд.ofd.ru">https://ofd|-|98||Specify the cost code.ru/rec/7722756555/0001611984048555/9289000100295555/124555/2899551555</receipt> <deliveredto>Иванова, секр||Укажите значение поля «Кост-код».</deliveredto> <delivereddate>2016-06|-02</delivereddate> <deliveredtime>17:22</deliveredtime>|99||The item is not in stock.||Товар отсутствует на складе. <outstrbarcode>EXT123456</outstrbarcode>|- <items> <|100||Set the quantity of the item code="34533" extcode="abc123" quantity="marked with Chestny ZNAK to one.||Укажите количество товара, маркированного кодом «Честный ЗНАК», равным единице.|-|101||Quantity of item Delivery cannot be greater than 1||Количество вложений типа «Доставка» не может быть более 1" mass="0.2" retprice="37|-|102||А database error occurred. Please try later again.||Ошибка базы данных. Попробуйте позже.5" VATrate="0" barcode="2345625213125" article="1" returns="0" origincountry="040" GTD="" excise="0|-|103||Order not found.00" governmentCode="11223311" suppcompany="Поставщик" suppINN="1112223334" suppphone="79161234567">Мяч</item>||Заказ не найден.|- <item code="34456" extcode="abc124" quantity="2" mass="2" retprice="100" VATrate="10" barcode="4645625213138" article="2" returns="0" governmentCode="">Обруч</item>|104||Cannot edit order in the current status.||Невозможно изменить заказ в текущем статусе.|-|105||Discount cannot be greater than the order amount. Specify a smaller value.||Размер скидки не может превышать сумму заказа. Укажите меньшее значение скидки.|- <item |106||Specify the correct additional service code="34421" extcode="abc125" quantity="3" mass="0.3" retprice="50" VATrate="18" barcode="2345625213126" article="3" returns="0" governmentCode="">Погремушка желтая</item>||Укажите корректный код дополнительной услуги.|-|107||Specify the correct additional service name.||Укажите корректное значение поля [advprice][value]. </items>|-|108||Specify the «Additional services» field value.||Укажите значение поля «Дополнительные услуги». <packages>|- <package code="33331" strbarcode="ORD0000001" mass="1" message="" got="YES"></package>|110||Specify the correct TIN.||Укажите корректный ИНН.|- <package code="33332" strbarcode="ORD0000002" mass="2|111||Specify the correct IIN (KZ).||Укажите корректный ИИН (КЗ).5" message="" got="NO"></package> </packages>|- </order></statusreq> |112||Specify the overall volume.||Укажите общий объем.|-|113||Cannot apply the delivery mode. Select another delivery mode.||Режим доставки не подходит для заказа. Выберите другой режим.|-<|114||The pickup point does not support the selected delivery mode. Specify another pickup point.||ПВЗ не подходит для выбранного режима доставки. Укажите другой ПВЗ.|-|115||Specify a valid recipient phone number.||Укажите корректный телефон получателя.|-|116||Specify recipient PIN code.||Укажите пин-код получателя.|-|117||Order date cannot be earlier than {0}. Specify another date.||Дата заказа не может быть раньше {0}. Укажите другую дату.|-|118||Pickup date cannot be earlier than {0}. Specify another date.||Дата забора не может быть раньше {0}. Укажите другую дату.|-|119||Specify the correct item type.||Укажите корректный тип вложения.|-|120||The pickup point does not accept payment by card.||В выбранном ПВЗ оплата картой не принимается.|-|121||Invalid item code format||Неверный формат кода товарной номенклатуры|-|122||Pickup time cannot be earlier than {0} hours.||Время забора не может быть раньше чем через {0} часа.|-|123||Pickup interval cannot be less than {0} minutes.||Интервал времени забора не может быть менее {0} минут. Укажите корректный интервал.|-|124||Specify a valid "Payment type" field value.||Укажите корректное значение поля «Тип оплаты».|-|125||Recepient city/source>town by postcode not found.||Город получателя по его индексу не найден.|-|126||Incorrect items prepayment and pickup.||Заказ не может содержать только вложения «Предоплата» и «Забор».|-|127||Package limit exceeded||Превышен лимит количества мест|-|128||Quantity of item Prepayment cannot be greater than 1||Количество вложений типа «Предоплата» не может быть больше 1.|-|129||Sum of cod must be equal sum of items||Объявленная стоимость должна быть равна сумме вложений.|-|130||Specify a valid respstore code.||Укажите код ответственного филиала.|-|131||Cannot edit, order has not been synchronized.||Невозможно изменить заказ пока он не синхронизирован.|-|132||Specify a valid "Recipient city/town" field value.||Укажите город получателя|-|133||Specify a valid "weight" for the town.||Укажите корректный вес для города|-|134||Specify a valid "paytype" for the town.||Укажите тип оплаты для города|-|135||Specify the correct SKU ID/code for item.||Укажите артикул/код вложения|-|136||Specify warehouse goods in the order.||Укажите вложения в заказе|-|137||The order's date of creation is more than 60 days ago.||Заказ создан более 60 дней назад|-|138||Specify a valid "Package dimension" field value.||Укажите корректные габариты места|-|139||Wrong type of XML query||Ошибка запроса|-|140||Duplicate item code in the order.||Дублирование кода вложения в заказе|-|141||Duplicate additional service in the order.||Дублирование кода дополнительной услуги в заказе|-|144||Incorrect extrafields.||Некорректные расширенные поля.|-|}
=== Пример запроса статуса заказа ===
<source lang="xml">
<?xml version="1.0" encoding="utfUTF-8"?><requeststatusreq> <error errorauth extra="18" login=" errormsglogin" pass="authorization errorpass"></errorauth> <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></requeststatusreq>
</source>
<div style="color: #a94442; background-color: #f2dede; border: 1px solid #ebccd1; padding: 3px 10px 10px;">
'''Обратите внимание!'''
# Атрибуты контейнера Периода запроса статусов (контейнеры '''datefrom''' и '''dateto'''status) ограничивается двумя месяцами — два месяца до даты ''' заполняются для версий системы «по»'''2008.0# Если не указаны обе даты — '''dateto''' принимается равной текущей дате.0.670# Если не указана дата '''dateto''' — она принимается равной '''datefrom''' и новееплюс 2 месяца.# Контейнер Если не указана дата '''statushistorydatefrom''' заполняется для тарифа "[[Личный_кабинет#.D0.9F.D0.BE.D0.B4.D0.BA.D0.BB.D1.8E.D1.87.D0.B5.D0.BD.D0.B8.D0.B5|Премиум]]" и версий системы — она принимается равной '''2008.0.0.670dateto''' и новееминус 2 месяца.# Контейнер Поиск по '''deliverypriceconditions''' заполняется работает только для тарифа "[[Личный_кабинет#.D0.9F.D0.BE.D0.B4.D0.BA.D0.BB.D1.8E.D1.87.D0.B5.D0.BD.D0.B8.D0.B5|Премиум]]".«Номер заказа(шифр)» и только от 4 символов
</div>
<br />
=== Передача только изменившихся статусов Примеры ответов ===В нашем API предусмотрено очень удобное средство получения статусов всех заказов, без необходимости "бомбить" сервер запросами статусов по каждому заказу. Работает это так: раз в какое-то время, например, в 10 минут, вы посылаете запрос "А покажите все изменившиеся статусы". '''Пример запроса ниже. Система вам отдает ВСЕ заказы, статусы (или некоторые другие поля, см ниже) которых изменились с момента последнего запроса. Вы разбираете полученный документ, по каждому заказу сохраняете его актуальный статус в своей системе, и если все хорошо, у вас все получилось, ваша система неожиданно не упала от наплыва информации, посылаете нам запрос подтверждения получения статусов (commitlaststatus). Мы у себя отмечаем, что эти статусы вами получены, и их не надо передавать повторно. Т.о. сколько бы заказов у вас не было, статусы по ним всем почти в реальном времени вы можете получать всего 2-мя запросами.успешного ответа'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8" ?><statusreqcount="23"> <auth extraorder orderno="8111111" awb="qwerty" orderno2="123123" loginordercode="login34534234" passgivencode="pass2345334"> <barcode>111111</authbarcode> <sender> <changescompany>ONLY_LASTМВД</changescompany> <person>Иванов И.И.</statusreqperson> <phone>123-45-67</sourcephone> <contacts> <phone>+74951234567</phone>Система выдает все заказы, в которых, с момента последнего запроса в этом режиме, изменилось хотя бы одно из полей: </contacts> orderno <town code="23432">Санкт-Петербург</town> status <address>Петровка 38 офис 35</address> delivereddate <date>2014-03-22</date> deliveredtime <time_min>09:00</time_min> deliveredto <time_max>14:00</time_max> receiver- </sender>date <receiver->address price <company>МВД</company> <person>Иванов И.И.</person>После успешной обработки ответа необходимо отметить полученные статусы успешно полученными <phone>123-45-67 - Иван (916)234.45.21 Петр, отправив запросmvd@mail.ru</phone> <contacts> <source lang="xml"phone>+74951234567</phone> <phone>+79162344521</phone> <?xml version="1email>mvd@mail.0" encoding="UTF-8" ?ru</email> </contacts> <inn>1112223335</inn> <zipcode>125480<commitlaststatus/zipcode> <auth extratown code="8153361" loginregioncode="login78" passregionname="passСанкт-Петербург город">Санкт-Петербург город</authtown> <clientaddress>CLIENTПетровка 38 офис 35</clientaddress> <area>Район 1</commitlaststatusarea> <pvz> <code>126</sourcecode> <clientcode>QWERTY</clientcode>'''Описание полей запроса''' </pvz> *'''auth''' <date>2014- Авторизация. Обязательный элемент.*'''client''' 03- Признак клиента или агента. Необязательный элемент.22</date> <time_min>09:* CLIENT - Признак клиента, значение по умолчанию00</time_min> <time_max>14:* AGENT - Признак агента. В ответ отдается информация по заказам, переданным агенту на доставку В случае успеха Вы получите ответ 00<source lang="xml"/time_max> <?xml versioncoords lat="155.0680327" encodinglon="UTF-837.604456" ?></coords> <commitlaststatus error="0"deliveryPIN>OK1234</commitlaststatusdeliveryPIN> </sourcereceiver> <price>387.5</price>Данный способ передачи статусов гарантирует полную корректную передачу статусов, даже в случае, если в нашей системе статус изменился в промежутке времени между запросом статусов и подтверждением их получения. Если система не получила подтверждение успешной передачи статуса, она будет считать информацию не переданной, и выдаст ее при повторном запросе <inshprice>387. 5</inshprice> <div stylepaytype code="color: #a94442; background-color: #f2dede; border: 1px solid #ebccd1; padding: 3px 10px 10px;1">CASH</paytype>'''Обратите внимание!''' <weight>5.1</weight> <quantity>2</quantity># При данном способе передачи ( <changesservice>ONLY_LAST2</changesservice> <type>) система просматривает заказы, оформленные за последние 3 месяца. Если заказ сделан ранее - изменение статуса по нему не попадет в результат выполнения данного запроса.</type># Система всегда выдает текущий статус. Т.е. Вы можете одним запросом получить статус "NEW", а следующим - "COMPLETE". В промежутке между запросами отправление могло пройти через несколько промежуточных статусов. Если нужна гарантия получения всех промежуточных статусов, нужно анализировать блок statushistory (может не заполняться в следствии ограничений версии или тарифа конкретной службы доставки).# Система никогда не гарантирует последовательность прохождения заказом набора статусов. Т.е. Вы можете получить статус "COMPLETE", а следующим запросом - "NEW" - такое может произойти, например, если оператор ошибочно отметил заказ выполненным, а затем исправил ошибку. <return>NO</return> <return_service>2</divservice> <return_type>3<br /return_type> == Трекинг заказа по номеру == Запрос трекинга по номеру предназначен для выдачи минимальной обезличенной информации о конкретном заказе не авторизованному пользователю <return_weight>5. Наша система имеет для этого интерфейс по адресу "home.courierexe.ru1</{код экстра}return_weight> <return_message>Доставлено в целости</tracking". Вы можете либо сделать ссылку на такую страницу на своем сайте, либо разместить ее iframe'ом у себя, либо сделать свою и пользоваться нашим API. Этот интерфейс создан специально для выдачи информации живому пользователю сайта. Для получения статусов заказов в свою информационную систему нужно использовать запрос "statusreq", желательно с параметром changes=ONLY_LAST!return_message> <return_date>2026-01-19</return_date>'''Пример запроса <return_time>13:18:'''00<source lang="xml"/return_time> <?xml version="1.0" encoding="UTF-8"?pickup>NO<tracking/pickup> <extraprint_check>8YES</extraprint_check> <ordernowaittime>123412</ordernowaittime> <enclosure>Детские игрушки</trackingenclosure> <instruction>Проверить при покупателе, подписать акт</sourceinstruction> '''Пример ответа:''' <source langcurrcoords lat="xml55.680327"><?xml versionlon="137.0604456" accuracy="50" encodingRequestDateTime="UTF2014-04-821 18:07:45"?></currcoords> <trackingcourier> <order orderno="1234"code> 26<sender/code> <town code="1" country="RU"name>Москва городИванов Владимир Петрович</townname> <datephone>+79161234567</datephone> </sendercourier> <receiverdeliveryprice total="158.6" delivery="100.00" return="58.6"> <town advprice code="1" countryprice="RU150">Москва городБаза</townadvprice> <dateadvprice code="2" price="0">2015-04-18% от объявленной стоимости</dateadvprice> <advprice code="3" price="8.6">Топливный сбор</receiveradvprice> <AWBadvprice code="4" price="0">BarCodeОкругление</AWBadvprice> <weight>0 </weightdeliveryprice> <quantityreceiverpays>1NO</quantityreceiverpays> <acceptpartially>NO<currcoords lat="" lon="" accuracy="" RequestDateTime="" /acceptpartially> <status eventstore="филиал в Санкт-Петербурге" eventtime="2016-06-02 17:22:00" createtimegmt="2016-06-03 16:14:44" message="" title="Доставлен" countryeventtown="Санкт-Петербург город" color="RU16777215">COMPLETE</status> <statushistory> <status eventstore="Офис в Москве" eventtime="2016-05-30 10:20:00" createtimegmt="2016-06-03 16:14:44" message="" title="Новый" eventtown="Москва город" country="RU">NEW</status> <status eventstore="Офис в Москве" eventtime="2016-06-01 17:38:00" createtimegmt="2016-06-03 16:14:44" message="филиал в Санкт-Петербурге" title="Планируется отправка" eventtown="Москва город" country="RU">DEPARTURING</status> <status eventstore="Офис в Москве" eventtime="2016-06-01 19:53:00" createtimegmt="2016-06-03 16:14:44" message="филиал в Санкт-Петербурге" title="Отправлено со склада" eventtown="Москва город" country="RU">DEPARTURE</status> <status eventstore="филиал в Санкт-Петербурге" eventtime="2016-06-02 07:41:00" createtimegmt="2016-06-03 16:14:44" message="" title="Получен складом" eventtown="Санкт-Петербург город" country="RU">ACCEPTED</status> <status eventstore="филиал в Санкт-Петербурге" eventtime="2016-06-02 09:17:00" createtimegmt="2016-06-03 16:14:44" message="" title="Выдан курьеру на доставку" eventtown="Санкт-Петербург город" country="RU">DELIVERY</status> <status eventstore="филиал в Санкт-Петербурге" eventtime="2016-06-02 17:22:00" createtimegmt="2016-06-03 16:14:44" message="" title="Доставлен (предварительно)" eventtown="Санкт-Петербург город" country="RU">COURIERDELIVERED</status> <status eventstore="филиал в Санкт-Петербурге" eventtime="2016-06-02 17:22:00" createtimegmt="2016-06-03 16:14:44" message="" title="Доставлен" eventtown="Санкт-Петербург город" country="RU">COMPLETE</status> </statushistory> <customstatecode>2<customstatecode> <clientstatecode></orderclientstatecode> <deliveredto>Иванова, секр.</trackingdeliveredto> <delivereddate>2016-06-02</sourcedelivereddate> <deliveredtime>17:22</deliveredtime> <department>Отдел</department>'''Получение информации в формате 17 TRACK''' <costcode>cc12345</costcode> <outstrbarcode>EXT123456</outstrbarcode> <respstore>14</respstore> <partner>Офис на Ленина</partner>'''Пример запроса <arrival>2016-05-02 23:'''21</arrival> <source langreceipt fdNum="124555" fnSn="9289000100295555" kktNum="0001611984048555" inn="7722756555" fdValue="2899551555" summ="387.5" ofdUrl="xmlgate.ofd.ru">https://ofd.ru/rec/7722756555/0001611984048555/9289000100295555/124555/2899551555</receipt> <items> <?xml versionitem code="34533" extcode="abc123" quantity="1" mass="0.2" retprice="37.5" VATrate="0" barcode="2345625213125" article="1" returns="0" origincountry="040" GTD="" excise="0.00" governmentCode="11223311" govType="1" suppcompany="Поставщик" suppINN="1112223334" suppphone="79161234567">Мяч</item> <item code="34456" extcode="abc124" quantity="2" mass="2" retprice="100" VATrate="10" barcode="4645625213138" article="2" returns="0" governmentCode="" govType="1">Обруч</item> <item code="34421" extcode="abc125" quantity="3" mass="0.3" retprice="50" VATrate="18" barcode="2345625213126" itemcode="44123" article="3" returns="0" encodinggovernmentCode="UTF-8"?govType="1">Погремушка желтая</item> </items> <packages> <package code="33331" strbarcode="ORD0000001" mass="1" message="" got="YES"></package> <tracking17package code="33332" strbarcode="ORD0000002" mass="2.5" message="" got="NO"></package> </packages> <extrafields> <extrafield> <name>courier_car</name> <value>ВАЗ 2106, бежевый<extra/value>8 </extraextrafield> <orderno/extrafields>1234 </ordernoorder></tracking17statusreq>
</source>
'''Пример ответа:если нет заказов''' <pre>{ source lang="numberxml":"ExtNumber",> <?xml version="oriNumber1.0":encoding="1234utf-8",?> <statusreq count="oriCountry0":"RU",> "destCountry":"RU",</statusreq> "status":"Complete",</source> "events":[ {'''Пример ответа при ошибке авторизации''' "time":"2016-06-02 17:22:00", <source lang="locationxml":"RU",> "content<?xml version=":1.0"Completeencoding=" }, { "time":"2016-06utf-02 17:22:008",?> "location":"RU",<request> <error error="content1":errormsg="Courierdeliveredauthorization error"></error> },</request> {</source> "time":"2016-06-02 09:17:00", "location":"RU",'''Пример ответа при ошибке синтаксиса''' "content":"Delivery" }, { <source lang="timexml":"2016-06-02 07:41:00",> "location":"RU", "content":"Accepted" }, { <?xml version="time1.0":encoding="2016UTF-06-01 19:53:008",?> "location":"RU",<request> "content":"Departure" }, { "time" <error>column:"2016-06-01 171 line:3811 message:00",expected '>'</error> "location":"RU",</request> "content":"Departuring"</source> }, {=== Описание полей ответа статусов === "time":"2016-05-30 10:20:00", "location":"RU"Все поля ответа соответствуют структуре order при создании заказа, "content"с некоторыми добавлениями:"New" } ]}</pre>
*'''paytype''' - Тип оплаты заказа получателем. Принимает значения:
:: CASH - Наличными при получении (по-умолчанию)
:: CARD - Картой при получении
:: NO - Без оплаты.
:: OTHER - Прочее (Предусмотрен для того, чтобы оплата поступала непосредственно в курьерскую службу посредством прочих типов оплаты - таких как: вебмани, яденьги, картой на сайте, прочие платежные системы и т.д.)
* Атрибуты контейнера '''paytype''':
** '''''code''''' - (integer) внутренний код типа оплаты заказа в системном справочнике "Типы оплаты корреспонденции". Не обязательный элемент.
* '''status''' — статус доставки (список статусов см. ниже). Атрибуты (заполняются начиная с версии системы 2008.0.0.670)::* '''''eventstore''''' — филиал, к которому относится текущий статус:* '''''eventtime''''' — время события по часовому поясу места его наступления.:* '''''createtimegmt''''' — время по GMT создания записи о смене статуса в БД. Используется для сортировки записей, чтобы соблюсти хронологическую последовательность. <spoiler text=== Описание полей ответа изменения ===Все поля ответа соответствуют ответу "Подробнее">Большинство событий фиксируются в полях eventtime и createtimegmt на основании одного действия, тогда они отличаются только сдвигом от GMT. Однако, если курьер доставил отправление 10.10.2010 в 20:00, по какой-то причине не внес это в мобильное приложение, на следующий день сдал накладную, и в 9 утра оператор внесла, что он доставил вчера в 20:00. Тогда в createtimegmt будет сегодня 6 утра (для Москвы), а в eventtime — вчера в 20:00. При этом оператор по каким-то причинам может внести время вручения раньше, чем какое-то предыдущее событие, т.о. нарушится последовательность времени в eventtime, но при создании заказа за исключением корневого тэга сортировке по createtimegmt все- вместо равно все будет правильно.</spoiler>:* '''neworder''message' возвращается '''editorder' — наименование филиала-получателя, при передаче между филиалами:* ''.'''title''''' — русское наименование статуса
: RETURNING — Планируется возврат заказчику (после CANCELED).
: RETURNED — Возвращен заказчику.
: LOST — Утрачен/утерян.
'''Примечание.''' В будущем возможно дополнение используемого набора статусов.
<div style="color: #a94442; background-color: #f2dede; border: 1px solid #ebccd1; padding: 3px 10px 10px;">'''Описание полей запроса статуса:Обратите внимание!'''
# Контейнер '''cancelorderstatushistory''' - Корневой контейнер. Обязательный элемент.*и '''authdeliveryprice''' - Авторизация. Обязательный элементзаполняется для тарифов [[Личный кабинет курьерской службы#Функции личного кабинета|Премиум и Максимум]].*# Контейнер '''orderpackages''' - Контейнер отменяемого заказане возвращает более 1000 элементов. Обязательный элемент# Система никогда не гарантирует последовательность прохождения заказом набора статусов. Запрос То есть Вы можете получить статус «COMPLETE», а следующим запросом — «NEW» — такое может содержать более одного контейнера '''order'''. Атрибуты::* '''''orderno''''' - Шифр заказапроизойти, например, если оператор ошибочно отметил заказ выполненным, а затем исправил ошибку.:* '''''ordercode''''' - Внутренний код заказа.</div>Обратите внимание, что должен быть указан хотя бы один из атрибутов ''orderno'' или ''ordercode''!<br>
=== Передача только изменившихся статусов ===
В нашем API предусмотрено удобное средство получения статусов всех заказов, без необходимости «бомбить» сервер запросами статусов по каждому заказу. Работает это так: раз, например, в 10 минут, вы посылаете запрос «покажите все изменившиеся статусы». Пример запроса ниже. Система вам отдает ВСЕ заказы, статусы (или некоторые другие поля, см. ниже) которых изменились с момента последнего запроса. Вы разбираете полученный документ, по каждому заказу сохраняете его актуальный статус в своей системе, и если все хорошо, у вас все получилось, ваша система неожиданно не упала от наплыва информации, посылаете нам запрос подтверждения получения статусов (commitlaststatus). Мы у себя отмечаем, что эти статусы вами получены и их не надо передавать повторно. Таким образом, сколько бы заказов у вас ни было, статусы по ним всем почти в реальном времени вы можете получать всего двумя запросами.
<source lang="xml">
<?xml version="1.0" encoding="UTF-8" ?>
<cancelorderstatusreq> <order ordernoauth extra="123test8" ordercodelogin="123456login" errorpass="0" errormsg="OK" errormsgru="Успешноpass" ></auth> <changes>ONLY_LAST</changes> <order orderno="123aaa" ordercode="" error="52" errormsg="order not found" errormsgru="Заказ не найден" streamid>1234</streamid></cancelorderstatusreq>
</source>
<source lang="xml">
<?xml version="1.0" encoding="UTF-8" ?>
<attachmentscommitlaststatus> <auth extra="8" login="login" pass="pass" ></auth> <client>CLIENT</client> <ordernostreamid>12345671234</ordernostreamid></attachmentscommitlaststatus>
</source>
'''Описание полей:запроса'''
* '''attachmentsauth''' - Корневой контейнер — авторизация. Обязательный элемент.*'''authstreamid''' - Авторизация — идентификатор потока. Если у вас несколько интеграций и каждая нуждается в получении статусов, вы можете передавать данный параметр и тем самым разделять получение и отметку об успешном получении статусов по заказам. Обязательный Значение должно входить в промежуток от 100 до 10000, включительно. Необязательный элемент.*'''ordernoclient''' - Номер/код заказа — признак клиента или агента. Обязательный Необязательный элемент.:* CLIENT — признак клиента, значение по умолчанию:* AGENT — признак агента. В ответ отдается информация по заказам, переданным агенту на доставку
</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>
Для получения ограниченного числа изменившихся заказов отправьте запрос:
<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" ?>
<setorderinfocommitlaststatus> <auth extra="8" login="login" pass="pass" /> <order ordercode="123456"> <message>Получил Иванов</message> </orderauth> <order ordercode="234567"acs> <statusac>PICKUPREADY11111</statusac> <eventtimeac>2016-05-30 10:20:0022222</eventtimeac> <messageac>Клиент отказался от покупки33333</messageac> <paytypeac>CASH44444</paytypeac> <itemsac> <item code="34533" quantity="1" reason="0" /> <item code="34456" quantity="0" reason="0" /> <item code="34421" quantity="2" reason="0" /> </items> <image filename="filename1.jpg"> /9j/4AAQSkZJRgA BAQAAAQABAAD/2wBDAA0JCg sKCA0LCgsODg0PEyAVExISEy ccHhcgLikxMC4pLSwzOko+M zZGNywtQFdBRkxOUlNSMj5aY VpQYEpRUk//2wBDAQ4ODhMR EyYVFSZPNS01T09PT09PT09P T09PT09PT09PT09PT09PT09 PT09PT09PT09PT09PT09PT09 PT09PT0//wAARCAYACAADAS IA55555</imageac> </orderacs></setorderinfocommitlaststatus>
</source>
* '''Описание полей acs''' — контейнер. Обязательный элемент.* '''ac''' — атрибут''' ordercode''' контейнера '''order''' полученного на этапе запроса статуса:'''statusreq'''.
== Трекинг заказа по номеру ==
Запрос трекинга по номеру предназначен для выдачи минимальной обезличенной информации о конкретном заказе не авторизованному пользователю. Наша система имеет для этого интерфейс по адресу «home.courierexe.ru/{код экстра}/tracking». Вы можете либо сделать ссылку на такую страницу на своем сайте, либо разместить ее [[#Размещение страниц на своем сайте (iframe)|iframe’ом]] у себя, либо сделать свою и пользоваться нашим API. Этот интерфейс создан специально для выдачи информации живому пользователю сайта. Для получения статусов заказов в свою информационную систему нужно использовать запрос «statusreq», желательно с параметром changes=ONLY_LAST!
'''Пример запроса:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<tracking>
<extra>8</extra>
<orderno>1234</orderno>
</tracking>
</source>
'''Пример ответа:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<setorderinfotracking> <order ordercodeorderno="123456111111" errorordercode="012345" errormsg> <barcode>111111</barcode> <AWB>111111</AWB> <sender> <town code="OK1" errormsgrucountry="УспешноRU" >Москва город</town> <date>2014-03-22</date> <time_min>09:00</time_min> <time_max>14:00</time_max> <order ordercode/sender> <receiver> <town code="2345671" errorcountry="59RU" errormsg>Москва город</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> <deliveryprice total="value [date_put] is already set158.6" errormsgrudelivery="Значение [Дата доставки] уже указано100.00" return="58.6" /> <courier> <code>26</code> <name>Иванов Владимир Петрович</setorderinfoname> <phone>+79161234567</sourcephone> </courier> <currcoords lat="55.680327" lon= Получение документов для печати "37.604456" accuracy="50" RequestDateTime= '''Пример запроса получения печатных форм"2014-04-21 18:07:'''45" /> <source langstatus eventstore="xmlфилиал в Санкт-Петербурге"><?xml versioneventtime="1.02016-06-02 17:22:00" encodingcreatetimegmt="UTF2016-806-03 16:14:44" message="" title="Доставлен" ?>COMPLETE</status> <waybillstatushistory> <auth extrastatus eventstore="8Офис в Москве" eventtime="2016-05-30 10:20:00" createtimegmt="2016-06-03 16:14:44" loginmessage="login" passtitle="passНовый" /> NEW<orders/status> <order ordernostatus eventstore="Офис в Москве" eventtime="2016-06-01 17:38:00" createtimegmt="2016-06-03 16:14:44" message="1234567филиал в Санкт-Петербурге" ordercodetitle="33331Планируется отправка" >DEPARTURING</status> <order ordernostatus eventstore="Офис в Москве" eventtime="2016-06-01 19:53:00" createtimegmt="2016-06-03 16:14:44" message="1234568филиал в Санкт-Петербурге" ordercodetitle="33332Отправлено со склада" /> DEPARTURE</ordersstatus> <formstatus eventstore="филиал в Санкт-Петербурге" eventtime="2016-06-02 07:41:00" createtimegmt="2016-06-03 16:14:44" message="" title="Получен складом">1ACCEPTED</formstatus> </waybillstatus eventstore="филиал в Санкт-Петербурге" eventtime="2016-06-02 09:17:00" createtimegmt="2016-06-03 16:14:44" message="" title="Выдан курьеру на доставку">DELIVERY</sourcestatus> '''Описание полей:''' '''waybill''' <status eventstore="филиал в Санкт- Корневой контейнер. Обязательный элемент*'''auth''' Петербурге" eventtime="2016- Авторизация. Обязательный элемент*'''orders''' 06- Список заказов для получения печатных форм. Содержит тэги '''order''' с атрибутами02 17:22:* '''''orderno''''' 00" createtimegmt="2016-06- шифр заказа03 16:14:44" message="" title="Доставлен (предварительно)">COURIERDELIVERED</status>:* '''''ordercode''''' <status eventstore="филиал в Санкт-Петербурге" eventtime="2016- внутренний код заказа. Указывать необходимо один из атрибутов для всех заказов. Приоритет имеет атрибут '''''ordercode'''''*'''form''' 06- Формат накладной. Не обязательный элемент. Принимает значения02 17:22:* 1 00" createtimegmt="2016- Подробная накладная (по06-умолчанию)03 16:14:44" message="" title="Доставлен">COMPLETE</status> </statushistory> <deliveredto>Иванова, секр.</deliveredto>:* 2 <delivereddate>2016- Наклейки Zebra:* 3 06- Наклейки на страницу формата А402</delivereddate> <deliveredtime>17:* 4 - Акты приема-передачи22</deliveredtime> <outstrbarcode>EXT123456</outstrbarcode> <items>'''Пример ответа:''' <item code="34533" extcode="abc123" quantity="1" mass="0.2" retprice="37.5" VATrate="0" barcode="2345625213125" article="1" returns="0" origincountry="040" GTD="" excise="0.00" governmentCode="11223311" suppcompany="Поставщик" suppINN="1112223334" suppphone="79161234567">Мяч</item> <source langitem code="34456" extcode="abc124" quantity="2" mass="2" retprice="100" VATrate="10" barcode="4645625213138" article="2" returns="0" governmentCode="xml">Обруч</item> <?xml versionitem code="134421" extcode="abc125" quantity="3" mass="0.3" retprice="50" VATrate="18" barcode="2345625213126" article="3" returns="0" encodinggovernmentCode="UTF-8"?>Погремушка желтая</item> <waybill/items> <contentacquirers>EODIcaI8KSBlwQ 4MnEOR7Px8U8EBAyGICBnwpw IZhQgz0ZxuPs8EBM <acquirer code="2" name="Ibox"/GcbjzB AwhBl8hwQYIO00GmEwg1CeEG > mqYTChNU0wqf8l8nz4zgc+K fCno+zwU5GjOZmzXGcbEQYIM <acquirer code="5" name="Payme"/> 4zkegRE40zWzONyoNNMIOIa cWnp6aDCGEGE9NQmoQd2mg00 <acquirer code="6" name="Click"/> 79U4f3hPTwnfp6Sdrafeqpa JDpFw </1aYT077VNNNdO00G3q acquirers> mqqvp9p2E7T0/wiFemv8uG6 OM </contentorder></waybilltracking></source> В тэге content возвращаются бинарные данные (файл pdf), закодированные в base64.
где,
* '''acquirers''' / '''acquirer''' - эквайринг, доступный для получения ссылки на оплату заказа
** '''acquirers''' / '''acquirer''' / ''code'' - внутренний код эквайринга
** '''acquirers''' / '''acquirer''' / ''name'' - наименование эквайринга
'''Получение информации в формате 17 TRACK'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<townlisttracking17> <auth extra=">8" /> <codesearch> <zipcode>110000</zipcode> <kladrcode>0100000100800</kladrcode> <fiascode>bd21979d-46f8-49d0-9105-e8d65172a983</fiascode> <code>123</codeextra> </codesearchorderno> <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> 1234</limitorderno></townlisttracking17>
</source>
'''Пример ответа:'''
<source lang=pre>{ "number":"ExtNumber", "oriNumber":"1234", "oriCountry":"RU", "destCountry":"RU", "status":"Complete", "xmlevents">:[ {<?xml version= "1.0time" encoding=:"UTF2016-06-802 17:22:00", "location":"RU", "town":"Москва", "store":"Москва Главный", "content":"Complete"?><townlist count= }, { "3time" page=:"12016-06-02 17:22:00" totalcount=, "3location" totalpages=:"1RU">, < "town>":"Москва", "store":"Москва Главный", "content":"Courierdelivered" }, { "time":"2016-06-02 09:17:00", <code>26379</code> "location":"RU", <city> "town":"Москва", <code>23</code> "store":"Москва Главный", <name>Краснодарский край</name> "content":"Delivery" </city> }, <name>Сочи город</name> { <fiascode>79da737a "time":"2016-603b06-4c1902 07:41:00", "location":"RU", "town":"Москва", "store":"Москва Главный", "content":"Accepted" }, { "time":"2016-9b5406-9114c96fb912</fiascode>01 19:53:00", "location":"RU", "town":"Горький", "store":"Горький Автозавод", "content":"Departure" <kladrcode>2300000700000</kladrcode> }, <shortname /> (not yet supported) { <typename /> (not yet supported) "time":"2016-06-01 17:38:00", <coords lat= "43.5855location" lon=:"39.7231RU" />, </ "town>":"Горький", "store":"Горький Автозавод", "content":"Departuring" }, { "time":"2016-05-30 10:20:00", "location":"RU", < "town>":"Горький", "store":"Горький Автозавод", "content":"New" } ] <code>40331}</codepre> Функция ищет последний заказ по номеру среди заказов всех клиентов. Выдает неперсонализированную информацию о текущем состоянии заказа.<citybr> <code>32</code>Описание контейнеров ответа аналогично описанию [[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|Запроса статусов заказов]]. <name>Брянская область</name> </city>=== Получение ссылки для оплаты заказа === <name>Сочилов хутор</name> <fiascode>c9c96c67div style="color: #a94442; background-2cc9-4f10-afde-fd32417ea216</fiascodecolor: #f2dede; border: 1px solid #ebccd1; padding: 3px 10px 10px;"> <kladrcode>3201900011100'''Обратите внимание!'''Этим методом вы можете только получить ссылку на оплату. Фискализация этого платежа идет отдельным процессом. По его возможности уточняйте в службе поддержки.</kladrcodediv> <shortname /> Заказ доступен для оплаты, если:* тип оплаты заказа не наличными, а например картой или по договору, альтернативой может стать установка параметра "Спрашивать тип оплаты" в карточке клиента.* заказ имеет наложенный платеж* не оплачен* активен (не доставлен, не возвращен в т.ч. курьером) '''Пример запроса:'''<typename /source lang="xml"> <coords lat?xml version="521.64070" lonencoding="33.1724UTF-8" /?> </town> <townacqlink> <codeextra>1140168</codeextra> <cityacq> <code>602</code> <name>Псковская область</name> </cityacq> <name>Сочихино деревня</nameorder> <fiascodecode>10df7588-19c1-49d1-a387-9de1cf3eb26f12345</fiascode> <kladrcode>6001900015400</kladrcode> <shortname /> <typename /code> <coords lat="56.6003" lon="29.3542" /> </townorder></townlistacqlink>
</source>
'''Пример ответа:'''<source lang="xml"><?xml version= Справочник регионов "1.0" encoding="UTF-8"?><acqlink error="0" amount="2000" extid="161083231">https://qr.nspk.ru/AD10001A7GLVGA9YDO2I0789SIOPV3?type=02&bank=1000011&sum=2000&cur=RUB&crc=7E9C</acqlink></source>
где*'''Пример запроса справочника:acqlink''' - ссылка на оплату заказа*acqlink.'''amount''' - тип integer сумма платежа в копейках в общем случае, в других случаях в соответствии с типом валюты*acqlink.'''extid''' - идентификатор счета на стороне платежной системы*acqlink.'''error''- код ошибки, если отличается от 0, означает невозможность получения ссылки на оплату, в этом случае ссылки на оплату не будет и ответ будет выглядеть так:
<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<regionlist> <codesearch> <code>77<acqlink error="2" message="Ошибка авторизации: Invalid token" amount="2000" extid=""/code> </codesearch> <conditions> <namecontains>край</namecontains> <namestarts>Моск</namestarts> <fullname>Московская область</fullname> <country>1</country> </conditions></regionlist>
</source>
где*acqlink.'''Пример ответа:message'''- текст ошибки возвращаемой эквайрингом <source lang="xml">Возможные типы ошибок получения ссылки:<?xml version="* '''1.0" encoding="UTF''' -8"?>не настроен эквайринг, либо не найден заказ<regionlist count="* '''2">''' - ошибка на стороне эквайринга <city>* '''3''' - запрещающий статус курьера (заказ доставлен, частично доставлен) <code>80</code>* '''4''' - оплата заказа не разрешена <country> <code>1</code>== Изменение заказа == <name>Россия</name>Запрос предназначен для изменения заказов. <id>643</id> <ShortName1Изменять заказы могут курьерские службы с тарифами «Премиум» и «Максимум». Чтобы разрешить изменение заказов, в личном кабинете курьерской службы перейдите в '''Настройки''' >RU</ShortName1> <ShortName2>RUS</ShortName2> </country> <name>Агинский Бурятский автономный округ</name>'''Заказы''' и в разделе '''Отмена и редактирование''' установите флажок '''Разрешить отмену и изменение заказов'''. Вы также можете пометить в списке '''Статусы для отмены и редактирования заказов''' </city>галками статусы корреспонденции, для которых возможны отмена и изменение заказов. По умолчанию (когда в этом списке ничего не выбрано) редактирование и отмена разрешены для статуса «Новый» <city> <code>1</codediv style="color: #a94442; background-color: #f2dede; border: 1px solid #ebccd1; padding: 3px 10px 10px;"> <country>'''Обратите внимание!''' <code>1</code># Данные запроса изменения указываются '''полностью''', как если бы заказ создавался впервые. <name>Россия</name># При отсутствии вложения в запросе изменения данное вложение '''не удаляется''' из заказа, но его количество становится равным 0. <id>643</id> <ShortName1>RU</ShortName1> <ShortName2>RUS</ShortName2> </country> <name>Адыгея республика</name> </city></regionlist># При одновременном изменении заказа в API и системе курьерской службы приоритет отдается данным системы курьерской службы. То есть изменения в API приняты не будут.</sourcediv>
=== Описание полей запроса изменения ===Все поля запроса соответствуют структуре order при создании заказа за исключением: * значение '''Пример запроса справочника улиц:orderno'''данным методом изменить нельзя.<source lang="xml"><?xml version="1* значение '''barcode''' изменяется в случае явного его указания.0" encoding="UTFВ случае отсутствия или пустого значения -8"?>остается прежним.<streetlist>* вместо корневого тэга '''neworder''' указывается '''editorder'''; <conditions>* тэг курьера '''courier''' можно изменить только при включенной настройке '''Разрешить изменение курьера по АПИ'''; <town>Москва город</town> // ОБЯЗАТЕЛЬНОЕ ПОЛЕ!* для вложений '''item''' указывается внутренний код вложения в атрибуте '''code''', который можно получить при получении статуса заказа. <namecontains>Хохло</namecontains> <namestarts>Академика Х</namestarts> <name>Академика Хохлова</name> <fullname>Академика Хохлова ул* для мест '''package''' указывается внутренний код вложения в атрибуте '''code''', который можно получить при получении статуса заказа.</fullname> </conditions> <limit> <limitfrom>30</limitfrom> <limitcount>10</limitcount> <countall>YES</countall> </limit></streetlist></source>Необходимо иметь в виду, что:
'''Пример запроса справочника номенклатурыотмены заказа:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8" ?>
<itemlistcancelorder> <auth extra="8" login="login" pass="pass"></auth> <codesearch> <code>order orderno="" ordercode="123456<" /code> <article>FD343 <order orderno="123aaa" ordercode="" /article> <barcode>2345625213125</barcodecancelorder> </codesearch> <conditionssource> <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> </limit></itemlist></source>
'''Пример ответа:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?><itemlist countcancelorder> <order orderno="3123test" totalcountordercode="3123456" pageerror="10" totalpageserrormsg="1OK"errormsgru="Успешно" /> <item> <code>123456</code> <article>FD343</article> <barcode>2345625213125</barcode> <name>Sony KDL-55W905 ЖК-телевизор</name> <retprice>65000</retprice> <purchprice>50000</purchprice> <weight>5.1</weight> <length>50</length> <width>30</width> <height>40</height> <CountInPallet>30</CountInPallet> <HasSerials>1</HasSerials> <CountryOfOrigin>Малайзия</CountryOfOrigin> (order orderno="123aaa" ordercode="" error="52" errormsg="order not yet supported) <Message>Хороший телевизор<found" errormsgru="Заказ не найден" /Message> <Message2>Снова хороший телевизор</Message2> <quantity>12</quantity> <reserved>3</reserved> <item> ...</itemlistcancelorder>
</source>
'''Пример запроса движения номенклатуры:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8" ?>
<itemmovementsaddattachments> <auth extra="8" login="login" pass="pass"/> <orderno>1234567</orderno> <attachments> <item name="photo1.jpg">JVBERi0xLjMN1wb25lbnQgMQ JUBQREYwMTIzNDU2Nzg5IDI NMyAwIG9iag08PA0vVHlwZSA U3VidHlwZSAvSW1hZ2UNL1d pZHRoIDE4MDgNL0hlaWdodCA ggNCAwIFINL0JpdHNQZXJDb 21wb25lbnQgMQ0vRGVjb2RlU ENL0NvbHVtbnMgMTgwOA0+P g0vSW1hZ2VNYXNrIHRydWUNL XhEZWNvZGUNPj4Nc3RyZWFt DQ</authitem> <item name="photo2.jpg">VBERi0xLjMNAwIG9iag0HRoJ JUBQREYwMTIzNDU2Nzg5IDI NMyAwIG9iag08PA0vVHlwZSA vWE9iamVjdA0vU3VidHlwZS AvSW1hZ2UNL1dpZHRoIDEzNj gNL0hlaWdodCAxMzMzDS9MZ W5ndGggNCAwIFINL0JpdHNQZ XJDb21wb25lbnQgMQ0vRGVj b2RlUGFybXMgPDwNL0sgLTEN L0NvbHVtbnMgMTM2OA0+Pg0 vSW<code/item>4259 </codeattachments></itemmovementsaddattachments>
</source>
'''Описание полей:'''
'''addattachments''' — Корневой контейнер. Обязательный элемент.* '''auth''' — Авторизация. Обязательный элемент.* '''orderno''' — Номер заказа. Обязательный элемент. Может использоваться тэг <ordercode> с указанием внутреннего кода заказа.* '''attachments''' — Обязательный элемент, в котором перечисляются передаваемые данные файлов.** '''item''' — Бинарные данные (файл), закодированные в base64. Обязательный элемент.*** '''name''' — Атрибут элемента '''item''', в котором передается имя файла. Обязательный элемент. '''Пример ответа движения номенклатуры:'''<source lang="xml"><?xml version="1.0" encoding="UTF-8"?><addattachments> <attachments> <item name="photo1.jpg" error="0" errormsg="OK" errormsgru="Успешно" /> <item name="photo2.jpg" error="0" errormsg="OK" errormsgru="Успешно" /> </attachments></addattachments></source> == Получение вложений к накладной =='''Пример запроса:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8" ?>
<itemmovements countattachments> <auth extra="8" login="login" pass="16pass"/> <itemmovement> <codeorderno>1515001234567</codeorderno> <date>2017-05-26</dateattachments> <retprice>0</retpricesource> <quantity>1<'''Описание полей:''' '''attachments''' — Корневой контейнер. Обязательный элемент.* '''auth''' — Авторизация. Обязательный элемент.* '''orderno''' — Номер/quantity>код заказа. Обязательный элемент. <delivered>0</delivered>'''Пример ответа:''' <itemsource lang="xml"> <code>4259</code?xml version="1.0" encoding="UTF-8"?> <name>Настольная игра Дженга</nameattachments> </itemname="doc1.docx" timestamp="2025-01-01 12:00:00" size="35654">JVBERixLjMN <status> UwLJdLwIDKxTn+AScMjKqor7Xm3sp1yj1k6BzlPdX2Qsiit6yg3g1fCI4YVAgclUOIY5tDra2LvAcIS <code> 5</code> <name>Возврат от покупателя<+8PsL/sXb0+aoper/9kL/name> <4Ov/status>YE9QsHwyg7YZTtKICy0YVIYb4Nt7L1tPUMfaX9NpuTsvFCtBAvYG <store> eJVZoZ2tm6+fZVqAavZpeLizVLtct1a+xvG0+bTSkw3Ac8PhdNfL4smrT2hSgPJLfyaVGyA2ndyW22t <code>1< sFtTP5knktPNumSZ56QsFRPJkaU8ExDxAcMYMDIoBiIoR4/code> <name>офис в Москве<dDjHMbMW/name>EW4fiB1pvWmV2ONWIl1Xdub < Xg1ob0qWX9W4qagsqzGhjRLsEGeJGVXg9oVC+XkJa9esrhGUmC0tuKEla+AplVO/store>OtHwXcW0FWui1z7 <order> 6KHrtobuWV0xa9sCEiSvb91w3ePHOvfcveo5xt9o4ZevHF7ZOeKxV5qmVx2MI44a1L+Mhk5YuGT12xd <ordercode>3374830< Ibsb7r+j9bff/ordercode> <number>123660-0<unQlv0al6HBnoD5G89q4+tkjgDtvwwARmqm2aa2Jgvmth8mrXquTNtl2u467vbF/number>5r <date>2017-05-24< vnMt9uesu21Me1bjeNJGlVfAaCtw+/date> <orderno>14123<jfenJ/orderno>fWjqa7ygExx+L0BcTGroxrKexQXIQ1ImfEW7ZRJZa+O <barcode>0000000670< ip7xJmmNESMxrgu/barcode>dquBbGypjJpFDJVRH1rVPR1Ifl4aFS5IEdDWZFSdyBBWKWhVSVu517ZgzOCFAwp <company>ТОВАР< wwbFph29g4fTaxnvn/company>3X78x+Tt56ZNffArgULt+HByvy7+yz6U6XWMawCi3+6gJXN0S+jf4t+HT34wg <address>Кравченко ул., 1< km7/address>HDp55YTSWMoCMgZsvZkBrXtIv4WA7xgkT4YpYpxjwLvnsWKkGE+pDbxER0UUWlpVFRY4oilTfM4 <delivereddate>2017-05-29</delivereddate> MIzgCPgxjOlZ87ceA7ceRJrgpipFGyugPQ4OTI2S8lWJoqTpHJlJbNOeYM7zTcoVxSNyJXiYWSAMklT <deliveredtime>12:00:00< q/deliveredtime> <deliveredto xd+3fd3/>USq2V1rJ7RyBLHsuDSiLwgaOFc5LUCRGI+QWuBAsIwPlZrgRpSMseJyTzD15PKiIRE7bc </order> Rggk5ijXAPpqISetD4wVm0AD2LHuBZdaxmK3HOKIZoG0QLmiZdVqspXnFIJwVyCKhWiDCI4bzH8Y76w <document> TAnwM67HIqMISOkmJXY8mlYhpiNa7g2oTBkKxo4wgnvETQIUUrlFOn9KdOreDiKQx071rN4N61yRAi1 <code>21991< 7EGRhSOgoeLYv+k41+KZ1SVBXAuDjB+xuxnQmm8wJDcP5IRn+5penzbR/code>ivm7qleHK5o790w8ejXchI <number>318 vOHIPWtWwYhtAO34LdDXqFqWxZEBLNstMCwwITBTWirxk12zuUppp</numberitem> <date>2017-05-26</dateattachments> <message></messagesource> </document> </itemmovements>В тегах item возвращаются бинарные данные (файлы), закодированные в base64. </itemlist>== Изменение статуса агентом ==<Запрос изменения статуса заказа позволяет установить окончательный статус заказа — «Доставлен» или «Не доставлен (Возврат/source>Отмена)».
'''Описание полей запроса статуса:''' '''setorderinfo''' — Корневой контейнер. Обязательный элемент.* '''auth''' — Авторизация. Обязательный элемент.* '''order''' — Контейнер заказа. Обязательный элемент. Запрос может содержать более одного контейнера '''order'''. Атрибут '''''ordercode''''' — внутренний код заказа.* '''status''' — Новый статус заказа. Доступны статусы из раздела [[#Описание полей ответа статусов]], кроме AWAITING_SYNC и NEW.* '''eventtime''' — Дата и время изменения статуса. Обязательно при указании статуса.* '''message''' — Текст сообщения ''Инфо о доставке''.*'''documentoutstrbarcode''' - контейнер документа операции — код у подрядчика (код заказа во внешней системе). Используется в интеграциях с внешними системами.* '''paytype''' — Тип оплаты заказа. Допустимые значения CASH/CARD.* '''storeprice''' — Агентское вознаграждение.* '''items''' — Контейнер для описания вложений '''item''' . Атрибуты::* '''''code''' - внутренний код документа'' — Код вложения.:* '''''quantity''''' — Количество доставленных единиц вложения.:* '''''reason''''' — Причина недоставки, выбирается из соответствующего списка статусов.:* '''number''governmentCode''''' — Указание кода ТН для вложения при необходимости.* '''attachments''' — Контейнер прикрепляемых изображений. Может содержать несколько контейнеров '''attachment''' - номер документа:* '''dateattachment''' - дата документа — Контейнер изображения. Содержит текст файла изображения, закодированный по стандарту ''base64''. Атрибут:::* '''message''filename''''' - комментарий — Имя файла.
'''Пример запроса пунктов самовывозаответа:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8" ?><pvzlistsetorderinfo> <auth extraorder ordercode="8123456" loginerror="login0" passerrormsg="passOK" errormsgru="Успешно"></auth> <code>1234</code> <town>Нижний Тагил</town> <parentcode>6</parentcode> <acceptcash>YES</acceptcash> <acceptcard>YES</acceptcard> <acceptfitting>YES</acceptfitting> <maxweight>30</maxweight> <acceptindividuals>YES</acceptindividuals> <lt>57.924737</lt> <lg>order ordercode="234567" error="59.940019</lg> <rt>57.905682</rt> <rg>59.984669</rg> <json>YES<" errormsg="value [date_put] is already set" errormsgru="Значение [Дата доставки] уже указано" /json></pvzlistsetorderinfo>
</source>
<source lang="xml">
<?xml version="1.0" encoding="UTF-8" ?>
<pvzlist count="2"waybill> <pvz> <code>126<auth extra="8" login="login" pass="pass" /code> <clientcodeclient>3CLIENT</clientcodeclient> <name>Нижний Тагил </nameorders> <parentcode>6<order orderno="1234567" ordercode="33331" /parentcode> <parentname>Интеграция</parentname> <town codeorder orderno="1234568" ordercode="12426733332">Нижний Тагил город</town> <address>622036, г. Нижний Тагил, ул. Циолковского, д. 17 </addressorders> <phoneform>+73435417709, +734352549891</phoneform> <commentstart>Новый пункт доставки5</commentstart> <worktimeintegration>Вс 10:00-16:00, Сб 10:00-16:00, Пн-Пт 10:00-20:0021</worktimeintegration> <traveldescription>Жилое 5-ти этажное здание, торцом к дороге, второе здание от перекрестка Пархоменко-Циолковского</traveldescriptionwaybill> <maxweight>10</maxweightsource> <acceptcash>YES</acceptcash> <acceptcard>YES</acceptcard>'''Описание полей:''' <acceptfitting>YES</acceptfitting> <acceptindividuals>YES</acceptindividuals>'''waybill''' — Корневой контейнер. Обязательный элемент <latitude>57* '''auth''' — Авторизация.93457</latitude>Обязательный элемент <longitude>59* '''client''' — Признак клиента или агента. Необязательный элемент.95131</longitude> </pvz>:* CLIENT — Признак клиента, значение по умолчанию <pvz>:* AGENT — Признак агента. В ответ отдается информация по заказам, переданным агенту на доставку <code>245</code>* '''orders''' — Список заказов для получения печатных форм. Содержит тэги '''order''' с атрибутами: <clientcode>NTG1</clientcode>:* '''''orderno''''' — шифр заказа <name>На Красноармейской</name>:* '''''ordercode''''' — внутренний код заказа. Указывать необходимо один из атрибутов для всех заказов. Приоритет имеет атрибут '''''ordercode''''' <parentcode>6</parentcode> <parentname>Интеграция</parentname> <town code="124267">Нижний Тагил город</town> <address>КРАСНОАРМЕЙСКАЯ, д* '''form''' — Формат накладной. Не обязательный элемент.79</address>Принимает значения: <phone>+7:* 1 — Подробная накладная (3435по-умолчанию)379-044</phone> <comment>Возможность примерки отсутствует</comment>:* 2 — Наклейки Zebra <worktime>Вс 10:00-16* 3 — Наклейки на страницу формата А4:00, Сб 10:00* 4 — Акты приема-16:00, Пн-Пт 10:00-20:00</worktime>передачи <traveldescription>Напротив ТЦ Пирамида</traveldescription>* '''start''' — Имеет смысл только для form = 3. Начальная позиция первой наклейки. Используется для пропуска наклеек на листе для их экономии. <maxweight>20</maxweight> <acceptcash>YES</acceptcash> <acceptcard>YES</acceptcard> <acceptfitting>NO</acceptfitting> <acceptindividuals>YES</acceptindividuals> <latitude>57* '''integration''' - Получение наклеек от подрядчика.93468</latitude> <longitude>60Не обязательный элемент, имеет смысл при наличии кода подрядчика в карточке заказа.55476</longitude>Принимает значение: </pvz>:* 21 - подрядчик GTD</pvzlist></source>
Блок integration содержит отдельные наклейки для заказов, предоставленные подрядчиком, так же закодированные в base64. '''Пример запроса Видов срочности:Обратите внимание'''<source lang="xml"><?xml version="1Лимит количества при единовременном получении печатных форм - 1000 штук.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" ?><calculatorwaybill> <auth extra="8" login="login" pass="pass" /error> Текст ошибки<calc townfrom="Москва" townto="3800000300000" l="10" w="20" h="30" mass="3.7" service="1" /error></calculatorwaybill>
</source>
<?xml version="1.0" encoding="UTF-8"?>
<calculatortownlist> <calcauth extra="8" /> <codesearch> <zipcode>110000</zipcode> <kladrcode>0100000100800</kladrcode> <fiascode>bd21979d-46f8-49d0-9105-e8d65172a983</fiascode> <townfrom code="1">Москва город123</code> </codesearch> <conditions> <city>Краснодарский край</city> <namecontains>новгород</townfromnamecontains> <townto code="56603"namecontainsparts>Иркутск городмолоково моск</towntonamecontainsparts> <massnamestarts>3.7Моск</massnamestarts> <service name="Экспресс">1Москва</name> <fullname>Москва город</servicefullname> <zonecountry>1</country>2 </zoneconditions> <limit> <pricelimitfrom>116330</pricelimitfrom> <mindeliverydayslimitcount>110</mindeliverydayslimitcount> <maxdeliverydayscountall>3YES</maxdeliverydayscountall> </calclimit></calculatortownlist>
</source>
* '''conditions''Обратите внимание' — Задает условия поиска. Все вложенные элементы одновременно накладывают условие «И».:* '''city''' — Поиск по всем населенным пунктам региона.:* '''namecontainsparts'' В реальном ответе сервера в теге calc присутствует атрибут ' — Поиск населенных пунктов, название которых содержит все указанные слова, с разбиением поисковой фразы через пробел. Например "моск моло" найдет деревню "priceМолоково"в Московской области. Он оставлен для обратной совместимости:* '''namecontains''' — Поиск населенных пунктов, название которых содержит указанный текст.:* '''namestarts''' — Поиск населенных пунктов, название которых начинается с указанного текста.:* '''name''' — Поиск населенных пунктов, название которых соответствует указанному тексту.:* '''fullname''' — Поиск населенных пунктов, не используйте егоназвание вместе с типом населенного пункта которых соответствует указанному тексту. Пользуйтесь вложенным тегом price:* '''country''' — Поиск только по стране с указанным внутренним кодом или текстовым кодом в соответствии [https://ru.wikipedia.org/wiki/ISO_3166-1 стандартом ISO_3166-1], например, «RU», «RUS» для России.
'''Пример запроса списка актов передачи денегответа:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8" ?><smalist> <auth extratownlist count="3" page="81" logintotalcount="login3" passtotalpages="pass1" /> <datefromtown> <code>2016-02-1026379</datefromcode> <city> <datetocode>2016-03-1023</datetocode> <name>Краснодарский край</smalistname> </sourcecity> <name>Сочи город</name>'''smalist''' <fiascode>79da737a- Корневой контейнер. Обязательный элемент.*'''auth''' 603b- Авторизация. Обязательный элемент.*'''datefrom''' 4c19- Дата "с". Необязательный элемент.*'''dateto''' 9b54- Дата "по". Необязательный элемент.9114c96fb912</fiascode>Если интервал дат не указан, то возвращаются акты передачи денег за последний месяц. <kladrcode>2300000700000</kladrcode> <shortname /> (not yet supported)'''Пример ответа на запрос списка актов передачи денег:''' <source lang="xml"typename /> (not yet supported) <?xml versioncoords lat="143.05855" encodinglon="UTF-839.7231"?/> <smalist count="1"/town> <smatown> <code>627840331</code> <numbercity> <code>399232</numbercode> <name>Брянская область<actdate/name>2016-02-12 </actdatecity> <datepayname>Сочилов хутор</datepayname> <datetofiascode>2016c9c96c67-2cc9-024f10-12afde-fd32417ea216</datetofiascode> <promiseddatepaykladrcode>3201900011100</promiseddatepaykladrcode> <priceshortname />637.00 <typename /price> <pricecorrcoords lat="52.6407" lon="33.1724" />113.00 </pricecorrtown> <town> <rurcode>13430.00114016</rurcode> <pricekurcity>570.00 <code>60</pricekurcode> <name>Псковская область<priceag/name>67.00 </priceagcity> <paynoname>42423Сочихино деревня</paynoname> <paytypefiascode>110df7588-19c1-49d1-a387-9de1cf3eb26f</paytypefiascode> <paytypenamekladrcode>Безнал6001900015400</paytypenamekladrcode> <signedcopyreceivedshortname />NO <typename /> <coords lat="56.6003" lon="29.3542" /signedcopyreceived> </smatown></smalisttownlist>
</source>
== Детализация актов передачи денег Справочник регионов == '''Пример запроса детализации актов передачи денегсправочника:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8" ?><smadetailregionlist> <codesearch> <code>77</code> <auth extra="8" login="login" pass="pass" /codesearch> <codeconditions> <namecontains>край</namecontains> <namestarts>Моск</namestarts> <fullname>Московская область</fullname> <country>RU</country>6278 </codeconditions></smadetailregionlist>
</source>
<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<smadetail regionlist count="2"> <specialsmacity> <code>4249480</code> <ordercodecountry>14424 <code>1</ordercodecode> <ordernoname>11111Россия</ordernoname> <orderdateid>2018-01-01643</orderdateid> <delivereddateShortName1>2018-10-01RU</delivereddateShortName1> <ShortName2>RUS<company/ShortName2>Компания </companycountry> <pricename>314.00Агинский Бурятский автономный округ</pricename> </city> <city> <rurcode>8800.001</rurcode> <inshpricecountry> <code>314.001</inshpricecode> <pricekurname>270.00Россия</pricekurname> <priceagid>44.00643</priceagid> <pricecalcShortName1>8486.00RU</pricecalcShortName1> <paytypeShortName2>2RUS</paytypeShortName2> <paytypename>наличными курьером</paytypenamecountry> <statusname>ДоставленоАдыгея республика</statusname> </specialsmacity></smadetailregionlist>
</source>
<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<shortlinkmanifest> <hashresult error="Текст ошибки">35AF350CERROR</hashresult></shortlinkmanifest>
</source>