Изменения

API

56 383 байта добавлено, 25 июнь

→‎Оформление манифеста

<div style="font-size: ~~24px~~18px; color: #a92424; background-color: #ffdede; border: 1px solid #ebccd1; padding: 3px 10px 10px;">'''~~ВНИМАНИЕ!~~ Изменения для 54-ФЗ!'''

Для передачи ставки НДС при оформлении заказа добавлен атрибут items -> item -> VATrate.

При использовании услуги кассового обслуживания необходимо в обязательном порядке передавать состав заказа со ставками НДС!.

'''ВНИМАНИЕ!'''

В ближайшем будущем, при подключенной услуге кассового обслуживания, система '''перестанет''' принимать заказы без состава вложений!.

</div>

'''English version is [[API ~~documentation~~Documentation|HERE!]]'''

</div>

~~В системе "Курьерская служба 2008" имеется возможность интеграции~~ Вы можете настроить интеграцию с MeaSoft средствами XML API, по протоколу HTTP POST.

~~Данное~~ API предназначено для интеграции клиентов (интернет-магазинов и прочих компаний-заказчиков доставки) с [http://courierexe.ru/our_clients.htm курьерскими службами], работающими под управлением системы [https://curie.ru/ MeaSoft ~~"Курьерская служба 2008"~~]. Если Вы являетесь '''агрегатором''', передающим данные от клиентов, возможно, Вам придется последовательно подключаться под разными пользователями, если курьерская служба должна вести раздельный учет взаиморасчетов по клиентам. Если Вы являетесь '''подрядчиком''' - Вы можете забирать заказы, используя значение client=AGENT в запросе [[#Пример запроса статуса заказа|statusreq]], и передавать статусы заказов используя метод [[#Изменение статуса агентом|setorderinfo]]. Так же для интеграций с подрядчиками у нас есть специальная платформа, но добавлять подрядчиков в нее можно только на нашей стороне. Присылайте нам коммерческое предложение, описание Вашего сервиса, и мы с радостью его рассмотрим.

~~При написании данной документации мы предполагаем~~Если вы '''агрегатор''', ~~что ее читатель обладает необходимой для понимания квалификацией программиста~~передающий данные от клиентов, ~~владеет XML и средой разработки~~возможно, в которой он делает интеграцию. Если Вы не являетесь программистом - Вам необходимо привлечь к проекту профессионального программиставам придется последовательно подключаться под разными пользователями, если курьерская служба должна вести раздельный учет взаиморасчетов по клиентам.

Если вы '''подрядчик''', вы можете забирать заказы, используя значение client=AGENT в запросе [[#Пример запроса статуса заказа|statusreq]], и передавать статусы заказов, используя метод [[#Изменение статуса агентом|setorderinfo]]. Также для интеграций с подрядчиками у ~~Вас~~нас есть специальная платформа, но добавлять подрядчиков в нее можно только на нашей стороне. Присылайте нам коммерческое предложение, описание вашего сервиса, и мы с радостью его рассмотрим. При написании этой документации мы предполагаем, что ее читатель обладает необходимой для понимания квалификацией программиста, владеет XML и средой разработки, в которой он делает интеграцию. Если вы не программист, вам необходимо привлечь к проекту профессионального программиста. Если у вас после прочтения ~~данной~~ документации остались вопросы, ~~Вы можете~~ задайте их ~~задать~~ по почте [mailto:support@courierexe.ru support@courierexe.ru]. Обязательно представьтесь, напишите ~~Ваши~~ ваши контактные данные (телефон, скайп) и название компании, с которой Вы вы хотите интегрироваться.

== Готовые интеграции ==

Для работы с популярными CMS и CRM-системами разработаны модули интеграции, перечисленные в таблице ниже.

'''Модули распространяются бесплатно, без гарантий со стороны разработчика''', и не являются средством полной автоматизации взаимодействия с курьерской службой. Модули — это помощь разработчикам интернет-магазинов в построении интеграции с курьерскими службами. '''Ответственность за корректность передачи данных лежит на интернет-магазине.'''

Модули сторонних разработчиков обслуживаются и разрабатываются сторонними компаниями. Все вопросы по их приобретению и поддержке необходимо задавать им.

~~Для интеграции с популярными CMS можно скачать модули интеграции:~~Сообщайте нам свои пожелания по работе наших модулей. Мы учтем их в новых версиях.

{| class="wikitable" align="center" style="width: 80%; margin: auto; background-color:#ffffff; border: 1px solid #999999;" cellpadding="10" cellspacing="0"

|-

|[[Файл:bitrix.png|center|x44px]]

|style="text-align: center;"|[~~http~~https://marketplace.1c-bitrix.ru/solutions/measoft.courier/ Установить] |Поддерживает версии 1420.5 .0 и выше. Подробнее см. [[~~Интеграция с другими системами#Bitrix~~1C-Битрикс|описание]].

|-

|[[Файл:prestashop.png|center|x60px]]

|style="text-align: center;"|[~~http~~https://courierexe.ru/download/api/prestashop.zip Скачать]|Поддерживает версии 1.5.2.0 и выше (2.x Инструкция в ~~том числе!)~~архиве

|-

|[[Файл:OpencartOCStore.png|center|~~x70px~~x60px]]|style="text-align: center;"|[~~http~~https://courierexe.ru/download/api/opencart.zip Скачать для версии 1.5.5.1]<br>[~~http~~https://courierexe.ru/download/api/measoft_oc2.ocmod.zip Скачать для версии 2.0]<br>[~~http~~https://courierexe.ru/download/api/measoft_oc2.3.ocmod.zip Скачать для версии 2.3]<br>[~~http~~https://courierexe.ru/download/api/~~measoft_ос3~~measoft_oc3.ocmod.zip Скачать для версии 3.0]|Поддерживает версии с 1.5.5.1.<br>Скачивайте модули для своей версии OpenCart.<br>Подробнее см. [[~~Интеграция с другими системами#~~OpenCart ~~1.5.5.1~~|описание]].<br>[https://opencartforum.com/files/file/2906-avtomatizaciya-otpravki-i-otslezhivanie-dostavok-courierexe-dlya-opencart-15x/ Альтернативный модуль сторонних разработчиков]

|-

|[[Файл:webasyst-shopscript.png|center|x44px]]

|style="text-align: center;"|[~~http~~https://www.webasyst.ru/store/plugin/shop/measoftcourier/ Установить модуль]<br>[https://www.webasyst.ru/store/plugin/shipping/measoftcourier/ Установить плагин]|Модуль предназначен для отправки заявок в КС, а плагин для расчета стоимости доставки при оформлении заказа.Инструкции в маркете

|-

<!--|[[Файл:advantshop.png|center|x44px]]

|style="text-align: center;"|[https://promo-z.ru/ Сайт компании PROMO]

|-

|[[Файл:~~insales~~iiko.~~png~~jpg|center|x80px]]|style="text-align: center;"|Настраивается в [~~http://www.insales.ru/collection/all/product/kurierskaya-sluzhba-2008 Установить~~[Личный кабинет клиента|ЛК пользователя]]|[[~~Интеграция с другими системами#InSales~~Iiko|~~Настраивается~~Инструкция по настройке]] ~~в ЛК пользователя в системе~~

|-

|[[Файл:Leadvertex.png|center|x44px]]

|style="text-align: center;"|[~~[Файл:Leadvertex-howto.png|center|x44px]]|[http~~https://blog.leadvertex.ru/news/2110-integraciya-s-kurerkami-na-platforme-measoft/ Настраивается] в ЛК ~~пользователя в системе~~ [https://Leadvertex.ru Leadvertex]|[[LeadVertex|Инструкция по настройке]]<br>Модуль разработан и поддерживается компанией LeadVertex.

|-

|[[Файл:Retailcrm.png|center|~~x44px~~x30px]]

|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|x60px]]

|style="text-align: center;"|[~~http~~https://courierexe.ru/download/api/com_measoft.zip Скачать]|Работает только с компонентом Virtuemart. Внимание! Модуль новый, поэтому возможна некорректная передача данных. Проверяйте, если что - сообщайте, исправим!Инструкция в архиве

|-

|[[Файл:Amocrm.png|center|x44px]]

|style="text-align: center;"|[https://www.amocrm.ru/extensions/courier2008 Установить]

|-

|-

|[[Файл:wordpress.jpg|center|x80px]]

|style="text-align: center;"|[~~http~~https://courierexe.ru/~~download/api~~wordpress/wordpress.~~zip~~ php Скачать]|[[~~Интеграция с другими системами#~~Wordpress|Инструкция]]<br>Внимание! Модуль новый, поэтому возможна некорректная передача данных. Проверяйте, если что - сообщайте, исправим!

|-

|[[Файл:Cscart.png|center|x60px]]

|-

|[[Файл:~~Moguta~~webhooks.~~png~~jpg|center|~~x80px~~x100px]]|style="text-align: center;"|~~https://salesbeat.pro/~~Читайте описание [[Webhook|на этой странице]]|~~По вопросам интеграции обращайтесь~~ Передача информации о статусах и заказах в ~~[https://salesbeat.pro Salesbeat]~~вашу систему

|-

|}

'''Обратите внимание!''' В модулях систем PrestaShop и Joomla для отправки заказа в курьерскую службу зайдите в карточку заказа. В карточке отображается специальная форма отправки заказа, а если заказ отправлен, она позволяет проверить его статус:[[Файл:Form.png|400 px|Форма отправки заказа|none]]

Для отображения списка пунктов выдачи есть ~~'''готовый JavaScript модуль''':~~ [https://home.courierexe.ru/js/measoft_map.js JavaScript модуль]. Инструкция по ~~использованию -~~ использованию — внутри. Посмотреть пример работы можно [https://home.courierexe.ru/pvz_test.html ~~Здесь~~здесь] Модули распространяются бесплатно, без гарантий со стороны разработчика, и не являются средством полной автоматизации взаимодействия с курьерской службой. Модули — это помощь разработчикам интернет-магазинов в построении интеграции с курьерскими службами. Ответственность за корректность передачи данных лежит на интернет-магазине. ~~Сообщайте нам свои пожелания по работе наших модулей. Мы учтем их в новых версиях~~.

== Тестовый аккаунт ==

Для отладки зайдите в тестовый личный кабинет по адресу [https://home.courierexe.ru/8 https://home.courierexe.ru/8], логин: login пароль: pass.

~~Для отладки Вы~~ На вкладке '''Интеграция''' > '''Отладка''' вы можете зайти в тестовый личный кабинет по адресу [https://home.courierexe.ru/8 https://home.courierexe.ru/8], логин: test пароль: testm. Там на закладке "Автоматизация" Вы сможете увидеть свои пробовать выполнять запросы ~~"глазами" нашей системы. Так же там есть интерфейс~~ к API для ~~выполнения~~ отладки, а также видеть историю отправленных запросов. ~~На закладке "~~Созданные заказы появятся в пункте основного меню '''Отслеживание~~" Вы увидите созданные заказы~~'''.

Для упрощения интеграции можно скачать [~~http~~https://courierexe.ru/download/api/php_sample.zip пример обращения к сервису на PHP].

== Рабочий аккаунт для подключения ==

Строка подключения выглядит следующим образом:

</source>

~~Для подключения к площадке Вашего~~ Описание параметров:* '''extra''' — экстра-код, уникальный идентификатор компании, с которой вы интегрируетесь.* '''login''' — логин клиента ~~необходимо иметь три параметра:~~ ;* '''pass''' — пароль клиента;* '''measoftid''' — системная переменная, используемая системой.

~~1. '''Параметр extra''' (Цифровой код, уникальный идентификатор компании.~~ Запросите ~~этот параметр~~ эти данные у ~~компании~~курьерской службы, с к которой ~~Вы интегрируетесь)~~вы подключаетесь. ~~Посмотреть этот код можно~~ Курьерская служба передает временный пароль, его нужно сменить после первого входа в ~~интерфейсе программы КС2008 через основное меню '''"Справочники - Дополнительные возможности"'''~~[[Личный кабинет клиента|ЛК клиента]]. ~~Цифровое значение будет указано во второй гиперссылке (на скриншоте ниже отмечено "звездочкой"):~~

~~[[Файл~~== Авторизация курьерской службы ==Если курьерской службе требуется подключение под своими учетным данными, используйте строку вида:~~extra1.png|750px]]~~

~~2. '''Логин''' - параметр учетной записи для ЛК клиента и API, указывается в карточке клиента на вкладке '''~~<source lang=xml><auth extra="~~Прочее~~8"~~''' в поле '''~~login="~~Имя пользователя~~login"~~'''. Возможно, что в программе КС2008 понадобится создать новую карточку клиента (на скриншоте ниже).~~pass="pass" clientcode="123"></auth></source>

3. Описание:* '''~~Пароль~~extra''' ~~- параметр учетной записи для ЛК клиента и API, указывается в карточке клиента на вкладке~~ — уникальный идентификатор компании;* '''login''' — логин курьерской службы;* '''~~"Прочее"~~pass''' ~~в поле~~ — пароль курьерской службы;* '''~~"Пароль"~~clientcode''' — внутренний код клиента (~~на скриншоте ниже~~вкладка '''Клиенты''', столбец «Внутренний код»).

Вы можете узнать код экстра, логин и пароль курьерской службы в офисном приложении MeaSoft в справочнике '''Дополнительные возможности'''. Подробнее см. раздел «[[~~Файл:33_client.png~~Личный кабинет курьерской службы#Подключение|~~500px~~Подключение]]».

== Общие понятия ==

На стороне курьерской службы имеется веб-сервис по адресу: https://home.courierexe.ru/api/. <rspoiler text="Еще есть порт 8443.">Некоторые маршрутизаторы, используемые провайдерами, РНК и прочее, в попытке глубокого анализа могут повреждать трафик на стандартный порт 443. Сделано по тикету 10964.</rspoiler> Обратите внимание на символ '''«/»''' (slash) в конце адреса.

Тестовые авторизационные данные: логин: login пароль: pass, параметр extra: 8. Обратите внимание, что тестовая площадка для всех одна. Не нужно передавать в нее заказы с конфиденциальными данными, их смогут увидеть другие участники.

Для использования интеграции в «боевом» режиме, запросите '''логин''', '''пароль''', и параметр '''extra''' у той компании, с которой интегрируетесь.

Вы можете отправлять тестовые запросы к нашему сервису и видеть историю отправленных запросов в личном кабинете на закладке '''Интеграция'''.

~~На стороне курьерской службы имеется веб-~~Клиент отправляет запросы к сервису методом HTTP POST, сервис ~~по адресу: https://home~~обрабатывает запросы и возвращает результат выполнения.~~courierexe.ru/api/. <rspoiler text="Еще есть порт 8443.">Некоторые маршрутизаторы, используемые провайдерами, РНК~~ Все запросы и ~~прочее,~~ ответы передаются в ~~попытке глубокого анализа, могут повреждать трафик на стандартный порт 443~~формате XML. ~~Сделано по тикету 10964.</rspoiler> Тестовые авторизационные данные: логин: test пароль: testm, параметр extra:~~ Кодировка — UTF-8. ~~Обратите внимание, что тестовая площадка для всех одна~~Разделитель целой и дробной частей чисел — используется символ точки. ~~Не нужно передавать~~ Даты представляются в ~~нее заказы с конфиденциальными данными~~виде YYYY-MM-DD, ~~их смогут увидеть другие участники.~~Для использования интеграции в "боевом" режиме, запросите '''логин''', '''пароль''', и параметр '''extra''' у той компании, с которой интегрируетесь.Вы можете отправлять тестовые запросы к нашему сервису в личном кабинете на закладке "Автоматизация". В личном кабинете так же можно видеть историю отправленных Вами запросоввремя — HH:MM.

Клиент отправляет запросы к сервису, методом HTTP POST, сервис обрабатывает запросы и возвращает результат выполнения. Все запросы и ответы передаются в формате XML.Кодировка - UTF-8. Разделитель целой и дробной частей чисел - используется символ точки. Даты представляются в виде YYYY-MM-DD, время - HH:MM.В силу [https://ru.wikipedia.org/wiki/XML#.D0.A0.D0.B5.D1.88.D0.B5.D0.BD.D0.B8.D0.B5_.D0.BF.D1.80.D0.BE.D0.B1.D0.BB.D0.B5.D0.BC.D1.8B_.D0.BD.D0.B5.D0.BE.D0.B4.D0.BD.D0.BE.D0.B7.D0.BD.D0.B0.D1.87.D0.BD.D0.BE.D1.81.D1.82.D0.B8_.D1.80.D0.B0.D0.B7.D0.BC.D0.B5.D1.82.D0.BA.D0.B8 особенностей языка XML], некоторые символы в тексте должны быть заменены: & на &amp; < на &lt; > на &gt; " на &quot;

Наше 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]].* вы должны знать номера заказов, которые вы отправили. Не нужно перебирать номера всех заказов или брутфорсом перебирать все возможные номера.

Мы абсолютно уверены, что данные ограничения на порядки превосходят необходимые объемы предоставления сервиса для решения любых задач. Если у вас возникают проблемы, вы не знаете, как уложиться в эти ~~рамки -~~ рамки — спросите у нас, мы обязательно поможем!

== Оформление заказа ==

=== Пример оформления заказа ===

<?xml version="1.0" encoding="UTF-8"?>

</receiver>

<~~return~~price>NO387.5</~~return~~price> <~~weight~~inshprice>387.5.1</~~weight~~inshprice> <deliveryprice VATrate="20">150</deliveryprice> <discount>120</discount> <paytype>CASH</paytype> <~~return_weight~~weight>5.1</~~return_weight~~weight>

~~<paytype>CASH</paytype>~~

<return_service>1</return_service>

~~<type>3</type>~~

<return_type>3</return_type>

<return_weight>5.1</return_weight>

~~<price>387.5</price>~~

~~<deliveryprice VATrate="20">150</deliveryprice>~~

~~<inshprice>387.5</inshprice>~~

~~<discount>120</discount>~~

<enclosure>Детские игрушки</enclosure>

<instruction>Проверить при покупателе, подписать акт</instruction>

<items>

<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>

</advprices>

<overall_volume>81</overall_volume>

<groupid>customer</groupid>

</order>

</neworder>

=== Описание элементов для оформления заказа ===

'''Обязательные поля'''

Обязательными на уровне системы являются только 3 поля: receiver->company или receiver->person, receiver->address и receiver->phone. Так же в настройках системы сама курьерская служба может назначить какие-то дополнительные поля обязательными, тогда, если вы их не укажете, получите сообщение об ошибке.

<?xml version="1.0" encoding="UTF-8"?>

<order>

<address>Петровка, 38</address>

</receiver>

</order>

</neworder>

</source>

</spoiler>

'''Описание полей'''

*'''neworder''' - — Корневой контейнер, обязательный элемент.

:* '''''newfolder''''' - — Признак нового заказа YES/NO. Если стоит YES, то в системе курьерской службы для данной корреспонденции создастся новый заказ. Необязательный элемент.

*'''order''' - — Контейнер для описания одного заказа, обязательный элемент. В одном контейнере '''neworder''' может быть много контейнеров '''order''' для создания нескольких заказов одним запросом.

:* '''''orderno''''' - — Номер заказа. Если присваивается ~~клиентом -~~ клиентом — указывается здесь. Если не ~~присваивается -~~ присваивается — можно оставить пустым, система сгенерирует свой номер, и вернет его в ответе. Система проверяет наличие заказов с указанным номером в пределах текущего календарного года, и в случае их ~~существования -~~ существования — заказ создан не будет, а в ответе вернется ошибка 17 ~~"Such~~ «Such number ~~exists"~~exists». Если не указан ~~штрих-код~~ штрихкод (поле barcode), и значение поля подходит для использования его в качестве ~~штрих-кода~~штрихкода, данное значение будет скопировано в поле ~~"Штрих-код"~~«Штрихкод». Это накладывает ограничения в частности, на длину указанного поля (25 знаков, чтобы работали стандартные печатные формы).

*'''barcode''' ~~- Штрих-код~~ — Штрихкод заказа. ~~В случае, если~~ Если клиент ~~штрих-кодирует~~ штрихкодирует свои отправления, и ~~штрих-код~~ штрихкод отличается от номера заказа, в этом поле указывается ~~штрих-код~~штрихкод. ~~В случае наличия нескольких мест, и раздельной их маркировки, в этом поле допустимы маски в виде~~ Если ШК содержит кириллицу или малое количество символов ~~подчеркивания~~, ~~говорящие о позициях штрих-кода, переменных для разных мест~~ то формируется ШК в ~~рамках одного заказа.<br />~~''Например'': В заказе номер 123 имеется 20 товарных вложений, которые упакованы в 3 транспортных места. Клиент формирует 3 штрих-кода на транспортные места: CLNT0012301, CLNT0012302, CLNT0012303, где CLNT - префикс клиента, 00123 - номер заказа, 01-03 - номер транспортного места в заказе. В поле barcode нужно указать CLNT00123__ (система поймет, что 2 последних символа могут быть любыми, и будут отражать штрих-коды к одному заказу). Если вы не сами печатаете накладные с указанным штрих-кодом, то указанный штрих-код не должен быть длиннее 25 знаков, иначе он не поместится на стандартных печатных формахформате 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> <company>Название компании отправителя</company>

<person>Контактное лицо отправителя</person>

<phone>Телефон, Email отправителя</phone>

</source>

*'''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 — Наличными при получении (по-умолчанию):* CARD — Картой при получении:* NO — Без оплаты. Этот тип оплаты передается, если заказ уже оплачен и не требует инкассации. API добавит к товарам строку предоплаты в сумму заказа, чтобы общая сумма была 0, однако в кассовом чеке будут все товары с ценами, и оплата предоплатой, как того требует 54-ФЗ.:* OTHER — Прочее (Предусмотрен для того, чтобы оплата поступала непосредственно в курьерскую службу посредством прочих типов оплаты — таких как: вебмани, яденьги, картой на сайте, прочие платежные системы и т. д.):* 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''' - Универсальный идентификатор заказа на стороне отправителя. Не обязательный параметр, ограниченного по времени действия. Время хранения в системе, - сутки. * '''items''' — Контейнер для описания вложений. <rspoiler text="Необязательный контейнер">Если для поставщика товара в системе MeaSoft не указаны полное наименование компании и ИНН в карточке клиента, заполните параметры <code>suppcompany</code> и <code>suppINN</code> в этом контейнере. Отсутствие информации о поставщике приведет к [[Настройка модуля печати кассовых чеков#Ошибка фискализации (ошибка программирования реквизита 1226)|ошибке фискализации]].</rspoiler>. Атрибуты::* '''''item''''' — Название вложения.:* '''''quantity''''' — Количество единиц товара.:* '''''mass''''' — Масса единицы товара в килограммах.:* '''''volume''''' — Объемный вес единицы товара в килограммах. При указании объемного веса значение подставляется вместо массы:* '''''length''''' — Длина единицы товара (в сантиметрах).:* '''''width''''' — Ширина единицы товара (в сантиметрах).:* '''''height''''' — Высота единицы товара (в сантиметрах).:* '''''retprice''''' — Цена единицы товара. Округляется до копеек. Должна быть с учетом всех скидок и наценок. Для вложений типов 1, 2, 3 не может быть отрицательной. :* '''''inshprice''''' — Объявленная ценность единицы товара. Округляется до копеек. Если не указана принимается равной '''''retprice'''''.:* '''''VATrate''''' — Ставка НДС — целое число процентов. Если товар хранится в КС (смотрите '''article''' ниже), значение берется из номенклатуры. Иначе, если значение указано, берется указанное значение, если нет - значение из настроек фирмы КС. Значение «0» означает ставку «Без НДС», ставка «0%» на данный момент не поддерживается.:* '''''barcode''''' — Штрихкод вложения.:* '''''article''''' — Артикул вложения. ''Внимание!'' Указание артикула используется только тогда, когда товар хранится на ответственном хранении в службе доставки, и необходима комплектация. В этом случае система пытается привязать товар к [[API#Справочник номенклатуры|справочнику номенклатуры]]. Если товар в справочнике не найден — система выдаст соответствующую ошибку. Если по артикулу найдено несколько товаров — система выберет один из них случайным образом, что может привести к ошибочной комплектации! Если товар НЕ на ответственном хранении — артикул указывать НЕ нужно. Позиция попадет в систему просто текстом.:* '''''itemcode''''' — Внутренний код товара, может использоваться вместо артикула. ''Внимание!'' Указание кода товара используется только тогда, когда товар хранится на ответственном хранении в службе доставки, и необходима комплектация. В этом случае система пытается привязать товар к [[API#Справочник номенклатуры|справочнику номенклатуры]]. Если товар в справочнике не найден — система выдаст соответствующую ошибку. Если товар НЕ на ответственном хранении — код товара указывать НЕ нужно.:* '''''type''''' — Тип вложения. Принимает значения::: 1 — Товар. По-умолчанию.:: 2 — Доставка. Такое вложение добавится автоматически, если заполнить order->deliveryprice:: 3 — Услуга:: 4 — Предоплата. Указывается сумма. Поле quantity игнорируется, всегда «1». В заказе сумма будет отрицательной независимо от знака в запросе. Такое вложение добавится автоматически при указании order->paytype=NO.:: 6 — Оплата кредитом. Указывается сумма. Поле quantity игнорируется, всегда «1». В заказе сумма будет отрицательной независимо от знака в запросе.:: 7 — Забор товара. Если товар нужно у получателя забрать, возможно — вернуть деньги, или его стоимость вычтется из суммы других товаров. У такого товара в заказе будет отрицательное количество независимо от знака в запросе.:* '''''extcode''''' — Внешний код строки. Используется для идентификации строк заказов при получении статусов. Необязательное поле.:* '''''origincountry''''' — Код страны-производителя в соответствии со [https://ru.wikipedia.org/wiki/ISO_3166-1 стандартом ISO_3166-1], например, «RU», «RUS» или «643» для России.:* '''''GTD''''' — Номер ГТД.:* '''''excise''''' — Сумма акциза.:* '''''suppcompany''''' — Наименование компании поставщика, если отличается от заказчика.:* '''''suppphone''''' — Номер телефона компании поставщика, если отличается от заказчика.:* '''''suppINN''''' — ИНН компании поставщика, если отличается от заказчика.:* '''''governmentCode''''' — Код товарной номенклатуры. Используется для [[Маркировка|маркированных товаров, например («Честный знак»)]]. Для кода '''Честный знак''' Нужно указывать все данные из нанесенного QR-кода кроме не читаемых символов (#29). Если код не известен — укажите знак вопроса «?», тогда курьер отсканирует код фактически передаваемого покупателю товара. Для некоторых процессов может использоваться значение «!» — в этом случае курьер сканирует серийный номер товара, но это не считается кодом маркировки. При этом, если указано значение «?» или «!» и quantity больше 1, то такое вложение растиражируется quantity раз.:* '''''govType''''' — Тип маркировки товара. В данный момент существуют следующие типы маркировки::: 1 — Честный знак. По-умолчанию.:: 2 — ГИИС ДМДК.:: 3 — Серийный номер. :* '''''extraTags''''' — Строка в формате JSON для отправки в ОФД. :: Тэг 1265 - значение отраслевого реквизита = код места деятельности аптеки :: Тэг 1262 – идентификатор ФОИВ = "020" (константа ФОИВ МИНЗДРАВа) :: Тэг 1263 - дата нормативного акта федерального органа исполнительной власти = "14.12.2018" (константа) :: Тэг 1264 - номер нормативного акта федерального органа исполнительной власти = "1556"(константа) :: Тэг 1212 - Признак предмета расчета :: Пример: <source lang="json">"item_industry_props":{"tag1262":"020","tag1263":"14.12.2018","tag1264":"1556","tag1265":"tm=mdlp&sid=00000000XXXXXX"},"tag1212": "1"</source>

*'''paytype''' - Тип оплаты заказа получателем. Принимает значения:

~~:* CASH - Наличными при получении (по-умолчанию)~~

~~:* CARD - Картой при получении~~

:* NO - Без оплаты. Этот тип оплаты передается, если заказ уже оплачен и не требует инкассации. API добавит к товарам строку предоплаты в сумму заказа, чтобы общая сумма была 0, однако в кассовом чеке будут все товары с ценами, и оплата предоплатой, как того требует 54-ФЗ.

:* OTHER - Прочее (Предусмотрен для того, чтобы оплата поступала непосредственно в курьерскую службу посредством прочих типов оплаты - таких как: вебмани, яденьги, картой на сайте, прочие платежные системы и т.д.)

:* OPTION - На выбор получателя. Этот тип оплаты нельзя передавать с заказом. Он выставляется автоматически в зависимости от настройки клиента.

*'''~~zipcode~~packages''' ~~- Почтовый индекс~~ — Контейнер для описания мест. Необязательный контейнер.Атрибуты::*'~~''weight~~''' ~~- Общий вес заказа в килограммах.~~*'package''~~return_weight~~''' ~~- Общий вес возврата заказа в килограммах~~ — Название места.:*'''~~quantity~~''code' ~~- Количество мест.~~*'''~~service~~'~~'' - Режим доставки (тип услуги) передается~~ — Внутренний код ~~из справочника [[#Справочник Видов срочности|"Виды срочности"]]~~строки.:*'''~~return_service~~''strbarcode' ~~- Режим возврата (тип услуги) передается код из справочника "Виды срочности"~~'''' — Штрихкод места.:*'''~~type~~''mass''''' ~~- Тип корреспонденции (отправления) передается код из справочника "Типы корреспонденции"~~ — Масса места в килограммах.:*'''~~return_type~~''message'''' ~~- Тип возвратной корреспонденции (отправления) передается код из справочника "Типы корреспонденции"~~' — Строка сообщения.:*''~~'price~~''' - Сумма заказа. В случае наличия контейнера items значение данного параметра будет проигнорировано, и рассчитано автоматически.*length'''~~deliveryprice~~''~~' - Сумма доставки. В случае наличия контейнера items,~~ — Длина товарного места (в ~~него будет добавлено вложение "Доставка"~~сантиметрах).:* '''''~~VATrate~~width''''' ~~- Ставка НДС - целое число процентов~~ — Ширина товарного места (в сантиметрах).:*'''~~return~~''height' ~~- Признак необходимости возврата.~~*'''~~return_service~~'~~'' - Режим возврата~~ — Высота товарного места (~~тип услуги~~в сантиметрах) ~~передается код из справочника "Виды срочности"~~.:*'''~~discount~~''quantity''''' ~~- Сумма скидки~~ — Количество мест с данным набором параметров. ~~Скидка "размазывается" по товарным вложениям, сумма НП уменьшается~~ Действует ограничение на ~~сумму скидки~~общее количество мест в заказе. ~~При этом вложение Скидка~~ Общее количество мест в заказе не ~~создается. ВНИМАНИЕ, при использовании этого тега общая сумма~~ может расходиться на копейки из-за округления! Старайтесь не использовать этот тег, а указывать цену товаров уже с учетом скидокбыть больше 1000.*'''enclosure''' - Вложение.*'''~~inshprice~~deliveryset''' ~~- Объявленная ценность. Если явно не указана сумма - автоматически считается как сумма по товарам~~ — настройка [[Дифференцированная стоимость доставки|дифференцированной стоимости доставки]].Атрибуты::*'''~~instruction~~''above_price' ~~- Поручение - Примечание.~~*'''~~courier~~'~~'' - Запланированный курьер. Согласно коду курьера~~ — стоимость в случае полного выкупа заказа (действует как «сумма от» последней границы, указанной в ~~КС2008.~~теге below_sum):*'''~~receiverpays~~''return_price' ~~- Признак оплаты стоимости доставки - услуг службы доставки получателем, а не заказчиком YES/NO.~~*'''~~department~~'~~'' - Подразделение,~~ — стоимость в ~~котором оформляется заказ.~~случае возврата заказа:*'''~~pickup~~''VATrate' - Признак оформления забора YES/NO. Если стоит YES, то весь заказ считается заданием на забор груза, а не на доставку! Применяется для вызова курьера к отправителю для забора других отправлений.*'''~~acceptpartially~~'~~'' - Признак возможности частичного выкупа товаров отправления YES/NO~~ — Ставка НДС — целое число процентов.

*'''~~items~~below''' ~~- Контейнер для описания вложений. Необязательный контейнер. Атрибуты:~~ — граница стоимости настроек:* '''''~~item~~below_sum''''' ~~- Название вложения.~~ — граница стоимости выкупаемого заказа:* '''''~~quantity~~price''''' ~~- Количество единиц товара.:* '''''mass''''' - Масса единицы товара в килограммах.~~:* '''''volume''''' - Объемный вес единицы товара в килограммах. При указании объемного веса значение подставляется вместо массы~~:* '''''length''''' - Длина единицы товара (в сантиметрах).:* '''''width''''' - Ширина единицы товара (в сантиметрах).:* '''''height''''' - Высота единицы товара (в сантиметрах).~~:* '''''retprice''''' - Цена единицы товара. Округляется до копеек. Должна быть с учетом всех скидок и наценок. Для вложений типов 1, 2, 3 не может быть отрицательной. ~~:* '''''inshprice''''' - Объявленная ценность единицы товара. Округляется~~ — стоимость выкупаемого заказа до ~~копеек. Если не указана принимается равной '''''retprice'''''.~~:* '''''VATrate''''' - Ставка НДС - целое число процентов. Если значение не указано, подставляется значение "20". Значение "0" означает ставку "Без НДС", ставка "0%" на данный момент не поддерживается.~~:* '''''barcode''''' - Штрих-код вложения. [[Файл:Article.png|thumb|100px|right]]~~:* '''''article''''' - Артикул вложения. ''Внимание!'' Указание артикула используется только тогда, когда товар хранится на ответственном хранении в службе доставки, и необходима комплектация. В этом случае система пытается привязать товар к [[API#Справочник номенклатуры|справочнику номенклатуры]]. Если товар в справочнике не найден - система выдаст соответствующую ошибку. Если по артикулу найдено несколько товаров - система выберет один из них случайным образом, что может привести к ошибочной комплектации! Если товар НЕ на ответственном хранении - артикул указывать НЕ нужно. Позиция попадет в систему просто текстом.~~:* '''''type''''' - Тип вложения. Принимает значения::: 1 - Товар. По-умолчанию.:: 2 - Доставка. Такое вложение добавится автоматически, если заполнить order->deliveryprice:: 3 - Услуга~~:: 4 - Предоплата. Указывается сумма. Поле quantity игнорируется, всегда "1". В заказе сумма будет отрицательной независимо от знака в запросе. Такое вложение добавится автоматически при указании order->paytype=NO.:: 6 - Оплата кредитом. Указывается сумма. Поле quantity игнорируется, всегда "1". В заказе сумма будет отрицательной независимо от знака в запросе.:: 7 - Забор товара. Если товар нужно у получателя забрать, возможно - вернуть деньги, или его стоимость вычтется из суммы других товаров. У такого товара в заказе будет отрицательное количество независимо от знака в запросе.:* '''''extcode''''' - Внешний код строки. Используется для идентификации строк заказов при получении статусов. Необязательное поле.:* '''''origincountry''''' - Код страны-производителя в соответствии со [https://ru.wikipedia.org/wiki/ISO_3166-1 стандартом ISO_3166-1], например, "RU", "RUS" или "643" для России.~~:* '''''GTD''''' - Номер ГТД.:* '''''excise''''' - Сумма акциза.:* '''''suppcompany''''' - Наименование компании поставщика, если отличается от заказчика.:* '''''suppphone''''' - Номер телефона компании поставщика, если отличается от заказчика.:* '''''suppINN''''' - ИНН компании поставщика, если отличается от заказчика.~~:* '''''governmentCode''''' - Код товарной номенклатуры. Используется для [[Маркировка | маркированных товаров ("Честный знак")]]. Нужно указывать все данные из нанесенного QR-кода кроме не читаемых символов (#29). Если код не известен - укажите знак вопроса "?", тогда курьер отсканирует код фактически передаваемого покупателю товара. Для некоторых процессов может использоваться значение "!" - в этом случае курьер сканирует серийный номер товара, но это не считается кодом маркировки. Если поле заполнено - поле quantity должно содержать только "1", иначе вернется ошибка. соответствующей границы

*'''~~packages~~advprices''' - — Контейнер для описания ~~мест~~дополнительных услуг. Необязательный ~~контейнер~~элемент. ~~Атрибуты~~<span style="color:~~:* '''''package''''' - Название места.~~red;>Для обработки в API включите дополнительные услуги в настройках полей [[Личный кабинет курьерской службы#Настройка личного кабинета клиента|заказов и заборов]]</span>:* '''''code''''' ~~- Внутренний~~ — код ~~строки~~услуги.:* '''''~~strbarcode~~value''''' ~~- Штрих-код места~~ — значение услуги.~~:* '''''mass''''' - Масса места в килограммах.:* '''''message''''' - Строка сообщения.:* '''''length''''' - Длина единицы товара (в сантиметрах).:* '''''width''''' - Ширина единицы товара (в сантиметрах).:* '''''height''''' - Высота единицы товара (~~Если тип услуги bool, то в ~~сантиметрах)~~значении передаем true.

* '''~~deliveryset~~overall_volume''' ~~- настройка [[Дифференциальная стоимость доставки | дифференциальной стоимости доставки]]~~ — Общий объем, м3. ~~Атрибуты::* '''''above_price''''' - стоимость~~ Виртуальное поле. Необязательное. Из этого поля рассчитывается длина/высота/ширина места. Расчет срабатывает только если в ~~случае полного выкупа заказа (действует как "сумма от" последней границы, указанной в теге below_sum):* '''''return_price''''' - стоимость в случае возврата заказа:* '''''VATrate''''' - Ставка НДС - целое число процентов~~каждом месте есть нулевые значения длины или высоты или ширины.

* '''~~below~~userid''' ~~- граница стоимости настроек:* '''''below_sum''''' - граница стоимости выкупаемого заказа:* '''''price''''' - стоимость выкупаемого заказа до соответствующей границы~~ — Идентификатор пользователя, строковый или числовой тип. Виртуальное поле. Необязательное. Данное поле используется совместно с настройками «Цена доставки для получателя», определяя приоритет правила. Можно использовать в различных CMS/CRM системах, настраивая цены для определенного покупателя.

* '''~~advprices~~groupid''' ~~- Контейнер для описания дополнительных услуг~~ — Идентификатор группы пользователя, строковый или числовой тип. Виртуальное поле. ~~Необязательный:* '''''code''''' - код услуги:* '''''value''''' - значение услуги~~Необязательное. ~~Если тип услуги bool~~Данное поле используется совместно с настройками «Цена доставки для получателя», то определяя приоритет правила. Можно использовать в ~~значении передаем true~~различных CMS/CRM системах, настраивая цены для определенной группы покупателей.

*<div style="color: #a94442; background-color: #f2dede; border: 1px solid #ebccd1; padding: 3px 10px 10px;">'''~~costcode~~Обратите внимание!''' ~~- Кост-код сотрудника~~При передаче заказов, у которых плановая дата доставки/забора меньше ближайшей возможной, дата автоматически меняется на самую раннюю возможную.[[Личный кабинет курьерской службы#Как считается минимальная дата возможной доставки|Подробнее]]</div>

*'''overall_volume''' - Общий объем, м3. Виртуальное поле. Необязательное. Из этого поля рассчитывается длина/высота/ширина места. Расчет срабатывает только если в каждом месте есть нулевые значения длины или высоты или ширины.

В случае необходимости указания, помимо товаров, дополнительных услуг (например, ДОСТАВКА, комплектация, подъем на этаж ~~и т~~и т.д д.) - — их нужно указать в том же контейнере items как товары, без артикула.

=== Примеры ответов ===

При успешном выполнении запроса, создании заказа, возвращается сумма заказа в атрибуте orderprice, а также ошибка 0. При не ~~успешном -~~ успешном — номер ошибки и текст ее на английском языке в атрибуте errormsg, для некоторых ошибок выводится перевод на русский в атрибуте errormsgru.В атрибут orderno помещается номер заказа, в атрибут barcode — штрихкод заказа.

'''Пример успешного ответа'''

<?xml version="1.0" encoding="UTF-8"?>

</neworder>

</source>

<?xml version="1.0" encoding="UTF-8"?>

</neworder>

</source>

== ~~Запрос статуса заказов~~ = Коды и описание ошибок ==={|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.||Дата не может быть раньше чем завтра. ~~<acceptpartially>NO</acceptpartially>~~|- ~~<status eventstore="филиал в Санкт-Петербурге" eventtime="2016~~|72||Date cannot be later than 15 days from now.||Дата не может быть позже чем через 15 дней.|-06|73||Date cannot be earlier than today.||Дата не может быть раньше чем сегодня.|-~~02 17:22: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="Доставлен">COMPLETE</status>~~ ~~<statushistory>~~|76||Specify a valid «Quantity» field value.||Укажите корректное значение поля «Количество товара». ~~<status eventstore="Офис в Москве" eventtime="2016~~|-~~05-30 10:20:00" createtimegmt="2016-06~~|77||Specify a valid «Item price» field value.||Укажите корректное значение поля «Цена единицы товара».|-~~03 16:14:44" message="" title="Новый">NEW</status>~~ ~~<status eventstore="Офис в Москве" eventtime="2016~~|78||Specify a valid «Delivery time from» field value.||Укажите корректное значение поля «Время доставки с».|-~~06-01 17:38:00" createtimegmt="2016~~|79||Specify a valid «Delivery time to» field value.||Укажите корректное значение поля «Время доставки до».|-06|80||Specify a valid «Pickup time from» field value.||Укажите корректное значение поля «Время забора с».|-~~03 16:14:44" message="филиал в Санкт-Петербурге" title="Планируется отправка">DEPARTURING</status>~~ ~~<status eventstore="Офис в Москве" eventtime="2016~~|81||Specify a valid «Pickup time to» field value.||Укажите корректное значение поля «Время забора до».|-~~06-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~~|85||Specify a valid «Weight at return trip» field value.||Укажите корректное значение поля «Вес возврата».|-06|86||Specify the «Weight at return trip» field value.||Укажите значение поля «Вес возврата».|-~~02 07:41:00" createtimegmt="2016-06~~|87||Order weight exceeds the allowed maximum for the pickup point.||Вес превышает допустимое значение для этого ПВЗ.|-~~03 16:14:44" message="" title="Получен складом">ACCEPTED</status>~~ ~~<status eventstore="филиал в Санкт~~|88||Pickup date cannot be earlier than today.||Дата забора не может быть раньше чем сегодня.|-~~Петербурге" eventtime="2016~~|89||Specify a later delivery date.||Укажите более позднюю дату доставки.|-~~06-02 09:17:00" createtimegmt="2016~~|90||Inappropriate «Weight» or «Pay type» field value for the selected city or town. Please review and correct the values.||Значение поля «Масса» или «Тип оплаты» для выбранного города указано некорректно или отсутствует. Проверьте значения и исправьте.|-~~06-03 16:14:44" message="" title="Выдан курьеру на доставку">DELIVERY</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="Доставлен~~ |96||Order barcode exceeds the allowed maximum (~~предварительно~~25)~~">COURIERDELIVERED</status>~~symbols.||Длина штрихкода заказа превышает максимально допустимую (25 символов). ~~<status eventstore="филиал в Санкт~~|-~~Петербурге" eventtime="2016~~|97||The pickup date format is not valid. Specify a date in YYYY-06MM-~~02 17:22:00" createtimegmt="2016~~DD format.||Укажите значение поля «Дата забора» в формате гггг-06мм-~~03 16:14:44" message="" title="Доставлен">COMPLETE</status>~~дд. ~~</statushistory>~~|- ~~<customstatecode>2<customstatecode>~~ ~~<clientstatecode></clientstatecode>~~ ~~<costcode>cc12345</costcode>~~ ~~<receipt fdNum="124555" fnSn="9289000100295555" kktNum="0001611984048555" inn="7722756555" fdValue="2899551555" summ="387~~|98||Specify the cost code.~~5" ofdUrl="gate~~||Укажите значение поля «Кост-код».~~ofd~~|-|99||The item is not in stock.~~ru">https://ofd~~||Товар отсутствует на складе.~~ru/rec/7722756555/0001611984048555/9289000100295555/124555/2899551555</receipt>~~ ~~<deliveredto>Иванова, секр.</deliveredto>~~|- ~~<delivereddate>2016-06-02</delivereddate>~~|100||Set the quantity of the item marked with Chestny ZNAK to one.||Укажите количество товара, маркированного кодом «Честный ЗНАК», равным единице. ~~<deliveredtime>17:22</deliveredtime>~~ ~~<arrival>2016~~|-~~05-02 23:21</arrival>~~ ~~<outstrbarcode>EXT123456</outstrbarcode>~~ ~~<items>~~ <|101||Quantity of item ~~code="34533" extcode="abc123" quantity="~~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.||Размер скидки не может превышать сумму заказа. Укажите меньшее значение скидки.|-|106||Specify the correct additional service code.||Укажите корректный код дополнительной услуги. ~~<item code="34421" extcode="abc125" quantity="3" mass="0~~|-|107||Specify the correct additional service name.||Укажите корректное значение поля [advprice][value].~~3" retprice="50" VATrate="18" barcode="2345625213126" article="3" returns="0" governmentCode="">Погремушка желтая</item>~~ ~~</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>~~|112||Specify the overall volume.||Укажите общий объем.~~</statusreq>~~ |-|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.||Дублирование кода дополнительной услуги в заказе|-|}

~~'''Пример ответа если нет заказов'''~~=== Передача значений полей в форме создания заказа в Личном Кабинете через GET параметры ===Если вам требуется передавать значения полей в форме создания заказа в Личном Кабинете через GET параметры, то вы можете подробно ознакомиться с этим на данной странице - [[Личный_кабинет_клиента#Передача и подстановка значений полей формы создания заказа через GET параметры]]

~~<source lang~~=~~"xml"><?xml version~~=~~"1.0" encoding~~Запрос статуса заказов =~~"utf-8"?><statusreq count~~=~~"0"></statusreq>~~ ~~</source>~~ ~~'''Пример ответа при ошибке авторизации'''~~

=== Пример запроса статуса заказа ===

<?xml version="1.0" encoding="~~utf~~UTF-8"?><~~request~~statusreq> <~~error error~~auth extra="8" login="1login" ~~errormsg~~pass="~~authorization error~~pass"></~~error~~auth> <client>CLIENT</client> <orderno>1234</~~request~~orderno> <orderno2>5678</~~source~~orderno2> <ordercode>34234</ordercode>~~'''Пример ответа при ошибке синтаксиса'''~~ <givencode>234534</givencode> <uid>af11c7c6-6645-4a20-9604-be911a75722d</uid> <datefrom>2016-07-21<~~source lang="xml"~~/datefrom> <~~?xml version="1.0" encoding="UTF~~dateto>2016-07-~~8"?~~21</dateto> <target>Автозавод</target> <done>ONLY_NOT_DONE</done> <changes>ONLY_LAST</changes> <~~request~~conditions> <~~error~~namecontains/>~~column:1 line:11 message:expected '~~ <namestarts/>' </~~error~~conditions></~~request~~statusreq>

</source>

=== Описание полей ~~ответа статусов~~ запроса статуса ===~~Все поля ответа соответствуют структуре order~~ '''statusreq''' — Корневой контейнер. Обязательный элемент.* '''auth''' — Авторизация. Обязательный элемент.* '''client''' — Признак клиента или агента. Необязательный элемент.:* CLIENT — Признак клиента, значение по умолчанию:* AGENT — Признак агента. В ответ отдается информация по заказам, переданным агенту на доставку* '''orderno''' — Идентификатор заказа у клиента (шифр). Необязательный элемент.* '''ordercode''' — Внутренний код заказа. Необязательный элемент.* '''orderno2''' — Номер заказа из срочных. Необязательный элемент. * '''uid''' — Уникальный идентификатор, если он был добавлен при создании заказа. Необязательный элемент. Запрос информации по uid возможен в течении суток после создания заказа* '''datefrom''' — Дата заказа «с». Необязательный элемент.* '''dateto''' — Дата заказа «по». Необязательный элемент.* '''target''' — Строка поиска. Позволяет указать текст, ~~с некоторыми добавлениями~~который содержится в названии компании или адресе получателя.* '''done''' — Может принимать значения::* ONLY_DONE — Только доставленные (имеются в виду успешные статусы, например, '''Доставлен''' или '''Частично доставлен'''):* ONLY_NOT_DONE — Только не доставленные (заказы, которые не являются доставленными, например, '''Не доставлен''' или '''Утерян'''):* ONLY_NEW — Только новые:* ONLY_DELIVERY — Только заказы в обработке — заказы, находящиеся в любом статусе, кроме конечных: Доставлено, Не доставлено, Отменён и т. д.:* ''Пусто'' — все корреспонденции

* ~~Атрибуты контейнера~~ '''~~order~~changes''':~~:* '''''awb''''' - Номер накладной в системе курьерской службы.:* '''''orderno2''''' - Номер накладной в подсистеме срочной доставки курьерской службы~~ — может принимать значение только ONLY_LAST.~~:* '''''ordercode''''' - внутренний код заказа в системе~~Если указан этот параметр, ~~применяется для некоторых внутренних операций~~все остальные игнорируются.Описание данного режима приведено здесь:* '''''givencode''''' - внутренний код заказа в системе, применяется для некоторых внутренних операций.[[#Передача только изменившихся статусов|Передача только изменившихся статусов]]

* ~~атрибут~~ '''~~''code~~conditions''' — Задает условия фильтрации по «orderno». Все вложенные элементы одновременно накладывают условие «И». Минимум 5 символов!:* '' ~~контейнера~~ 'namecontains''~~item~~'~~'' - внутренний код строки~~ — Поиск по номеру заказа ~~в системе~~(шифр), ~~применяется для некоторых внутренних операций~~который содержит «orderno».:* '''namestarts''~~returns~~'~~'''' - количество данного товара~~ — Поиск по номеру заказа(шифр), ~~от которого отказался получатель. Не нулевое только в случае частичного отказа~~который начинается с «orderno».

* атрибут '''''got''''' контейнера '''package''' - признак принятого места YES / NO.

:* '''''returns''''' - количество данного товара, от которого отказался получатель. Не нулевое только в случае частичного отказа.

* '''''coords''''' в контейнере '''receiver''' - координаты получателя.

* '''currcoords''' - текущие координаты заказа. Атрибуты:

~~:* '''''lat''''' - широта~~

~~:* '''''lon''''' - долгота~~

~~:* '''''accuracy''''' - точность в метрах~~

~~:* '''''RequestDateTime''''' - дата/время последнего обновления координат.~~

* '''courier''' <div style="color: #a94442; background- ~~Данные курьера, которому выдан заказ. Если заказ не выдан, то выводятся данные запланированного курьера.~~color: #f2dede; border: 1px solid #ebccd1; padding: 3px 10px 10px;">* '''~~waittime~~ Обратите внимание!''' ~~- Время ожидания курьера.~~* # Периода запроса статусов (контейнеры '''~~deliveryprice~~datefrom''' ~~- Стоимость услуг в валюте расчетов с клиентом. Атрибуты:~~:* и '''dateto''~~total~~') ограничивается двумя месяцами — два месяца до даты '''«по»' ~~- общая стоимость услуг~~:* ''.# Если не указаны обе даты — '''~~delivery~~dateto'''принимается равной текущей дате.# Если не указана дата '' ~~- стоимость доставки "Туда"~~:* 'dateto''' — она принимается равной '~~return~~''datefrom''' ~~- стоимость доставки "Обратно" (если order->return=YES)~~плюс 2 месяца.~~Тэг '''deliveryprice'~~# Если не указана дата '' ~~включает список дополнительных услуг (только для тарифа "Премиум"):~~:* 'datefrom''' — она принимается равной '~~advprice~~''dateto''' ~~- наименование дополнительной услуги~~минус 2 месяца.:* # Поиск по '''conditions''~~code~~'~~'''' - код дополнительной услуги~~работает только для «Номер заказа(шифр)» и только от 4 символов</div>~~:* '''''price''''' - стоимость дополнительной услуги~~<br>

* '''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>== Примеры ответов ===~~:* '''''message''''' - наименование филиала-получателя, при передаче между филиалами:* ''''~~'~~title~~''Пример успешного ответа''' ~~- русское наименование статуса~~

* '''statushistory''' - история статусов доставки. Содержит список контейнеров '''status'''. Заполняется только для тарифа "Премиум" начиная с версии системы 2008.0.0.670.

* '''customstatecode''' - код внутреннего статуса курьерской службы. Значения уточняйте в курьерской службе. Назначаются курьерской службой в разделе "Справочники" - "Статусы" - "15 Статусы корреспонденции". Справочник не передается через API клиенту по причине возможного наличия в нем внутренних технологических статусов курьерской службы.

* '''clientstatecode''' - код статуса клиента. Используется, если клиент предлагает свои коды статусов доставки/причин недоставки.

* '''deliveredto''' - данные о вручении, либо причина недоставки.

* '''delivereddate''' - дата вручения.

* '''deliveredtime''' - время вручения. В случае недоставки может быть пустым.

* '''arrival''' - плановая дата прибытия в формате гггг-мм-дд чч:мм:сс

* '''outstrbarcode''' - код у подрядчика (код заказа во внешней системе). Используется в интеграциях с внешними системами.

~~Значения контейнеров '''status''' могут принимать следующие значения:~~

~~: AWAITING_SYNC - Ожидает синхронизации. Данные заказа пока не появились в бэкофисе~~

~~: NEW - Новый~~

~~: PICKUP - Забран у отправителя~~

~~: ACCEPTED - Получен складом~~

~~: INVENTORY - Инвентаризация~~

~~: DEPARTURING - Планируется отправка~~

~~: DEPARTURE - Отправлено со склада~~

~~: DELIVERY - Выдан курьеру на доставку~~

~~: COURIERDELIVERED - Доставлен (предварительно)~~

~~: COMPLETE - Доставлен~~

~~: PARTIALLY - Доставлен частично~~

: COURIERRETURN - Возвращено курьером. Курьер не смог доставить до получателя, и вернул заказ обратно на склад. Это промежуточный статус, после которого менеджер выясняет, нужно ли пытаться заново доставить заказ, или это окончательная недоставка.

~~: CANCELED - Не доставлен (Возврат/Отмена)~~

~~: RETURNING - Планируется возврат~~

~~: RETURNED - Возвращен~~

~~: WMSASSEMBLED - Скомплектован на складе~~

~~: WMSDISASSEMBLED - Разукомплектован~~

~~: CONFIRM - Согласована доставка~~

~~: DATECHANGE - Перенос~~

~~: NEWPICKUP - Создан забор~~

~~: UNCONFIRM - Не удалось согласовать доставку~~

~~: PICKUPREADY - Готов к выдаче~~

~~: LOST - Утрачен/утерян~~

~~: COURIERPARTIALLY - Частично со слов курьера~~

~~: COURIERCANCELED - Отказ со слов курьера~~

~~''Примечание:'' В будущем возможно расширение и изменение используемого набора статусов.~~

~~<div style="color: #a94442; background-color: #f2dede; border: 1px solid #ebccd1; padding: 3px 10px 10px;">~~

~~'''Обратите внимание!'''~~

~~# Атрибуты контейнера '''status''' заполняются для версий системы '''2008.0.0.670''' и новее.~~

# Контейнер '''statushistory''' заполняется для тарифа "[[Личный_кабинет#.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.670''' и новее.

~~# Контейнер '''deliveryprice''' заполняется для тарифа "[[Личный_кабинет#.D0.9F.D0.BE.D0.B4.D0.BA.D0.BB.D1.8E.D1.87.D0.B5.D0.BD.D0.B8.D0.B5|Премиум]]".~~

~~</div>~~

~~<br />~~

~~=== Передача только изменившихся статусов ===~~

В нашем API предусмотрено очень удобное средство получения статусов всех заказов, без необходимости "бомбить" сервер запросами статусов по каждому заказу. Работает это так: раз в какое-то время, например, в 10 минут, вы посылаете запрос "А покажите все изменившиеся статусы". Пример запроса ниже. Система вам отдает ВСЕ заказы, статусы (или некоторые другие поля, см ниже) которых изменились с момента последнего запроса. Вы разбираете полученный документ, по каждому заказу сохраняете его актуальный статус в своей системе, и если все хорошо, у вас все получилось, ваша система неожиданно не упала от наплыва информации, посылаете нам запрос подтверждения получения статусов (commitlaststatus). Мы у себя отмечаем, что эти статусы вами получены, и их не надо передавать повторно. Т.о. сколько бы заказов у вас не было, статусы по ним всем почти в реальном времени вы можете получать всего 2-мя запросами.

~~Для получения только изменившихся статусов отправьте запрос~~

<?xml version="1.0" encoding="UTF-8" ?><statusreqcount="23"> <~~auth extra~~order orderno="111111" awb="qwerty" orderno2="8123123" ~~login~~ordercode="~~login~~34534234" ~~pass~~givencode="~~pass~~2345334"~~></auth~~> <~~changes~~barcode>~~ONLY_LAST~~111111</~~changes~~barcode> <~~/statusreq~~sender> <company>МВД</~~source~~company> <person>Иванов И.И.</person>Система выдает все заказы, в которых, с момента последнего запроса в этом режиме, изменилось хотя бы одно из полей: ~~orderno~~ <phone>123-45-67</phone> ~~status~~ ~~delivereddate~~ ~~deliveredtime~~ ~~deliveredto~~ ~~receiver-~~ <contacts>~~date~~ ~~receiver-~~ <phone>+74951234567</phone>~~address~~ ~~price~~ После успешной обработки ответа необходимо отметить полученные статусы успешно полученными, отправив запрос </contacts> <~~source lang~~town code="~~xml~~23432">Санкт-Петербург</town> <~~?xml version="1.0" encoding="UTF-8" ?~~address>Петровка 38 офис 35<~~commitlaststatus~~/address> <~~auth extra="8" login="login" pass="pass">~~date>2014-03-22</~~auth~~date> <~~client~~time_min>~~CLIENT~~09:00</~~client~~time_min> <~~/commitlaststatus~~time_max>14:00</~~source~~time_max> </sender>~~'''Описание полей запроса'''~~ <receiver> <company>МВД</company>*'''auth''' - Авторизация <person>Иванов И. ~~Обязательный элемент~~И.</person>*'''client''' <phone>123-45-67 - ~~Признак клиента или агента~~Иван (916)234. ~~Необязательный элемент~~45.~~:* CLIENT - Признак клиента~~21 Петр, ~~значение по умолчанию:* AGENT - Признак агента~~mvd@mail. ~~В ответ отдается информация по заказам, переданным агенту на доставку~~ru</phone> <contacts>~~В случае успеха Вы получите ответ~~ <phone>+74951234567<~~source lang="xml"~~/phone> <~~?xml version="1.0" encoding="UTF-8" ?~~phone>+79162344521</phone> <~~commitlaststatus error="0"~~email>OKmvd@mail.ru</~~commitlaststatus~~email> </~~source~~contacts> <inn>1112223335</inn>Данный способ передачи статусов гарантирует полную корректную передачу статусов, даже в случае, если в нашей системе статус изменился в промежутке времени между запросом статусов и подтверждением их получения. Если система не получила подтверждение успешной передачи статуса, она будет считать информацию не переданной, и выдаст ее при повторном запросе. <~~div style="color: #a94442; background-color: #f2dede; border: 1px solid #ebccd1; padding: 3px 10px 10px;">'''Обратите внимание!'''~~ ~~# При данном способе передачи (<changes>ONLY_LAST~~zipcode>125480</~~changes~~zipcode>) система просматривает заказы, оформленные за последние 3 месяца. Если заказ сделан ранее - изменение статуса по нему не попадет в результат выполнения данного запроса.~~# Система всегда выдает текущий статус. Т.е. Вы можете одним запросом получить статус~~ <town code="~~NEW~~153361"~~, а следующим -~~ regioncode="~~COMPLETE~~78". В промежутке между запросами отправление могло пройти через несколько промежуточных статусов. Если нужна гарантия получения всех промежуточных статусов, нужно анализировать блок statushistory (может не заполняться в следствии ограничений версии или тарифа конкретной службы доставки).# Система никогда не гарантирует последовательность прохождения заказом набора статусов. Т.е. Вы можете получить статус regionname="~~COMPLETE", а следующим запросом~~ Санкт- Петербург город"~~NEW"~~ >Санкт- ~~такое может произойти, например, если оператор ошибочно отметил заказ выполненным, а затем исправил ошибку.~~Петербург город</town> <address>Петровка 38 офис 35</~~div~~address> <area>Район 1<br /area> <pvz> <code>126</code>~~== Трекинг заказа по номеру ==~~ <clientcode>QWERTY</clientcode> </pvz>Запрос трекинга по номеру предназначен для выдачи минимальной обезличенной информации о конкретном заказе не авторизованному пользователю. Наша система имеет для этого интерфейс по адресу "home.courierexe.ru <date>2014-03-22</~~{код экстра}~~date> <time_min>09:00</tracking". Вы можете либо сделать ссылку на такую страницу на своем сайте, либо разместить ее iframe'ом у себя, либо сделать свою и пользоваться нашим APItime_min> <time_max>14:00</time_max> <coords lat="55. Этот интерфейс создан специально для выдачи информации живому пользователю сайта. Для получения статусов заказов в свою информационную систему нужно использовать запрос 680327"~~statusreq~~lon="~~, желательно с параметром changes=ONLY_LAST!~~ ~~'''Пример запроса:'''~~37.604456"><~~source lang="xml"~~/coords> <~~?xml version="1.0" encoding="UTF-8"?~~deliveryPIN>1234</deliveryPIN> <~~tracking~~/receiver> <~~extra~~price>8387.5</~~extra~~price> <~~orderno~~inshprice>~~1234~~387.5</~~orderno~~inshprice> <paytype code="1">CASH</~~tracking~~paytype> <~~/source~~weight>5.1</weight> ~~'''Пример ответа:'''~~ <~~source lang="xml"~~quantity>2<~~?xml version="1.0" encoding="UTF-8"?~~/quantity> <~~tracking~~service> 2<~~order orderno="111111"~~/service> <~~barcode~~type>~~111111~~3</~~barcode~~type> <~~AWB~~return>~~111111~~NO</~~AWB~~return> <~~sender~~return_service>2</service> <return_type>3<~~town code="1" country="RU"~~/return_type> <return_weight>~~Москва город~~5.1</~~town~~return_weight> <~~date~~return_message>~~2014-03-22~~Доставлено в целости</~~date~~return_message> <~~time_min~~pickup>~~09:00~~NO</~~time_min~~pickup> <~~time_max~~print_check>~~14:00~~YES</~~time_max~~print_check> <waittime>12</~~sender~~waittime> <~~receiver~~enclosure> Детские игрушки<~~town code="1" country="RU"~~/enclosure> <instruction>~~Москва город~~Проверить при покупателе, подписать акт</~~town~~instruction> <~~zipcode>125480</zipcode>~~ ~~<date>2014~~currcoords lat="55.680327" lon="37.604456" accuracy="50" RequestDateTime="2014-0304-2221 18:07:45"></~~date~~currcoords> <~~time_min~~courier>~~09:00~~ <code>26</~~time_min~~code> <~~time_max~~name>~~14:00~~Иванов Владимир Петрович</~~time_max~~name> <~~/receiver~~phone> ~~<price>387.5~~+79161234567</~~price~~phone> ~~<inshprice>387.5~~</~~inshprice~~courier> <~~paytype>CASH</paytype~~deliveryprice total="158.6" delivery="100.00" return="58.6"> <~~weight>5.~~advprice code="1" price="150">База</~~weight~~advprice> <~~quantity~~advprice code="2" price="0">2% от объявленной стоимости</~~quantity~~advprice> <~~service~~advprice code="3" price="8.6">2Топливный сбор</~~service~~advprice> <~~type~~advprice code="4" price="0">3Округление</~~type~~advprice> <~~return>NO</return~~/deliveryprice> <~~return_service~~receiverpays>2NO</~~service~~receiverpays> <~~return_date~~acceptpartially>NO</~~return_date~~acceptpartially> <~~return_time></return_time>~~ ~~<return_message></return_message>~~ ~~<waittime>12</waittime>~~ ~~<enclosure>Детские игрушки</enclosure>~~ ~~<instruction>Проверить при покупателе, подписать акт</instruction>~~ ~~<deliveryprice total~~status eventstore="филиал в Санкт-Петербурге" eventtime="2016-06-02 17:22:00" createtimegmt="2016-06-03 16:14:44" message="~~158.6~~" ~~delivery~~title="~~100.00~~Доставлен" eventtown="Санкт-Петербург город" ~~return~~color="~~58.6~~16777215" >COMPLETE</status> <~~courier~~statushistory> <~~code>26</code>~~ ~~<name>Иванов Владимир Петрович</name>~~ ~~<phone>+79161234567</phone>~~ ~~</courier>~~ ~~<currcoords lat~~status eventstore="Офис в Москве" eventtime="2016-05-30 10:20:00" createtimegmt="~~55.680327~~2016-06-03 16:14:44" ~~lon~~ message="~~37.604456~~" ~~accuracy~~title="50Новый" ~~RequestDateTime~~eventtown="~~2014-04-21 18:07:45~~Москва город" country="RU" >NEW</status> <status eventstore="~~филиал~~ Офис в ~~Санкт-Петербурге~~Москве" eventtime="2016-06-02 01 17:2238:00" createtimegmt="2016-06-03 16:14:44" message="филиал в Санкт-Петербурге" title="~~Доставлен~~Планируется отправка" eventtown="Москва город" country="RU">~~COMPLETE~~DEPARTURING</status> ~~<statushistory~~> <status eventstore="Офис в Москве" eventtime="2016-0506-~~30 10~~01 19:2053:00" createtimegmt="2016-06-03 16:14:44" message="филиал в Санкт-Петербурге" title="~~Новый~~Отправлено со склада"~~>NEW</status>~~ ~~<status eventstore~~eventtown="~~Офис~~ Москва город" country="RU">DEPARTURE</status> <status eventstore="филиал в ~~Москве~~Санкт-Петербурге" eventtime="2016-06-~~01 17~~02 07:3841:00" createtimegmt="2016-06-03 16:14:44" message="~~филиал в~~ " title="Получен складом" eventtown="Санкт-~~Петербурге~~Петербург город" ~~title~~country="~~Планируется отправка~~RU">~~DEPARTURING~~ACCEPTED</status> <status eventstore="~~Офис~~ филиал в ~~Москве~~Санкт-Петербурге" eventtime="2016-06-~~01 19~~02 09:5317:00" createtimegmt="2016-06-03 16:14:44" message="~~филиал в Санкт-Петербурге~~" title="~~Отправлено со склада~~Выдан курьеру на доставку" eventtown="~~>DEPARTURE~~Санкт-Петербург город" country="RU">DELIVERY</status> <status eventstore="филиал в Санкт-Петербурге" eventtime="2016-06-02 0717:4122:00" createtimegmt="2016-06-03 16:14:44" message="" title="~~Получен складом~~Доставлен (предварительно)" eventtown="~~>ACCEPTED<~~Санкт-Петербург город" country="RU">COURIERDELIVERED</status> <status eventstore="филиал в Санкт-Петербурге" eventtime="2016-06-02 0917:1722:00" createtimegmt="2016-06-03 16:14:44" message="" title="~~Выдан курьеру на доставку~~Доставлен" eventtown="~~>DELIVERY</~~Санкт-Петербург город" country="RU">COMPLETE</status> </statushistory> <~~status eventstore="филиал в Санкт-Петербурге" eventtime="2016-06-02 17:22:00" createtimegmt="~~customstatecode>2<customstatecode> <clientstatecode></clientstatecode> <deliveredto>Иванова, секр.</deliveredto> <delivereddate>2016-06-~~03 16:14~~02</delivereddate> <deliveredtime>17:~~44" message="" title="Доставлен (предварительно)">COURIERDELIVERED~~22</~~status~~deliveredtime> <~~status eventstore="филиал в Санкт-Петербурге" eventtime="2016~~department>Отдел</department> <costcode>cc12345</costcode> <outstrbarcode>EXT123456</outstrbarcode> <respstore>14</respstore> <partner>Офис на Ленина</partner> <arrival>2016-0605-02 1723:~~22:00~~21</arrival> <receipt fdNum="124555" ~~createtimegmt~~fnSn="~~2016-06-03 16:14:44~~9289000100295555" ~~message~~kktNum="0001611984048555" ~~title~~inn="~~Доставлен~~7722756555" fdValue="2899551555" summ="387.5" ofdUrl="gate.ofd.ru">~~COMPLETE~~https://ofd.ru/rec/7722756555/0001611984048555/9289000100295555/124555/2899551555</~~status~~receipt> <~~/statushistory~~items> <~~deliveredto>Иванова, секр.</deliveredto>~~ ~~<delivereddate>2016-06-02</delivereddate>~~ ~~<deliveredtime>17:22</deliveredtime>~~ ~~<outstrbarcode>EXT123456</outstrbarcode>~~ ~~<items>~~ ~~<item code~~item code="34533" extcode="abc123" quantity="1" mass="0.2" retprice="37.5" VATrate="0" barcode="2345625213125" article="~~34533~~1" ~~extcode~~returns="~~abc123~~0" ~~quantity~~origincountry="1040" ~~mass~~GTD="~~0.2~~" ~~retprice~~excise="370.500" ~~VATrate~~governmentCode="011223311" ~~barcode~~suppcompany="~~2345625213125~~Поставщик" ~~article~~suppINN="11112223334" ~~returns~~suppphone="079161234567" ~~origincountry~~>Мяч</item> <item code="~~040~~34456" ~~GTD~~extcode="abc124" ~~excise~~quantity="~~0.00~~2" ~~governmentCode~~mass="~~11223311~~2" ~~suppcompany~~retprice="~~Поставщик~~100" VATrate="10" barcode="4645625213138" article="2" ~~suppINN~~returns="~~1112223334~~0" ~~suppphone~~governmentCode="~~79161234567~~">~~Мяч~~Обруч</item> <item code="~~34456~~34421" extcode="~~abc124~~abc125" quantity="23" mass="20.3" retprice="~~100~~50" VATrate="1018" barcode="~~4645625213138~~2345625213126" itemcode="44123" article="23" returns="0" governmentCode="">~~Обруч~~Погремушка желтая</item> <~~item code="34421" extcode~~/items> <packages> <package code="~~abc125~~33331" ~~quantity~~strbarcode="3ORD0000001" mass="~~0.3~~1" ~~retprice~~message="50" ~~VATrate~~got="18YES" ~~barcode~~></package> <package code="33332" strbarcode="~~2345625213126~~ORD0000002" ~~article~~mass="32.5" ~~returns~~message="0" ~~governmentCode~~got="NO">~~Погремушка желтая~~</~~item~~package> </~~items~~packages> </order></~~tracking~~statusreq> </source> '''Пример ответа если нет заказов''' <source lang="xml"><?xml version="1.0" encoding="utf-8"?><statusreq count="0"></statusreq>

</source>

'''Пример ответа при ошибке авторизации'''

<?xml version="1.0" encoding="utf-8"?>

</request>

</source>

'''~~Получение информации в формате 17 TRACK~~Пример ответа при ошибке синтаксиса'''

~~'''Пример запроса:'''~~

<?xml version="1.0" encoding="UTF-8"?>

<~~tracking17~~request> <~~extra~~error>~~8</extra>~~ ~~<orderno~~column:1 line:11 message:expected '>~~1234~~'</~~orderno~~error></~~tracking17~~request>

</source>

=== Описание полей ответа статусов ===Все поля ответа соответствуют структуре order при создании заказа, с некоторыми добавлениями: * Атрибуты контейнера '''~~Пример ответа~~order'''::* '''''awb''''' — Номер накладной в системе курьерской службы.:* '''''orderno2''''' — Номер накладной в подсистеме срочной доставки курьерской службы.~~<pre>{~~:* '''''ordercode''''' — внутренний код заказа в системе, применяется для некоторых внутренних операций. ~~"number"~~:~~"ExtNumber"~~* '''''givencode''''' — внутренний код заказа в системе,применяется для некоторых внутренних операций. ~~"oriNumber"~~*'''paytype''' - Тип оплаты заказа получателем. Принимает значения::: CASH - Наличными при получении (по-умолчанию):: CARD - Картой при получении:: NO - Без оплаты.:: OTHER - Прочее (Предусмотрен для того, чтобы оплата поступала непосредственно в курьерскую службу посредством прочих типов оплаты - таких как:~~"1234"~~вебмани, яденьги, картой на сайте,прочие платежные системы и т.д.) ~~"oriCountry"~~* Атрибуты контейнера '''paytype''':** '''''code''''' - (integer) внутренний код типа оплаты заказа в системном справочнике "RUТипы оплаты корреспонденции". Не обязательный элемент. * атрибут '''''code''''' контейнера '''item''' — внутренний код строки заказа в системе,применяется для некоторых внутренних операций. ~~"destCountry"~~:~~"RU"~~* '''''returns''''' — количество данного товара,от которого отказался получатель. Не нулевое только в случае частичного отказа. * атрибут '''''got''''' контейнера '''package''' — признак принятого места YES / NO. ~~"status"~~:~~"Complete"~~* '''''returns''''' — количество данного товара,от которого отказался получатель. Не нулевое только в случае частичного отказа. * '''''area''''' в контейнере '''receiver''' — район/метро получателя.* '''''coords''''' в контейнере '''receiver''' — координаты получателя.* '''''deliveryPIN''''' в контейнере '''receiver''' — Пин-код. ~~"events"~~* '''pickup''' — признак оформления забора, возможные значения:['''YES''', '''NO'''. Если указано '''YES''', то весь заказ считается заданием на забор груза, а не на доставку. {* '''currcoords''' — текущие координаты заказа. Атрибуты: ~~"time"~~:~~"2016-06-02 17~~* '''''lat''''' — широта:22* '''''lon''''' — долгота:~~00",~~* '''''accuracy''''' — точность в метрах ~~"location"~~:~~"RU"~~* '''''RequestDateTime''''' — дата/время последнего обновления координат. * '''courier''' — Данные курьера, которому выдан заказ. Если заказ не выдан,то выводятся данные запланированного курьера.* '''waittime ''' — Время ожидания курьера. ~~"content"~~* '''deliveryprice''' — Стоимость услуг в валюте расчетов с клиентом. Атрибуты:~~"Complete"~~ },:* '''''total''''' — общая стоимость услуг {:* '''''delivery''''' — стоимость доставки «Туда» ~~"time"~~:~~"2016~~* '''''return''''' — стоимость доставки «Обратно» (если order-~~06-02 17~~>return=YES)Тэг '''deliveryprice''' включает список дополнительных услуг (только для тарифа «Премиум»):22:~~00",~~* '''''advprice''''' — наименование дополнительной услуги:* '''''code''''' — код дополнительной услуги ~~"location"~~:~~"RU",~~* '''''price''''' — стоимость дополнительной услуги ~~"content"~~* '''status''' — статус доставки (список статусов см. ниже). Атрибуты (заполняются начиная с версии системы 2008.0.0.670):~~"Courierdelivered"~~ }:* '''''eventstore''''' — филиал,к которому относится текущий статус {:* '''''eventtime''''' — время события по часовому поясу места его наступления. :* '''''createtimegmt''''' — время по GMT создания записи о смене статуса в БД. Используется для сортировки записей, чтобы соблюсти хронологическую последовательность. <spoiler text="~~time~~Подробнее">Большинство событий фиксируются в полях eventtime и createtimegmt на основании одного действия, тогда они отличаются только сдвигом от GMT. Однако, если курьер доставил отправление 10.10.2010 в 20:~~"2016~~00, по какой-~~06-02 09~~то причине не внес это в мобильное приложение, на следующий день сдал накладную, и в 9 утра оператор внесла, что он доставил вчера в 20:1700. Тогда в createtimegmt будет сегодня 6 утра (для Москвы), а в eventtime — вчера в 20:00". При этом оператор по каким-то причинам может внести время вручения раньше, чем какое-то предыдущее событие, т.о. нарушится последовательность времени в eventtime,но при сортировке по createtimegmt все-равно все будет правильно.</spoiler> ~~"location"~~:~~"RU"~~* '''''message''''' — наименование филиала-получателя,при передаче между филиалами ~~"content"~~:~~"Delivery"~~* '''''title''''' — русское наименование статуса * '''statushistory''' — история статусов доставки. Содержит список контейнеров '''status'''. Заполняется только для тарифа «Премиум» начиная с версии системы 2008.0.0.670.* '''customstatecode''' — код внутреннего статуса курьерской службы. Значения уточняйте в курьерской службе. Назначаются курьерской службой в разделе «Справочники» — «Статусы» — «15 Статусы корреспонденции». Справочник не передается через API клиенту по причине возможного наличия в нем внутренних технологических статусов курьерской службы.* '''clientstatecode''' — код статуса клиента. Используется, если клиент предлагает свои коды статусов доставки/причин недоставки. }* '''deliveredto''' — данные из поля «Инфо. о доставке» (может быть информация о доставке,причина недоставки и т. п.).* '''delivereddate''' — дата вручения. {* '''deliveredtime''' — время вручения. В случае недоставки может быть пустым. ~~"time":"2016~~* '''arrival''' — плановая дата прибытия в формате гггг-06мм-~~02 07~~дд чч:41мм:~~00"~~сс. Заполняется только при использовании автоматических систем планирования (Максоптра, Яндекс доставка), во всех остальных случаях - пустое.* '''outstrbarcode''' — код у подрядчика (код заказа во внешней системе). Используется в интеграциях с внешними системами.* '''partner''' — текущий филиал/подрядчик.* '''return_message''' — информация о возврате* '''department''' — Подразделение,в котором оформляется заказ. Контейнер '''status''' может принимать следующие значения:: AWAITING_SYNC — Ожидает синхронизации. Данные заказа пока не появились в службе доставки. ~~"location"~~:~~"RU"~~'''NEW''' — Успешно создан,передан в службу доставки.: NEWPICKUP — Создан забор.: PICKUP — Забран у отправителя. ~~"content"~~:~~"Accepted"~~WMSASSEMBLED — Скомплектован на складе фулфилмента. },: WMSDISASSEMBLED — Разукомплектован на склад фулфилмента. {: '''ACCEPTED''' — Получен складом. ~~"time"~~:~~"2016-06-01 19~~CUSTOMSPROCESS — Производится таможенный контроль.:53CUSTOMSFINISHED — Таможенный контроль произведен.:~~00",~~CONFIRM — Согласована доставка. ~~"location"~~:~~"RU",~~UNCONFIRM — Не удалось согласовать доставку. ~~"content"~~:~~"Departure"~~DEPARTURING — Планируется отправка со склада на другой склад. },: DEPARTURE — Отправлено со склада на другой склад. {: INVENTORY — Инвентаризация. Убедились в наличии отправления на складе. ~~"time"~~:~~"2016-06-01 17~~PICKUPREADY — Готов к выдаче в ПВЗ.:38'''DELIVERY''' — Выдан курьеру на доставку.:~~00"~~COURIERDELIVERED — Доставлен (предварительно, ожидает подтверждения менеджером,чтобы перейти в статус COMPLETE). ~~"location"~~:~~"RU"~~COURIERPARTIALLY — Частично доставлен (предварительно, ожидает подтверждения менеджером,чтобы перейти в статус PARTIALLY). ~~"content"~~:~~"Departuring"~~COURIERCANCELED — Отказ (предварительно, после этого ожидается COURIERRETURN). }: COURIERRETURN — Возвращено курьером. Курьер не смог доставить до получателя и вернул заказ обратно на склад. Это промежуточный статус, после которого менеджер выясняет,нужно ли повторно доставлять (статусы DATECHANGE/DELIVERY) или это окончательная недоставка (CANCELED).: DATECHANGE — Перенос даты доставки. { ~~"time"~~:~~"2016-05-30 10~~'''COMPLETE''' — Доставлен.:20'''PARTIALLY''' — Доставлен частично.:~~00"~~'''CANCELED''' — Не доставлен (Возврат/Отмена). После этого статуса отправление должны вернуть заказчику,будут статусы RETURNING и RETURNED : RETURNING — Планируется возврат заказчику (после CANCELED).: RETURNED — Возвращен заказчику.: LOST — Утрачен/утерян. : PARTLYRETURNING — Планируется возврат остатков.: PARTLYRETURNED — Остаток возвращен. ~~"location"~~:~~"RU",~~TRANSACCEPTED — Прибыл на склад перевозчика. ~~"content"~~:~~"New"~~PICKUPTRANS — Забран у перевозчика. } ]~~}</pre>~~'''Примечание.''' В будущем возможно дополнение используемого набора статусов.

Функция ищет последний заказ по номеру среди заказов всех клиентов. Выдает неперсонализированную информацию о текущем состоянии заказа.<~~br /~~div style="color: #a94442; background-color: #f2dede; border: 1px solid #ebccd1; padding: 3px 10px 10px;">Описание контейнеров ответа аналогично описанию [[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|Запроса статусов заказов]].'''Обратите внимание!'''

~~== Изменение заказа ==~~ Запрос предназначен для изменения заказов, находящихся в статусах "Ожидает синхронизации" или "Новый", а также по которым не было произведено изменений - статуса корреспонденции, времени доставки - то есть заказов, которые ещё не находятся в работе. ~~<div style="color:~~ #~~a94442; background-color: #f2dede; border: 1px solid #ebccd1; padding: 3px 10px 10px;">~~Контейнер '''~~Обратите внимание!~~statushistory'''~~# Данные запроса изменения указываются~~ и '''~~полностью~~deliveryprice'''~~, как если бы заказ создавался впервые~~заполняется для тарифов [[Личный кабинет курьерской службы#Функции личного кабинета|Премиум и Максимум]].# ~~При отсутствии вложения в запросе изменения данное вложение '''~~Система никогда не ~~удаляется''' из заказа, но его количество становится равным 0.~~# При одновременном изменении заказа в API и системе курьерской службы приоритет отдается данным системы курьерской службыгарантирует последовательность прохождения заказом набора статусов. То есть ~~изменения в API приняты не будут!~~Вы можете получить статус «COMPLETE», а следующим запросом — «NEW» — такое может произойти, например, если оператор ошибочно отметил заказ выполненным, а затем исправил ошибку.

</div>

<br /> ~~=== Описание полей запроса изменения ===Все поля запроса соответствуют структуре order при создании заказа за исключением:~~* вместо корневого тэга '''neworder''' указывается '''editorder'''* тэг штрих-кода '''barcode''' не указывается, поскольку присваивается при создании заказа. ~~=== Описание полей ответа изменения ===~~Все поля ответа соответствуют ответу при создании заказа за исключением корневого тэга - вместо '''neworder''' возвращается '''editorder'''. ~~== Отмена заказа ==~~ Запрос отмены предназначен для отмены тех заказов, по которым не было произведено изменений - статуса доставки, статуса корреспонденции, времени доставки - то есть заказов, которые ещё не находятся в работе.Возможность отмены заказа есть только у курьерских служб с тарифом "Премиум" и по-умолчанию она выключена, ее нужно отдельно включить: [[Личный кабинет курьерской службы#Дополнительные настройки]]. При отмене заказа поле "Инфо о доставке" получает значение "Отменено заказчиком", поле "Дата доставки" - текущую дату, а "Вручил курьер" - системную запись "ОТМЕНА".

=== Передача только изменившихся статусов ===

В нашем API предусмотрено удобное средство получения статусов всех заказов, без необходимости «бомбить» сервер запросами статусов по каждому заказу. Работает это так: раз, например, в 10 минут, вы посылаете запрос «покажите все изменившиеся статусы». Пример запроса ниже. Система вам отдает ВСЕ заказы, статусы (или некоторые другие поля, см. ниже) которых изменились с момента последнего запроса. Вы разбираете полученный документ, по каждому заказу сохраняете его актуальный статус в своей системе, и если все хорошо, у вас все получилось, ваша система неожиданно не упала от наплыва информации, посылаете нам запрос подтверждения получения статусов (commitlaststatus). Мы у себя отмечаем, что эти статусы вами получены и их не надо передавать повторно. Таким образом, сколько бы заказов у вас ни было, статусы по ним всем почти в реальном времени вы можете получать всего двумя запросами.

~~'''Пример запроса отмены заказа~~Для получения только изменившихся статусов отправьте запрос:~~'''~~

<?xml version="1.0" encoding="UTF-8" ?>

<~~cancelorder~~statusreq> <auth extra="8" login="login" pass="pass" ></auth> <~~order orderno="" ordercode="123456"~~ changes>ONLY_LAST</changes> <~~order orderno="123aaa" ordercode=""~~ streamid>1234</streamid></~~cancelorder~~statusreq>

</source>

Система выдает все заказы, в которых с момента последнего запроса в этом режиме изменилось хотя бы одно из полей:

orderno

status

delivereddate

deliveredtime

deliveredto

receiver->date

receiver->address

price

~~'''Описание полей запроса статуса~~После успешной обработки ответа необходимо отметить полученные статусы успешно полученными, отправив запрос:~~'''~~<source lang="xml"><?xml version="1.0" encoding="UTF-8" ?><commitlaststatus> <auth extra="8" login="login" pass="pass"></auth> <client>CLIENT</client> <streamid>1234</streamid></commitlaststatus></source>

'''~~cancelorder~~Описание полей запроса''' ~~- Корневой контейнер. Обязательный элемент.~~*'''auth''' - Авторизация. Обязательный элемент.*'''order''' - Контейнер отменяемого заказа. Обязательный элемент. Запрос может содержать более одного контейнера '''order'''. Атрибуты:~~:* '''''orderno''''' - Шифр заказа.:* '''''ordercode''''' - Внутренний код заказа.Обратите внимание, что должен быть указан хотя бы один из атрибутов ''orderno'' или ''ordercode''!~~

* '''auth''' — авторизация. Обязательный элемент.

* '''streamid''' — идентификатор потока. Если у вас несколько интеграций и каждая нуждается в получении статусов, вы можете передавать данный параметр и тем самым разделять получение и отметку об успешном получении статусов по заказам. Значение должно входить в промежуток от 100 до 10000, включительно. Необязательный элемент.

* '''client''' — признак клиента или агента. Необязательный элемент.

:* CLIENT — признак клиента, значение по умолчанию

:* AGENT — признак агента. В ответ отдается информация по заказам, переданным агенту на доставку

~~'''Пример ответа~~В случае успеха вы получите ответ:~~'''~~

<?xml version="1.0" encoding="UTF-8" ?>

<~~cancelorder>~~ ~~<order orderno="123test" ordercode="123456"~~ commitlaststatus error="0" ~~errormsg="~~>OK~~" errormsgru="Успешно" />~~ ~~<order orderno="123aaa" ordercode="" error="52" errormsg="order not found" errormsgru="Заказ не найден" />~~</~~cancelorder~~commitlaststatus>

</source>

~~== Добавление вложений к накладной ==~~Такой способ передачи статусов гарантирует полную корректную передачу статусов, даже если в нашей системе статус изменился между запросом статусов и подтверждением их получения. Если система не получила подтверждение передачи статуса, она будет считать информацию непереданной и выдаст ее при повторном запросе.

<div style="color: #a94442; background-color: #f2dede; border: 1px solid #ebccd1; padding: 3px 10px 10px;"># При этом способе передачи (<changes>ONLY_LAST</changes>) система просматривает заказы, оформленные за последние 3 месяца. Если заказ сделан ранее, изменение статуса по нему не попадет в результат выполнения запроса.# Система всегда выдает текущий статус. Вы можете одним запросом получить статус «NEW», а следующим — «COMPLETE». Между запросами отправление могло пройти через несколько промежуточных статусов. Если нужна гарантия получения всех промежуточных статусов, нужно анализировать блок statushistory (может не заполняться вследствие ограничений версии или тарифа конкретной службы доставки).# Система не гарантирует последовательность прохождения заказом набора статусов. Вы можете получить статус «COMPLETE», а следующим запросом «NEW» — такое может произойти, например, если оператор ошибочно отметил заказ выполненным, а затем исправил ошибку.</div><br> == Трекинг заказа по номеру ==Запрос трекинга по номеру предназначен для выдачи минимальной обезличенной информации о конкретном заказе не авторизованному пользователю. Наша система имеет для этого интерфейс по адресу «home.courierexe.ru/{код экстра}/tracking». Вы можете либо сделать ссылку на такую страницу на своем сайте, либо разместить ее [[#Размещение страниц на своем сайте (iframe)|iframe’ом]] у себя, либо сделать свою и пользоваться нашим API. Этот интерфейс создан специально для выдачи информации живому пользователю сайта. Для получения статусов заказов в свою информационную систему нужно использовать запрос «statusreq», желательно с параметром changes=ONLY_LAST! '''Пример запроса:'''

<?xml version="1.0" encoding="UTF-8" ?><~~addattachments~~tracking> <~~auth~~ extra=">8~~" login="login" pass="pass"~~ </extra> <orderno>~~1234567~~1234</orderno> ~~<attachments>~~ ~~<item name="photo1.jpg">JVBERi0xLjMN1wb25lbnQgMQ~~ ~~JUBQREYwMTIzNDU2Nzg5IDI NMyAwIG9iag08PA0vVHlwZSA~~ ~~U3VidHlwZSAvSW1hZ2UNL1d pZHRoIDE4MDgNL0hlaWdodCA~~ ~~ggNCAwIFINL0JpdHNQZXJDb 21wb25lbnQgMQ0vRGVjb2RlU~~ ~~ENL0NvbHVtbnMgMTgwOA0+P g0vSW1hZ2VNYXNrIHRydWUNL~~ ~~XhEZWNvZGUNPj4Nc3RyZWFt DQ</item>~~ ~~<item name="photo2.jpg">VBERi0xLjMNAwIG9iag0HRoJ~~ ~~JUBQREYwMTIzNDU2Nzg5IDI NMyAwIG9iag08PA0vVHlwZSA~~ ~~vWE9iamVjdA0vU3VidHlwZS AvSW1hZ2UNL1dpZHRoIDEzNj~~ ~~gNL0hlaWdodCAxMzMzDS9MZ W5ndGggNCAwIFINL0JpdHNQZ~~ ~~XJDb21wb25lbnQgMQ0vRGVj b2RlUGFybXMgPDwNL0sgLTEN~~ ~~L0NvbHVtbnMgMTM2OA0+Pg0 vSW</item>~~ ~~</attachments~~></~~addattachments~~tracking>

</source>

~~'''Описание полей:'''~~

~~'''addattachments''' - Корневой контейнер. Обязательный элемент.~~

*'''auth''' - Авторизация. Обязательный элемент.

*'''orderno''' - Номер заказа. Обязательный элемент. Может использоваться тэг <ordercode> с указанием внутреннего кода заказа.

*'''attachments''' - Обязательный элемент, в котором перечисляются передаваемые данные файлов.

**'''item''' - Бинарные данные (файл), закодированные в base64. Обязательный элемент.

***'''name''' - Атрибут элемента '''item''', в котором передается имя файла. Обязательный элемент.

'''Пример ответа:'''

<?xml version="1.0" encoding="UTF-8"?>

<~~addattachments~~tracking> <~~attachments~~order orderno="111111"> <barcode>111111</barcode> <~~item name~~AWB>111111</AWB> <sender> <town code="~~photo1.jpg~~1" ~~error~~country="0RU" ~~errormsg~~>Москва город</town> <date>2014-03-22</date> <time_min>09:00</time_min> <time_max>14:00</time_max> </sender> <receiver> <town code="OK1" ~~errormsgru~~country="~~Успешно~~RU" >Москва город</town> <zipcode>125480</zipcode> <date>2014-03-22</date> <time_min>09:00</time_min> <time_max>14:00</time_max> </receiver> <price>387.5</price> <inshprice>387.5</inshprice> <paytype>CASH</paytype> <weight>5.1</weight> <quantity>2</quantity> <service>2</service> <type>3</type> <return>NO</return> <return_service>2</return_service> <return_date></return_date> <return_time></return_time> <return_message></return_message> <waittime>12</waittime> <enclosure>Детские игрушки</enclosure> <instruction>Проверить при покупателе, подписать акт</instruction> <~~item name~~deliveryprice total="~~photo2~~158.~~jpg~~6" ~~error~~delivery="0100.00" ~~errormsg~~return="~~OK" errormsgru="Успешно~~58.6" /> <courier> <code>26</~~attachments~~code> <name>Иванов Владимир Петрович</~~addattachments~~name> <phone>+79161234567</~~source~~phone> </courier> <currcoords lat="55.680327" lon= ~~Получение вложений к накладной~~ "37.604456" accuracy="50" RequestDateTime="2014-04-21 18:07:45" /> <status eventstore="филиал в Санкт-Петербурге" eventtime="2016-06-02 17:22:00" createtimegmt="2016-06-03 16:14:44" message="" title="Доставлен">COMPLETE</status>~~'''Пример запроса:'''~~ <statushistory> <~~source lang~~status eventstore="Офис в Москве" eventtime="2016-05-30 10:20:00" createtimegmt="2016-06-03 16:14:44" message="~~xml~~" title="Новый">NEW</status> <~~?xml version~~status eventstore="Офис в Москве" eventtime="~~1.0~~2016-06-01 17:38:00" createtimegmt="2016-06-03 16:14:44" ~~encoding~~message="~~UTF~~филиал в Санкт-8Петербурге" title="Планируется отправка" ?>DEPARTURING<~~attachments~~/status> <~~auth extra~~status eventstore="8Офис в Москве" ~~login~~eventtime="~~login~~2016-06-01 19:53:00" ~~pass~~createtimegmt="~~pass~~2016-06-03 16:14:44" message="филиал в Санкт-Петербурге" title="Отправлено со склада">DEPARTURE</status> <~~orderno~~status eventstore="филиал в Санкт-Петербурге" eventtime="2016-06-02 07:41:00" createtimegmt="2016-06-03 16:14:44" message="" title="Получен складом">~~1234567~~ACCEPTED</~~orderno~~status> <status eventstore="филиал в Санкт-Петербурге" eventtime="2016-06-02 09:17:00" createtimegmt="2016-06-03 16:14:44" message="" title="Выдан курьеру на доставку">DELIVERY</~~attachments~~status> <status eventstore="филиал в Санкт-Петербурге" eventtime="2016-06-02 17:22:00" createtimegmt="2016-06-03 16:14:44" message="" title="Доставлен (предварительно)">COURIERDELIVERED</~~source~~status> ~~'''Описание полей~~ <status eventstore="филиал в Санкт-Петербурге" eventtime="2016-06-02 17:22:00" createtimegmt="2016-06-03 16:14:~~'''~~44" message="" title="Доставлен">COMPLETE</status> </statushistory>~~'''attachments''' - Корневой контейнер. Обязательный элемент~~ <deliveredto>Иванова, секр.</deliveredto>*'''auth''' <delivereddate>2016- ~~Авторизация. Обязательный элемент.~~*'''orderno''' 06- ~~Номер~~02</~~код заказа. Обязательный элемент.~~delivereddate> <deliveredtime>17:22</deliveredtime> <outstrbarcode>EXT123456</outstrbarcode>~~'''Пример ответа:'''~~ <items> <~~source lang~~item code="~~xml~~34533">~~<?xml version~~extcode="abc123" quantity="1" mass="0.2" retprice="37.5" VATrate="0" ~~encoding~~barcode="2345625213125" article="~~UTF-8~~1" returns="0" origincountry="040" GTD="" excise="0.00" governmentCode="11223311" suppcompany="Поставщик" suppINN="1112223334" suppphone="79161234567"?>Мяч<~~attachments~~/item> <item ~~name~~code="34456" extcode="abc124" quantity="2" mass="2" retprice="100" VATrate="10" barcode="4645625213138" article="2" returns="~~doc1.docx~~0" ~~size~~governmentCode="~~35654~~">~~JVBERi0xLjMN~~ ~~JUBQREYwMTIzNDU2Nzg5IDI NMyAwIG9iag08PA0vVHlwZSA~~ ~~U3VidHlwZSAvSW1hZ2UNL1d pZHRoIDE4MDgNL0hlaWdodCA~~ ~~ggNCAwIFINL0JpdHNQZXJDb 21wb25lbnQgMQ0vRGVjb2RlU~~ ~~ENL0NvbHVtbnMgMTgwOA0+P g0vSW1hZ2VNYXNrIHRydWUNL~~ ~~XhEZWNvZGUNPj4Nc3RyZWFt DQ~~Обруч</item> <item ~~name~~code="34421" extcode="abc125" quantity="3" mass="~~photo2~~0.~~jpg~~3" retprice="50" VATrate="18" barcode="2345625213126" article=" ~~size~~3" returns="~~74861~~0"governmentCode="">Погремушка желтая</item>~~VBERi0xLjMN~~ ~~JUBQREYwMTIzNDU2Nzg5IDI NMyAwIG9iag08PA0vVHlwZSA~~ </items> ~~vWE9iamVjdA0vU3VidHlwZS AvSW1hZ2UNL1dpZHRoIDEzNj~~ ~~gNL0hlaWdodCAxMzMzDS9MZ W5ndGggNCAwIFINL0JpdHNQZ~~ ~~XJDb21wb25lbnQgMQ0vRGVj b2RlUGFybXMgPDwNL0sgLTEN~~ ~~L0NvbHVtbnMgMTM2OA0+Pg0 vSW~~ </~~item~~order></~~attachments~~tracking>

</source>

~~В тегах item возвращаются бинарные данные (файлы), закодированные в base64.~~

~~== Изменение статуса агентом ==~~'''Получение информации в формате 17 TRACK'''

~~Запрос изменения статуса заказа позволяет установить окончательный статус заказа -~~ '''Пример запроса:'''<source lang="xml"><?xml version="1.0"~~Доставлен~~encoding=" ~~или~~ UTF-8"~~Не доставлен (Возврат~~?><tracking17> <extra>8</extra> <orderno>1234</~~Отмена)".~~orderno></tracking17>Кроме этого, устанавливается дата и время (при необходимости) изменения статуса, а также сообщение в поле ''Инфо о доставке''.</source>

~~При необходимости к заказу можно прикрепить изображения.~~ '''Пример ~~запроса изменения статуса~~ответа:'''<~~source lang=~~pre>{ "number":"ExtNumber", "oriNumber":"1234", "oriCountry":"RU", "~~xml~~destCountry">:"RU",~~<?xml version=~~ "status":"~~1.0~~Complete" ~~encoding=~~, "~~UTF-8~~events" ?>:[~~<setorderinfo>~~ { ~~<auth extra=~~ "time":"82016-06-02 17:22:00" ~~login=~~, "~~login~~location" ~~pass=~~:"~~pass~~RU" />, ~~<order ordercode=~~ "content":"~~123456~~Complete"> ~~<message>Получил Иванов</message>~~ }, { "time":"2016-06-02 17:22:00", ~~</order>~~ "location":"RU", ~~<order ordercode=~~ "content":"~~234567~~Courierdelivered"> ~~<status>PICKUPREADY</status>~~ }, { ~~<eventtime>~~ "time":"2016-0506-~~30 10~~02 09:2017:00~~</eventtime>~~", "location":"RU", "content":"Delivery" ~~<message>Клиент отказался от покупки</message>~~ }, ~~<paytype>CASH</paytype>~~ { ~~<items>~~ "time":"2016-06-02 07:41:00", ~~<item code=~~ "location":"~~34533~~RU" ~~quantity=~~, "1content" ~~reason=~~:"0Accepted" /> ~~<item code=~~ }, { "time":"~~34456~~2016-06-01 19:53:00" ~~quantity=~~, "0location" ~~reason=~~:"0RU" />, ~~<item code=~~ "~~34421~~content" ~~quantity=~~:"2Departure" ~~reason=~~ }, { "time"0:" />2016-06-01 17:38:00", ~~</items>~~ "location":"RU", ~~<image filename=~~ "content":"~~filename1.jpg~~Departuring"~~> /9j/4AAQSkZJRgA~~ ~~BAQAAAQABAAD/2wBDAA0JCg sKCA0LCgsODg0PEyAVExISEy~~ }, ~~ccHhcgLikxMC4pLSwzOko+M zZGNywtQFdBRkxOUlNSMj5aY~~ { ~~VpQYEpRUk//2wBDAQ4ODhMR EyYVFSZPNS01T09PT09PT09P~~ "time":"2016-05-30 10:20:00", ~~T09PT09PT09PT09PT09PT09 PT09PT09PT09PT09PT09PT09~~ "location":"RU", ~~PT09PT0//wAARCAYACAADAS IA</image>~~ "content":"New" ~~</order>~~ }~~</setorderinfo>~~ ]}</~~source~~pre>

Функция ищет последний заказ по номеру среди заказов всех клиентов. Выдает неперсонализированную информацию о текущем состоянии заказа.<br>

Описание контейнеров ответа аналогично описанию [[API#.D0.97.D0.B0.D0.BF.D1.80.D0.BE.D1.81 .D1.81.D1.82.D0.B0.D1.82.D1.83.D1.81.D0.B0 .D0.B7.D0.B0.D0.BA.D0.B0.D0.B7.D0.BE.D0.B2|Запроса статусов заказов]].

~~'''Описание полей запроса статуса:'''~~== Изменение заказа ==Запрос предназначен для изменения заказов.

~~'''setorderinfo''' - Корневой контейнер~~Изменять заказы могут курьерские службы с тарифами «Премиум» и «Максимум». ~~Обязательный элемент.~~*Чтобы разрешить изменение заказов, в личном кабинете курьерской службы перейдите в '''~~auth~~Настройки''' ~~- Авторизация. Обязательный элемент.~~*> '''~~order~~Заказы''' ~~- Контейнер заказа. Обязательный элемент. Запрос может содержать более одного контейнера~~ и в разделе '''~~order'~~Отмена и редактирование''~~. Атрибут~~ 'установите флажок '''Разрешить отмену и изменение заказов'~~ordercode~~''~~''' - внутренний код заказа~~.* Вы также можете пометить в списке '''~~status~~Статусы для отмены и редактирования заказов''' ~~- Новый статус заказа. Доступны~~ галками статусы ~~из раздела [[#Описание полей ответа статусов]]~~корреспонденции, ~~кроме AWAITING_SYNC~~ для которых возможны отмена и ~~NEW~~изменение заказов.*'''eventtime''' - Дата По умолчанию (когда в этом списке ничего не выбрано) редактирование и ~~время изменения статуса. Обязательно при указании~~ отмена разрешены для статуса.*'''message''' - Текст сообщения ''Инфо о доставке''.*'''paytype''' - Тип оплаты заказа. Допустимые значения CASH/CARD.*'''items''' - Контейнер для описания вложений '''item''' . Атрибуты:~~:* '''''code''''' - Код вложения.:* '''''quantity''''' - Количество доставленных единиц вложения.:* '''''reason''''' - Причина недоставки, выбирается из соответствующего списка статусов.~~*'''image''' - Контейнер прикрепляемого изображения. Содержит текст файла изображения, закодированный по стандарту ''base64''. Контейнер '''order''' может содержать более одного контейнера '''image'''. Атрибут:~~:* '''''filename''''' - Имя файла.~~ «Новый»

'''Обратите внимание!'''

# Данные запроса изменения указываются '''полностью''', как если бы заказ создавался впервые.

# При отсутствии вложения в запросе изменения данное вложение '''не удаляется''' из заказа, но его количество становится равным 0.

# При одновременном изменении заказа в API и системе курьерской службы приоритет отдается данным системы курьерской службы. То есть изменения в API приняты не будут.

</div>

При редактировании заказа может быть отменен запланированный курьер. Это зависит от значения переменной '''Справочники''' > '''Переменные''' > '''Корреспонденция''' > '''Автоматически устанавливать заплан. курьера по району''':

* '''Нет''' — при редактировании заказа по АПИ курьер не изменяется;

* '''Район''' — если изменен адрес доставки, курьер сбрасывается;

* '''Район или дата план. доставки''' — если изменен адрес доставки или плановая дата вручения, курьер сбрасывается.

=== Описание полей запроса изменения ===

Все поля запроса соответствуют структуре order при создании заказа за исключением:

* значение '''orderno''' данным методом изменить нельзя.

* значение '''barcode''' изменяется в случае явного его указания. В случае отсутствия или пустого значения - остается прежним.

* вместо корневого тэга '''neworder''' указывается '''editorder''';

* тэг курьера '''courier''' можно изменить только при включенной настройке '''Разрешить изменение курьера по АПИ''';

* для вложений '''item''' указывается внутренний код вложения в атрибуте '''code''', который можно получить при получении статуса заказа.

* для мест '''package''' указывается внутренний код вложения в атрибуте '''code''', который можно получить при получении статуса заказа.

Необходимо иметь в виду, что:

# Заказ нельзя изменить, пока он не синхронизирован с системой (пока предыдущие изменения не переданы в бэк-офис)

# Удаление вложений и мест выполняется не моментально, а в процессе синхронизации с бэк-офисом (для записей указываются метки Удалено)

=== Описание полей ответа изменения ===

Все поля ответа соответствуют ответу при создании заказа за исключением корневого тэга — вместо '''neworder''' возвращается '''editorder'''.

== Отмена заказа ==

Запрос предназначен для отмены заказов.

Отменять заказы могут курьерские службы с тарифами «Премиум» и «Максимум». Разрешения для отмены заказов и статусы в которых заказы можно отменять описаны в разделе '''Изменение заказов'''

~~'''Пример ответа:'''<source lang="xml"><?xml version="1~~При отмене заказа поле «Инфо о доставке» получает значение «Отменено заказчиком», поле «Дата доставки» — текущую дату, а «Вручил курьер» — системную запись «ОТМЕНА».~~0" encoding="UTF-8"?><setorderinfo>~~ ~~<order ordercode="123456" error="0" errormsg="OK" errormsgru="Успешно" />~~ ~~<order ordercode="234567" error="59" errormsg="value [date_put] is already set" errormsgru="Значение [Дата доставки] уже указано" /></setorderinfo></source>~~

~~== Получение документов для печати ==~~

'''Пример запроса ~~получения печатных форм~~отмены заказа:'''

<?xml version="1.0" encoding="UTF-8" ?>

<~~waybill~~cancelorder>

~~<orders>~~ <order orderno="~~1234567~~" ordercode="~~33331~~123456" /> <order orderno="~~1234568~~123aaa" ordercode="~~33332~~" /> ~~</orders>~~ ~~<form>1</form~~></~~waybill~~cancelorder>

</source>

'''Описание полей:'''

'''~~waybill~~cancelorder''' - — Корневой контейнер. Обязательный элемент.*'''auth''' - — Авторизация. Обязательный элемент.*'''~~orders~~order''' ~~- Список заказов для получения печатных форм~~ — Контейнер отменяемого заказа. Обязательный элемент. ~~Содержит тэги~~ Запрос может содержать более одного контейнера '''order''' ~~с атрибутами~~. Атрибуты::* '''''orderno''''' ~~- шифр~~ — Шифр заказа.:* '''''ordercode''''' ~~- внутренний~~ — Внутренний код заказа. ~~Указывать необходимо~~ Обратите внимание, что должен быть указан хотя бы один из атрибутов ~~для всех заказов. Приоритет имеет атрибут~~ ''orderno'' или ''ordercode''~~'''~~*'''form''' - Формат накладной. Не обязательный элемент. Принимает значения:~~:* 1 - Подробная накладная (по-умолчанию):* 2 - Наклейки Zebra:* 3 - Наклейки на страницу формата А4:* 4 - Акты приема-передачи~~!

'''Пример ответа:'''

<?xml version="1.0" encoding="UTF-8"?><~~waybill~~cancelorder> <~~content~~order orderno="123test" ordercode="123456" error="0" errormsg="OK" errormsgru="Успешно" />~~EODIcaI8KSBlwQ 4MnEOR7Px8U8EBAyGICBnwpw~~ ~~IZhQgz0ZxuPs8EBM/GcbjzB AwhBl8hwQYIO00GmEwg1CeEG~~ ~~mqYTChNU0wqf8l8nz4zgc+K fCno+zwU5GjOZmzXGcbEQYIM~~ ~~4zkegRE40zWzONyoNNMIOIa cWnp6aDCGEGE9NQmoQd2mg00~~ ~~79U4f3hPTwnfp6Sdrafeqpa JDpFw/1aYT077VNNNdO00G3q~~ ~~mqqvp9p2E7T0/wiFemv8uG6 OM~~<order orderno="123aaa" ordercode="" error="52" errormsg="order not found" errormsgru="Заказ не найден" /~~content~~></~~waybill~~cancelorder>

</source>

== Добавление вложений к накладной ==

~~В тэге content возвращаются бинарные данные (файл pdf), закодированные в base64~~Метод позволяет прикрепить файлы к корреспонденции.Размер загружаемого файла не должен превышать 1 Мб. '''Пример запроса:'''<source lang="xml"><?xml version="1.0" encoding="UTF-8" ?><addattachments> <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</item> <item name="photo2.jpg">VBERi0xLjMNAwIG9iag0HRoJ JUBQREYwMTIzNDU2Nzg5IDI NMyAwIG9iag08PA0vVHlwZSA vWE9iamVjdA0vU3VidHlwZS AvSW1hZ2UNL1dpZHRoIDEzNj gNL0hlaWdodCAxMzMzDS9MZ W5ndGggNCAwIFINL0JpdHNQZ XJDb21wb25lbnQgMQ0vRGVj b2RlUGFybXMgPDwNL0sgLTEN L0NvbHVtbnMgMTM2OA0+Pg0 vSW</item> </attachments></addattachments></source>

'''~~Обратите внимание~~Описание полей:'''~~, что печатные формы для заборов не формируются.~~

'''addattachments''' — Корневой контейнер. Обязательный элемент.

* '''auth''' — Авторизация. Обязательный элемент.

* '''orderno''' — Номер заказа. Обязательный элемент. Может использоваться тэг <ordercode> с указанием внутреннего кода заказа.

* '''attachments''' — Обязательный элемент, в котором перечисляются передаваемые данные файлов.

** '''item''' — Бинарные данные (файл), закодированные в base64. Обязательный элемент.

*** '''name''' — Атрибут элемента '''item''', в котором передается имя файла. Обязательный элемент.

~~== Справочник городов ==~~

'''Пример ~~запроса справочника городов~~ответа:'''

<?xml version="1.0" encoding="UTF-8"?>

<~~townlist~~addattachments> <~~auth extra="8" />~~ ~~<codesearch~~attachments> <~~zipcode>110000<~~item name="photo1.jpg" error="0" errormsg="OK" errormsgru="Успешно" /~~zipcode~~> <~~kladrcode>0100000100800<~~item name="photo2.jpg" error="0" errormsg="OK" errormsgru="Успешно" /~~kladrcode~~> ~~<fiascode>bd21979d-46f8-49d0-9105-e8d65172a983~~ </~~fiascode~~attachments> ~~<code>123~~</~~code~~addattachments> </~~codesearch~~source> ~~<conditions>~~ ~~<city>Краснодарский край</city>~~== Получение вложений к накладной == ~~<namecontains>новгород</namecontains>~~'''Пример запроса:''' <~~namestarts>Моск</namestarts~~source lang="xml"> <~~name>Москва</name~~?xml version="1.0" encoding="UTF-8" ?> ~~<fullname>Москва город~~<~~/fullname>~~ ~~<country>1</country~~attachments> <auth extra="8" login="login" pass="pass" /~~conditions~~> <~~limit~~orderno> ~~<limitfrom>30</limitfrom>~~ ~~<limitcount>10</limitcount>~~ ~~<countall>YES</countall>~~ 1234567</~~limit~~orderno></~~townlist~~attachments>

</source>

Внутри контейнера townlist все элементы могут как отсутствовать, так и комбинироваться. Поиск не чувствителен к регистру. *'''auth''' - Авторизация, необязательный элемент. Используется в случае включенного и настроенного ограничения по населенным пунктам в конкретной курьерской службе. *'''codesearch''' - Поиск по кодам. В случае использования - контейнеры conditions и limit игнорируются.Описание полей:* '''zipcode''' - Поиск по индексу. Обратите внимание на то, что один почтовый индекс может распространяться на несколько населенных пунктов. В этом случае система вернет несколько записей.~~:* '''kladrcode''' - Поиск по 13-ти значному коду КЛАДР.:* '''fiascode''' - Поиск по коду ФИАС (AOGUID).:* '''code~~''' ~~- Поиск по коду в системе.~~

*'''~~conditions~~attachments''' ~~- Задает условия поиска~~ — Корневой контейнер. ~~Все вложенные элементы одновременно накладывают условие "И".:* '''city''' - Поиск по всем населенным пунктам региона~~Обязательный элемент.:* '''~~namecontains~~auth''' ~~- Поиск населенных пунктов, название которых содержит указанный текст~~ — Авторизация.~~:* '''namestarts''' - Поиск населенных пунктов, название которых начинается с указанного текста~~Обязательный элемент.:* '''~~name~~orderno''' ~~- Поиск населенных пунктов, название которых соответствует указанному тексту~~ — Номер/код заказа.:* '''fullname''' - Поиск населенных пунктов, название вместе с типом населенного пункта которых соответствует указанному тексту.~~:* '''country''' - Поиск только по стране с указанным кодом~~Обязательный элемент.

*'''limit''' - Ограничивает вывод результата.

~~:* '''limitfrom''' - Задает номер записи результата, начиная с которой выдавать ответ. По-умолчанию - 0.~~

~~:* '''limitcount'''- Задает количество записей результата, которые нужно вернуть. По-умолчанию - 10000.~~

:* '''countall''' - YES указывает на необходимость подсчета общего количества найденных совпадений. Это может замедлять выполнение запроса. Если отключено - в ответе не указываются totalcount и totalpages.

'''Пример ответа:'''

<?xml version="1.0" encoding="UTF-8"?>

<~~townlist count="3" page="1" totalcount="3" totalpages="1"~~attachments> <~~town>~~ ~~<code>26379</code>~~ ~~<city>~~ ~~<code>23</code>~~ ~~<name>Краснодарский край</name>~~ ~~</city>~~ <item name~~>Сочи город</name>~~ ~~<fiascode>79da737a-603b-4c19-9b54-9114c96fb912</fiascode>~~ ~~<kladrcode>2300000700000</kladrcode>~~ ~~<shortname /> (not yet supported)~~ ~~<typename /> (not yet supported)~~ ~~<coords lat~~="43doc1.~~5855~~docx" ~~lon~~size="~~39.7231~~35654" />JVBERi0xLjMN ~~</town>~~JUBQREYwMTIzNDU2Nzg5IDI NMyAwIG9iag08PA0vVHlwZSA ~~<town>~~U3VidHlwZSAvSW1hZ2UNL1d pZHRoIDE4MDgNL0hlaWdodCA ~~<code>40331</code>~~ ggNCAwIFINL0JpdHNQZXJDb 21wb25lbnQgMQ0vRGVjb2RlU ~~<city>~~ ENL0NvbHVtbnMgMTgwOA0+P g0vSW1hZ2VNYXNrIHRydWUNL ~~<code>32~~ XhEZWNvZGUNPj4Nc3RyZWFt DQ</~~code~~item> ~~<name>Брянская область~~ </item name> ~~</city>~~ ~~<name>Сочилов хутор</name>~~ ~~<fiascode>c9c96c67-2cc9-4f10-afde-fd32417ea216</fiascode>~~ ~~<kladrcode>3201900011100</kladrcode>~~ ~~<shortname />~~ ~~<typename />~~ ~~<coords lat~~="52photo2.~~6407~~jpg" ~~lon~~size="~~33.1724~~74861" />VBERi0xLjMN ~~</town>~~JUBQREYwMTIzNDU2Nzg5IDI NMyAwIG9iag08PA0vVHlwZSA ~~<town>~~vWE9iamVjdA0vU3VidHlwZS AvSW1hZ2UNL1dpZHRoIDEzNj ~~<code>114016</code>~~ gNL0hlaWdodCAxMzMzDS9MZ W5ndGggNCAwIFINL0JpdHNQZ ~~<city>~~ XJDb21wb25lbnQgMQ0vRGVj b2RlUGFybXMgPDwNL0sgLTEN ~~<code>60~~ L0NvbHVtbnMgMTM2OA0+Pg0 vSW</~~code~~item> ~~<name>Псковская область~~</~~name~~attachments> </~~city~~source> ~~<name>Сочихино деревня</name>~~ ~~<fiascode>10df7588-19c1-49d1-a387-9de1cf3eb26f</fiascode>~~ ~~<kladrcode>6001900015400</kladrcode>~~В тегах item возвращаются бинарные данные (файлы), закодированные в base64. ~~<shortname />~~ ~~<typename />~~ ~~<coords lat~~=~~"56.6003" lon~~=~~"29.3542" />~~Изменение статуса агентом == <Запрос изменения статуса заказа позволяет установить окончательный статус заказа — «Доставлен» или «Не доставлен (Возврат/~~town>~~Отмена)».~~</townlist></source>~~Кроме этого, устанавливается дата и время (при необходимости) изменения статуса, а также сообщение в поле ''Инфо о доставке''.

~~В ответе города сортируются по популярности, важности (районные центры и т.д.), и только затем - по алфавиту~~При необходимости к заказу можно прикрепить изображения.

~~== Справочник регионов ==~~

'''Пример запроса ~~справочника~~изменения статуса:'''

<?xml version="1.0" encoding="UTF-8"?><~~regionlist~~setorderinfo> <~~codesearch~~auth extra="8" login="login" pass="pass" /> <order ordercode="123456"> <message>Получил Иванов</message> <~~code~~outstrbarcode>777654312</~~code~~outstrbarcode> </~~codesearch~~order> <~~conditions~~order ordercode="234567"> <status>PICKUPREADY</status> <~~namecontains~~eventtime>~~край~~2016-05-30 10:20:00</~~namecontains~~eventtime> <~~namestarts~~message>~~Моск~~Клиент отказался от покупки</~~namestarts~~message> <~~fullname~~paytype>~~Московская область~~CASH</~~fullname~~paytype> <~~country~~storeprice>123</storeprice> <items> <item code="34533" quantity="1" reason="0" governmentCode="11223311" /> <item code="34456" quantity="0" reason="0" /~~country~~> <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 IA</image> </~~conditions~~order></~~regionlist~~setorderinfo></source> '''Описание полей запроса статуса:''' '''setorderinfo''' — Корневой контейнер. Обязательный элемент.* '''auth''' — Авторизация. Обязательный элемент.* '''order''' — Контейнер заказа. Обязательный элемент. Запрос может содержать более одного контейнера '''order'''. Атрибут '''''ordercode''''' — внутренний код заказа.* '''status''' — Новый статус заказа. Доступны статусы из раздела [[#Описание полей ответа статусов]], кроме AWAITING_SYNC и NEW.* '''eventtime''' — Дата и время изменения статуса. Обязательно при указании статуса.* '''message''' — Текст сообщения ''Инфо о доставке''.* '''outstrbarcode''' — код у подрядчика (код заказа во внешней системе). Используется в интеграциях с внешними системами.* '''paytype''' — Тип оплаты заказа. Допустимые значения CASH/CARD.* '''storeprice''' — Агентское вознаграждение.* '''items''' — Контейнер для описания вложений '''item''' . Атрибуты::* '''''code''''' — Код вложения.:* '''''quantity''''' — Количество доставленных единиц вложения.:* '''''reason''''' — Причина недоставки, выбирается из соответствующего списка статусов.:* '''''governmentCode''''' — Указание кода ТН для вложения при необходимости.* '''image''' — Контейнер прикрепляемого изображения. Содержит текст файла изображения, закодированный по стандарту ''base64''. Контейнер '''order''' может содержать более одного контейнера '''image'''. Атрибут::* '''''filename''''' — Имя файла. '''Пример ответа:'''

<?xml version="1.0" encoding="UTF-8"?>

<~~regionlist count="2"~~setorderinfo> <~~city>~~ ~~<code>80<~~order ordercode="123456" error="0" errormsg="OK" errormsgru="Успешно" /~~code>~~ ~~<country>~~ ~~<code>1</code>~~ ~~<name>Россия</name>~~ ~~<id>643</id>~~ ~~<ShortName1>RU</ShortName1>~~ ~~<ShortName2>RUS</ShortName2>~~ ~~</country>~~ ~~<name>Агинский Бурятский автономный округ</name~~> <order ordercode="234567" error="59" errormsg="value [date_put] is already set" errormsgru="Значение [Дата доставки] уже указано" /~~city>~~ ~~<city>~~ ~~<code>1</code~~> ~~<country>~~ ~~<code>1~~</~~code>~~ ~~<name>Россия</name>~~ ~~<id>643</id>~~ ~~<ShortName1>RU</ShortName1>~~ ~~<ShortName2>RUS</ShortName2>~~ ~~</country>~~ ~~<name>Адыгея республика</name>~~ ~~</city></regionlist~~setorderinfo></source> == ~~Справочник улиц~~ Получение документов для печати == '''Пример запроса ~~справочника улиц~~получения печатных форм:'''

<?xml version="1.0" encoding="UTF-8"?><~~streetlist~~waybill> <~~conditions~~auth extra="8" login="login" pass="pass" /> ~~<town>Москва город</town>~~ ~~// ОБЯЗАТЕЛЬНОЕ ПОЛЕ!~~ ~~<namecontains>Хохло~~<~~/namecontains~~orders> <~~namestarts>Академика Х<~~order orderno="1234567" ordercode="33331" /~~namestarts~~> <~~name>Академика Хохлова<~~order orderno="1234568" ordercode="33332" /~~name>~~ ~~<fullname>Академика Хохлова ул.</fullname~~> </~~conditions~~orders> <~~limit~~form> ~~<limitfrom>30~~1</~~limitfrom~~form> <~~limitcount~~start>~~10</limitcount>~~ ~~<countall>YES</countall>~~ 5</~~limit~~start></~~streetlist~~waybill>

</source>

'''Описание полей:''' '''waybill''' — Корневой контейнер. Обязательный элемент*'''~~conditions~~auth''' ~~- Задает условия поиска. Все вложенные элементы одновременно накладывают условие "И"~~ — Авторизация.Обязательный элемент:* '''~~town~~orders''' ~~- Обязательное поле. Название или код населенного пункта~~ — Список заказов для получения печатных форм.Содержит тэги '''order''' с атрибутами::* '''~~namecontains~~''orderno' ~~- Поиск населенных пунктов, название которых содержит указанный текст.~~'''' — шифр заказа:* '''~~namestarts~~''ordercode''' ~~- Поиск населенных пунктов, название которых начинается с указанного текста~~'' — внутренний код заказа. Указывать необходимо один из атрибутов для всех заказов.Приоритет имеет атрибут '''''ordercode''''':* '''~~name~~form''' — Формат накладной. Не обязательный элемент. Принимает значения::* 1 — Подробная накладная (по- ~~Поиск населенных пунктов, название которых соответствует указанному тексту.~~умолчанию):* 2 — Наклейки Zebra:* 3 — Наклейки на страницу формата А4:* 4 — Акты приема-передачи* '''~~fullname~~start''' - Поиск населенных пунктов, название вместе с типом населенного пункта которых соответствует указанному тексту — Имеет смысл только для form = 3. Начальная позиция первой наклейки. Используется для пропуска наклеек на листе для их экономии.

*'''limit''' - Ограничивает вывод результата.

~~:* '''limitfrom''' - Задает номер записи результата, начиная с которой выдавать ответ. По-умолчанию - 0.~~

~~:* '''limitcount'''- Задает количество записей результата, которые нужно вернуть. По-умолчанию - 10000.~~

:* '''countall''' - YES указывает на необходимость подсчета общего количества найденных совпадений. Это может замедлять выполнение запроса. Если отключено - в ответе не указываются totalcount и totalpages.

'''Пример ответа:'''

<?xml version="1.0" encoding="UTF-8"?>

<~~streetlist count="1" page="1" totalcount="3" totalpages="1"~~waybill> <~~street~~content>EODIcaI8KSBlwQ 4MnEOR7Px8U8EBAyGICBnwpw ~~<name>Академика Хохлова ул.<~~ IZhQgz0ZxuPs8EBM/~~name>~~GcbjzB AwhBl8hwQYIO00GmEwg1CeEG mqYTChNU0wqf8l8nz4zgc+K fCno+zwU5GjOZmzXGcbEQYIM ~~<shortname>Академика Хохлова</shortname>~~ 4zkegRE40zWzONyoNNMIOIa cWnp6aDCGEGE9NQmoQd2mg00 ~~<typename>ул.<~~ 79U4f3hPTwnfp6Sdrafeqpa JDpFw/~~typename>~~1aYT077VNNNdO00G3q mqqvp9p2E7T0/wiFemv8uG6 OM</~~street~~content></~~streetlist~~waybill>

</source>

~~В ответе улицы сортируются по алфавиту.~~

~~== Справочник номенклатуры ==~~В тэге content возвращаются бинарные данные (файл pdf), закодированные в base64.При записи в файл необходимо использовать двоичный формат записи! '''Обратите внимание''', что печатные формы для заборов не формируются.

'''Пример ~~запроса справочника номенклатуры~~ответа с ошибкой:'''

<?xml version="1.0" encoding="UTF-8" ?><~~itemlist~~waybill> <~~auth extra="8" login="login" pass="pass"></auth>~~ ~~<codesearch>~~ ~~<code>123456</code>~~ ~~<article>FD343</article>~~ ~~<barcode>2345625213125</barcode>~~ ~~</codesearch>~~ ~~<conditions>~~ ~~<namecontains>телевизор</namecontains>~~ ~~<namestarts>sony</namestarts>~~ ~~<name>Sony KDL-55W905 ЖК-телевизор</name>~~ ~~<quantity>EXISTING_ONLY</quantity>~~ ~~<store>2</store>~~ ~~</conditions>~~ ~~<limit>~~ ~~<limitfrom>30</limitfrom>~~ ~~<limitcount>10</limitcount>~~ ~~<countall>YES</countall~~error> Текст ошибки</~~limit~~error></~~itemlist~~waybill></source> Внутри контейнера itemlist все элементы могут как отсутствовать, так и комбинироваться. Поиск не чувствителен к регистру.*'''codesearch''' - Поиск по кодам. В случае использования - контейнеры conditions и limit игнорируются.~~:* '''code''' - Поиск по внутреннему коду системы.:* '''article''' - Поиск по артикулу.:* '''barcode''' - Поиск по штрих-коду.~~ *'''conditions''' - Задает условия поиска. Все вложенные элементы одновременно накладывают условие "И".~~:* '''namecontains''' - Поиск товаров, название которых содержит указанный текст.:* '''namestarts''' - Поиск товаров, название которых начинается с указанного текста.:* '''name''' - Поиск товаров, название которых соответствует указанному тексту.~~:* '''quantity''' - Наличие на складе. Принимает значения EXISTING_ONLY - Только в наличии, NOT_EXISTING_ONLY - Только не в наличии, ALL - Все. ''Это поле может быть недоступным в некоторых установках.''~~:* '''store''' - Поиск товаров по определенному складу.~~ *'''limit''' - Ограничивает вывод результата.~~:* '''limitfrom''' - Задает номер записи результата, начиная с которой выдавать ответ.:* '''limitcount''' - Задает количество записей результата, которые нужно вернуть.~~== Справочник городов =='''Пример ~~ответа~~запроса справочника городов:'''

<?xml version="1.0" encoding="UTF-8"?>

<~~itemlist count~~townlist> <auth extra="~~3" totalcount="3" page="1" totalpages="1~~8"/> <~~item~~codesearch> <~~code~~zipcode>~~123456~~110000</~~code~~zipcode> <~~article~~kladrcode>~~FD343~~0100000100800</~~article~~kladrcode> <~~barcode~~fiascode>~~2345625213125~~bd21979d-46f8-49d0-9105-e8d65172a983</~~barcode~~fiascode> <~~name~~code>~~Sony KDL-55W905 ЖК-телевизор~~123</~~name~~code> <~~retprice~~/codesearch>~~65000~~ <~~/retprice~~conditions> <~~purchprice~~city>~~50000~~Краснодарский край</~~purchprice~~city> <~~weight~~namecontains>~~5.1~~новгород</~~weight~~namecontains> <~~length~~namecontainsparts>50молоково моск</~~length~~namecontainsparts> <~~width~~namestarts>30Моск</~~width~~namestarts> <~~height~~name>40Москва</~~height~~name> <~~CountInPallet~~fullname>30Москва город</~~CountInPallet~~fullname> <~~HasSerials~~country>1</~~HasSerials~~country> ~~<CountryOfOrigin>Малайзия~~ </~~CountryOfOrigin~~conditions> ~~(not yet supported)~~ <~~Message>Хороший телевизор</Message~~limit> <~~Message2~~limitfrom>~~Снова хороший телевизор~~30</~~Message2~~limitfrom> <~~quantity~~limitcount>1210</~~quantity~~limitcount> <~~reserved~~countall>3YES</~~reserved~~countall> <~~item~~/limit> ~~...~~</~~itemlist~~townlist>

</source>

~~'''Описание полей:'''~~*'''code''' - Внутренний идентификаторВнутри контейнера townlist все элементы могут как отсутствовать, ~~присвоенный системой~~так и комбинироваться.*'''article''' - Артикул, назначенный клиентом (поставщиком).*'''barcode''' - Штрих-код производителя.*'''name''' - Наименование.*'''retprice''' - Розничная цена по-умолчанию. При оформлении заказа цена используется та, которая указана в заказе.*'''purchprice''' - Закупочная цена.*'''weight''' - Масса в килограммах.*'''length''' - Длина в сантиметрах.*'''width''' - Ширина в сантиметрах.*'''height''' - Высота в сантиметрах.*'''CountInPallet''' - Количество штук в паллете.*'''HasSerials''' - Требует учета серийных номеров. Принимает значения 1 - да, 0 - нет.*'''CountryOfOrigin''' - Наименование страны происхождения на русском языке.*'''Message''' - Комментарий.*'''Message2''' - Дополнительный комментарий.*'''quantity''' - Количество на складе. Товары, уже собранные в заказы в этом количестве Поиск не присутствуют, считаются покинувшими товарный склад. ''Это поле может быть недоступным в некоторых установках.''*'''reserved''' - Количество зарезервированного товара. Может превышать остаток на складе, если покупатели ждут следующей поставки. ''Это поле может быть недоступным в некоторых установкахчувствителен к регистру.''

~~== Движение номенклатуры ==~~* '''auth''' — Авторизация, необязательный элемент. Используется в случае включенного и настроенного ограничения по населенным пунктам в конкретной курьерской службе.

* '''~~Пример запроса движения номенклатуры~~codesearch''' — Поиск по кодам. В случае использования — контейнеры conditions и limit игнорируются.:* '''zipcode''' — Поиск по индексу. Обратите внимание на то, что один почтовый индекс может распространяться на несколько населенных пунктов. В этом случае система вернет несколько записей.~~<source lang="xml">~~:* '''kladrcode''' — Поиск по 13-ти значному коду КЛАДР.~~<?xml version="1~~:* '''fiascode''' — Поиск по коду ФИАС (AOGUID).~~0" encoding="UTF-8" ?><itemmovements>~~ ~~<auth extra="8" login="login" pass="pass"></auth>~~ <:* '''code~~>4259</code>~~ ~~<datefrom>2020-10-01</datefrom>~~ ~~<dateto>2020-10-02</dateto></itemmovements></source>~~''' — Поиск по коду в системе.

*'''~~code~~conditions''' ~~- внутренний код товара~~ — Задает условия поиска. Все вложенные элементы одновременно накладывают условие «И».:* '''city''' — Поиск по всем населенным пунктам региона.:* '''namecontainsparts''' — Поиск населенных пунктов, название которых содержит все указанные слова, с разбиением поисковой фразы через пробел. Например "моск моло" найдет деревню "Молоково" в ~~справочнике номенклатуры~~Московской области.:* '''namecontains''' — Поиск населенных пунктов, название которых содержит указанный текст.:* '''namestarts''' — Поиск населенных пунктов, название которых начинается с указанного текста.:*'''~~datefrom~~name''' ~~- дата начала периода~~ — Поиск населенных пунктов, название которых соответствует указанному тексту.:*'''~~dateto~~fullname''' ~~- дата окончания периода~~ — Поиск населенных пунктов, название вместе с типом населенного пункта которых соответствует указанному тексту.~~Может быть указан~~ :* '''country''' — Поиск только по стране с указанным внутренним кодом или ~~код~~текстовым кодом в соответствии [https://ru.wikipedia.org/wiki/ISO_3166-1 стандартом ISO_3166-1], например, ~~или период~~«RU», ~~или код и период одновременно~~«RUS» для России.

* '''limit''' — Ограничивает вывод результата.

:* '''limitfrom''' — Задает номер записи результата, начиная с которой выдавать ответ. По-умолчанию — 0.

:* '''limitcount'''- Задает количество записей результата, которые нужно вернуть. По-умолчанию — 10000.

:* '''countall''' — YES указывает на необходимость подсчета общего количества найденных совпадений. Это может замедлять выполнение запроса. Если отключено — в ответе не указываются totalcount и totalpages.

'''Пример ответа ~~движения номенклатуры~~:'''

<?xml version="1.0" encoding="UTF-8" ?><~~itemmovements~~ townlist count="163" page="1" totalcount="3" totalpages="1"> <~~itemmovement~~town> <code>~~151500~~26379</code> <~~date~~city> <code>~~2017-05-26~~23</~~date~~code> <~~retprice~~name>0Краснодарский край</~~retprice~~name> ~~<quantity>1~~</~~quantity~~city> <~~delivered~~name>0Сочи город</~~delivered~~name> <~~item~~fiascode> ~~<code>4259~~79da737a-603b-4c19-9b54-9114c96fb912</~~code~~fiascode> <~~name~~kladrcode>~~Настольная игра Дженга~~2300000700000</~~name~~kladrcode> <shortname /~~item~~> (not yet supported) <~~status~~typename /> (not yet supported) <~~code~~coords lat="43.5855" lon="39.7231" />5 </~~code~~town> <~~name~~town>~~Возврат от покупателя~~ <~~/name~~code> 40331</~~status~~code> <~~store~~city> <code>132</code> <name>~~офис в Москве~~Брянская область</name> </~~store~~city> <~~order>~~ ~~<ordercode~~name>~~3374830~~Сочилов хутор</~~ordercode~~name> <~~number~~fiascode>~~123660~~c9c96c67-2cc9-4f10-afde-0fd32417ea216</~~number~~fiascode> <~~date~~kladrcode>~~2017-05-24~~3201900011100</~~date~~kladrcode> <~~orderno~~shortname />~~14123~~ <typename /~~orderno~~> <~~barcode~~coords lat="52.6407" lon="33.1724" />~~0000000670~~ </~~barcode~~town> <~~company>ТОВАР</company~~town> <~~address~~code>~~Кравченко ул., 1~~114016</~~address~~code> ~~<delivereddate>2017-05-29~~ <~~/delivereddate~~city> <~~deliveredtime~~code>~~12:00:00~~60</~~deliveredtime~~code> <~~deliveredto~~ name>Псковская область</name> </~~order~~city> <~~document>~~ ~~<code~~name>~~21991~~Сочихино деревня</~~code~~name> <~~number~~fiascode>~~318~~10df7588-19c1-49d1-a387-9de1cf3eb26f</~~number~~fiascode> <~~date~~kladrcode>~~2017-05-26~~6001900015400</~~date~~kladrcode> <~~message~~shortname /> <typename /~~message~~> <coords lat="56.6003" lon="29.3542" /~~document~~> </~~itemmovements~~town></~~itemlist~~townlist>

</source>

~~''' Описание полей ответа '''~~*'''code''' - внутренний код операции движения*'''date''' - дата операции*'''retprice''' - цена товара*'''quantity''' - количество товара операции*'''delivered''' - количество доставленного товараВ ответе города сортируются по популярности, важности (районные центры и т. д.), и только затем — по алфавиту.

*'''item''' - контейнер товара~~:* '''code''' - внутренний код товара:* '''name''' - наименование товара~~ *'''status''' - контейнер статуса операции~~:* '''code''' - код статуса:* '''name''' - наименование~~ *'''store''' - контейнер филиала, к которому относится операция~~:* '''code''' - код филиала:* '''name''' - наименование филиала~~ *'''order''' - контейнер корреспонденции~~:* '''ordercode''' - внутренний код заказа:* '''number''' - номер заказа:* '''date''' - дата заказа:* '''orderno''' - шифр:* '''barcode''' - штрих-код:* '''company''' - компания:* '''address''' - адрес:* '''delivereddate''' - дата вручения:* '''deliveredtime''' - время вручения:* '''deliveredto''' - данные о вручении, либо причина недоставки~~ *'''document''' - контейнер документа операции~~:* '''code''' - внутренний код документа:* '''number''' - номер документа:* '''date''' - дата документа:* '''message''' - комментарий~~ == ~~Номенклатура приходной накладной~~ Справочник регионов == '''Пример запроса ~~номенклатуры приходной накладной~~справочника:'''

<?xml version="1.0" encoding="UTF-8" ?><~~itemdoc~~regionlist> <~~auth extra="8" login="login" pass="pass"~~codesearch> <code>77</code> </codesearch> <conditions> <namecontains>край</namecontains> <namestarts>Моск</namestarts> <fullname>Московская область</~~auth~~fullname> <~~code~~country>RU</country>~~21991~~ </~~code~~conditions></~~itemdoc~~regionlist>

</source>

*'''code''' - внутренний код документа приходной накладной (см. предыдущий запрос). '''Пример ответа ~~движения номенклатуры~~:'''

<?xml version="1.0" encoding="UTF-8" ?><~~itemdoc~~regionlist count="2"> <city> <code>~~21991~~80</code> <country> <code>1</code> <name>Россия</name> <id>643</id> <~~number~~ShortName1>~~318~~RU</~~number~~ShortName1> <ShortName2>RUS<~~date~~/ShortName2>~~2017-05-26~~ </~~date~~country> <name>Агинский Бурятский автономный округ<~~message~~/name> </~~message~~city> <~~items~~city> <code>1</code> <~~item~~ country> <code~~="4259" quantity="~~>1~~" barcode="200300" article="123555"~~</code> <name>Россия</name> <id>643</id> <ShortName1>RU</ShortName1> <ShortName2>RUS</ShortName2> </country> <name>~~Настольная игра Дженга~~Адыгея республика</~~item~~name> </~~items~~city></~~itemdoc~~regionlist></source>

~~''' Описание полей ответа '''~~* '''code''' - внутренний код приходной накладной* '''number''' - номер документа* '''date''' - дата документа* '''message''' - комментарий *'''item''' - контейнер товара~~:* '''code''' - внутренний код товара:* '''barcode''' - штрих-код товара:* '''article''' - артикул товара:* '''quantity''' - количество поступившего товара~~ == Справочник ~~филиалов~~ улиц == '''Пример запроса ~~списка филиалов~~справочника улиц:'''

<?xml version="1.0" encoding="UTF-8" ?><~~storelist~~streetlist> <~~auth extra="8"~~conditions> <town>Москва город</town> // ОБЯЗАТЕЛЬНОЕ ПОЛЕ! <namecontains>Хохло</namecontains> <namestarts>Академика Х</namestarts> <name>Академика Хохлова</name> <fullname>Академика Хохлова ул.</fullname> </conditions> <limit> <limitfrom>30</~~auth~~limitfrom> <~~json~~limitcount>~~YES~~10</~~json~~limitcount> <countall>YES<~~client_code~~/countall>~~7890~~ </~~client_code~~limit></~~storelist~~streetlist>

</source>

*'''~~auth~~conditions''' ~~- Атрибут~~ — Задает условия поиска. Все вложенные элементы одновременно накладывают условие «И».:* '''town''' — Обязательное поле. Название или код населенного пункта.:* '''namecontains''' — Поиск улиц, название которых содержит указанный текст.:* '''namestarts''' — Поиск улиц, название которых начинается с указанного текста.:* '''name''' — Поиск улиц, название которых соответствует указанному тексту.:* '''~~extra~~fullname''' ~~- обязателен~~ — Поиск улиц, ~~по нему определяется курьерская служба~~для которых название вместе с типом соответствует указанному тексту. * '''limit''' — Ограничивает вывод результата.:*'''~~json~~limitfrom''' — Задает номер записи результата, начиная с которой выдавать ответ. По- ~~Признак вывода ответа в виде JSON YES/NO~~умолчанию — 0.:*'''~~client_code~~limitcount''' - ~~Код клиента курьерской службы~~Задает количество записей результата, которые нужно вернуть. По-умолчанию — 10000.:* '''countall''' — YES указывает на необходимость подсчета общего количества найденных совпадений. Это может замедлять выполнение запроса. Если отключено, в ответе не указываются totalcount и totalpages.

'''Пример ответа:'''

<?xml version="1.0" encoding="UTF-8" ?><~~storelist~~ streetlist count="21" page="1" totalcount="3" totalpages="1"> <~~store~~street> <code>~~123~~124</code> <name>~~ABC~~Академика Хохлова ул.</name> <~~/store~~shortname> ~~<store>~~ ~~<code>456~~Академика Хохлова</~~code~~shortname> <~~name~~typename>~~Филиал 2~~ул.</~~name~~typename> </~~store~~street></~~storelist~~streetlist>

</source>

*'''code''' - Код филиала. *'''name''' - Наименование филиалаВ ответе улицы сортируются по алфавиту.

== Справочник ~~пунктов самовывоза~~ номенклатуры == Для отображения списка пунктов выдачи (ПВЗ) есть '''готовый JavaScript модуль''': https://home.courierexe.ru/js/measoft_map.js Инструкция по использованию - внутри. '''Пример запроса ~~пунктов самовывоза~~справочника номенклатуры:'''

<?xml version="1.0" encoding="UTF-8" ?>

<~~pvzlist~~itemlist> <auth extra="8" login="login" pass="pass"></auth> <codesearch> <code>~~1234~~123456</code> <~~client_code~~article>~~7890~~FD343</~~client_code~~article> <~~town~~barcode>~~Нижний Тагил~~2345625213125</barcode> </~~town~~codesearch> <conditions> <~~parentcode~~namecontains>6телевизор</~~parentcode~~namecontains> <~~acceptcash~~namestarts>~~YES~~sony</~~acceptcash~~namestarts> <~~acceptcard~~name>~~YES~~Sony KDL-55W905 ЖК-телевизор</~~acceptcard~~name> <~~acceptfitting~~quantity>~~YES~~EXISTING_ONLY</~~acceptfitting~~quantity> <~~maxweight~~store>302</~~maxweight~~store> <~~acceptindividuals~~/conditions>~~YES~~ <~~/acceptindividuals~~except> <ltcode>~~57.924737~~123478</ltcode> <lg/except>~~59.940019~~ <~~/lg~~limit> <rtlimitfrom>~~57.905682~~30</rtlimitfrom> <rglimitcount>~~59.984669~~10</rglimitcount> <~~json~~countall>YES</~~json~~countall> </limit></~~pvzlist~~itemlist>

</source>

*'''auth''' - Атрибут '''extra''' - обязателен, по нему определяется курьерская служба, '''login''' и '''pass''' позволяют авторизоваться под клиентом: для отдельного клиента Внутри контейнера itemlist все элементы могут ~~быть ограничения по доступности некоторых ПВЗ~~как отсутствовать, так и ~~в этом случае они будут учтены~~комбинироваться. Поиск не чувствителен к регистру.*'''~~code~~codesearch''' ~~- Внутренний код~~ — Поиск по кодам. В случае использования — контейнеры conditions и limit игнорируются.:*'''~~client_code~~code''' ~~- Код клиента курьерской службы~~ — Поиск по внутреннему коду системы.:*'''~~town~~article''' ~~- Город получателя~~ — Поиск по артикулу.:*'''~~parentcode~~barcode''' ~~- Фильтр~~ — Поиск по ~~родительскому элементу~~штрихкоду.*'''acceptcash''' - Фильтр по приему наличных YES/NO*'''~~acceptcard~~conditions''' ~~- Фильтр по приему банковских карт YES/NO~~ — Задает условия поиска. Все вложенные элементы одновременно накладывают условие «И».:*'''~~acceptfitting~~namecontains''' ~~- Фильтр по наличию примерки YES/NO~~ — Поиск товаров, название которых содержит указанный текст.:*'''~~maxweight~~namestarts''' ~~- Фильтр по максимальному весу~~ — Поиск товаров, название которых начинается с ~~которым работает ПВЗ~~указанного текста.:*'''~~acceptindividuals~~name''' ~~- Фильтр по доступности физическим лицам YES/NO~~ — Поиск товаров, название которых соответствует указанному тексту.:*'''ltquantity''' ~~- Широта левого верхнего угла~~* — Наличие на складе. Принимает значения EXISTING_ONLY — Только в наличии, NOT_EXISTING_ONLY — Только не в наличии, ALL — Все. ''~~'lg'~~Это поле может быть недоступным в некоторых установках.'' ~~- Долгота левого верхнего угла~~:*'''rtstore''' ~~- Широта правого нижнего угла~~ — Поиск товаров по определенному складу. *'''rgexcept''' ~~- Долгота правого нижнего угла~~ — Описание исключений для корректного определения количества зарезервированной номенклатуры.:*'''~~json~~code''' ~~- Признак вывода ответа в виде JSON YES/NO~~ — Код заказа.

* '''limit''' — Ограничивает вывод результата.

:* '''limitfrom''' — Задает номер записи результата, начиная с которой выдавать ответ.

:* '''limitcount''' — Задает количество записей результата, которые нужно вернуть.

'''Пример ответа ~~справочника пунктов самовывоза~~:'''

<?xml version="1.0" encoding="UTF-8" ?><~~pvzlist~~ itemlist count="23" totalcount="3" page="1" totalpages="1"> <~~pvz~~item> <code>~~126~~123456</code> <~~clientcode~~article>3FD343</~~clientcode~~article> <~~name~~barcode>~~Нижний Тагил~~2345625213125</~~name~~barcode> <~~parentcode~~name>6Sony KDL-55W905 ЖК-телевизор</~~parentcode~~name> <~~parentname~~retprice>~~Интеграция~~65000</~~parentname~~retprice> <~~town code="124267" regioncode="66" regionname="Свердловская область"~~purchprice>~~Нижний Тагил город~~50000</~~town~~purchprice> <~~address~~weight>~~622036, г. Нижний Тагил, ул~~5. ~~Циолковского, д. 17~~1</~~address~~weight> <~~phone~~length>~~+73435417709, +73435254989~~50</~~phone~~length> <~~comment~~width>~~Новый пункт доставки~~30</~~comment~~width> <~~worktime~~height>~~Вс 10:00-16:00, Сб 10:00-16:00, Пн-Пт 10:00-20:00~~40</~~worktime~~height> <~~traveldescription~~VATrate>~~Жилое 5-ти этажное здание, торцом к дороге, второе здание от перекрестка Пархоменко-Циолковского~~20</~~traveldescription~~VATrate> <~~maxweight~~CountInPallet>1030</~~maxweight~~CountInPallet> <~~acceptcash~~CountInBox>~~YES~~2</~~acceptcash~~CountInBox> <~~acceptcard~~HasSerials>~~YES~~1</~~acceptcard~~HasSerials> <~~acceptfitting~~CountryOfOrigin>~~YES~~Малайзия</~~acceptfitting~~CountryOfOrigin> (not yet supported) <~~acceptindividuals~~Message>~~YES~~Хороший телевизор</~~acceptindividuals~~Message> <~~latitude~~Message2>~~57.93457~~Снова хороший телевизор</~~latitude~~Message2> <~~longitude~~quantity>~~59.95131~~12</~~longitude~~quantity> <reserved>3</~~pvz~~reserved> <~~pvz~~item> ~~<code>245</code>~~ ... ~~<clientcode>NTG1~~</~~clientcode~~itemlist> ~~<name>На Красноармейской~~</~~name~~source> ~~<parentcode>6</parentcode>~~ ~~<parentname>Интеграция</parentname>~~'''Описание полей:''' ~~<town~~ * '''code~~="124267" regioncode="66" regionname="Свердловская область">Нижний Тагил город</town>~~ ~~<address>КРАСНОАРМЕЙСКАЯ~~''' — Внутренний идентификатор, дприсвоенный системой.~~79</address>~~ ~~<phone>+7~~* '''article''' — Артикул, назначенный клиентом (~~3435~~поставщиком)~~379~~.* '''barcode''' — Штрихкод производителя.* '''name''' — Наименование.* '''retprice''' — Розничная цена по-~~044</phone>~~умолчанию. При оформлении заказа цена используется та, которая указана в заказе.* '''purchprice''' — Закупочная цена.* '''weight''' — Масса в килограммах.* '''length''' — Длина в сантиметрах.* '''width''' — Ширина в сантиметрах.* '''height''' — Высота в сантиметрах.* '''VATrate''' — Ставка НДС, целое число процентов.* '''CountInPallet''' — Количество штук в паллете.* '''CountInBox''' — Количество штук в упаковке.* '''HasSerials''' — Требует учета серийных номеров. Принимает значения 1 — да, 0 — нет.* '''CountryOfOrigin''' — Наименование страны происхождения на русском языке.* '''Message''' — Комментарий. ~~<comment>Возможность примерки отсутствует</comment>~~* '''Message2''' — Дополнительный комментарий. ~~<worktime>Вс 10:00-16:00~~* '''quantity''' — Количество на складе. Товары, уже собранные в заказы в этом количестве не присутствуют, ~~Сб 10:00-16:00~~считаются покинувшими товарный склад. ''Это поле может быть недоступным в некоторых установках.''* '''reserved''' — Количество зарезервированного товара. Может превышать остаток на складе, ~~Пн-Пт 10~~если покупатели ждут следующей поставки. ''Это поле может быть недоступным в некоторых установках.'' == Движение номенклатуры =='''Пример запроса движения номенклатуры:~~00-20:00</worktime>~~''' <~~traveldescription>Напротив ТЦ Пирамида</traveldescription~~source lang="xml"> <~~maxweight>20</maxweight~~?xml version="1.0" encoding="UTF-8" ?> ~~<acceptcash>YES~~<~~/acceptcash~~itemmovements> <~~acceptcard~~auth extra="8" login="login" pass="pass">~~YES~~</~~acceptcard~~auth> <~~acceptfitting~~code>NO4259</~~acceptfitting~~code> <~~acceptindividuals~~datefrom>~~YES~~2020-10-01</~~acceptindividuals~~datefrom> <~~latitude~~dateto>~~57.93468</latitude>~~ ~~<longitude>60.55476</longitude>~~ 2020-10-02</~~pvz~~dateto></~~pvzlist~~itemmovements>

</source>

*'''code''' ~~- Код ПВЗ~~ — внутренний код товара в ~~системе~~справочнике номенклатуры. ~~Используется в запросе [[API#Оформление заказа|оформления заказов]]~~*'''~~clientcode~~datefrom''' ~~- Код ПВЗ используемый компанией-подрядчиком~~ — дата начала периода.*'''~~name~~dateto''' ~~- Наименование ПВЗ~~ — дата окончания периода.*'''parentcode''' - Код родительского элемента.*'''parentname''' - Наименование родительского элемента.*'''town''' - Населенный пункт с кодом из [[#Справочник городов|справочника городов]]Может быть указан или код, ~~а также с кодом и наименованием региона.~~*'''address''' - Адрес ПВЗ.*'''phone''' - Телефоны ПВЗ.*'''comment''' - Дополнительная информация.*'''worktime''' - Режим работы ПВЗ.*'''traveldescription''' - Описание местонахождения ПВЗ или ~~пути к нему.~~*'''maxweight''' - Максимальный веспериод, ~~с которым работает ПВЗ~~или код и период одновременно.*'''acceptcash''' - Признак приема наличных*'''acceptcard''' - Признак приема банковских карт*'''acceptfitting''' - Наличие примерки*'''latitude''' - Широта*'''longitude''' - Долгота

~~== Получение фискальных данных заказа ==~~

'''Пример ~~запроса получения фискальных данных~~ответа движения номенклатуры:'''

<?xml version="1.0" encoding="UTF-8"?><~~receiptdata>~~ ~~<auth extra="8" login="test" pass~~itemmovements count="~~testm~~16" /> <~~orders~~itemmovement> <code>151500<~~order orderno="123456"~~ /code> <date>2017-05-26<~~order orderno="890111C"~~ /date> <retprice>0</~~orders~~retprice> <quantity>1</~~receiptdata~~quantity> <delivered>0</delivered> <item> <code>4259</~~source~~code> ~~'''Пример ответа получения фискальных данных:'''~~ <~~source lang="xml"~~name> Настольная игра Дженга<~~?xml version="1.0" encoding="UTF-8"?~~/name> <~~receipts count="1"~~/item> <~~receipt~~status> <~~orderno~~code>~~123456~~5</~~orderno~~code> <~~fdDatetime~~name>Возврат от покупателя</name>~~2020-06-07 12:14:00~~ </~~fdDatetime~~status> <store> <~~fdValue~~code>~~123~~1</~~fdValue~~code> <~~fdNum~~name>~~456~~офис в Москве</~~fdNum~~name> <~~fnSn~~/store>~~789~~ <~~/fnSn~~order> <~~kktNum~~ordercode>~~100~~3374830</~~kktNum~~ordercode> <~~inn~~number>~~222~~123660-0</~~inn~~number> <~~ofdUrl~~date>~~gate.ofd.ru~~2017-05-24</~~ofdUrl~~date> <~~fullUrl~~orderno>~~https://check.ofd.ru/123~~14123</~~fullUrl~~orderno> <~~price~~barcode>~~12345~~0000000670</~~price~~barcode> <~~lines count="1"~~company> ТОВАР<~~line~~/company> <~~item~~address>~~1111764~~Кравченко ул., 1</~~item~~address> <~~name~~delivereddate>~~Сапоги~~2017-05-29</~~name~~delivereddate> <~~qty~~deliveredtime>112:00:00</~~qty~~deliveredtime> <~~price~~deliveredto />~~1000~~ </~~price~~order> <~~vatRate~~document>20 <code>21991</~~vatRate~~code> <~~governmentCode~~number>~~Z16513LK2~~318</~~governmentCode~~number> <~~itemType~~date>12017-05-26</~~itemType~~date> <message></~~line~~message> </~~lines~~document> </~~receipt~~itemmovements></~~receipts~~itemlist>

</source>

~~Параметры~~ ''' Описание полей ответа:'''*'''~~orderno~~code''' ~~- Номер заказа~~ — внутренний код операции движения*'''~~fdDatetime~~date''' ~~- Дата и время пробития фискального чека~~ — дата операции*'''~~fdValue~~retprice''' ~~- ФПД (фискальный признак документа)~~ — цена товара*'''~~fdNum~~quantity''' ~~- ФИСКАЛЬНЫЙ ДОКУМЕНТ (фискальный номер чека)~~ — количество товара операции*'''~~fnSn~~delivered''' ~~- ФН (номер фискального накопителя)~~ — количество доставленного товара *'''~~kktNum~~item''' ~~- РН (регистрационный номер кассы)~~ — контейнер товара:*'''~~inn~~code''' ~~- ИНН~~ — внутренний код товара:*'''~~ofdUrl~~name''' ~~- URL адрес (доменное имя) ОФД~~ — наименование товара *'''~~price~~status''' ~~- Сумма чека~~ — контейнер статуса операции:*'''~~fullUrl~~code''' ~~- URL чека для просмотра онлайн~~ — код статуса:*'''~~lines~~name''' ~~- Позиции чека~~ — наименование * '''store''' — контейнер филиала, к которому относится операция:*'''~~item~~code''' - — код ~~товара~~филиала:*'''name''' - — наименование ~~товара~~филиала * '''order''' — контейнер корреспонденции:* '''ordercode''' — внутренний код заказа:* '''number''' — номер заказа:* '''date''' — дата заказа:* '''orderno''' — шифр:* '''barcode''' — штрихкод:* '''company''' — компания:* '''address''' — адрес:*'''~~qty~~delivereddate''' ~~- количество товара~~ — дата вручения:*'''~~price~~deliveredtime''' ~~- цена товара~~ — время вручения:*'''~~governmentCode~~deliveredto''' ~~- считанная последовательность~~ — данные о вручении, ~~которая в дальнейшем преобразуется по алгоритму тега 1162~~либо причина недоставки * '''document''' — контейнер документа операции:*'''~~vatRate~~code''' ~~- НДС товара~~ — внутренний код документа:* '''number''' — номер документа:* '''extnumber''' — внешний номер документа:* '''date''' — дата документа:*'''~~itemType~~message''' ~~- тип товара (товар, доставка и т.д.)~~ — комментарий

== ~~Справочник Видов срочности~~ Получение справочника тарифов по городам ==

'''Пример запроса ~~Видов срочности:~~справочника тарифов по городам'''

<?xml version="1.0" encoding="UTF-8" ?><~~services~~tariffs> <auth extra="8"login="login" pass="pass" /> <townfrom>Москва</townfrom> <service>1</service> <mainonly>1</mainonly> </~~services~~tariffs>

</source>

* '''~~Пример ответа справочника Видов срочности:~~auth''' — атрибут '''extra'''обязателен, по нему определяется курьерская служба.~~<source lang="xml"><?xml version="1~~* '''townfrom''' — город-отправитель. Если не передан, то городом будет «Москва».~~0" encoding="UTF-8" ?><services count="2">~~ <* '''service>''' — режим доставки. Обязательный элемент. ~~<code>1</code>~~ ~~<name>Эконом</name>~~ ~~</service>~~ ~~<service>~~ ~~<code>2</code>~~ ~~<name>Срочно</name>~~ ~~</service></services></source~~* '''mainonly''' — необязательный элемент. Если передан, то в ответе будут данные только по городам из справочника '''Межгород''' >'''Зоны'''.

~~== Справочник дополнительных услуг ==~~

'''Пример ~~запроса дополнительных услуг:~~ответа справочника тарифов по городам'''<source lang="~~xml~~json">~~<?xml version=~~{ "townfrom": "0c5b2444-70a0-4932-980c-b4dc0d3f02b5", "service": 1, "tariffs": [ { "towntofias": "0c5b2444-70a0-4932-980c-b4dc0d3f02b5", "towntocode": 1, "towntoname": "Москва город", "townregion": "Город Москва", "distance": 0, "pricedistance": 0, "pricesnew": { "before": [ { "price": 100, "every": 0, "mass": 1. }, { "price": 150, "every": 0, "mass": 5 } ], "after": [ { "price": 0, "every": 1, "mass" ~~encoding=~~: 38.01 }, { "~~UTF-8~~price"?>: 15,~~<advprices>~~ "every": 1, ~~<auth extra=~~ "8mass" ~~login=~~: 51.01 } ] }, "~~login~~deliveryPeriodMin" ~~pass=~~: 1, "~~pass~~deliveryPeriodMax" />: 2 } ~~<visible>NO</visible>~~ ]~~</advprices>~~}

</source>

'''~~advprices~~Описание полей ответа ''' * '''townfrom''' — код ФИАС города-отправителя.* '''service''' — режим доставки.* '''tariffs''' — cписок тарифов по городу.:* '''townregion''' — регион города-получателя.:* '''towntofias''' — код ФИАС города- ~~Корневой контейнер~~получателя. ~~Обязательный элемент~~:* '''towntocode''' — внутренний код города-получателя. :*'''~~visible~~towntoname''' — наименование города- ~~Признак возврата~~ получателя.:* '''distance''' — дистанция в км до города от МКАД, если в запросе townfrom — Москва.:* '''~~только~~pricedistance''' ~~тех услуг~~ — сумма за километраж до города от МКАД, ~~что доступны для отображения~~ если в ~~ЛК YES~~запросе townfrom — Москва.:* '''pricesnew''' — ваши настройки тарифов из справочника '''Межгород''' > '''Тарифы по зонам'''.::* '''before/after''' — контейнеры ДО/NOОТ.:::* '''price''' — цена. ~~Необязательный~~ Если ответ идет по «before», то в цену также плюсуется сумма pricedistance:::* '''every''' — за каждые.:::* '''mass''' — масса.:* '''prices''' — устаревший элемент, не используется.:* '''deliveryPeriodMin''' — минимальный срок доставки.:* '''deliveryPeriodMax''' — максимальный срок доставки. ~~По-умолчанию NO~~

== Номенклатура приходной накладной =='''Пример ~~ответа справочника дополнительных услуг~~запроса номенклатуры приходной накладной:'''

<?xml version="1.0" encoding="UTF-8" ?>

<~~advprices~~itemdoc> <~~advprice~~auth extra="8" login="login" pass="pass"> ~~<code>1</code>~~ ~~<name>Этажей в доме</name>~~ ~~<type>int~~</~~type~~auth> ~~</advprice>~~ ~~<advprice>~~ <code>221991</code> ~~<name>Коэффициент надбавки</name>~~ ~~<type>float</type>~~ ~~</advprice>~~ ~~<advprice>~~ ~~<code>3</code>~~ ~~<name>Расписаться на упаковке</name>~~ ~~<type>bool</type>~~ ~~</advprice~~></~~advprices~~itemdoc>

</source>

~~Параметры:~~*'''code''' - — внутренний код ~~услуги~~*'''name''' - наименование услугидокумента приходной накладной (см. ~~Если поле "название в ЛК" в настройках услуги не пусто, то возвращает значение поля "название в ЛК".~~*'''hine''' - подсказка по доп услуге для пользователя*'''type''' - тип услугипредыдущий запрос). ~~Может иметь значения::*'''bool''' - для услуг вида "чекбокс", "Да":*'''float''' - для числа с плавающей точкой:*'''int''' - для целого числа~~

~~== Расчет стоимости доставки ==~~

'''Пример ~~запроса стоимости доставки~~ответа движения номенклатуры:'''

<?xml version="1.0" encoding="UTF-8" ?>

<~~calculator~~itemdoc> <~~auth extra="8" login="login" pass="pass"~~ code>21991</code> <~~calc~~ number>318</number> ~~pricetype="CLIENT"~~ <date>2017-05-26</date> ~~townfrom="Москва"~~ <message></message> ~~addressfrom="Ленинский проспект, 95"~~ <items> ~~zipcode="664000"~~ ~~townto="3800000300000"~~ ~~addressto="Ленина ул., 10"~~ ~~pvz="123"~~ ~~l="10"~~ ~~w="20"~~ ~~h="30"~~ ~~mass~~ <item code="~~3.7~~4259" ~~service~~quantity="1" ~~price~~barcode="~~1200~~200300" ~~inshprice~~article="~~1200~~123555">Настольная игра Дженга</item> ~~paytype="CASH"~~ </items></~~calculator~~itemdoc>

</source>

~~Параметры:~~*'''pricetype''' - тип требуемой цены. Возможные значения: "CLIENT" (по-умолчанию) - цена для клиента. "CUSTOMER" - цена для конечного получателя. (пока не поддерживается)*'''townfrom''' - Город отправления*'''addressfrom''' - Адрес отправления*'''zipcode''' - Почтовый индекс города назначения*'''townto''' - Город назначения*'''addressto''' - Адрес назначения*'''pvz''' - Код пункта самовывоза по справочнику*'''l''' - Длина в сантиметрах (не обязательный параметр)*'''w''' - Ширина в сантиметрах (не обязательный параметр)*'''h''' - Высота в сантиметрах (не обязательный параметр)*'''~~mass~~Описание полей ответа ''' ~~- Масса в килограммах~~*'''~~service~~code''' - Режим доставки - число, указывающее на запись в справочнике [[#Справочник Видов срочности|видов срочности]]. Если этот параметр опустить, система выдаст расчет для всех доступных видов срочности, передав много контейнеров <calc> в ответе. — внутренний код приходной накладной*'''~~price~~number''' ~~- Сумма наложенного платежа~~ — номер документа*'''~~inshprice~~date''' ~~- Сумма объявленной ценности~~ — дата документа*'''~~paytype~~message''' ~~- Тип оплаты~~ — комментарий

Суммы НП и ОЦ, а также тип оплаты CARD имеют значение при настроенных в тарифе на вкладке Прочее долях (в процентах) от данных сумм.* '''item''' — контейнер товара:* '''code''' — внутренний код товара:* '''barcode''' — штрихкод товара:* '''article''' — артикул товара:* '''quantity''' — количество поступившего товара

В авторизации можно опустить параметры login и pass, тогда расчет будет производиться по стандартному тарифу курьерской службы, без учета возможных отличий для конкретного клиента== Справочник филиалов =='''Пример запроса списка филиалов:'''<source lang="xml"><?xml version="1.0" encoding="UTF-8" ?><storelist> <auth extra="8"></auth> <brjson>YES</json> <client_code>7890</client_code>~~Объемный вес будет учитываться только при условии указания всех габаритов: длины, ширины и высоты.~~<br/storelist>В полях город-отправитель и город-получатель можно указывать название города (не рекомендуется!), либо код города из нашего справочника, либо 13-ти значный код КЛАДР, либо 36-ти значный код адресной системы ФИАС (AOID).</source>

* '''auth''' — Атрибут '''extra''' — обязателен, по нему определяется курьерская служба

* '''json''' — Признак вывода ответа в виде JSON YES/NO

* '''client_code''' — Код клиента курьерской службы

'''Пример ответа ~~стоимости доставки~~:'''

<?xml version="1.0" encoding="UTF-8"?><~~calculator~~storelist count="2"> <~~calc~~store> <~~townfrom~~ code~~="1"~~>~~Москва город~~123</~~townfrom>~~ ~~<townto~~ code~~="56603">Иркутск город</townto~~> <~~mass~~name>~~3.7~~ABC</~~mass>~~ ~~<service~~ name~~="Экспресс">1</service~~> ~~<zone>2~~ </~~zone~~store> ~~<price>1163~~ <~~/price~~store> <~~mindeliverydays~~code>1456</~~mindeliverydays~~code> <~~maxdeliverydays~~name>3Филиал 2</~~maxdeliverydays>~~ ~~<mindeliverydate>2020-05-13</mindeliverydate~~name> </~~calc~~store></~~calculator~~storelist>

</source>

~~Параметры:~~*'''townfrom''' - Город-отправитель так, как система его распознала и привязала к справочнику. Атрибут '''code''' - код из справочника городов системы.*~~'''townto''' - Город-получатель так, как система его распознала и привязала к справочнику. Атрибут~~ '''code''' ~~- код из справочника городов системы.~~*'''mass''' - Масса в килограммах*'''service''' - Режим доставки - число, указывающее на запись в справочнике видов срочности (см описание на этой странице).*'''zone''' - номер тарифной зоны, по которой рассчиталась стоимость. В зависимости от зоны выбирается тарифная сетка. Так же к цене могут применяться повышающие или понижающие коэффициенты при доставке не из/в региональный центр.*'''price''' - рассчитанная стоимость доставки в валюте прайс-листа курьерской службы. Рекомендуется к использованию в отличие от одноименного атрибута родительского контейнера.*'''maxdeliverydays''' - максимальный срок доставки в рабочих днях — Код филиала.*'''~~mindeliverydate~~name''' ~~- минимальная дата доставки в учетом выходных дней~~ — Наименование филиала.

== Справочник пунктов самовывоза ==Для отображения списка пунктов выдачи (ПВЗ) есть '''готовый JavaScript модуль''~~Обратите внимание~~': https://home.courierexe.ru/js/measoft_map.js Инструкция по использованию — внутри. Посмотреть пример работы можно [https:~~''''' В реальном ответе сервера в теге calc присутствует атрибут "price"~~//home. ~~Он оставлен для обратной совместимости, не используйте его~~courierexe. ~~Пользуйтесь вложенным тегом price~~ru/pvz_test.html Здесь]

~~== Получение информации о клиенте ==~~Уникальные запросы списка ПВЗ кешируются на стороне личного кабинета и хранятся до 7 часов утра по московскому времени следующего дня. Например, если уникальный запрос с массой 2 кг был отправлен сегодня в 10 часов, то завтра в 7 утра он сбросится. Если сегодня в 18 часов в этом же запросе вы укажете массу 2 кг, в ответе вернется тот же список ПВЗ. Если передадите массу 3 кг, список может быть другим.

Обратите внимание, что если в выборке количество ПВЗ больше '''10000''' и не указаны параметры '''code''', '''json''' или '''limitcount''', то будет возвращаться ошибка. В этом случае необходимо использовать блок '''limit'''. '''Пример запроса ~~получения информации о клиенте~~пунктов самовывоза:'''

<?xml version="1.0" encoding="UTF-8" ?>

<~~client~~pvzlist> <auth extra="8" login="~~test~~login" pass="~~testm~~pass"></auth> <code>1234</code> <client_code>7890</client_code> <city>Свердловская область</city> <town regioncode="66" country="RU">Нижний Тагил</town> <address>Щёлковское шоссе</address> <house>77</house> <parentcode>6</parentcode> <acceptcash>YES</acceptcash> <acceptcard>YES</acceptcard> <acceptfitting>YES</acceptfitting> <maxweight>30</maxweight> <acceptindividuals>YES</acceptindividuals> <lt>57.924737</lt> <lg>59.940019</lg> <rt>57.905682</rt> <rg>59.984669</rg> <json>YES</json> <with_coords>YES</with_coords> <limit> <limitfrom>30</limitfrom> <limitcount>2</limitcount> <countall>YES</countall> </limit> </~~client~~pvzlist>

</source>

* '''auth''' — Атрибут '''extra''' — обязателен, по нему определяется курьерская служба, '''login''' и '''pass''' позволяют авторизоваться под клиентом: для отдельного клиента могут быть ограничения по доступности некоторых ПВЗ, и в этом случае они будут учтены.* '''code''' — Внутренний код.* '''client_code''' — Код клиента курьерской службы.* '''city''' — Регион получателя. Можно указать код региона или полное наименование региона из [[#Справочник регионов|справочника регионов]].* '''town''' — Город получателя.Для тега города '''town''' можно указать код региона в атрибуте '''''regioncode'''''из [[#Справочник регионов|справочника регионов]]. Поиск будет производиться в указанном регионе. Также можно указать страну получателя в атрибуте '~~client~~''' 'country''''' в соответствии с [https://ru.wikipedia.org/wiki/ISO_3166-1 стандартом ISO_3166- ~~Корневой контейнер~~1], например, «RU», «RUS» или «643» для России. ~~Обязательный элемент~~Для формата запроса JSON фильтрация по городу работает только в связке с фильтром по адресу. * '''address''' — Фильтр по адресу, работает только в связке с фильтром по городу* '''house''' — Фильтр по номеру дома, работает только в связке с фильтрами по адресу и городу*'''~~auth~~parentcode''' — Фильтр по родительскому [[#Справочник филиалов|филиалу]]* '''acceptcash''' — Фильтр по приему наличных YES/NO* '''acceptcard''' — Фильтр по приему банковских карт YES/NO* '''acceptfitting''' — Фильтр по наличию примерки YES/NO* '''maxweight''' — Фильтр по максимальному весу, с которым работает ПВЗ* '''acceptindividuals''' — Фильтр по доступности физическим лицам YES/NO* '''lt''' — Широта левого верхнего угла* '''lg''' — Долгота левого верхнего угла* '''rt''' — Широта правого нижнего угла* '''rg''' — Долгота правого нижнего угла* '''json''' — Признак вывода ответа в виде JSON YES/NO* '''with_coords''' — Признак вывода ПВЗ только с наличием координат YES/NO* '''limit''' — Ограничивает вывод результата.:* '''limitfrom''' — Задает номер записи результата, начиная с которой выдавать ответ. По-умолчанию — 0.:* '''limitcount''' - ~~Авторизация~~Задает количество записей результата, которые нужно вернуть. По-умолчанию — 100.:* '''countall''' — YES указывает на необходимость подсчета общего количества найденных совпадений. Это может замедлять выполнение запроса. ~~Обязательный элемент~~Если отключено — в ответе не указываeтся totalcount.

~~'''Пример ответа на запрос получения информации о клиенте:'''~~

~~<source lang="xml">~~

~~<?xml version="1.0" encoding="UTF-8" ?>~~

~~<client>~~

~~<code>1082</code>~~

~~</client>~~

~~</source>~~

*'''code''' - Код клиента ~~== Список актов передачи денег ==~~ '''Пример ~~запроса списка актов передачи денег~~ответа справочника пунктов самовывоза:'''

<?xml version="1.0" encoding="UTF-8" ?>

<~~smalist~~pvzlist count="2" totalcount="40465"> <~~auth extra~~pvz> <code>126</code> <clientcode>3</clientcode> <name>Нижний Тагил</name> <parentcode>6</parentcode> <parentname>Интеграция</parentname> <town code="8124267" ~~login~~regioncode="~~login~~66" ~~pass~~regionname="~~pass~~Свердловская область" >Нижний Тагил город</town> <address>622036, г. Нижний Тагил, ул. Циолковского, д. 17</address> <phone>+73435417709, +73435254989</phone> <comment>Новый пункт доставки</comment> <~~datefrom~~worktime>~~2016~~Вс 10:00-16:00, Сб 10:00-0216:00, Пн-Пт 10:00-20:00</~~datefrom~~worktime> <~~dateto~~traveldescription>~~2016~~Жилое 5-03ти этажное здание, торцом к дороге, второе здание от перекрестка Пархоменко-Циолковского</traveldescription> <maxweight>10</~~dateto~~maxweight> <acceptcash>YES</~~smalist~~acceptcash> <acceptcard>YES</~~source~~acceptcard> <acceptfitting>YES</acceptfitting>~~'''smalist''' - Корневой контейнер. Обязательный элемент.~~ <acceptindividuals>YES</acceptindividuals>*'''auth''' - Авторизация. Обязательный элемент <latitude>57.93457</latitude>*'''datefrom''' - Дата "с". Необязательный элемент <longitude>59.*'''dateto''' - Дата "по". Необязательный элемент.~~Если интервал дат не указан, то возвращаются акты передачи денег за последний месяц.~~ ~~'''Пример ответа на запрос списка актов передачи денег:'''~~95131<~~source lang="xml"~~/longitude> <~~?xml version="1.0" encoding="UTF~~uid>40606d00-9c51-11eb-b2c9-~~8"?~~cfd6c1111392</uid> <~~smalist count="1"~~/pvz> <~~sma~~pvz> <code>~~6278~~245</code> <~~number~~clientcode>~~3992~~NTG1</~~number~~clientcode> <~~actdate~~name>~~2016-02-12~~На Красноармейской</~~actdate~~name> <~~datepay~~parentcode>6</~~datepay~~parentcode> <~~dateto~~parentname>~~2016-02-12~~Интеграция</~~dateto~~parentname> <~~promiseddatepay~~town code="124267" regioncode="66" regionname="Свердловская область">Нижний Тагил город</~~promiseddatepay~~town> <~~price~~address>~~637~~КРАСНОАРМЕЙСКАЯ, д.0079</~~price~~address> <~~pricecorr~~phone>~~113.00~~+7(3435)379-044</~~pricecorr~~phone> <~~rur~~comment>~~13430.00~~Возможность примерки отсутствует</~~rur~~comment> <~~pricekur~~worktime>~~570.~~Вс 10:00-16:00, Сб 10:00-16:00, Пн-Пт 10:00-20:00</~~pricekur~~worktime> <~~priceag~~traveldescription>~~67.00~~Напротив ТЦ Пирамида</~~priceag~~traveldescription> <~~payno~~maxweight>~~42423~~20</~~payno~~maxweight> <~~paytype~~acceptcash>1YES</~~paytype~~acceptcash> <~~paytypename~~acceptcard>~~Безнал~~YES</~~paytypename~~acceptcard> <~~signedcopyreceived~~acceptfitting>NO</~~signedcopyreceived~~acceptfitting> <acceptindividuals>YES</acceptindividuals> <latitude>57.93468</latitude> <longitude>60.55476</longitude> <uid>41116853-9c51-11eb-b2c9-cfd6c1451392</uid> </~~sma~~pvz></~~smalist~~pvzlist>

</source>

*'''code''' — Код ПВЗ в системе. Используется в запросе [[API#Оформление заказа|оформления заказов]]* '''clientcode''' — Код ПВЗ используемый компанией- подрядчиком.* '''name''' — Наименование ПВЗ.* '''parentcode''' — Код ~~акта~~родительского элемента.* '''parentname''' — Наименование родительского элемента.* '''town''' — Населенный пункт с кодом из [[#Справочник городов|справочника городов]], а также с кодом и наименованием региона.*'''~~number~~address''' ~~- Номер акта в системе~~ — Адрес ПВЗ.*'''~~actdate~~phone''' ~~- Дата акта~~ — Телефоны ПВЗ.*'''~~datepay~~comment''' ~~- Дата оплаты по акту~~ — Дополнительная информация.*'''~~dateto~~worktime''' ~~- Дата конечного периода для формирования АПД~~ — Режим работы ПВЗ.*'''~~promiseddatepay~~traveldescription''' ~~- Плановая дата оплаты~~ — Описание местонахождения ПВЗ или пути к нему.*'''~~price~~maxweight''' ~~- Стоимость услуг~~ — Максимальный вес, с которым работает ПВЗ.*'''~~pricecorr~~acceptcash''' ~~- Сумма корректировки~~ — Признак приема наличных*'''~~rur~~acceptcard''' ~~- Сумма заказа~~ — Признак приема банковских карт*'''~~pricekur~~acceptfitting''' ~~- Стоимость курьерской доставки~~ — Наличие примерки*'''~~priceag~~latitude''' ~~- Агентское вознаграждение~~ — Широта*'''~~payno~~longitude''' ~~- Номер платежного поручения~~ — Долгота*'''~~paytype~~uid''' ~~- Тип оплаты: 1 - безнал, 2 - наличными курьером, 3 - наличными~~ — Уникальный идентификатор ПВЗ в ~~офисе, 4 - перевод на карту~~системе Measoft*'''~~paytypename~~count''' ~~- Строковое представление типа оплаты~~ — Количество записей в ответе*'''~~signedcopyreceived~~totalcount''' ~~- Признак факта возврата акта YES/NO~~ — Общее количество записей, отвечающее параметрам запроса

== ~~Детализация актов передачи денег~~ Получение фискальных данных заказа =='''Пример запроса получения фискальных данных:'''<source lang="xml"><?xml version="1.0" encoding="UTF-8"?><receiptdata> <auth extra="8" login="login" pass="pass" /> <orders> <order orderno="123456" /> <order orderno="890111C" /> </orders></receiptdata> </source>

'''Пример ~~запроса детализации актов передачи денег~~ответа получения фискальных данных:'''

~~<?xml version="1.0" encoding="UTF-8" ?>~~

~~<smadetail>~~

~~<auth extra="8" login="login" pass="pass" />~~

~~<code>6278</code>~~

~~</smadetail>~~

~~</source>~~

~~'''smadetail''' - Корневой контейнер. Обязательный элемент.~~

*'''auth''' - Авторизация. Обязательный элемент.

*'''code''' - Код акта передачи денег (см. запрос списка АПД). Обязательный элемент.

~~'''Пример ответа на запрос детализации актов передачи денег:'''~~

~~<source lang="xml">~~

<?xml version="1.0" encoding="UTF-8"?>

<~~smadetail~~ receipts count="1"> <receipt> <orderno>123456</orderno> <fdDatetime>2020-06-07 12:14:00</fdDatetime> <fdValue>123</fdValue> <fdNum>456</fdNum> <fnSn>789</fnSn> <kktNum>100</kktNum> <inn>222</inn> <ofdUrl>gate.ofd.ru</ofdUrl> <fullUrl>https://check.ofd.ru/123</fullUrl> <price>12345</price> <lines count="1"> <line> <item>1111764</item> <name>Сапоги</name> <qty>1</qty> <price>1000</price> <vatRate>20</vatRate> <governmentCode>Z16513LK2</governmentCode> <itemType>1</itemType> </line> </lines> </receipt></receipts></source> Параметры ответа:* '''orderno''' — Номер заказа* '''fdDatetime''' — Дата и время пробития фискального чека* '''fdValue''' — ФПД (фискальный признак документа)* '''fdNum''' — ФИСКАЛЬНЫЙ ДОКУМЕНТ (фискальный номер чека)* '''fnSn''' — ФН (номер фискального накопителя)* '''kktNum''' — РН (регистрационный номер кассы)* '''inn''' — ИНН* '''ofdUrl''' — URL адрес (доменное имя) ОФД* '''price''' — Сумма чека* '''fullUrl''' — URL чека для просмотра онлайн* '''lines''' — Позиции чека:* '''item''' — код товара:* '''name''' — наименование товара:* '''qty''' — количество товара:* '''price''' — цена товара:* '''governmentCode''' — считанная последовательность, которая в дальнейшем преобразуется по алгоритму тега 1162:* '''vatRate''' — НДС товара:* '''itemType''' — тип товара (товар, доставка и т. д.) == Справочник Виды срочности =='''Пример запроса видов срочности:'''<source lang="xml"><?xml version="1.0" encoding="UTF-8" ?><services><auth extra="8"/></services></source> '''Пример ответа справочника видов срочности:'''<source lang="xml"><?xml version="1.0" encoding="UTF-8" ?><services count="2"> <~~specialsma~~service> <code>1</code> <name>Эконом</name> </service> <service> <code>2</code> <name>Срочно</name> </service></services></source> == Справочник дополнительных услуг =='''Пример запроса дополнительных услуг:'''<source lang="xml"><?xml version="1.0" encoding="UTF-8"?><advprices> <auth extra="8" login="login" pass="pass" /></advprices></source> '''advprices''' — Корневой контейнер. Обязательный элемент. '''Пример ответа справочника дополнительных услуг:'''<source lang="xml"><?xml version="1.0" encoding="UTF-8" ?><advprices> <advprice> <code>1</code> <name>Этажей в доме</name> <type>int</type> </advprice> <advprice> <code>2</code> <name>Коэффициент надбавки</name> <type>float</type> </advprice> <advprice> <code>3</code> <name>Расписаться на упаковке</name> <type>bool</type> </advprice></advprices></source> Параметры:* '''code''' — внутренний код услуги* '''name''' — наименование услуги. Если поле «название в ЛК» в настройках услуги не пусто, то возвращает значение поля «название в ЛК».* '''hine''' — подсказка по доп услуге для пользователя* '''type''' — тип услуги. Может иметь значения::* '''bool''' — для услуг вида «чекбокс», «Да»:* '''float''' — для числа с плавающей точкой:* '''int''' — для целого числа == Расчет стоимости доставки =='''Пример запроса стоимости доставки:'''<source lang="xml"><?xml version="1.0" encoding="UTF-8" ?><calculator> <auth extra="8" login="login" pass="pass" /> <order> <pricetype>CUSTOMER</pricetype> <sender> <town>Санкт-Петербург</town> <address>Петровка 38 офис 35</address> <coords lat="55.680327" lon="37.604456"></coords> </sender> <receiver> <zipcode>125480</zipcode> <town regioncode="78" country="RU">Санкт-Петербург</town> <address>Петровка 38 офис 35</address> <pvz>124</pvz> <coords lat="55.680327" lon="37.604456"></coords> </receiver> <weight>5.1</weight> <service>2</service> <paytype>CASH</paytype> <price>387.5</price> <deliveryprice>150</deliveryprice> <inshprice>387.5</inshprice> <packages> <package mass="1" quantity="5"></package> <package mass="2.5" length="10" width="20" height="30"></package> </packages> <userid>user123</userid> <groupid>customer</groupid> </order></calculator></source> Параметры:Структура данных и заполнение полей аналогичны и совместимы с [[#Оформление заказа]]. Дополнительные поля:* '''pricetype''' — тип требуемой цены. Возможные значения: «CUSTOMER» (по-умолчанию) — [[Личный кабинет клиента#Цена доставки для получателя|цена для конечного получателя]], «CLIENT» — цена курьерской службы для клиента.* '''userid''' — Идентификатор пользователя, строковый или числовой тип. Виртуальное поле. Необязательное. Данное поле используется совместно с настройками «Цена доставки для получателя», определяя приоритет правила. Можно использовать в различных CMS/CRM системах, настраивая цены для определенного покупателя.* '''groupid''' — Идентификатор группы пользователя, строковый или числовой тип. Виртуальное поле. Необязательное. Данное поле используется совместно с настройками «Цена доставки для получателя», определяя приоритет правила. Можно использовать в различных CMS/CRM системах, настраивая цены для определенной группы покупателей. Суммы НП и ОЦ, а также тип оплаты CARD имеют значение при настроенных в тарифе на вкладке Прочее долях (в процентах) от данных сумм. В авторизации можно опустить параметры login и pass, тогда расчет будет производиться по стандартному тарифу курьерской службы, без учета возможных отличий для конкретного клиента.<br>Объемный вес будет учитываться только при условии указания всех габаритов: длины, ширины и высоты.<br>В полях город-отправитель и город-получатель можно указывать название города (не рекомендуется!), либо код города из нашего справочника, либо 13-ти значный код КЛАДР, либо 36-ти значный код адресной системы ФИАС (AOID). '''Пример ответа стоимости доставки:'''<source lang="xml"><?xml version="1.0" encoding="UTF-8"?><calculator> <calc> <townfrom code="1">~~42494~~Москва город</townfrom> <townto code="56603">Иркутск город</townto> <mass>3.7</mass> <service name="Экспресс">1</service> <zone>2</zone> <~~ordercode~~price>~~14424~~1113</~~ordercode~~price> <~~orderno~~mindeliverydays>1</mindeliverydays> <maxdeliverydays>3</maxdeliverydays> <mindeliverydate>~~11111~~2020-05-13</~~orderno~~mindeliverydate> <~~orderdate~~intervals> <workdays> <interval>10:00-16:00</interval> <interval>~~2018~~16:00-0122:00</interval> </workdays> <holidays> <interval>12:00-16:00</interval> </holidays> </intervals> <deliveryprice> <advprice code="1" price="1000">База</advprice> <advprice code="4" price="100">Процент от суммы руб</advprice> <advprice code="5" price="63">Процент от объявленной стоимости</advprice> <advprice code="6" price="-0150">Скидка при доставке</~~orderdate~~advprice> <~~delivereddate~~/deliveryprice> </calc></calculator></source> Параметры:* '''townfrom''' — Город-отправитель так, как система его распознала и привязала к справочнику. Атрибут '''code''' — код из справочника городов системы.* '''townto''' — Город-получатель так, как система его распознала и привязала к справочнику. Атрибут '''code''' — код из справочника городов системы.* '''mass''' — Масса в килограммах* '''service''' — Режим доставки — число, указывающее на запись в справочнике видов срочности (см описание на этой странице).* '''zone''' — номер тарифной зоны, по которой рассчиталась стоимость. В зависимости от зоны выбирается тарифная сетка. Так же к цене могут применяться повышающие или понижающие коэффициенты при доставке не из/в региональный центр.* '''price''' — рассчитанная стоимость доставки в валюте прайс-листа курьерской службы. Рекомендуется к использованию в отличие от одноименного атрибута родительского контейнера.* '''maxdeliverydays''' — максимальный срок доставки в рабочих днях.* '''mindeliverydate''' — минимальная дата доставки в учетом выходных дней.* '''intervals''' — список интервалов доставки для соответствующей зоны и режима срочности.* '''deliveryprice''' — Данные по составляющим ценам доставки '''''Обратите внимание:''''' В реальном ответе сервера в теге calc присутствует атрибут «price». Он оставлен для обратной совместимости, не используйте его. Пользуйтесь вложенным тегом price. == Получение информации о клиенте =='''Пример запроса получения информации о клиенте:'''<source lang="xml">~~2018~~<?xml version="1.0" encoding="UTF-8" ?><client> <auth extra="8" login="login" pass="pass" /> </client></source> '''client''' — Корневой контейнер. Обязательный элемент.* '''auth''' — Авторизация. Обязательный элемент. '''Пример ответа на запрос получения информации о клиенте:'''<source lang="xml"><?xml version="1.0" encoding="UTF-8" ?><client> <code>1082</code></client></source> * '''code''' — Код клиента == Список актов передачи денег =='''Пример запроса списка актов передачи денег:'''<source lang="xml"><?xml version="1.0" encoding="UTF-8" ?><smalist> <auth extra="8" login="login" pass="pass" /> <datefrom>2016-02-10</datefrom> <dateto>2016-0103-10</dateto></smalist></~~delivereddate~~source> '''smalist''' — Корневой контейнер. Обязательный элемент.* '''auth''' — Авторизация. Обязательный элемент.* '''datefrom''' — Дата «с». Необязательный элемент.* '''dateto''' — Дата «по». Необязательный элемент.Если интервал дат не указан, то возвращаются акты передачи денег за последний месяц. '''Пример ответа на запрос списка актов передачи денег:'''<source lang="xml"><?xml version="1.0" encoding="UTF-8"?><smalist count="1"> <sma> <code>6278</code> <number>3992</number> <actdate>2016-02-12</actdate> <datepay></datepay> <dateto>2016-02-12</dateto> <~~company~~promiseddatepay>~~Компания~~</~~company~~promiseddatepay> <price>~~314~~637.00</price> <~~rur~~pricecorr>~~8800~~113.00</~~rur~~pricecorr> <~~inshprice~~rur>~~314~~13430.00</~~inshprice~~rur> <pricekur>~~270~~570.00</pricekur> <priceag>4467.00</priceag> <~~pricecalc~~payno>~~8486.00~~42423</~~pricecalc~~payno> <paytype>21</paytype> <paytypename>~~наличными курьером~~Безнал</paytypename> <~~status~~signedcopyreceived>NO</signedcopyreceived> </sma></smalist></source> * '''code''' — Код акта* '''number''' — Номер акта в системе* '''actdate''' — Дата акта* '''datepay''' — Дата оплаты по акту* '''dateto''' — Дата конечного периода для формирования АПД* '''promiseddatepay''' — Плановая дата оплаты* '''price''' — Стоимость услуг* '''pricecorr''' — Сумма корректировки* '''rur''' — Сумма заказа* '''pricekur''' — Стоимость курьерской доставки* '''priceag''' — Агентское вознаграждение* '''payno''' — Номер платежного поручения* '''paytype''' — Тип оплаты: 1 — безнал, 2 — наличными курьером, 3 — наличными в офисе, 4 — перевод на карту* '''paytypename''' — Строковое представление типа оплаты* '''signedcopyreceived''' — Признак факта возврата акта YES/NO == Детализация актов передачи денег =='''Пример запроса детализации актов передачи денег:'''<source lang="xml"><?xml version="1.0" encoding="UTF-8" ?><smadetail>~~Доставлено~~ <auth extra="8" login="login" pass="pass" /~~status~~> <code>6278</~~specialsma~~code>

</smadetail>

</source> '''smadetail''' — Корневой контейнер. Обязательный элемент.* '''auth''' — Авторизация. Обязательный элемент.*'''code''' — Код акта передачи денег (см. запрос списка АПД). Обязательный элемент. '''Пример ответа на запрос детализации актов передачи денег:'''<source lang="xml"><?xml version="1.0" encoding="UTF-8"?><smadetail count="2"> <specialsma> <code>42494</code> <ordercode>14424</ordercode> <orderno>11111</orderno> <orderdate>2018-01-01</orderdate> <delivereddate>2018-10- 01</delivereddate> <company>Компания</company> <price>314.00</price> <rur>8800.00</rur> <inshprice>314.00</inshprice> <pricekur>270.00</pricekur> <priceag>44.00</priceag> <pricecalc>8486.00</pricecalc> <paytype>2</paytype> <paytypename>наличными курьером</paytypename> <weight>0.400</weight> <distance>0.0</distance> <status>Доставлено</status> </specialsma></smadetail></source> * '''code''' — Код записи.*'''ordercode''' - — Код заказа.*'''orderno''' - — Шифр заказа.*'''orderdate''' - — Дата заказа.*'''delivereddate''' - — Дата доставки.*'''company''' - — Получатель.*'''price''' - — Стоимость услуг.*'''rur''' - — Сумма заказа.*'''inshprice''' - — Стоимость заказа.*'''pricekur''' - — Стоимость курьерской доставки.*'''priceag''' - — Агентское вознаграждение.*'''pricecalc''' - — Сумма для передачи агенту.*'''paytype''' - — Тип оплаты: ~~1 -~~ 1 — безнал, ~~2 -~~ 2 — наличными курьером, ~~3 -~~ 3 — наличными в офисе, ~~4 -~~ 4 — перевод на карту.*'''paytypename''' - — Строковое представление типа оплаты* '''weight''' — Вес заказа.* '''distance''' — Дистанция по заказу*'''status''' - — Статус заказа. == Генерация коротких ссылок == В некоторых случаях, например, при использовании в СМС, может потребоваться использование коротких ссылок на ЛК.Для этого, необходимо отправить запрос с полной ссылкой, в ответ на который придёт хэш-код для ссылки. '''Пример запроса генерации коротких ссылок:'''<source lang="xml"><?xml version="1.0" encoding="UTF-8" ?><shortlink> <link short="0"> https://home.courierexe.ru/8/site/orders </link></shortlink></source> '''shortlink''' - — Корневой контейнер. Обязательный элемент.*'''link''' - — Полная ссылка, для которой необходимо получить код. Обязательный элемент. Если атрибут '''short''' равен 1, то ответ не будет содержать XML, а только хэш-код. '''Пример ответа на запрос генерации коротких ссылок:'''<source lang="xml"><?xml version="1.0" encoding="UTF-8"?><shortlink> <hash>35AF350C</hash></shortlink></source> * '''hash''' — Хэш-код ссылки. Далее, можно использовать ссылку на ЛК: <nowiki>https://home.courierexe.ru/35AF350C или curie.ru/35AF350C</nowiki> '''Примечание!''' Сервис коротких ссылок работает только для ресурсов компании MeaSoft. == Проверка надежности покупателя ==Проверка надежности работает только для тарифа «Максимум» личного кабинета. <source lang="xml"><?xml version="1.0" encoding="UTF-8" ?><mcheck> <auth extra="8" login="login" pass="pass" /> <phones> <phone>89161147992</phone> </phones></mcheck></source> Ответ: <source lang="xml"><?xml version="1.0" encoding="UTF-8" ?><mcheck> <phones> <phone rate="90">89161147992</phone> </phones></mcheck></source> == Размещение страниц на своем сайте (iframe) == В некоторых случаях имеет смысл разметить те или иные страницы на своем сайте. Например, чтобы клиенты могли рассчитать стоимость доставки не переходя по внешней ссылке, а там же, на сайте, калькулятор можно разместить прямо на странице такого сайта посредством так называемого фрейма — '''iframe'''. [https://ya.ru/search/?text=iframe Фрейм] — контейнер внутри обычной страницы, который позволяет загружать сторонние страницы. Пример загрузки калькулятора: <source lang="html"><iframe id="frame" src="https://home.courierexe.ru/8/calculator"> Здесь должен отобразиться калькулятор</iframe></source> Для удобства пользователей вашего сайта можно указать язык интерфейса (который переключается непосредственно на сайте) параметром '''lang''': <source lang="html"><iframe id="frame" src="https://home.courierexe.ru/8/calculator?lang=2"> Здесь должен отобразиться калькулятор</iframe></source> Обратите внимание! Если язык не указать, то на страницах калькулятора и трекинга отображается свой переключатель языка. Если язык указан, то переключатель не отоборажается. Поддерживаемые языки и их коды::'''1''' — русский:'''2''' — английский:'''4''' — узбекский == Оформление манифеста == '''Пример запроса на создание манифеста:'''<source lang="xml"><?xml version="1.0" encoding="UTF-8" ?><manifest> <auth extra="8" login="login" pass="pass" /> <store_from>1</store_from> <store_to>2</store_to> <trn_code>3</trn_code> <addresses> <address> <code>456</code> </address> </addresses></manifest></source> '''manifest''' - Корневой контейнер. Обязательный элемент.*'''auth''' - Авторизация. Обязательный элемент.*'''store_from''' - код филиала отправителя. Обязательный элемент.*'''store_to''' - код филиала получателя. Обязательный элемент.*'''trn_code''' - код перевозчика. Обязательный элемент. '''Пример успешного ответа'''<source lang="xml"><?xml version="1.0" encoding="UTF-8"?><manifest> <result>OK</result></manifest></source> '''Пример ответа с ошибкой'''

<?xml version="1.0" encoding="UTF-8"?>

<~~shortlink~~manifest> <~~hash~~result error="Текст ошибки">~~35AF350C~~ERROR</~~hash~~result></~~shortlink~~manifest>

</source>

*'''~~hash~~manifest''' - ~~Хэш-код ссылки~~Корневой контейнер. Обязательный элемент. ~~Далее, можно использовать ссылку на ЛК:~~ ~~<nowiki>https://home.courierexe~~*'''result ''' - Результат.~~ru/35AF350C~~ Принимает значения OK или ~~curie~~ERROR.~~ru/35AF350C</nowiki>~~ *'''~~Примечание!~~error''' ~~Сервис коротких ссылок работает только для ресурсов компании MeaSoft~~- атрибут с текстом ошибки, если она была.

Бутусов

306

правок

Изменения

API

Навигация

Персональные инструменты

Пространства имён

Варианты

Просмотры

Ещё

Поиск

Навигация

Инструменты