Изменения

← Предыдущая правка

API

66 245 байт добавлено, во вторник в 05:03

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

<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: ~~black~~#ffffff; ~~boreder~~border: 1px solid #999999;" cellpadding="10" cellspacing="0"

!style="width: 35%;"|Система управления контентом (CMS)

!style="width: 15%;"|Ссылка

|-

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

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

|-

|-

|[[Файл:OpencartOCStore.png|center|~~x44px~~x60px]]|style="text-align: center;"|[~~http~~https://courierexe.ru/download/api/opencart.zip Скачатьдля версии 1.5.5.1]<br>[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>~~<br>[~~http~~https://courierexe.ru/download/api/~~measoft_ос3~~measoft_oc3.ocmod.zip Скачатьдля версии 3.0]|Поддерживает версии с 1.5.5.1.<br>~~Версия 2.0.0 поддерживает~~ Скачивайте модули для своей версии ~~с 2~~OpenCart.0<br>Подробнее см. [[~~https://opencartforum~~OpenCart|описание]].~~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|~~x44px~~x80px]]|style="text-align: center;"|Настраивается в [[~~http://www.insales.ru/collection/all/product/kurierskaya-sluzhba-2008 Установить~~Личный кабинет клиента|ЛК пользователя]]|[~~http://wiki.courierexe.ru/index.php?title=Интеграция_с_другими_системами#Insales Настраивается~~[Iiko|Инструкция по настройке]] ~~в ЛК пользователя в системе~~

|-

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

|style="text-align: center;"|[~~[Файл:Leadvertex-howto.png|center|x44px]]|[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|~~x44px~~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 Установить]

|~~Внимание! Модуль новый, поэтому возможна некорректная передача данных~~Подробнее см. [[amoCRM|описание]]. ~~Проверяйте, если что - сообщайте, исправим!~~

|-

|-

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

|-

|}

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

'''Обратите внимание!''' В модулях систем '''PrestaShop''', '''OpenCart''', '''OCStore''', '''Webasyst''', '''InSales''' и '''Joomla''' для отправки заказа в курьерскую службу необходимо зайти в карточку заказа, в которой должна отображаться форма (смДля отображения списка пунктов выдачи есть [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.

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

~~Данные модули распространяются бесплатно, без каких-либо гарантий со стороны разработчика~~Для упрощения интеграции можно скачать [https://courierexe. Их наличие не нужно рассматривать как средство полной автоматизации взаимодействия с курьерской службой, а скорее как помощь разработчикам интернет-магазинов в построении интеграции с курьерскими службамиru/download/api/php_sample. ~~В любом случае нужно понимать, что ответственность за корректность передачи данных лежит~~ zip пример обращения к сервису на интернет-магазине. Однако, мы будем очень признательны, если Вы будете нам сообщать о своих потребностях и/или найденных неточностях в наших модулях, это позволит нам учитывать пожелания в новых версияхPHP].

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

~~Для отладки Вы можете зайти в тестовый личный кабинет по адресу [https://home.courierexe.ru/~~<source lang=xml><auth extra="8 ~~https://home.courierexe.ru/8], логин: test пароль: testm. Там на закладке~~ "~~Автоматизация~~login=" ~~Вы сможете увидеть свои запросы~~ login"~~глазами~~pass=" ~~нашей системы. Так же там есть интерфейс для выполнения запросов. На закладке~~ pass"~~Отслеживание" Вы увидите созданные заказы.~~></auth></source>

~~Для упрощения интеграции можно скачать [http~~Описание параметров:~~//courierexe~~* '''extra''' — экстра-код, уникальный идентификатор компании, с которой вы интегрируетесь.~~ru/download/api/php_sample.zip пример обращения к сервису на PHP]~~* '''login''' — логин клиента;* '''pass''' — пароль клиента;* '''measoftid''' — системная переменная, используемая системой.

~~== Рабочий аккаунт для подключения ==~~Запросите эти данные у курьерской службы, к которой вы подключаетесь. Курьерская служба передает временный пароль, его нужно сменить после первого входа в [[Личный кабинет клиента|ЛК клиента]].

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

1. <source lang=xml><auth extra="8" login="login" pass="pass" clientcode="123"></auth></source> Описание:* '''~~Параметр~~ extra''' ~~(Цифровой код,~~ — уникальный идентификатор компании~~. Запросите этот параметр у компании, с которой Вы интегрируетесь). Посмотреть этот~~ ;* '''login''' — логин курьерской службы;* '''pass''' — пароль курьерской службы;* '''clientcode''' — внутренний код ~~можно в интерфейсе программы КС2008 через основное меню~~ клиента (вкладка '''~~"Справочники - Дополнительные возможности"~~Клиенты''', столбец «Внутренний код»). ~~Цифровое значение будет указано во второй гиперссылке (на скриншоте ниже отмечено "звездочкой"):~~

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

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

3Тестовые авторизационные данные: логин: login пароль: pass, параметр extra: 8. ~~'''Пароль''' - параметр учетной записи~~ Обратите внимание, что тестовая площадка для ~~ЛК клиента и API~~всех одна. Не нужно передавать в нее заказы с конфиденциальными данными, ~~указывается в карточке клиента на вкладке '''"Прочее"''' в поле '''"Пароль"''' (на скриншоте ниже)~~их смогут увидеть другие участники.

~~[[Файл:33_client~~Для использования интеграции в «боевом» режиме, запросите '''логин''', '''пароль''', и параметр '''extra''' у той компании, с которой интегрируетесь.~~png|500px]]~~

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

~~На стороне курьерской службы имеется веб-~~Клиент отправляет запросы к сервису методом 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"?>

<time_min>09:00</time_min>

<time_max>14:00</time_max>

</receiver>

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

~~<return_weight>5.1</return_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>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>

</deliveryset>

</advprice> <advprice>

</advprice> <advprice>

</advprice> </advprices> <overall_volume>81</overall_volume> <userid>user123</userid> <groupid>customer</groupid>

</order>

</neworder>

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

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

*Обязательными на уровне системы являются только 3 поля: receiver->company или receiver->person, receiver->address и receiver->phone. Так же в настройках системы сама курьерская служба может назначить какие-то дополнительные поля обязательными, тогда, если вы их не укажете, получите сообщение об ошибке.<spoiler text="Пример минимально возможного заказа"><source lang="xml"><?xml version="1.0" encoding="UTF-8"?><neworder> <auth extra="8" login="login" pass="pass" /> <order> <receiver> <company>МВД</company> <phone>(495)123-45-67</phone> <address>Петровка, 38</address> </receiver> </order></neworder></source></spoiler> '''~~neworder~~Описание полей''' ~~- Корневой контейнер, обязательный элемент.~~

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

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

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

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

* '''barcode''' — Штрихкод заказа. Если клиент штрихкодирует свои отправления и штрихкод отличается от номера заказа, в этом поле указывается штрихкод. Если ШК содержит кириллицу или малое количество символов, то формируется ШК в формате EAN13. <spoiler text="Заполнение номера заказа (шифра) и штрих-кода">Шифр и штрих-код заполняются исходя из начальных значений: # Если шифр и ШК пустые - оба поля заполняются автоматически значением вида XXX#YYY, а после ШК проверяется на корректность (валидируется)# Если ШК пустой, а шифр заполнен - ШК заполняется значением из шифра и валидируется# Если шифр пустой, а ШК заполнен - шифр заполняется значением из ШК, после чего ШК валидируется# Если оба непустые - валидируется ШК, шифр не проверяется Корректный (валидный) ШК отвечает следующим требованиям:* длина не меньше 5 символов* значение не меньше значения переменной <mparam code="MinPrePrintedNum"/>* содержит символы, которые можно использовать для формирования штрих-код а формате Code128 (т.е.все печатные символы, кроме кириллицы) Если ШК не прошел проверку, то:* если переменная <mparam code="StoreInvLength"/> равна 0, ШК заполняются автоматически значением вида XXX#YYY (или приравнивается шифру в том же формате)* если переменная <mparam code="StoreInvLength"/> больше 0, ШК заполняются автоматически сквозным номером (если шифр в формате XXX#YYY, то шифр приравнивается ШК)</spoiler> В случае наличия нескольких мест и раздельной их маркировки в этом поле допустимы маски в виде символов подчеркивания, говорящие о позициях штрихкода, переменных для разных мест в рамках одного заказа.<br>''Например'': В заказе номер 123 имеется 20 товарных вложений, которые упакованы в 3 транспортных места. Клиент формирует 3 штрихкода на транспортные места: CLNT0012301, CLNT0012302, CLNT0012303, где CLNT — префикс клиента, 00123 — номер заказа, 01-03 — номер транспортного места в заказе. В поле barcode нужно указать CLNT00123__ (система поймет, что 2 последних символа могут быть любыми и будут отражать штрихкоды к одному заказу). Если вы не сами печатаете накладные с указанным штрихкодом, то указанный штрихкод не должен быть длиннее 25 знаков, иначе он не поместится на стандартных печатных формах. *'''sender''' - — Информация о отправителе заказа. Необязательный контейнер.<source lang="xml">

<company>Название компании отправителя</company>

</source>

*'''receiver''' - — Информация о получателе заказа. Обязательный контейнер.

<time_min>Желаемое время доставки в формате "HH:MM"</time_min>

<time_max>Желаемое время доставки в формате "HH:MM"</time_max>

<deliveryPIN>Пин-код для подтверждения получателем</deliveryPIN>

</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~~packages''' ~~- Тип оплаты заказа получателем~~ — Контейнер для описания мест. Необязательный контейнер. ~~Принимает значения~~Атрибуты::* ~~CASH - Наличными при получении (по-умолчанию)~~'''''package''''' — Название места.:* '''''code''''' — Внутренний код строки.:* ~~CARD - Картой при получении~~'''''strbarcode''''' — Штрихкод места.:* ~~NO - Без оплаты~~'''''mass''''' — Масса места в килограммах. ~~Этот тип оплаты передается, если заказ уже оплачен и не требует инкассации~~:* '''''message''''' — Строка сообщения. ~~API добавит к товарам строку предоплаты~~ :* '''''length''''' — Длина товарного места (в ~~сумму заказа, чтобы общая сумма была 0, однако~~ сантиметрах).:* '''''width''''' — Ширина товарного места (в ~~кассовом чеке будут все товары с ценами, и оплата предоплатой, как того требует 54-ФЗ~~сантиметрах).:* ~~OTHER - Прочее~~ '''''height''''' — Высота товарного места (~~Предусмотрен для того, чтобы оплата поступала непосредственно~~ в курьерскую службу посредством прочих типов оплаты - таких как: вебмани, яденьги, картой на сайте, прочие платежные системы и т.дсантиметрах).):* ~~OPTION - На выбор получателя~~'''''quantity''''' — Количество мест с данным набором параметров. ~~Этот тип оплаты нельзя передавать с заказом~~Действует ограничение на общее количество мест в заказе. ~~Он выставляется автоматически~~ Общее количество мест в ~~зависимости от настройки клиента~~заказе не может быть больше 1000.

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

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

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

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

При передаче заказов, у которых плановая дата доставки/забора меньше ближайшей возможной, дата автоматически меняется на самую раннюю возможную. [[Личный кабинет курьерской службы#Как считается минимальная дата возможной доставки|Подробнее]]</div>

*'''costcode''' - Кост-код сотрудника.

В случае необходимости указания, помимо товаров, дополнительных услуг (например, ДОСТАВКА, комплектация, подъем на этаж ~~и т~~и т.д д.) - — их нужно указать в том же контейнере 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!Код ошибки!Английское описание!Русское описание|-|0 ||Success||Успешно|- ~~Ошибок нет.~~ |1 ~~- Ошибка авторизации. (отсутствуют теги <auth login="" pass=""></auth>, неверный логин или пароль)~~||Wrong XML||Некорректный файл XML.|-|2 ||Lat is empty||Укажите широту.|- ~~Отправлен пустой запрос (отсутствует контейнер <neworder></neworder> в XML документе)~~|3||Specify a valid «Price» field value.||Укажите корректное значение поля «Сумма». 3 |- ~~Некорректно указана сумма заказа.~~ |4 ~~- Некорректный общий вес заказа~~||Specify a valid «Weight» field value.||Укажите корректное значение поля «Вес».|-|5 ~~- Не~~ ||Recepient city/town not found.||Город назначения не найден ~~город получатель~~.|-|6 ~~- Не найден город отправитель~~||Sender city/town not found.||Город отправления не найден.|- |7 ~~- Не заполнен адрес получателя~~||Specify the «Recipient address» field value.||Укажите значение поля «Адрес получателя».|-|8 ~~- Не заполнен телефон получателя~~||Specify the «Recipient phone» field value.||Укажите значение поля «Телефон получателя».|-|9 ~~- Не заполнено контактное имя получателя~~||Specify the «Recipient name» field value.||Укажите значение поля «ФИО получателя».|-|10 ~~- Не заполнено название компании получателя~~||Specify a valid «Quantity» field value.||Укажите корректное значение поля «Количество».|-|11 ~~- Некорректная сумма объявленной ценности~~||Specify a valid «Declared value» field value.||Укажите корректное значение поля «Объявленная ценность».|- |12 - ||Supplier SKU ID not found.||Артикул не найден.|-~~13 - Не заполнено название компании отправителя~~|17||Order number already exists in the database.||Такой номер заказа уже есть в базе.|-~~14 - Не заполнено контактное имя отправителя~~|18||Order code already exists in the database.||Такой код заказа уже есть в базе.|-15 |19||The delivery date format is not valid. Specify a date in YYYY- ~~Не заполнен телефон отправителя.~~ 16 MM- ~~Не заполнен адрес отправителя~~DD format. 17 ||Укажите значение поля «Дата доставки» в формате гггг-мм- ~~Заказ с таким номером уже существует~~дд.|-~~== Запрос статуса заказов ==~~|20||Specify a valid «Delivery mode» field value.||Укажите корректное значение поля «Режим доставки».|-|21||Specify a valid «Return trip mode» field value.||Укажите корректное значение поля «Режим возврата».~~=== Пример запроса статуса заказа ===~~|-~~<source lang="xml">~~|22||Specify a valid «Delivery type» field value.||Укажите корректное значение поля «Тип доставки».~~<?xml version="1.0" encoding="UTF~~|-~~8" ?><statusreq>~~|23||Specify a valid «Return shipment type» field value.||Укажите корректное значение поля «Тип возврата». ~~<auth extra="8" login="login" pass="pass"></auth>~~|- ~~<client>CLIENT</client>~~|30||Specify the «Order number» field value.||Укажите значение поля «Номер заказа». ~~<orderno>1234</orderno>~~|- ~~<orderno2>5678</orderno2>~~|31||Specify the «Barcode» field value.||Укажите значение поля «Штрихкод». ~~<ordercode>34234</ordercode>~~|- ~~<givencode>234534</givencode>~~|32||Specify the «Sender company» field value.||Укажите значение поля «Компания-отправитель». ~~<datefrom>2016~~|-07|33||Specify the «Sender name» field value.||Укажите значение поля «ФИО отправителя».|-~~21</datefrom>~~ ~~<dateto>2016~~|34||Specify the «Sender phone» field value.||Укажите значение поля «Телефон отправителя».|-~~07-21<~~|35||Specify the «Sender city/~~dateto>~~town» field value.||Укажите значение поля «Город отправителя». ~~<target>Автозавод</target>~~|-|36||Specify the «Sender address» field value.||Укажите значение поля «Адрес отправителя». ~~<done>ONLY_NOT_DONE</done>~~|- ~~<changes>ONLY_LAST</changes>~~|37||Specify the «Pickup date» field value.||Укажите значение поля «Дата забора».~~</statusreq>~~|-~~</source>~~ ~~=== Описание полей запроса статуса ===~~|38||Specify the «Pickup time from» field value.||Укажите значение поля «Время забора с».|-~~'''statusreq''' - Корневой контейнер. Обязательный элемент~~|39||Specify the «Pickup time to» field value.||Укажите значение поля «Время забора до».*'''auth''' |- ~~Авторизация~~|40||Specify the «Recipient company» field value. ~~Обязательный элемент~~||Укажите значение поля «Компания-получатель».*'''client''' |- ~~Признак клиента или агента~~|41||Specify the «Recipient name» field value. ~~Необязательный элемент~~||Укажите значение поля «ФИО получателя».~~:* CLIENT~~ |- ~~Признак клиента,~~ |42||Specify the «Recipient phone» field value.||Укажите значение ~~по умолчанию~~поля «Телефон получателя».~~:* AGENT~~ |- ~~Признак агента~~|43||Specify the «Recipient city/town» field value.||Укажите значение поля «Город получателя». ~~В ответ отдается информация по заказам, переданным агенту на доставку~~*'''orderno''' - Номер заказа|-|44||Specify the «Recipient address» field value. ~~Необязательный элемент~~||Укажите значение поля «Адрес получателя».*'''ordercode''' |- ~~Внутренний код заказа. Необязательный элемент.~~*'''orderno2''' - Номер заказа из срочных|45||Specify the «Delivery date» field value. ~~Необязательный элемент~~||Укажите значение поля «Дата доставки».*'''datefrom''' |- ~~Дата заказа "с"~~|46||Specify the «Delivery time from» field value. ~~Необязательный элемент~~||Укажите значение поля «Время доставки с».*'''dateto''' |- ~~Дата заказа "по"~~|47||Specify the «Delivery time to» field value. ~~Необязательный элемент~~||Укажите значение поля «Время доставки до».*'''target''' |- ~~Строка поиска~~|48||Specify the «Recipient postcode» field value.||Укажите значение поля «Индекс получателя». ~~Позволяет указать текст, который содержится в названии компании или адресе получателя~~|-|49||Specify the «Weight» field value.||Укажите значение поля «Вес».*'''done''' |- ~~Может принимать значения:~~ :* ONLY_DONE - Только доставленные (имеются в виду успешные статусы, например, '''Доставлен''' или '''Частично доставлен''')|50||Specify the «Payment type» field value.||Укажите значение поля «Тип оплаты».|-|51||Specify the «Quantity» field value.||Укажите значение поля «Количество».~~:* ONLY_NOT_DONE~~ |- ~~Только не доставленные (заказы, которые не являются доставленными, например, '''Не доставлен''' или '''Утерян'''):* ONLY_NEW~~ |52||Specify the «Amount» field value.||Укажите значение поля «Сумма».|- ~~Только новые~~:* ONLY_DELIVERY - Только заказы в обработке - заказы, находящиеся в любом статусе, кроме конечных: Доставлено, Не доставлено, Отменён и т|53||Specify the «Declared value» field value.д||Укажите значение поля «Объявленная стоимость».~~:* ''Пусто'' - все корреспонденции~~|-|54||Specify the «Description» field value.||Укажите значение поля «Описание».*'''changes''' |- ~~может принимать~~ |55||Specify the «Instruction» field value.||Укажите значение ~~только ONLY_LAST~~поля «Поручение».|-|56||Specify the «Delivery mode» field value. ~~Если указан этот параметр, все остальные игнорируются~~||Укажите значение поля «Режим доставки». ~~Описание данного режима приведено здесь: [[#Передача только изменившихся статусов~~|~~Передача только изменившихся статусов]]~~-|57||Specify the «Shipment type» field value.||Укажите значение поля «Тип отправления».|-~~<div style="color: #a94442; background~~|58||Specify whether return trip is required.||Укажите значение поля «Необходимость возврата».|-~~color: #f2dede; border: 1px solid #ebccd1; padding: 3px 10px 10px;">'''Обратите внимание!'''~~|59||Specify the «Return trip mode» field value.||Укажите значение поля «Режим возврата»# Периода запроса статусов (контейнеры '''datefrom''' и '''dateto''') ограничивается двумя месяцами — два месяца до даты '''"по"'''.|-~~# Если не указаны обе даты — '''dateto''' принимается равной текущей дате~~|60||Specify the «Return shipment type» field value.||Укажите значение поля «Тип возврата».~~# Если не указана дата '''dateto''' — она принимается равной '''datefrom''' плюс 2 месяца~~|-|61||Specify barcode.||Укажите штрихкод.~~# Если не указана дата '''datefrom''' — она принимается равной '''dateto''' минус 2 месяца~~|-|62||Specify item weight.||Укажите массу единицы товара.~~</div>~~|-~~<br />~~|63||Specify item quantity.||Укажите количество товара.|-~~=== Примеры ответов ===~~ |64||Specify item price.||Укажите цену единицы товара.|-~~'''Пример успешного ответа'''~~|65||Specify item name.||Укажите название товара.|-|66||Wrong XLS file||Некорректный файл XLS.~~<source lang="xml">~~|-~~<?xml version="1~~|67||Order barcode already exists in the database.~~0" encoding="UTF~~||Такой штрихкод заказа уже есть в базе.|-~~8"?><statusreq count="23">~~|68||Select the «Payment by recipient» field value.||Укажите значение поля «Оплата получателем». ~~<order orderno="111111" awb="qwerty" orderno2="123123" ordercode="34534234" givencode="2345334">~~|- ~~<barcode>111111</barcode>~~|69||Specify department.||Укажите отдел. ~~<sender>~~|- ~~<company>МВД</company>~~ ~~<person>Иванов И~~|70||Specify service partner code.И||Укажите значение поля «Код подрядчика».~~</person>~~ ~~<phone>123-45~~|-~~67</phone>~~ ~~<contacts>~~|71||Date cannot be earlier than tomorrow.||Дата не может быть раньше чем завтра. ~~<phone>+74951234567</phone>~~|- ~~</contacts>~~|72||Date cannot be later than 15 days from now.||Дата не может быть позже чем через 15 дней. ~~<town code="23432">Санкт~~|-~~Петербург</town>~~ ~~<address>Петровка 38 офис 35</address>~~|73||Date cannot be earlier than today.||Дата не может быть раньше чем сегодня. ~~<date>2014-03~~|-~~22</date>~~ ~~<time_min>09:00</time_min>~~|74||Date cannot be later than {0} days from now.||Дата не может быть позже, чем через {0} дней. ~~<time_max>14:00</time_max>~~|- ~~</sender>~~|75||Specify a valid «Item weight» field value.||Укажите корректное значение поля «Масса единицы товара». ~~<receiver>~~|- ~~<company>МВД</company>~~|76||Specify a valid «Quantity» field value.||Укажите корректное значение поля «Количество товара».|- ~~<person>Иванов И~~|77||Specify a valid «Item price» field value.И||Укажите корректное значение поля «Цена единицы товара».~~</person>~~ ~~<phone>123~~|-~~45-67 - Иван (916)234~~|78||Specify a valid «Delivery time from» field value.~~45.21 Петр,mvd@mail~~||Укажите корректное значение поля «Время доставки с».~~ru</phone>~~ ~~<contacts>~~|- ~~<phone>+74951234567</phone>~~|79||Specify a valid «Delivery time to» field value.||Укажите корректное значение поля «Время доставки до». ~~<phone>+79162344521</phone>~~|- ~~<email>mvd@mail~~|80||Specify a valid «Pickup time from» field value.||Укажите корректное значение поля «Время забора с».~~ru</email>~~ ~~</contacts>~~|- ~~<inn>1112223335</inn>~~|81||Specify a valid «Pickup time to» field value.||Укажите корректное значение поля «Время забора до». ~~<zipcode>125480</zipcode>~~|- ~~<town code="153361" regioncode="78" regionname="Санкт~~|82||Specify a valid «Pickup point» field value.||Укажите корректное значение поля «ПВЗ».|-~~Петербург город">Санкт~~|83||Duplicate number in the registry.||Дублирование номера в реестре.|-~~Петербург город</town>~~ ~~<address>Петровка 38 офис 35</address>~~|84||Duplicate barcode in the registry.||Дублирование штрихкода в реестре. ~~<pvz>~~|- ~~<code>126</code>~~|85||Specify a valid «Weight at return trip» field value.||Укажите корректное значение поля «Вес возврата». ~~<clientcode>QWERTY</clientcode>~~|- ~~</pvz>~~|86||Specify the «Weight at return trip» field value.||Укажите значение поля «Вес возврата». ~~<date>2014~~|-~~03-22</~~|87||Order weight exceeds the allowed maximum for the pickup point.||Вес превышает допустимое значение для этого ПВЗ.|-|88||Pickup date>cannot be earlier than today.||Дата забора не может быть раньше чем сегодня. ~~<time_min>09:00</time_min>~~|- ~~<time_max>14:00</time_max>~~ ~~<coords lat="55~~|89||Specify a later delivery date.~~680327" lon="37~~||Укажите более позднюю дату доставки.~~604456"></coords>~~ ~~</receiver>~~|- ~~<weight>5~~|90||Inappropriate «Weight» or «Pay type» field value for the selected city or town. Please review and correct the values.||Значение поля «Масса» или «Тип оплаты» для выбранного города указано некорректно или отсутствует.~~1</weight>~~ ~~<return_weight>5~~Проверьте значения и исправьте.~~1</return_weight>~~ ~~<quantity>2</quantity>~~|-|91||{deliverytype} {deliverydate} is {holidaytype}. Select another date.||{deliverytype} {deliverydate} является {holidaytype}. Выберите другую дату. ~~<paytype>CASH</paytype>~~|- ~~<service>2</service>~~|92||{deliverytype} {deliverydate} is {holidaytype}. Select another date.||{deliverytype} {deliverydate} является {holidaytype}. Выберите другую дату. ~~<return_service>2</service>~~|- ~~<type>3</type>~~|93||Add items.||Добавьте товары. ~~<return_type>3</return_type>~~|- ~~<waittime>12</waittime>~~ ~~<price>387~~|95||The selected pickup point only allows paid orders.||Выбранный ПВЗ выдает только предоплаченные заказы.~~5</price>~~ ~~<print_check>YES</print_check>~~|- ~~<inshprice>387~~|96||Order barcode exceeds the allowed maximum (25) symbols.||Длина штрихкода заказа превышает максимально допустимую (25 символов).~~5</inshprice>~~ ~~<enclosure>Детские игрушки</enclosure>~~|- ~~<instruction>Проверить при покупателе, подписать акт</instruction>~~ ~~<currcoords lat="55~~|97||The pickup date format is not valid.~~680327" lon="37~~Specify a date in YYYY-MM-DD format.~~604456" accuracy="50" RequestDateTime="2014~~||Укажите значение поля «Дата забора» в формате гггг-04мм-~~21 18:07:45"></currcoords>~~дд. ~~<courier>~~|- <|98||Specify the cost code~~>26</code>~~.||Укажите значение поля «Кост-код». ~~<name>Иванов Владимир Петрович</name>~~|- ~~<phone>+79161234567</phone>~~ ~~</courier>~~|99||The item is not in stock.||Товар отсутствует на складе.|- ~~<deliveryprice total="158.6" delivery="~~|100||Set the quantity of the item marked with Chestny ZNAK to one.~~00" return="58~~||Укажите количество товара, маркированного кодом «Честный ЗНАК», равным единице.~~6">~~ ~~<advprice code="~~|-|101||Quantity of item Delivery cannot be greater than 1||Количество вложений типа «Доставка» не может быть более 1~~" price="150">База</advprice>~~. ~~<advprice code="2" price="0">% от объявленной стоимости</advprice>~~|- ~~<advprice code="3" price="8~~|102||А database error occurred. Please try later again.||Ошибка базы данных. Попробуйте позже.~~6">Топливный сбор</advprice>~~ ~~<advprice code="4" price="0">Округление</advprice>~~|- ~~</deliveryprice>~~|103||Order not found.||Заказ не найден. ~~<receiverpays>NO</receiverpays>~~|- <|104||Cannot edit order in the current status ~~eventstore="филиал~~ .||Невозможно изменить заказ в ~~Санкт-Петербурге" eventtime="2016~~текущем статусе.|-06|105||Discount cannot be greater than the order amount. Specify a smaller value.||Размер скидки не может превышать сумму заказа. Укажите меньшее значение скидки.|-~~02 17:22:00" createtimegmt="2016-06~~|106||Specify the correct additional service code.||Укажите корректный код дополнительной услуги.|-~~03 16:14:44" message="" title="Доставлен">COMPLETE</status>~~ ~~<statushistory>~~|107||Specify the correct additional service name.||Укажите корректное значение поля [advprice][value]. ~~<status eventstore="Офис в Москве" eventtime="2016~~|-~~05-30 10:20:00" createtimegmt="2016~~|108||Specify the «Additional services» field value.||Укажите значение поля «Дополнительные услуги».|-06|110||Specify the correct TIN.||Укажите корректный ИНН.|-~~03 16:14:44" message="" title="Новый">NEW</status>~~ ~~<status eventstore="Офис в Москве" eventtime="2016~~|111||Specify the correct IIN (KZ).||Укажите корректный ИИН (КЗ).|-~~06-01 17:38:00" createtimegmt="2016~~|112||Specify the overall volume.||Укажите общий объем.|-06|113||Cannot apply the delivery mode. Select another delivery mode.||Режим доставки не подходит для заказа. Выберите другой режим.|-~~03 16:14:44" message="филиал в Санкт~~|114||The pickup point does not support the selected delivery mode. Specify another pickup point.||ПВЗ не подходит для выбранного режима доставки. Укажите другой ПВЗ.|-~~Петербурге" title="Планируется отправка">DEPARTURING</status>~~ ~~<status eventstore="Офис в Москве" eventtime="2016~~|115||Specify a valid recipient phone number.||Укажите корректный телефон получателя.|-06|116||Specify recipient PIN code.||Укажите пин-~~01 19:53:00" createtimegmt="2016-06-03 16:14:44" message="филиал в Санкт~~код получателя.|-~~Петербурге" title="Отправлено со склада">DEPARTURE</status>~~ ~~<status eventstore="филиал в Санкт~~|117||Order date cannot be earlier than {0}. Specify another date.||Дата заказа не может быть раньше {0}. Укажите другую дату.|-~~Петербурге" eventtime="2016-06-02 07:41:00" createtimegmt="2016~~|118||Pickup date cannot be earlier than {0}. Specify another date.||Дата забора не может быть раньше {0}. Укажите другую дату.|-06|119||Specify the correct item type.||Укажите корректный тип вложения.|-~~03 16:14:44" message="" title="Получен складом">ACCEPTED</status>~~ ~~<status eventstore="филиал в Санкт~~|120||The pickup point does not accept payment by card.||В выбранном ПВЗ оплата картой не принимается.|-~~Петербурге" eventtime="2016~~|121||Invalid item code format||Неверный формат кода товарной номенклатуры|-06|122||Pickup time cannot be earlier than {0} hours.||Время забора не может быть раньше чем через {0} часа.|-~~02 09:17:00" createtimegmt="2016~~|123||Pickup interval cannot be less than {0} minutes.||Интервал времени забора не может быть менее {0} минут. Укажите корректный интервал.|-~~06-03 16:14:44~~|124||Specify a valid " ~~message=~~Payment type"~~" title="Выдан курьеру на доставку">DELIVERY</status>~~field value.||Укажите корректное значение поля «Тип оплаты». ~~<status eventstore="филиал в Санкт~~|-~~Петербурге" eventtime="2016~~|125||Recepient city/town by postcode not found.||Город получателя по его индексу не найден.|-06|126||Incorrect items prepayment and pickup.||Заказ не может содержать только вложения «Предоплата» и «Забор».|-~~02 17:22:00" createtimegmt="2016~~|127||Package limit exceeded||Превышен лимит количества мест|-06|128||Quantity of item Prepayment cannot be greater than 1||Количество вложений типа «Предоплата» не может быть больше 1.|-~~03 16:14:44" message="" title="Доставлен (предварительно)">COURIERDELIVERED</status>~~ ~~<status eventstore="филиал в Санкт~~|129||Sum of cod must be equal sum of items||Объявленная стоимость должна быть равна сумме вложений.|-~~Петербурге" eventtime="2016-06~~|130||Specify a valid respstore code.||Укажите код ответственного филиала.|-|131||Cannot edit, order has not been synchronized.||Невозможно изменить заказ пока он не синхронизирован.|-~~02 17:22:00~~|132||Specify a valid " ~~createtimegmt=~~Recipient city/town"~~2016~~field value.||Укажите город получателя|-~~06-03 16:14:44~~|133||Specify a valid " ~~message=~~weight"for the town.||Укажите корректный вес для города|-|134||Specify a valid " ~~title=~~paytype"~~Доставлен">COMPLETE<~~for the town.||Укажите тип оплаты для города|-|135||Specify the correct SKU ID/~~status>~~ <code for item.||Укажите артикул/~~statushistory>~~код вложения ~~<customstatecode>2<customstatecode>~~|- ~~<clientstatecode></clientstatecode>~~|136||Specify warehouse goods in the order.||Укажите вложения в заказе ~~<costcode>cc12345</costcode>~~|- ~~<receipt fdNum="124555" fnSn="9289000100295555" kktNum="0001611984048555" inn="7722756555" fdValue="2899551555" summ="387~~|137||The order's date of creation is more than 60 days ago.5||Заказ создан более 60 дней назад|-|138||Specify a valid " ~~ofdUrl=~~Package dimension"~~gate~~field value.~~ofd.ru">https://ofd.ru/rec/7722756555/0001611984048555/9289000100295555/124555/2899551555</receipt>~~ ~~<deliveredto>Иванова, секр.</deliveredto>~~ ~~<delivereddate>2016-06~~||Укажите корректные габариты места|-~~02</delivereddate>~~ ~~<deliveredtime>17:22</deliveredtime>~~|139||Wrong type of XML query||Ошибка запроса ~~<outstrbarcode>EXT123456</outstrbarcode>~~|- ~~<items>~~ <|140||Duplicate item codein the order.||Дублирование кода вложения в заказе|-|141||Duplicate additional service in the order.||Дублирование кода дополнительной услуги в заказе|-|} =~~"34533" extcode="abc123" quantity~~=~~"1" mass~~=~~"0.2" retprice="37.5" VATrate~~Передача значений полей в форме создания заказа в Личном Кабинете через GET параметры =~~"0" barcode~~=~~"2345625213125" article~~=~~"1" returns~~Если вам требуется передавать значения полей в форме создания заказа в Личном Кабинете через GET параметры, то вы можете подробно ознакомиться с этим на данной странице - [[Личный_кабинет_клиента#Передача и подстановка значений полей формы создания заказа через GET параметры]] ==~~"0" origincountry~~Запрос статуса заказов =~~"040" GTD~~=~~"" excise~~ =~~"0.00" governmentCode~~=~~"11223311" suppcompany~~=~~"Поставщик" suppINN~~Пример запроса статуса заказа ===~~"1112223334" suppphone~~<source lang="~~79161234567~~xml"~~>Мяч</item~~> <~~item code~~?xml version="~~34456~~1.0" ~~extcode~~encoding="~~abc124" quantity=~~UTF-8"~~2" mass~~?><statusreq> <auth extra="28" ~~retprice~~login="~~100~~login" ~~VATrate="10" barcode="4645625213138" article="2" returns="0" governmentCode~~pass="pass">~~Обруч~~</~~item~~auth> <client>CLIENT</client> <orderno>1234<~~item code="34421" extcode="abc125" quantity="3" mass="0.3" retprice="50" VATrate="18" barcode="2345625213126" article="3" returns="0" governmentCode="">Погремушка желтая~~/orderno> <orderno2>5678</orderno2> <ordercode>34234</~~item~~ordercode> <givencode>234534</~~items~~givencode> <~~packages>~~ ~~<package code="33331" strbarcode="ORD0000001" mass="1" message="" got="YES"~~uid>af11c7c6-6645-4a20-9604-be911a75722d</~~package~~uid> <~~package code="33332" strbarcode="ORD0000002" mass="2.5" message="" got="NO">~~datefrom>2016-07-21</~~package~~datefrom> <~~/packages~~dateto> 2016-07-21</~~order~~dateto> <target>Автозавод</target> <done>ONLY_NOT_DONE</~~statusreq~~done> <changes>ONLY_LAST</~~source~~changes> <conditions> <namecontains/> <namestarts/> </conditions></statusreq></source> === Описание полей запроса статуса ==='''statusreq''' — Корневой контейнер. Обязательный элемент.* '''auth''' — Авторизация. Обязательный элемент.* '''client''' — Признак клиента или агента. Необязательный элемент.:* CLIENT — Признак клиента, значение по умолчанию:* AGENT — Признак агента. В ответ отдается информация по заказам, переданным агенту на доставку* '''orderno''' — Идентификатор заказа у клиента (шифр). Необязательный элемент.* '''ordercode''' — Внутренний код заказа. Необязательный элемент.* '''orderno2''' — Номер заказа из срочных. Необязательный элемент. * '''uid''' — Уникальный идентификатор, если он был добавлен при создании заказа. Необязательный элемент. Запрос информации по uid возможен в течении суток после создания заказа* '''datefrom''' — Дата заказа «с». Необязательный элемент.* '''dateto''' — Дата заказа «по». Необязательный элемент.* '''target''' — Строка поиска. Позволяет указать текст, который содержится в названии компании или адресе получателя.* '''done''' — Может принимать значения::* ONLY_DONE — Только доставленные (имеются в виду успешные статусы, например, '''Доставлен''' или '''Частично доставлен'''):* ONLY_NOT_DONE — Только не доставленные (заказы, которые не являются доставленными, например, '''Не доставлен''' или '''Утерян'''):* ONLY_NEW — Только новые:* ONLY_DELIVERY — Только заказы в обработке — заказы, находящиеся в любом статусе, кроме конечных: Доставлено, Не доставлено, Отменён и т. д.:* ''Пусто'' — все корреспонденции * '''changes''' — может принимать значение только ONLY_LAST. Если указан этот параметр, все остальные игнорируются. Описание данного режима приведено здесь: [[#Передача только изменившихся статусов|Передача только изменившихся статусов]]

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

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

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

~~<statusreq count="0">~~

~~</statusreq>~~

~~</source>~~

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

<~~source lang~~div style="~~xml~~color: #a94442; background-color: #f2dede; border: 1px solid #ebccd1; padding: 3px 10px 10px;">~~<?xml version="1~~'''Обратите внимание!'''# Периода запроса статусов (контейнеры '''datefrom''' и '''dateto''') ограничивается двумя месяцами — два месяца до даты '''«по»'''.# Если не указаны обе даты — '''dateto''' принимается равной текущей дате.# Если не указана дата '''dateto''' — она принимается равной '''datefrom''' плюс 2 месяца.~~0" encoding="utf-8"?><request>~~# Если не указана дата '''datefrom''' — она принимается равной '''dateto''' минус 2 месяца.~~<error error="1" errormsg="authorization error"></error>~~# Поиск по '''conditions''' работает только для «Номер заказа(шифр)» и только от 4 символов</~~request~~div><~~/source~~br>

=== Примеры ответов ==='''Пример успешного ответа ~~при ошибке синтаксиса~~'''

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

<~~request~~statusreq count="23"> <order orderno="111111" awb="qwerty" orderno2="123123" ordercode="34534234" givencode="2345334"> <barcode>111111</barcode> <~~error~~sender>~~column:1 line:11 message:expected '~~ <company>'МВД</~~error~~company> <person>Иванов И.И.</~~request~~person> <phone>123-45-67</~~source~~phone> <contacts> <phone>+74951234567</phone> </contacts> <town code=~~== Описание полей ответа статусов ===~~"23432">Санкт-Петербург</town>~~Все поля ответа соответствуют структуре order при создании заказа, с некоторыми добавлениями:~~ <address>Петровка 38 офис 35</address> <date>2014-03-22</date>* Атрибуты контейнера '''order''' <time_min>09:00</time_min> <time_max>14:* '''''awb''''' - Номер накладной в системе курьерской службы00</time_max> </sender> <receiver> <company>МВД</company> <person>Иванов И.И.</person>~~:* '''''orderno2'''''~~ <phone>123-45-67 - ~~Номер накладной в подсистеме срочной доставки курьерской службы~~Иван (916)234.45.~~:* '''''ordercode''''' - внутренний код заказа в системе~~21 Петр, ~~применяется для некоторых внутренних операций~~mvd@mail.ru</phone> <contacts> <phone>+74951234567</phone> <phone>+79162344521</phone>~~:* '''''givencode''''' - внутренний код заказа в системе, применяется для некоторых внутренних операций~~ <email>mvd@mail.ru</email> </contacts> <inn>1112223335</inn> <zipcode>125480</zipcode>* атрибут ''''' <town code~~''''' контейнера '''item'''~~ ="153361" regioncode="78" regionname="Санкт-Петербург город">Санкт- ~~внутренний код строки заказа в системе, применяется для некоторых внутренних операций.~~Петербург город</town> <address>Петровка 38 офис 35</address> <area>Район 1</area> <pvz> <code>126</code>:* '''''returns''''' - количество данного товара, от которого отказался получатель. Не нулевое только в случае частичного отказа. <clientcode>QWERTY</clientcode> </pvz>* атрибут '''''got''''' контейнера '''package''' <date>2014-03- ~~признак принятого места YES~~ 22</date> <time_min>09:00</ ~~NO.~~time_min> <time_max>14:* '''''returns''''' - количество данного товара, от которого отказался получатель00</time_max> <coords lat="55. ~~Не нулевое только в случае частичного отказа~~680327" lon="37.604456"></coords> <deliveryPIN>1234</deliveryPIN>* '''''coords''''' в контейнере ''' </receiver~~''' - координаты получателя~~> <price>387.5</price> <inshprice>387.5</inshprice>* '''currcoords''' - текущие координаты заказа <paytype code="1">CASH</paytype> <weight>5. ~~Атрибуты:~~1</weight> <quantity>2</quantity> <service>2</service> <type>3</type> <return>NO</return> <return_service>2</service>~~:* '''''lat''''' - широта~~ <return_type>3</return_type>~~:* '''''lon''''' - долгота~~ <return_weight>5.1</return_weight>~~:* '''''accuracy''''' - точность~~ <return_message>Доставлено в ~~метрах~~целости</return_message>~~:* '''''RequestDateTime''''' - дата~~ <pickup>NO</pickup> <print_check>YES</print_check> <waittime>12</~~время последнего обновления координат.~~waittime> <enclosure>Детские игрушки</enclosure>* '''courier''' - Данные курьера <instruction>Проверить при покупателе, ~~которому выдан заказ~~подписать акт</instruction> <currcoords lat="55. ~~Если заказ не выдан, то выводятся данные запланированного курьера~~680327" lon="37.* '''waittime ''' 604456" accuracy="50" RequestDateTime="2014- ~~Время ожидания курьера.~~* '''deliveryprice''' 04- ~~Стоимость услуг в валюте расчетов с клиентом. Атрибуты~~21 18:07:45"></currcoords> <courier> <code>26</code> <name>Иванов Владимир Петрович</name>~~:* '''''~~ <phone>+79161234567</phone> </courier> <deliveryprice total~~''''' - общая стоимость услуг:* '''''~~="158.6" delivery~~''''' - стоимость доставки~~ ="~~Туда~~100.00"~~:* '''''~~return~~''''' - стоимость доставки~~ ="~~Обратно~~58.6" ~~(если order-~~>~~return~~ <advprice code="1" price=~~YES)~~"150">База</advprice>~~Тэг '''deliveryprice''' включает список дополнительных услуг (только для тарифа~~ <advprice code="~~Премиум~~2"):price="0">% от объявленной стоимости</advprice>~~:* '''''~~ <advprice code="3" price="8.6">Топливный сбор</advprice~~''''' - наименование дополнительной услуги~~>~~:* '''''~~ <advprice code~~''''' - код дополнительной услуги~~="4" price="0">Округление</advprice> </deliveryprice>~~:* '''''price''''' - стоимость дополнительной услуги~~ <receiverpays>NO</receiverpays> <acceptpartially>NO</acceptpartially>* ''' <status~~'''~~ eventstore="филиал в Санкт- ~~статус доставки (список статусов см. ниже). Атрибуты (заполняются начиная с версии системы 2008.0.0.670)~~Петербурге" eventtime="2016-06-02 17:22:* '''''eventstore''''' 00" createtimegmt="2016-06- ~~филиал, к которому относится текущий статус~~03 16:* '''''eventtime''''' - время события по часовому поясу места его наступления.14:* '''''createtimegmt''''' 44" message="" title="Доставлен" eventtown="Санкт- время по GMT создания записи о смене статуса в БД. Используется для сортировки записей, чтобы соблюсти хронологическую последовательность. <spoiler textПетербург город" color="~~Подробнее~~16777215">~~Большинство событий фиксируются~~ COMPLETE</status> <statushistory> <status eventstore="Офис в ~~полях~~ Москве" eventtime и createtimegmt на основании одного действия, тогда они отличаются только сдвигом от GMT. Однако, если курьер доставил отправление ="2016-05-30 10~~.10.2010 в 20~~:00, по какой-то причине не внес это в мобильное приложение, на следующий день сдал накладную, и в 9 утра оператор внесла, что он доставил вчера в 20:00~~. Тогда в~~ " createtimegmt ~~будет сегодня 6 утра (для Москвы), а в eventtime~~ ="2016- вчера в 20:00. При этом оператор по каким-то причинам может внести время вручения раньше, чем какое-то предыдущее событие, т.о. нарушится последовательность времени в eventtime, но при сортировке по createtimegmt все06-~~равно все будет правильно.</spoiler>~~03 16:* '''''message''''' - наименование филиала-получателя, при передаче между филиалами14:* '''''title''''' - русское наименование статуса44" * '''statushistory''' - история статусов доставки. Содержит список контейнеров '''status'''. Заполняется только для тарифа message="~~Премиум~~" ~~начиная с версии системы 2008.0.0.670.~~* '''customstatecode''' - код внутреннего статуса курьерской службы. Значения уточняйте в курьерской службе. Назначаются курьерской службой в разделе title="~~Справочники~~Новый" - eventtown="~~Статусы~~Москва город" - country="~~15 Статусы корреспонденции~~RU". Справочник не передается через API клиенту по причине возможного наличия в нем внутренних технологических статусов курьерской службы.* '''clientstatecode''' - код статуса клиента. Используется, если клиент предлагает свои коды статусов доставки>NEW</~~причин недоставки.~~status>* '''deliveredto''' <status eventstore="Офис в Москве" eventtime="2016- ~~данные о вручении, либо причина недоставки.~~* '''delivereddate''' - дата вручения.* '''deliveredtime''' - время вручения. В случае недоставки может быть пустым.* '''outstrbarcode''' 06- ~~код у подрядчика (код заказа во внешней системе). Используется в интеграциях с внешними системами.~~ ~~Значения контейнеров '''status''' могут принимать следующие значения~~01 17:38: ~~AWAITING_SYNC~~ 00" createtimegmt="2016- ~~Ожидает синхронизации. Данные заказа пока не появились в бэкофисе: NEW~~ 06- ~~Новый~~03 16: ~~PICKUP - Забран у отправителя~~14: ~~ACCEPTED - Получен складом~~44"~~: INVENTORY - Инвентаризация: DEPARTURING~~ message="филиал в Санкт- Петербурге" title="Планируется отправка" eventtown="Москва город" country="RU">DEPARTURING</status>~~: DEPARTURE~~ <status eventstore="Офис в Москве" eventtime="2016-06- ~~Отправлено со склада~~01 19: ~~DELIVERY - Выдан курьеру на доставку~~53: ~~COURIERDELIVERED~~ 00" createtimegmt="2016- ~~Доставлен (предварительно): COMPLETE~~ 06- ~~Доставлен~~03 16: ~~PARTIALLY - Доставлен частично~~14: COURIERRETURN - Возвращено курьером. Курьер не смог доставить до получателя, и вернул заказ обратно на склад. Это промежуточный статус, после которого менеджер выясняет, нужно ли пытаться заново доставить заказ, или это окончательная недоставка.44"~~: CANCELED~~ message="филиал в Санкт- ~~Не доставлен (Возврат~~Петербурге" title="Отправлено со склада" eventtown="Москва город" country="RU">DEPARTURE</~~Отмена)~~status>~~: RETURNING~~ <status eventstore="филиал в Санкт-Петербурге" eventtime="2016- ~~Планируется возврат: RETURNED~~ 06- ~~Возвращен~~02 07: ~~WMSASSEMBLED - Скомплектован на складе~~41: ~~WMSDISASSEMBLED~~ 00" createtimegmt="2016- ~~Разукомплектован: CONFIRM~~ 06- ~~Согласована доставка~~03 16: ~~DATECHANGE - Перенос~~14: ~~NEWPICKUP - Создан забор~~44"~~: UNCONFIRM~~ message="" title="Получен складом" eventtown="Санкт- ~~Не удалось согласовать доставку~~Петербург город" country="RU">ACCEPTED</status>~~: PICKUPREADY~~ <status eventstore="филиал в Санкт- ~~Готов к выдаче: LOST~~ Петербурге" eventtime="2016- ~~Утрачен/утерян: COURIERPARTIALLY~~ 06- ~~Частично со слов курьера~~02 09: ~~COURIERCANCELED - Отказ со слов курьера~~ ~~''Примечание~~17:~~'' В будущем возможно расширение и изменение используемого набора статусов.~~ ~~<div style~~00" createtimegmt="~~color: #a94442; background~~2016-06-~~color: #f2dede; border~~03 16: ~~1px solid #ebccd1; padding~~14: ~~3px 10px 10px;~~44">~~'''Обратите внимание!'''~~ ~~# Атрибуты контейнера '''status''' заполняются для версий системы '''2008.0.0.670''' и новее.# Контейнер '''statushistory''' заполняется для тарифа~~ message="" title="Выдан курьеру на доставку" eventtown="~~[[Личный_кабинет#.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''' заполняется для тарифа~~ country="~~[[Личный_кабинет#.D0.9F.D0.BE.D0.B4.D0.BA.D0.BB.D1.8E.D1.87.D0.B5.D0.BD.D0.B8.D0.B5|Премиум]]~~RU".>DELIVERY</~~div~~status> <~~br />~~ status eventstore="филиал в Санкт-Петербурге" eventtime="2016-06-02 17:22:00" createtimegmt= ~~Передача только изменившихся статусов~~ "2016-06-03 16:14:44" message===~~В нашем API предусмотрено очень удобное средство получения статусов всех заказов, без необходимости~~ "~~бомбить~~" сервер запросами статусов по каждому заказу. Работает это так: раз в какое-то время, например, в 10 минут, вы посылаете запрос title="~~А покажите все изменившиеся статусы". Пример запроса ниже. Система вам отдает ВСЕ заказы, статусы~~ Доставлен (~~или некоторые другие поля, см ниже~~предварительно) которых изменились с момента последнего запроса. Вы разбираете полученный документ, по каждому заказу сохраняете его актуальный статус в своей системе, и если все хорошо, у вас все получилось, ваша система неожиданно не упала от наплыва информации, посылаете нам запрос подтверждения получения статусов (commitlaststatus). Мы у себя отмечаем, что эти статусы вами получены, и их не надо передавать повторно. Т.о. сколько бы заказов у вас не было, статусы по ним всем почти в реальном времени вы можете получать всего 2" eventtown="Санкт-~~мя запросами.~~ ~~Для получения только изменившихся статусов отправьте запрос<source lang~~Петербург город" country="~~xml~~RU">COURIERDELIVERED</status> <~~?xml version~~status eventstore="~~1.0~~филиал в Санкт-Петербурге" eventtime="2016-06-02 17:22:00" ~~encoding~~createtimegmt="~~UTF~~2016-06-803 16:14:44" ?>~~<statusreq>~~ ~~<auth extra~~ message="" title="8Доставлен" ~~login~~eventtown="~~login~~Санкт-Петербург город" ~~pass~~country="~~pass~~RU">COMPLETE</~~auth~~status> </statushistory> <customstatecode>2<customstatecode> <~~changes~~clientstatecode>~~ONLY_LAST~~</~~changes~~clientstatecode> <deliveredto>Иванова, секр.</~~statusreq~~deliveredto> <delivereddate>2016-06-02</~~source~~delivereddate> Система выдает все заказы, в которых, с момента последнего запроса в этом режиме, изменилось хотя бы одно из полей <deliveredtime>17:22</deliveredtime> ~~orderno~~ <department>Отдел</department> ~~status~~ <costcode>cc12345</costcode> ~~delivereddate~~ <outstrbarcode>EXT123456</outstrbarcode> ~~deliveredtime~~ <respstore>14</respstore> ~~deliveredto~~ <partner>Офис на Ленина</partner> ~~receiver~~ <arrival>2016-~~>date~~ ~~receiver~~05-02 23:21</arrival>~~address~~ ~~price~~ После успешной обработки ответа необходимо отметить полученные статусы успешно полученными, отправив запрос <~~source lang~~receipt fdNum="124555" fnSn="9289000100295555" kktNum="0001611984048555" inn="7722756555" fdValue="~~xml~~2899551555">~~<?xml version~~summ="1387.05" ~~encoding~~ofdUrl="~~UTF-8~~gate.ofd.ru" ?>https://ofd.ru/rec/7722756555/0001611984048555/9289000100295555/124555/2899551555</receipt> <~~commitlaststatus~~items> <~~auth extra~~item code="34533" extcode="abc123" quantity="1" mass="0.2" retprice="37.5" VATrate="0" barcode="2345625213125" article="1" returns="0" origincountry="040" GTD="" excise="0.00" governmentCode="811223311" suppcompany="Поставщик" ~~login~~suppINN="~~login~~1112223334" ~~pass~~suppphone="~~pass~~79161234567">Мяч</~~auth~~item> <~~client~~item code="34456" extcode="abc124" quantity="2" mass="2" retprice="100" VATrate="10" barcode="4645625213138" article="2" returns="0" governmentCode="">~~CLIENT~~Обруч</~~client~~item> <~~/commitlaststatus></source>~~ ~~'''Описание полей запроса'''~~ *'''auth''' - Авторизацияitem code="34421" extcode="abc125" quantity="3" mass="0. ~~Обязательный элемент.~~*'''client''' - Признак клиента или агента. Необязательный элемент.~~:* CLIENT - Признак клиента, значение по умолчанию:* AGENT - Признак агента. В ответ отдается информация по заказам, переданным агенту на доставку~~ ~~В случае успеха Вы получите ответ~~ ~~<source lang~~3" retprice="50" VATrate="18" barcode="~~xml~~2345625213126">~~<?xml version~~itemcode="~~1.0~~44123" ~~encoding~~article="~~UTF-8~~3" ?>~~<commitlaststatus error~~returns="0" governmentCode="">OKПогремушка желтая</~~commitlaststatus~~item> </~~source~~items> <packages>Данный способ передачи статусов гарантирует полную корректную передачу статусов, даже в случае, если в нашей системе статус изменился в промежутке времени между запросом статусов и подтверждением их получения. Если система не получила подтверждение успешной передачи статуса, она будет считать информацию не переданной, и выдаст ее при повторном запросе. <~~div style~~package code="33331" strbarcode="ORD0000001" mass="1" message="" got="~~color: #a94442; background-color: #f2dede; border: 1px solid #ebccd1; padding: 3px 10px 10px;~~YES">~~'''Обратите внимание!'''~~ ~~# При данном способе передачи (<changes>ONLY_LAST~~</~~changes~~package>) система просматривает заказы, оформленные за последние 3 месяца. Если заказ сделан ранее - изменение статуса по нему не попадет в результат выполнения данного запроса.~~# Система всегда выдает текущий статус. Т.е. Вы можете одним запросом получить статус~~ <package code="33332"~~NEW~~strbarcode="~~, а следующим -~~ ORD0000002"~~COMPLETE~~mass="2. В промежутке между запросами отправление могло пройти через несколько промежуточных статусов. Если нужна гарантия получения всех промежуточных статусов, нужно анализировать блок statushistory (может не заполняться в следствии ограничений версии или тарифа конкретной службы доставки).# Система никогда не гарантирует последовательность прохождения заказом набора статусов. Т.е. Вы можете получить статус 5" message="~~COMPLETE~~"~~, а следующим запросом -~~ got="~~NEW~~NO" ~~- такое может произойти, например, если оператор ошибочно отметил заказ выполненным, а затем исправил ошибку.~~></package> </packages> </~~div~~order><br /statusreq></source>

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

Запрос трекинга по номеру предназначен для выдачи минимальной обезличенной информации о конкретном заказе не авторизованному пользователю. Наша система имеет для этого интерфейс по адресу "home.courierexe.ru/{код экстра}/tracking". Вы можете либо сделать ссылку на такую страницу на своем сайте, либо разместить ее iframe'ом у себя, либо сделать свою и пользоваться нашим API. Этот интерфейс создан специально для выдачи информации живому пользователю сайта. Для получения статусов заказов в свою информационную систему нужно использовать запрос "statusreq", желательно с параметром changes=ONLY_LAST!''Пример ответа при ошибке авторизации'''

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

<?xml version="1.0" encoding="~~UTF~~utf-8"?><~~tracking~~request> <~~extra>8</extra>~~ ~~<orderno~~error error="1" errormsg="authorization error">~~1234~~</~~orderno~~error></~~tracking~~request>

</source>

'''Пример ответа:при ошибке синтаксиса'''

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

<~~tracking~~request> <~~order orderno="111111"~~error> ~~<barcode~~column:1 line:11 message:expected '>~~111111~~'</~~barcode~~error> <~~AWB~~/request>~~111111~~</~~AWB~~source> ~~<sender>~~ ~~<town code~~=~~"1" country~~=~~"RU">Москва город</town>~~= Описание полей ответа статусов ===Все поля ответа соответствуют структуре order при создании заказа, с некоторыми добавлениями: * Атрибуты контейнера '''order''': ~~<date>2014-03-22</date>~~:* '''''awb''''' — Номер накладной в системе курьерской службы. ~~<time_min>09~~:~~00</time_min>~~* '''''orderno2''''' — Номер накладной в подсистеме срочной доставки курьерской службы. ~~<time_max>14~~:~~00</time_max>~~* '''''ordercode''''' — внутренний код заказа в системе, применяется для некоторых внутренних операций. ~~</sender>~~:* '''''givencode''''' — внутренний код заказа в системе, применяется для некоторых внутренних операций. ~~<receiver>~~ ~~<town code="1" country="RU">Москва город</town>~~*'''paytype''' - Тип оплаты заказа получателем. Принимает значения: ~~<zipcode>125480</zipcode>~~:: CASH - Наличными при получении (по-умолчанию) ~~<date>2014~~:: CARD -03Картой при получении:: NO -~~22</date>~~Без оплаты. ~~<time_min>09~~:~~00</time_min>~~: OTHER - Прочее (Предусмотрен для того, чтобы оплата поступала непосредственно в курьерскую службу посредством прочих типов оплаты - таких как: вебмани, яденьги, картой на сайте, прочие платежные системы и т.д.) ~~<time_max>14~~* Атрибуты контейнера '''paytype''':~~00</time_max>~~ ~~</receiver>~~** '''''code''''' - (integer) внутренний код типа оплаты заказа в системном справочнике "Типы оплаты корреспонденции". Не обязательный элемент. ~~<price>387~~* атрибут '''''code''''' контейнера '''item''' — внутренний код строки заказа в системе, применяется для некоторых внутренних операций.~~5</price>~~ ~~<inshprice>387~~:* '''''returns''''' — количество данного товара, от которого отказался получатель. Не нулевое только в случае частичного отказа.~~5</inshprice>~~ ~~<paytype>CASH<~~* атрибут '''''got''''' контейнера '''package''' — признак принятого места YES /~~paytype>~~NO. ~~<weight>5~~:* '''''returns''''' — количество данного товара, от которого отказался получатель. Не нулевое только в случае частичного отказа.~~1</weight>~~ ~~<quantity>2<~~* '''''area''''' в контейнере '''receiver''' — район/~~quantity>~~метро получателя. ~~<service>2</service>~~* '''''coords''''' в контейнере '''receiver''' — координаты получателя. ~~<type>3</type>~~* '''''deliveryPIN''''' в контейнере '''receiver''' — Пин-код. ~~<return>~~* '''pickup''' — признак оформления забора, возможные значения: '''YES''', '''NO~~</return>~~'''. Если указано '''YES''', то весь заказ считается заданием на забор груза, а не на доставку. ~~<return_service>2</service>~~* '''currcoords''' — текущие координаты заказа. Атрибуты: ~~<return_date></return_date>~~:* '''''lat''''' — широта ~~<return_time></return_time>~~:* '''''lon''''' — долгота ~~<return_message></return_message>~~:* '''''accuracy''''' — точность в метрах ~~<waittime>12<~~:* '''''RequestDateTime''''' — дата/~~waittime>~~время последнего обновления координат. ~~<enclosure>Детские игрушки</enclosure>~~ ~~<instruction>Проверить при покупателе~~* '''courier''' — Данные курьера, которому выдан заказ. Если заказ не выдан, ~~подписать акт</instruction>~~то выводятся данные запланированного курьера.* '''waittime ''' — Время ожидания курьера. <* '''deliveryprice ''' — Стоимость услуг в валюте расчетов с клиентом. Атрибуты::* '''''total~~="158.6"~~ ''''' — общая стоимость услуг:* '''''delivery~~="100.00"~~ ''''' — стоимость доставки «Туда»:* '''''return''''' — стоимость доставки «Обратно» (если order->return=~~"58.6" />~~YES)Тэг '''deliveryprice''' включает список дополнительных услуг (только для тарифа «Премиум»): ~~<courier>~~:* '''''advprice''''' — наименование дополнительной услуги <:* '''''code~~>26</code>~~''''' — код дополнительной услуги ~~<name>Иванов Владимир Петрович</name>~~:* '''''price''''' — стоимость дополнительной услуги ~~<phone>+79161234567</phone>~~ ~~</courier>~~ ~~<currcoords lat="55~~* '''status''' — статус доставки (список статусов см. ниже). Атрибуты (заполняются начиная с версии системы 2008.0.~~680327" lon="37~~0.~~604456" accuracy="50" RequestDateTime="2014-04-21 18~~670):07:~~45" />~~ ~~<status~~ * '''''eventstore="''''' — филиал ~~в Санкт-Петербурге"~~ , к которому относится текущий статус:* '''''eventtime~~="2016-06-02 17~~''''' — время события по часовому поясу места его наступления.:~~22:00"~~ * '''''createtimegmt''''' — время по GMT создания записи о смене статуса в БД. Используется для сортировки записей, чтобы соблюсти хронологическую последовательность. <spoiler text="~~2016-06-03 16:14:44" message="" title="Доставлен~~Подробнее">~~COMPLETE</status>~~ ~~<statushistory>~~ ~~<status eventstore="Офис~~ Большинство событий фиксируются в ~~Москве"~~ полях eventtime~~="2016-05-30~~ и createtimegmt на основании одного действия, тогда они отличаются только сдвигом от GMT. Однако, если курьер доставил отправление 10.10.2010 в 20:00, по какой-то причине не внес это в мобильное приложение, на следующий день сдал накладную, и в 9 утра оператор внесла, что он доставил вчера в 20:00" . Тогда в createtimegmt~~="2016~~будет сегодня 6 утра (для Москвы), а в eventtime — вчера в 20:00. При этом оператор по каким-06то причинам может внести время вручения раньше, чем какое-~~03 16~~то предыдущее событие, т.о. нарушится последовательность времени в eventtime, но при сортировке по createtimegmt все-равно все будет правильно.</spoiler>:14* '''''message''''' — наименование филиала-получателя, при передаче между филиалами:~~44" message=""~~ * '''''title~~="Новый">NEW<~~''''' — русское наименование статуса * '''statushistory''' — история статусов доставки. Содержит список контейнеров '''status'''. Заполняется только для тарифа «Премиум» начиная с версии системы 2008.0.0.670.* '''customstatecode''' — код внутреннего статуса курьерской службы. Значения уточняйте в курьерской службе. Назначаются курьерской службой в разделе «Справочники» — «Статусы» — «15 Статусы корреспонденции». Справочник не передается через API клиенту по причине возможного наличия в нем внутренних технологических статусов курьерской службы.* '''clientstatecode''' — код статуса клиента. Используется, если клиент предлагает свои коды статусов доставки/~~status>~~причин недоставки.* '''deliveredto''' — данные из поля «Инфо. о доставке» (может быть информация о доставке, причина недоставки и т. п.).* '''delivereddate''' — дата вручения.* '''deliveredtime''' — время вручения. В случае недоставки может быть пустым. ~~<status eventstore="Офис~~ * '''arrival''' — плановая дата прибытия в ~~Москве" eventtime="2016~~формате гггг-06мм-~~01 17~~дд чч:38мм:~~00" createtimegmt="2016~~сс. Заполняется только при использовании автоматических систем планирования (Максоптра, Яндекс доставка), во всех остальных случаях -~~06-03 16~~пустое.* '''outstrbarcode''' — код у подрядчика (код заказа во внешней системе). Используется в интеграциях с внешними системами.* '''partner''' — текущий филиал/подрядчик.* '''return_message''' — информация о возврате* '''department''' — Подразделение, в котором оформляется заказ. Контейнер '''status''' может принимать следующие значения::14AWAITING_SYNC — Ожидает синхронизации. Данные заказа пока не появились в службе доставки.:~~44" message="филиал~~ '''NEW''' — Успешно создан, передан в ~~Санкт-Петербурге" title="~~службу доставки.: NEWPICKUP — Создан забор.: PICKUP — Забран у отправителя.: WMSASSEMBLED — Скомплектован на складе фулфилмента.: WMSDISASSEMBLED — Разукомплектован на склад фулфилмента.: '''ACCEPTED''' — Получен складом.: CUSTOMSPROCESS — Производится таможенный контроль.: CUSTOMSFINISHED — Таможенный контроль произведен.: CONFIRM — Согласована доставка.: UNCONFIRM — Не удалось согласовать доставку.: DEPARTURING — Планируется отправка~~">DEPARTURING</status>~~со склада на другой склад.: DEPARTURE — Отправлено со склада на другой склад. ~~<status eventstore="Офис~~ : INVENTORY — Инвентаризация. Убедились в ~~Москве" eventtime="2016-06-01 19~~наличии отправления на складе.:53PICKUPREADY — Готов к выдаче в ПВЗ.:~~00" createtimegmt="2016-06-03 16~~'''DELIVERY''' — Выдан курьеру на доставку.:14COURIERDELIVERED — Доставлен (предварительно, ожидает подтверждения менеджером, чтобы перейти в статус COMPLETE).:~~44" message="филиал~~ COURIERPARTIALLY — Частично доставлен (предварительно, ожидает подтверждения менеджером, чтобы перейти в ~~Санкт-Петербурге" title="Отправлено со склада">DEPARTURE<~~статус PARTIALLY).: COURIERCANCELED — Отказ (предварительно, после этого ожидается COURIERRETURN).: COURIERRETURN — Возвращено курьером. Курьер не смог доставить до получателя и вернул заказ обратно на склад. Это промежуточный статус, после которого менеджер выясняет, нужно ли повторно доставлять (статусы DATECHANGE/~~status>~~DELIVERY) или это окончательная недоставка (CANCELED).: DATECHANGE — Перенос даты доставки. : '''COMPLETE''' — Доставлен.: '''PARTIALLY''' — Доставлен частично. ~~<status eventstore="филиал в Санкт-Петербурге" eventtime="2016-06-02 07~~:41'''CANCELED''' — Не доставлен (Возврат/Отмена). После этого статуса отправление должны вернуть заказчику, будут статусы RETURNING и RETURNED :~~00" createtimegmt="2016-06-03 16~~RETURNING — Планируется возврат заказчику (после CANCELED).:14RETURNED — Возвращен заказчику.:~~44" message="" title="Получен складом">ACCEPTED<~~LOST — Утрачен/~~status>~~утерян. : PARTLYRETURNING — Планируется возврат остатков.: PARTLYRETURNED — Остаток возвращен.: TRANSACCEPTED — Прибыл на склад перевозчика.: PICKUPTRANS — Забран у перевозчика. '''Примечание.''' В будущем возможно дополнение используемого набора статусов. <~~status eventstore~~div style="~~филиал в Санкт~~color: #a94442; background-~~Петербурге" eventtime="2016-06-02 09:17~~color:~~00" createtimegmt="2016-06-03 16~~#f2dede; border:141px solid #ebccd1; padding:~~44" message="" title="Выдан курьеру на доставку~~3px 10px 10px;">~~DELIVERY~~'''Обратите внимание!''' # Контейнер '''statushistory''' и '''deliveryprice''' заполняется для тарифов [[Личный кабинет курьерской службы#Функции личного кабинета|Премиум и Максимум]].# Система никогда не гарантирует последовательность прохождения заказом набора статусов. То есть Вы можете получить статус «COMPLETE», а следующим запросом — «NEW» — такое может произойти, например, если оператор ошибочно отметил заказ выполненным, а затем исправил ошибку.</~~status~~div> <~~status eventstore~~br> === Передача только изменившихся статусов ==~~"филиал в Санкт-Петербурге" eventtime~~=~~"2016-06-02 17~~В нашем API предусмотрено удобное средство получения статусов всех заказов, без необходимости «бомбить» сервер запросами статусов по каждому заказу. Работает это так:22раз, например, в 10 минут, вы посылаете запрос «покажите все изменившиеся статусы». Пример запроса ниже. Система вам отдает ВСЕ заказы, статусы (или некоторые другие поля, см. ниже) которых изменились с момента последнего запроса. Вы разбираете полученный документ, по каждому заказу сохраняете его актуальный статус в своей системе, и если все хорошо, у вас все получилось, ваша система неожиданно не упала от наплыва информации, посылаете нам запрос подтверждения получения статусов (commitlaststatus). Мы у себя отмечаем, что эти статусы вами получены и их не надо передавать повторно. Таким образом, сколько бы заказов у вас ни было, статусы по ним всем почти в реальном времени вы можете получать всего двумя запросами. Для получения только изменившихся статусов отправьте запрос:~~00" createtimegmt~~<source lang="~~2016-06-03 16:14:44~~xml" ~~message~~><?xml version="1.0" ~~title~~encoding="~~Доставлен (предварительно)~~UTF-8"?>~~COURIERDELIVERED~~<~~/status~~statusreq> <~~status eventstore="филиал в Санкт-Петербурге" eventtime~~auth extra="~~2016-06-02 17:22:00~~8" ~~createtimegmt~~login="~~2016-06-03 16:14:44~~login" ~~message~~pass="~~" title="Доставлен~~pass">~~COMPLETE~~</~~status~~auth> <changes>ONLY_LAST</~~statushistory~~changes> <~~deliveredto~~streamid>~~Иванова, секр.~~1234</~~deliveredto~~streamid> <~~delivereddate~~/statusreq>~~2016-06-02~~</~~delivereddate~~source> ~~<deliveredtime>17~~Система выдает все заказы, в которых с момента последнего запроса в этом режиме изменилось хотя бы одно из полей:~~22</~~ orderno status delivereddate deliveredtime deliveredto receiver->date ~~<outstrbarcode>EXT123456</outstrbarcode~~ receiver->address price ~~<items>~~После успешной обработки ответа необходимо отметить полученные статусы успешно полученными, отправив запрос: <~~item code~~source lang="~~34533~~xml" ~~extcode="abc123" quantity~~><?xml version="1~~" mass="0.2" retprice="37~~.~~5" VATrate="~~0" ~~barcode~~encoding="~~2345625213125" article="1" returns="0" origincountry="040" GTD="" excise="0.00" governmentCode="11223311" suppcompany="Поставщик" suppINN="1112223334" suppphone="79161234567~~UTF-8"?>~~Мяч~~<~~/item~~commitlaststatus> <~~item code="34456" extcode="abc124" quantity="2" mass="2" retprice="100" VATrate~~auth extra="108" ~~barcode~~login="~~4645625213138~~login" ~~article="2" returns="0" governmentCode~~pass="pass">~~Обруч~~</~~item~~auth> <~~item code="34421" extcode="abc125" quantity="3" mass="0.3" retprice="50" VATrate="18" barcode="2345625213126" article="3" returns="0" governmentCode=""~~client>~~Погремушка желтая~~CLIENT</~~item~~client> <~~/items~~streamid> 1234</~~order~~streamid></~~tracking~~commitlaststatus>

</source>

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

* '''~~Получение информации~~ auth''' — авторизация. Обязательный элемент.* '''streamid''' — идентификатор потока. Если у вас несколько интеграций и каждая нуждается в получении статусов, вы можете передавать данный параметр и тем самым разделять получение и отметку об успешном получении статусов по заказам. Значение должно входить в ~~формате 17 TRACK~~промежуток от 100 до 10000, включительно. Необязательный элемент.* '''client''' — признак клиента или агента. Необязательный элемент.:* CLIENT — признак клиента, значение по умолчанию:* AGENT — признак агента. В ответ отдается информация по заказам, переданным агенту на доставку

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

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

</~~tracking17~~tracking>

</source>

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

<~~pre~~source lang="xml">{ <?xml version="1.0" encoding="~~number~~UTF-8":?><tracking> <order orderno="~~ExtNumber~~111111",> <barcode>111111</barcode> <AWB>111111</AWB> <sender> <town code="~~oriNumber~~1":country="~~1234~~RU",>Москва город</town> <date>2014-03-22</date> <time_min>09:00</time_min> <time_max>14:00</time_max> </sender> <receiver> <town code="~~oriCountry~~1":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> <deliveryprice total="158.6" delivery="~~destCountry~~100.00":return="RU58.6",/> <courier> <code>26</code> <name>Иванов Владимир Петрович</name> <phone>+79161234567</phone> </courier> <currcoords lat="~~status~~55.680327" lon=":37.604456"~~Complete~~accuracy=", 50"~~events~~RequestDateTime="2014-04-21 18:07:[45" /> { <status eventstore="~~time~~филиал в Санкт-Петербурге":eventtime="2016-06-02 17:22:00",createtimegmt="2016-06-03 16:14:44" message="" title="Доставлен">COMPLETE</status> <statushistory> <status eventstore="Офис в Москве"~~location~~eventtime="2016-05-30 10:20:00" createtimegmt="RU2016-06-03 16:14:44", message="~~content~~":title="~~Complete~~Новый">NEW</status> }, { <status eventstore="~~time~~Офис в Москве":eventtime="2016-06-02 01 17:2238:00", ~~"location~~createtimegmt="2016-06-03 16:14:44"RUmessage=", филиал в Санкт-Петербурге"~~content~~title="~~:"Courierdelivered~~Планируется отправка">DEPARTURING</status> }, { <status eventstore="~~time~~Офис в Москве":eventtime="2016-06-~~02 09~~01 19:1753:00", ~~"location~~createtimegmt="2016-06-03 16:14:44"RUmessage=", филиал в Санкт-Петербурге"~~content~~title="~~:"Delivery~~Отправлено со склада">DEPARTURE</status> }, { <status eventstore="~~time~~филиал в Санкт-Петербурге":eventtime="2016-06-02 07:41:00", ~~"location~~createtimegmt="2016-06-03 16:14:44"RUmessage=", "~~content~~title="~~:"Accepted~~Получен складом">ACCEPTED</status> }, { <status eventstore="~~time~~филиал в Санкт-Петербурге":eventtime="2016-06-~~01 19~~02 09:5317:00", ~~"location~~createtimegmt="2016-06-03 16:14:44"RUmessage=", "~~content~~title="~~:"Departure~~Выдан курьеру на доставку">DELIVERY</status> }, { <status eventstore="~~time~~филиал в Санкт-Петербурге":eventtime="2016-06-01 02 17:3822:00", ~~"location~~createtimegmt="2016-06-03 16:14:44"RUmessage=", "~~content~~title="~~:"Departuring~~Доставлен (предварительно)">COURIERDELIVERED</status> }, { <status eventstore="~~time~~филиал в Санкт-Петербурге":eventtime="2016-0506-~~30 10~~02 17:2022:00", ~~"location~~createtimegmt="2016-06-03 16:14:44"RUmessage=", "~~content~~title="~~:"New~~Доставлен">COMPLETE</status> } </statushistory> ] <deliveredto>Иванова, секр.</deliveredto>} <delivereddate>2016-06-02</~~pre~~delivereddate> <deliveredtime>17:22</deliveredtime>Функция ищет последний заказ по номеру среди заказов всех клиентов. Выдает неперсонализированную информацию о текущем состоянии заказа. <outstrbarcode>EXT123456<br /outstrbarcode> <items>~~Описание контейнеров ответа аналогично описанию [[API#~~ <item code="34533" extcode="abc123" quantity="1" mass="0.D02" retprice="37.~~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|Запроса статусов заказов]]~~5" VATrate="0" barcode="2345625213125" article="1" returns="0" origincountry="040" GTD="" excise="0.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> <item code="34421" extcode="abc125" quantity="3" mass="0.3" retprice="50" VATrate="18" barcode= ~~Изменение заказа~~ "2345625213126" article="3" returns="0" governmentCode="">Погремушка желтая</item> </items> </order></tracking></source>

Запрос предназначен для изменения заказов, находящихся в статусах "Ожидает синхронизации" или "Новый", а также по которым не было произведено изменений - статуса корреспонденции, времени доставки - то есть заказов, которые ещё не находятся в работе.

~~<div style="color: #a94442; background-color: #f2dede; border: 1px solid #ebccd1; padding: 3px 10px 10px;">~~'''~~Обратите внимание!'''# Данные запроса изменения указываются '''полностью''', как если бы заказ создавался впервые.# При отсутствии вложения~~ Получение информации в ~~запросе изменения данное вложение '~~формате 17 TRACK''~~не удаляется~~'~~'' из заказа, но его количество становится равным 0.~~# При одновременном изменении заказа в API и системе курьерской службы приоритет отдается данным системы курьерской службы. То есть изменения в API приняты не будут!~~</div><br />~~

~~=== Описание полей запроса изменения ===Все поля запроса соответствуют структуре order при создании заказа за исключением:~~* вместо корневого тэга '''neworder''' указывается '''editorder'''* тэг штрих-кода '''barcode''' не указывается, поскольку присваивается при создании заказа. ~~=== Описание полей ответа изменения ===~~Все поля ответа соответствуют ответу при создании заказа за исключением корневого тэга - вместо '''neworder''' возвращается '''editorder'''. ~~== Отмена заказа ==~~ Запрос отмены предназначен для отмены тех заказов, по которым не было произведено изменений - статуса доставки, статуса корреспонденции, времени доставки - то есть заказов, которые ещё не находятся в работе.Возможность отмены заказа есть только у курьерских служб с тарифом "Премиум" и по-умолчанию она выключена, ее нужно отдельно включить: [[Личный кабинет курьерской службы#Дополнительные настройки]]. При отмене заказа поле "Инфо о доставке" получает значение "Отменено заказчиком", поле "Дата доставки" - текущую дату, а "Вручил курьер" - системную запись "ОТМЕНА". '''Пример запроса ~~отмены заказа~~:'''<source lang="xml"><?xml version="1.0" encoding="UTF-8" ?><~~cancelorder~~tracking17> <~~auth~~ extra=">8~~" login="login" pass="pass"~~ </extra> <~~order~~ orderno~~="" ordercode="123456" /~~> 1234<~~order~~ /orderno~~="123aaa" ordercode="" /~~></~~cancelorder~~tracking17>

</source>

~~'''Описание полей запроса статуса:'''~~

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

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

*'''order''' - Контейнер отменяемого заказа. Обязательный элемент. Запрос может содержать более одного контейнера '''order'''. Атрибуты:

~~:* '''''orderno''''' - Шифр заказа.~~

~~:* '''''ordercode''''' - Внутренний код заказа.~~

~~Обратите внимание, что должен быть указан хотя бы один из атрибутов ''orderno'' или ''ordercode''!~~

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

<~~source lang=~~pre>{ "number":"ExtNumber", "oriNumber":"~~xml~~1234">,~~<?xml version=~~ "~~1.0~~oriCountry" ~~encoding=~~:"~~UTF-8~~RU" ?>,~~<cancelorder>~~ "destCountry":"RU", ~~<order orderno=~~ "~~123test~~status" ~~ordercode=~~:"~~123456~~Complete" ~~error=~~, "0events" ~~errormsg=~~:[ { "OKtime" ~~errormsgru=~~:"~~Успешно~~2016-06-02 17:22:00" />, ~~<order orderno=~~ "~~123aaa~~location" ~~ordercode=~~:"RU" ~~error=~~, "52content" ~~errormsg=~~:"~~order not found~~Complete" ~~errormsgru=~~ }, { "~~Заказ не найден~~time" />:"2016-06-02 17:22:00",~~</cancelorder>~~ "location":"RU",~~</source>~~ "content":"Courierdelivered" },~~== Добавление вложений к накладной ==~~ { "time":"2016-06-02 09:17:00",~~'''Пример запроса~~ "location":~~'''~~"RU",~~<source lang=~~ "content":"~~xml~~Delivery">~~<?xml version=~~ }, { "~~1.0~~time" ~~encoding=~~:"~~UTF~~2016-06-802 07:41:00" ?>,~~<addattachments>~~ ~~<auth extra=~~ "location":"8RU" ~~login=~~, "~~login~~content" ~~pass=~~:"~~pass~~Accepted" /> ~~<orderno>1234567</orderno>~~ }, ~~<attachments>~~ { ~~<item name=~~ "time":"~~photo1.jpg~~2016-06-01 19:53:00"~~>JVBERi0xLjMN1wb25lbnQgMQ~~, ~~JUBQREYwMTIzNDU2Nzg5IDI NMyAwIG9iag08PA0vVHlwZSA~~ "location":"RU", ~~U3VidHlwZSAvSW1hZ2UNL1d pZHRoIDE4MDgNL0hlaWdodCA~~ "content":"Departure" ~~ggNCAwIFINL0JpdHNQZXJDb 21wb25lbnQgMQ0vRGVjb2RlU~~ }, ~~ENL0NvbHVtbnMgMTgwOA0+P g0vSW1hZ2VNYXNrIHRydWUNL~~ { ~~XhEZWNvZGUNPj4Nc3RyZWFt DQ</item>~~ "time":"2016-06-01 17:38:00", ~~<item name=~~ "location":"~~photo2.jpg~~RU"~~>VBERi0xLjMNAwIG9iag0HRoJ~~, ~~JUBQREYwMTIzNDU2Nzg5IDI NMyAwIG9iag08PA0vVHlwZSA~~ "content":"Departuring" ~~vWE9iamVjdA0vU3VidHlwZS AvSW1hZ2UNL1dpZHRoIDEzNj~~ }, ~~gNL0hlaWdodCAxMzMzDS9MZ W5ndGggNCAwIFINL0JpdHNQZ~~ { ~~XJDb21wb25lbnQgMQ0vRGVj b2RlUGFybXMgPDwNL0sgLTEN~~ "time":"2016-05-30 10:20:00", ~~L0NvbHVtbnMgMTM2OA0+Pg0 vSW</item>~~ "location":"RU", "content":"New" ~~</attachments>~~ }~~</addattachments>~~ ]}</~~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|Запроса статусов заказов]].

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

~~'''addattachments''' - Корневой контейнер~~Изменять заказы могут курьерские службы с тарифами «Премиум» и «Максимум». ~~Обязательный элемент.~~*'''auth''' - Авторизация. Обязательный элемент.*Чтобы разрешить изменение заказов, в личном кабинете курьерской службы перейдите в '''~~orderno~~Настройки''' ~~- Номер заказа. Обязательный элемент. Может использоваться тэг <ordercode~~> ~~с указанием внутреннего кода заказа.~~*'''~~attachments~~Заказы''' ~~- Обязательный элемент,~~ и в ~~котором перечисляются передаваемые данные файлов.~~**разделе '''~~item~~Отмена и редактирование''' ~~- Бинарные данные (файл), закодированные в base64. Обязательный элемент.***~~установите флажок '''~~name~~Разрешить отмену и изменение заказов''' ~~- Атрибут элемента~~ . Вы также можете пометить в списке '''~~item~~Статусы для отмены и редактирования заказов''' галками статусы корреспонденции, для которых возможны отмена и изменение заказов. По умолчанию (когда в ~~котором передается имя файла. Обязательный элемент.~~этом списке ничего не выбрано) редактирование и отмена разрешены для статуса «Новый»

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

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

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

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

</div>

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

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

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

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

~~'''Пример ответа:'''<source lang~~=~~"xml"><?xml version~~=~~"1.0" encoding~~=~~"UTF-8"?><addattachments>~~ ~~<attachments>~~ ~~<item name~~Описание полей запроса изменения =~~"photo1.jpg" error~~=~~"0" errormsg~~=~~"OK" errormsgru="Успешно" />~~ ~~<item name="photo2.jpg" error="0" errormsg="OK" errormsgru="Успешно" />~~ ~~</attachments></addattachments></source>~~ ~~== Получение вложений к накладной ==~~Все поля запроса соответствуют структуре order при создании заказа за исключением:

* значение '''~~Пример запроса:~~orderno'''данным методом изменить нельзя.~~<source lang="xml"><?xml version="1~~* значение '''barcode''' изменяется в случае явного его указания.~~0" encoding="UTF~~В случае отсутствия или пустого значения -~~8" ?>~~остается прежним.~~<attachments>~~* вместо корневого тэга '''neworder''' указывается '''editorder'''; ~~<auth extra="8" login="login" pass="pass" />~~* тэг курьера '''courier''' можно изменить только при включенной настройке '''Разрешить изменение курьера по АПИ'''; ~~<orderno>1234567</orderno>~~* для вложений '''item''' указывается внутренний код вложения в атрибуте '''code''', который можно получить при получении статуса заказа.~~</attachments></source>~~* для мест '''package''' указывается внутренний код вложения в атрибуте '''code''', который можно получить при получении статуса заказа.

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

~~'''attachments''' - Корневой контейнер. Обязательный элемент.~~*'''auth''' - Авторизация. Обязательный элемент.*'''orderno''' - Номер/код заказа. Обязательный элемент.Необходимо иметь в виду, что:

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

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

=== Описание полей ответа изменения ===Все поля ответа соответствуют ответу при создании заказа за исключением корневого тэга — вместо '''~~Пример ответа:~~neworder''' возвращается '''editorder'''~~<source lang="xml"><?xml version="1.0" encoding="UTF-8"?><attachments>~~ ~~<item name="doc1~~.~~docx" size="35654">JVBERi0xLjMN~~ ~~JUBQREYwMTIzNDU2Nzg5IDI NMyAwIG9iag08PA0vVHlwZSA~~ ~~U3VidHlwZSAvSW1hZ2UNL1d pZHRoIDE4MDgNL0hlaWdodCA~~ ~~ggNCAwIFINL0JpdHNQZXJDb 21wb25lbnQgMQ0vRGVjb2RlU~~ ~~ENL0NvbHVtbnMgMTgwOA0+P g0vSW1hZ2VNYXNrIHRydWUNL~~ ~~XhEZWNvZGUNPj4Nc3RyZWFt DQ</item>~~ ~~<item name="photo2.jpg" size="74861">VBERi0xLjMN~~ ~~JUBQREYwMTIzNDU2Nzg5IDI NMyAwIG9iag08PA0vVHlwZSA~~ ~~vWE9iamVjdA0vU3VidHlwZS AvSW1hZ2UNL1dpZHRoIDEzNj~~ ~~gNL0hlaWdodCAxMzMzDS9MZ W5ndGggNCAwIFINL0JpdHNQZ~~ ~~XJDb21wb25lbnQgMQ0vRGVj b2RlUGFybXMgPDwNL0sgLTEN~~ ~~L0NvbHVtbnMgMTM2OA0+Pg0 vSW</item></attachments></source>~~

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

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

~~Запрос изменения статуса~~ При отмене заказа ~~позволяет установить окончательный статус заказа - "Доставлен" или "Не доставлен (Возврат/Отмена)"~~поле «Инфо о доставке» получает значение «Отменено заказчиком», поле «Дата доставки» — текущую дату, а «Вручил курьер» — системную запись «ОТМЕНА».

Кроме этого, устанавливается дата и время (при необходимости) изменения статуса, а также сообщение в поле ''Инфо о доставке''.

~~При необходимости к заказу можно прикрепить изображения.~~ '''Пример запроса ~~изменения статуса~~отмены заказа:'''

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

<~~setorderinfo~~cancelorder>

<order orderno="" ordercode="123456"> ~~<message>Получил Иванов<~~/~~message>~~ ~~</order~~> <order ~~ordercode~~orderno="~~234567~~123aaa"> ~~<status>PICKUPREADY</status>~~ ~~<eventtime>2016-05-30 10:20:00</eventtime>~~ ~~<message>Клиент отказался от покупки</message>~~ ~~<paytype>CASH</paytype>~~ ~~<items>~~ ~~<item code~~ordercode="~~34533" quantity="1" reason="0~~" /> ~~<item code="34456" quantity="0" reason="0" />~~ ~~<item code="34421" quantity="2" reason="0" />~~ ~~</items>~~ ~~<image filename="filename1.jpg"> /9j/4AAQSkZJRgA~~ ~~BAQAAAQABAAD/2wBDAA0JCg sKCA0LCgsODg0PEyAVExISEy~~ ~~ccHhcgLikxMC4pLSwzOko+M zZGNywtQFdBRkxOUlNSMj5aY~~ ~~VpQYEpRUk//2wBDAQ4ODhMR EyYVFSZPNS01T09PT09PT09P~~ ~~T09PT09PT09PT09PT09PT09 PT09PT09PT09PT09PT09PT09~~ ~~PT09PT0//wAARCAYACAADAS IA</image>~~ ~~</order~~></~~setorderinfo~~cancelorder>

</source>

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

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

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

* '''order''' — Контейнер отменяемого заказа. Обязательный элемент. Запрос может содержать более одного контейнера '''order'''. Атрибуты:

:* '''''orderno''''' — Шифр заказа.

:* '''''ordercode''''' — Внутренний код заказа.

Обратите внимание, что должен быть указан хотя бы один из атрибутов ''orderno'' или ''ordercode''!

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

<?xml version="1.0" encoding="UTF-8"?><~~setorderinfo~~cancelorder> <order orderno="123test" ordercode="123456" error="0" errormsg="OK" errormsgru="Успешно" /> <order orderno="123aaa" ordercode="~~234567~~" error="5952" errormsg="~~value [date_put] is already set~~order not found" errormsgru="~~Значение [Дата доставки] уже указано~~Заказ не найден" /></~~setorderinfo~~cancelorder>

</source>

== ~~Получение документов для печати~~ Добавление вложений к накладной == Метод позволяет прикрепить файлы к корреспонденции.Размер загружаемого файла не должен превышать 1 Мб.

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

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

<~~waybill~~addattachments>

<~~orders~~orderno>1234567</orderno> <attachments> <~~order orderno~~item name="~~1234567" ordercode="33331~~photo1.jpg" >JVBERi0xLjMN1wb25lbnQgMQ JUBQREYwMTIzNDU2Nzg5IDI NMyAwIG9iag08PA0vVHlwZSA U3VidHlwZSAvSW1hZ2UNL1d pZHRoIDE4MDgNL0hlaWdodCA ggNCAwIFINL0JpdHNQZXJDb 21wb25lbnQgMQ0vRGVjb2RlU ENL0NvbHVtbnMgMTgwOA0+P g0vSW1hZ2VNYXNrIHRydWUNL XhEZWNvZGUNPj4Nc3RyZWFt DQ</item> <~~order orderno~~item name="~~1234568~~photo2.jpg" ~~ordercode="33332" /~~>VBERi0xLjMNAwIG9iag0HRoJ JUBQREYwMTIzNDU2Nzg5IDI NMyAwIG9iag08PA0vVHlwZSA vWE9iamVjdA0vU3VidHlwZS AvSW1hZ2UNL1dpZHRoIDEzNj gNL0hlaWdodCAxMzMzDS9MZ W5ndGggNCAwIFINL0JpdHNQZ XJDb21wb25lbnQgMQ0vRGVj b2RlUGFybXMgPDwNL0sgLTEN L0NvbHVtbnMgMTM2OA0+Pg0 vSW</~~orders~~item> ~~<form>1~~</~~form~~attachments></~~waybill~~addattachments>

</source>

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

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

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

<~~waybill~~addattachments> <~~content~~attachments>~~EODIcaI8KSBlwQ 4MnEOR7Px8U8EBAyGICBnwpw~~ ~~IZhQgz0ZxuPs8EBM~~ <item name="photo1.jpg" error="0" errormsg="OK" errormsgru="Успешно" /~~GcbjzB AwhBl8hwQYIO00GmEwg1CeEG~~ > ~~mqYTChNU0wqf8l8nz4zgc+K fCno+zwU5GjOZmzXGcbEQYIM~~ ~~4zkegRE40zWzONyoNNMIOIa cWnp6aDCGEGE9NQmoQd2mg00~~ ~~79U4f3hPTwnfp6Sdrafeqpa JDpFw~~ <item name="photo2.jpg" error="0" errormsg="OK" errormsgru="Успешно" /~~1aYT077VNNNdO00G3q~~ > ~~mqqvp9p2E7T0/wiFemv8uG6 OM~~</~~content~~attachments></~~waybill~~addattachments>

</source>

== Получение вложений к накладной ==

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

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

</attachments>

</source>

~~В тэге content возвращаются бинарные данные (файл pdf), закодированные в base64.~~'''Описание полей:'''

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

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

* '''orderno''' — Номер/код заказа. Обязательный элемент.

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

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

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

<~~townlist~~attachments> <~~auth extra~~item name="doc1.docx" size="835654" />JVBERi0xLjMN ~~<codesearch>~~JUBQREYwMTIzNDU2Nzg5IDI NMyAwIG9iag08PA0vVHlwZSA ~~<zipcode>110000</zipcode>~~ U3VidHlwZSAvSW1hZ2UNL1d pZHRoIDE4MDgNL0hlaWdodCA ~~<kladrcode>0100000100800</kladrcode>~~ ggNCAwIFINL0JpdHNQZXJDb 21wb25lbnQgMQ0vRGVjb2RlU ~~<fiascode>bd21979d-46f8-49d0-9105-e8d65172a983</fiascode>~~ ~~<code>123</code>~~ ENL0NvbHVtbnMgMTgwOA0+P g0vSW1hZ2VNYXNrIHRydWUNL XhEZWNvZGUNPj4Nc3RyZWFt DQ</~~codesearch~~item> <~~conditions>~~ ~~<city>Краснодарский край</city>~~ ~~<namecontains>новгород</namecontains>~~ ~~<namestarts>Моск</namestarts>~~ ~~<name>Москва</~~item name="photo2.jpg" size="74861">VBERi0xLjMN ~~<fullname>Москва город</fullname>~~ JUBQREYwMTIzNDU2Nzg5IDI NMyAwIG9iag08PA0vVHlwZSA ~~<country>1</country>~~ vWE9iamVjdA0vU3VidHlwZS AvSW1hZ2UNL1dpZHRoIDEzNj ~~</conditions>~~gNL0hlaWdodCAxMzMzDS9MZ W5ndGggNCAwIFINL0JpdHNQZ ~~<limit>~~XJDb21wb25lbnQgMQ0vRGVj b2RlUGFybXMgPDwNL0sgLTEN ~~<limitfrom>30~~ L0NvbHVtbnMgMTM2OA0+Pg0 vSW</~~limitfrom~~item> ~~<limitcount>10~~</~~limitcount~~attachments> ~~<countall>YES~~</~~countall~~source> ~~</limit></townlist>~~В тегах item возвращаются бинарные данные (файлы), закодированные в base64. == Изменение статуса агентом ==<Запрос изменения статуса заказа позволяет установить окончательный статус заказа — «Доставлен» или «Не доставлен (Возврат/~~source>~~Отмена)».

~~Внутри контейнера townlist все элементы могут как отсутствовать~~Кроме этого, ~~так~~ устанавливается дата и ~~комбинироваться. Поиск не чувствителен к регистру~~время (при необходимости) изменения статуса, а также сообщение в поле ''Инфо о доставке''.

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

*'''codesearch''' - Поиск по кодам. В случае использования - контейнеры conditions и limit игнорируются.

:* '''zipcode''' - Поиск по индексу. Обратите внимание на то, что один почтовый индекс может распространяться на несколько населенных пунктов. В этом случае система вернет несколько записей.

~~:* '''kladrcode''' - Поиск по 13-ти значному коду КЛАДР.~~

~~:* '''fiascode''' - Поиск по коду ФИАС (AOGUID).~~

~~:* '''code''' - Поиск по коду в системе.~~

*'''~~conditions''' - Задает условия поиска. Все вложенные элементы одновременно накладывают условие "И".:* '''city''' - Поиск по всем населенным пунктам региона.:* '''namecontains''' - Поиск населенных пунктов, название которых содержит указанный текст.:* '''namestarts''' - Поиск населенных пунктов, название которых начинается с указанного текста.:* '''name''' - Поиск населенных пунктов, название которых соответствует указанному тексту.~~:* '''fullname''' - Поиск населенных пунктов, название вместе с типом населенного пункта которых соответствует указанному тексту.~~:* '''country''' - Поиск только по стране с указанным кодом.~~ *'''limit''' - Ограничивает вывод результата.~~:* '''limitfrom''' - Задает номер записи результата, начиная с которой выдавать ответ. По-умолчанию - 0.:* '''limitcount'''- Задает количество записей результата, которые нужно вернуть. По-умолчанию - 10000.~~:* '''countall''' - YES указывает на необходимость подсчета общего количества найденных совпадений. Это может замедлять выполнение Пример запроса~~. Если отключено - в ответе не указываются totalcount и totalpages.~~ ~~'''Пример ответа~~изменения статуса:'''

<?xml version="1.0" encoding="UTF-8"?><~~townlist count~~setorderinfo> <auth extra="38" ~~page~~login="1login" ~~totalcount~~pass="~~3" totalpages="1~~pass"/> <~~town~~order ordercode="123456"> <~~code~~message>~~26379~~Получил Иванов</~~code~~message> <~~city>~~ ~~<code~~outstrbarcode>237654312</~~code~~outstrbarcode> ~~<name>Краснодарский край~~ </~~name~~order> <~~/city~~order ordercode="234567"> <~~name~~status>~~Сочи город~~PICKUPREADY</~~name~~status> <~~fiascode~~eventtime>~~79da737a~~2016-~~603b~~05-~~4c19-9b54-9114c96fb912~~30 10:20:00</~~fiascode~~eventtime> <~~kladrcode~~message>~~2300000700000~~Клиент отказался от покупки</~~kladrcode~~message> <~~shortname~~ paytype>CASH</paytype> ~~(not yet supported)~~ <~~typename~~ storeprice>123</storeprice> ~~(not yet supported)~~ <~~coords lat~~items> <item code="34533" quantity="1" reason="~~43.5855~~0" ~~lon~~governmentCode="~~39.7231~~11223311" /> ~~</town>~~ ~~<town>~~ <item code~~>40331<~~="34456" quantity="0" reason="0" /~~code>~~ ~~<city~~> <item code~~>32</code>~~ ~~<name>Брянская область</name>~~ ~~</city>~~ ~~<name>Сочилов хутор</name>~~ ~~<fiascode>c9c96c67-2cc9-4f10-afde-fd32417ea216</fiascode>~~ ~~<kladrcode>3201900011100</kladrcode>~~ ~~<shortname />~~ ~~<typename />~~ ~~<coords lat~~="~~52.6407~~34421" quantity="2" ~~lon~~reason="~~33.1724~~0" /> ~~</town>~~ ~~<town~~> ~~<code>114016~~</~~code~~items> <~~city~~image filename="filename1.jpg"> ~~<code>60<~~/~~code>~~ ~~<name>Псковская область<~~9j/~~name>~~4AAQSkZJRgA <BAQAAAQABAAD/~~city>~~2wBDAA0JCg sKCA0LCgsODg0PEyAVExISEy ~~<name>Сочихино деревня</name>~~ccHhcgLikxMC4pLSwzOko+M zZGNywtQFdBRkxOUlNSMj5aY ~~<fiascode>10df7588-19c1-49d1-a387-9de1cf3eb26f<~~VpQYEpRUk//~~fiascode>~~2wBDAQ4ODhMR EyYVFSZPNS01T09PT09PT09P ~~<kladrcode>6001900015400</kladrcode>~~T09PT09PT09PT09PT09PT09 PT09PT09PT09PT09PT09PT09 ~~<shortname~~ PT09PT0/> ~~<typename~~ /> wAARCAYACAADAS IA<~~coords lat="56.6003" lon="29.3542"~~ /image> </~~town~~order></~~townlist~~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~~setorderinfo> <~~codesearch>~~ ~~<code>77</code>~~ ~~</codesearch>~~ ~~<conditions>~~ ~~<namecontains>край</namecontains>~~ ~~<namestarts>Моск</namestarts>~~ ~~<fullname>Московская область</fullname>~~ ~~<country>1<~~order ordercode="123456" error="0" errormsg="OK" errormsgru="Успешно" /~~country~~> <order ordercode="234567" error="59" errormsg="value [date_put] is already set" errormsgru="Значение [Дата доставки] уже указано" /~~conditions~~></~~regionlist~~setorderinfo>

</source>

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

<?xml version="1.0" encoding="UTF-8"?><~~regionlist count~~waybill> <auth extra="8" login="2login"pass="pass" /> <~~city~~orders> <~~code>80<~~order orderno="1234567" ordercode="33331" /~~code~~> <~~country~~order orderno="1234568" ordercode="33332" /> ~~<code>1~~ </~~code~~orders> <~~name~~form>~~Россия~~1</~~name~~form> <idstart>~~643~~5</idstart> ~~<ShortName1>RU~~</~~ShortName1~~waybill> ~~<ShortName2>RUS~~</~~ShortName2~~source> ~~</country>~~ ~~<name>Агинский Бурятский автономный округ</name>~~'''Описание полей:''' '''waybill''' — Корневой контейнер. Обязательный элемент* '''auth''' — Авторизация. Обязательный элемент* '''orders''' — Список заказов для получения печатных форм. Содержит тэги '''order''' с атрибутами::* '''''orderno''''' — шифр заказа:* '''''ordercode''''' — внутренний код заказа. Указывать необходимо один из атрибутов для всех заказов. Приоритет имеет атрибут '''''ordercode'''''* '''form''' — Формат накладной. Не обязательный элемент. Принимает значения::* 1 — Подробная накладная (по-умолчанию):* 2 — Наклейки Zebra:* 3 — Наклейки на страницу формата А4:* 4 — Акты приема-передачи* '''start''' — Имеет смысл только для form = 3. Начальная позиция первой наклейки. Используется для пропуска наклеек на листе для их экономии. ~~</city>~~ ~~<city>~~ ~~<code>1</code>~~'''Пример ответа:''' <~~country~~source lang="xml"> <~~code>~~?xml version="1~~</code~~.0" encoding="UTF-8"?> ~~<name>Россия~~<~~/name~~waybill> ~~<id>643~~ <~~/id~~content>EODIcaI8KSBlwQ 4MnEOR7Px8U8EBAyGICBnwpw ~~<ShortName1>RU<~~ IZhQgz0ZxuPs8EBM/~~ShortName1>~~GcbjzB AwhBl8hwQYIO00GmEwg1CeEG ~~<ShortName2>RUS</ShortName2>~~ mqYTChNU0wqf8l8nz4zgc+K fCno+zwU5GjOZmzXGcbEQYIM ~~</country>~~ 4zkegRE40zWzONyoNNMIOIa cWnp6aDCGEGE9NQmoQd2mg00 ~~<name>Адыгея республика<~~ 79U4f3hPTwnfp6Sdrafeqpa JDpFw/~~name>~~1aYT077VNNNdO00G3q mqqvp9p2E7T0/wiFemv8uG6 OM</~~city~~content></~~regionlist~~waybill>

</source>

~~== Справочник улиц ==~~

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

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

<~~streetlist~~waybill> <~~conditions~~error> ~~<town>Москва город</town> // ОБЯЗАТЕЛЬНОЕ ПОЛЕ!~~ ~~<namecontains>Хохло</namecontains>~~ ~~<namestarts>Академика Х</namestarts>~~ ~~<name>Академика Хохлова</name>~~ ~~<fullname>Академика Хохлова ул.</fullname>~~ ~~</conditions>~~ ~~<limit>~~ ~~<limitfrom>30</limitfrom>~~ ~~<limitcount>10</limitcount>~~ ~~<countall>YES</countall>~~ Текст ошибки</~~limit~~error></~~streetlist~~waybill>

</source>

*'''conditions''' - Задает условия поиска. Все вложенные элементы одновременно накладывают условие "И".== Справочник городов ==:* '''~~town''' - Обязательное поле. Название или код населенного пункта.:* '''namecontains''' - Поиск населенных пунктов, название которых содержит указанный текст.:* '''namestarts''' - Поиск населенных пунктов, название которых начинается с указанного текста.:* '''name''' - Поиск населенных пунктов, название которых соответствует указанному тексту.~~:* '''fullname''' - Поиск населенных пунктов, название вместе с типом населенного пункта которых соответствует указанному тексту. *'''limit''' - Ограничивает вывод результата.~~:* '''limitfrom''' - Задает номер записи результата, начиная с которой выдавать ответ. По-умолчанию - 0.:* '''limitcount'''- Задает количество записей результата, которые нужно вернуть. По-умолчанию - 10000.~~:* '''countall''' - YES указывает на необходимость подсчета общего количества найденных совпадений. Это может замедлять выполнение Пример запроса~~. Если отключено - в ответе не указываются totalcount и totalpages.~~ ~~'''Пример ответа~~справочника городов:'''

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

<~~streetlist count~~townlist> <auth extra="~~1" page="1" totalcount="3" totalpages="1~~8"/> <codesearch> <zipcode>110000</zipcode> <kladrcode>0100000100800</kladrcode> <fiascode>bd21979d-46f8-49d0-9105-e8d65172a983</fiascode> <code>123</code> </codesearch> <~~street~~conditions> <city>Краснодарский край</city> <namecontains>новгород</namecontains> <namecontainsparts>молоково моск</namecontainsparts> <namestarts>Моск</namestarts> <name>~~Академика Хохлова ул.~~Москва</name> <fullname>Москва город</fullname> <country>1</country> </conditions> <limit> <limitfrom>30</limitfrom> <~~shortname~~limitcount>~~Академика Хохлова~~10</~~shortname~~limitcount> <~~typename~~countall>~~ул.~~YES</~~typename~~countall> </~~street~~limit></~~streetlist~~townlist>

</source>

~~В ответе улицы сортируются по алфавиту~~Внутри контейнера townlist все элементы могут как отсутствовать, так и комбинироваться. Поиск не чувствителен к регистру.

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

* '''~~Пример запроса справочника номенклатуры:~~codesearch'''~~<source lang="xml"><?xml version="1~~ — Поиск по кодам.~~0" encoding="UTF-8" ?><itemlist>~~ ~~<auth extra="8" login="login" pass="pass"></auth>~~ ~~<codesearch>~~ ~~<code>123456</code>~~ ~~<article>FD343</article>~~ ~~<barcode>2345625213125</barcode>~~ ~~</codesearch>~~ <В случае использования — контейнеры conditions>и limit игнорируются. ~~<namecontains>телевизор</namecontains>~~:* '''zipcode''' — Поиск по индексу. Обратите внимание на то, что один почтовый индекс может распространяться на несколько населенных пунктов. В этом случае система вернет несколько записей. ~~<namestarts>sony</namestarts>~~ ~~<name>Sony KDL~~:* '''kladrcode''' — Поиск по 13-~~55W905 ЖК-телевизор</name>~~ти значному коду КЛАДР. ~~<quantity>EXISTING_ONLY</quantity>~~:* '''fiascode''' — Поиск по коду ФИАС (AOGUID). ~~</conditions>~~ ~~<limit>~~ ~~<limitfrom>30</limitfrom>~~ ~~<limitcount>10</limitcount>~~ ~~<countall>YES</countall>~~ ~~</limit></itemlist></source>~~:* '''code''' — Поиск по коду в системе.

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

*'''conditions''' - Задает условия поиска. Все вложенные элементы одновременно накладывают условие "И".~~:* '''namecontains''' - Поиск товаров, название которых содержит указанный текст.:* '''namestarts''' - Поиск товаров, название которых начинается с указанного текста.:* '''name''' - Поиск товаров, название которых соответствует указанному тексту.~~:* '''quantity''' - Наличие на складе. Принимает значения EXISTING_ONLY - Только в наличии, NOT_EXISTING_ONLY - Только не в наличии, ALL - Все. ''Это поле может быть недоступным в некоторых установках.'' *'''limit''' - — Ограничивает вывод результата.:* '''limitfrom''' - — Задает номер записи результата, начиная с которой выдавать ответ. По-умолчанию — 0.:* '''limitcount''' - Задает количество записей результата, которые нужно вернуть. По-умолчанию — 10000.:* '''countall''' — YES указывает на необходимость подсчета общего количества найденных совпадений. Это может замедлять выполнение запроса. Если отключено — в ответе не указываются totalcount и totalpages.

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

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

<~~itemlist~~ townlist count="3" ~~totalcount~~page="31" ~~page~~totalcount="13" totalpages="1"> <~~item~~town> <code>~~123456~~26379</code> <~~article~~city> <code>~~FD343~~23</~~article~~code> <name>Краснодарский край<~~barcode~~/name>~~2345625213125~~ </~~barcode~~city> <name>~~Sony KDL-55W905 ЖК-телевизор~~Сочи город</name> <~~retprice~~fiascode>~~65000~~79da737a-603b-4c19-9b54-9114c96fb912</~~retprice~~fiascode> <~~purchprice~~kladrcode>~~50000~~2300000700000</~~purchprice~~kladrcode> <~~weight~~shortname />~~5.1~~ (not yet supported) <typename /~~weight~~> (not yet supported) <~~length~~coords lat="43.5855" lon="39.7231" />50 </~~length~~town> <town> <~~width~~code>3040331</~~width~~code> <~~height~~city>40 <code>32</~~height~~code> <~~CountInPallet~~name>30Брянская область</~~CountInPallet~~name> ~~<HasSerials>1~~</~~HasSerials~~city> <~~CountryOfOrigin~~name>~~Малайзия~~Сочилов хутор</~~CountryOfOrigin~~name> ~~(not yet supported)~~ <~~Message~~fiascode>~~Хороший телевизор~~c9c96c67-2cc9-4f10-afde-fd32417ea216</~~Message~~fiascode> <~~Message2~~kladrcode>~~Снова хороший телевизор~~3201900011100</~~Message2~~kladrcode> <~~quantity~~shortname />12 <typename /~~quantity~~> <~~reserved~~coords lat="52.6407" lon="33.1724" />3 </~~reserved~~town> <~~item~~town> ~~...~~ <code>114016</~~itemlist~~code> <~~/source~~city> ~~'''Описание полей:'''~~*''' <code>60</code~~''' - Внутренний идентификатор, присвоенный системой.~~>*'''article''' - Артикул, назначенный клиентом (поставщиком). <name>Псковская область</name>*'''barcode''' - Штрих-код производителя. </city>*''' <name~~''' - Наименование.~~>Сочихино деревня</name>*'''retprice''' <fiascode>10df7588- ~~Розничная цена по~~19c1-~~умолчанию. При оформлении заказа цена используется та, которая указана в заказе.~~*'''purchprice''' 49d1- ~~Закупочная цена.~~*'''weight''' a387- ~~Масса в килограммах.~~*'''length''' - Длина в сантиметрах.*'''width''' - Ширина в сантиметрах.*'''height''' - Высота в сантиметрах.*'''CountInPallet''' - Количество штук в паллете.*'''HasSerials''' - Требует учета серийных номеров. Принимает значения 1 - да, 0 - нет.*'''CountryOfOrigin''' - Наименование страны происхождения на русском языке.*'''Message''' - Комментарий.*'''Message2''' - Дополнительный комментарий.*'''quantity''' - Количество на складе. Товары, уже собранные в заказы в этом количестве не присутствуют, считаются покинувшими товарный склад. ''Это поле может быть недоступным в некоторых установках.''*'''reserved''' - Количество зарезервированного товара. Может превышать остаток на складе, если покупатели ждут следующей поставки. ''Это поле может быть недоступным в некоторых установках.'' ~~== Движение номенклатуры ==~~ ~~'''Пример запроса движения номенклатуры:'''~~9de1cf3eb26f</fiascode> <kladrcode>6001900015400<~~source lang="xml"~~/kladrcode> <~~?xml version="1.0" encoding="UTF-8" ?~~shortname /> <~~itemmovements~~typename /> <~~auth extra~~coords lat="856.6003" ~~login~~lon="~~login" pass="pass~~29.3542"></~~auth~~> ~~<code>4259~~ </~~code~~town></~~itemmovements~~townlist>

</source>

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

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

<?xml version="1.0" encoding="UTF-8" ?><~~itemmovements count="16"~~regionlist> <~~itemmovement~~codesearch> <code>~~151500~~77</code> <~~date~~/codesearch>~~2017-05-26~~ <~~/date~~conditions> <~~retprice~~namecontains>0край</~~retprice~~namecontains> <~~quantity~~namestarts>1Моск</~~quantity~~namestarts> <~~delivered~~fullname>0Московская область</~~delivered~~fullname> <~~item~~country> RU<~~code~~/country>~~4259~~ </~~code~~conditions> ~~<name>Настольная игра Дженга~~</~~name~~regionlist> </~~item~~source> '''Пример ответа:'''<~~status~~source lang="xml"> <~~code~~?xml version="1.0" encoding="UTF-8"?>5<~~/code~~regionlist count="2"> <~~name~~city>~~Возврат от покупателя~~ <~~/name~~code> 80</~~status~~code> <~~store~~country>

<name>~~офис в Москве~~Россия</name> <~~/store~~id> 643<~~order~~/id> <~~ordercode~~ShortName1>~~3374830~~RU</~~ordercode~~ShortName1> <~~number~~ShortName2>~~123660-0~~RUS</~~number~~ShortName2> ~~<date>2017-05-24~~ </~~date~~country> <~~orderno~~name>~~14123~~Агинский Бурятский автономный округ</~~orderno~~name> ~~<barcode>0000000670~~ </~~barcode~~city> <~~company>ТОВАР</company~~city> <~~address~~code>~~Кравченко ул.,~~ 1</~~address~~code> <~~delivereddate>2017-05-29</delivereddate~~country> <~~deliveredtime~~code>~~12:00:00~~1</~~deliveredtime~~code> <~~deliveredto /~~name> Россия</~~order>~~ ~~<document~~name> <~~code~~id>~~21991~~643</~~code~~id> <~~number~~ShortName1>~~318~~RU</~~number~~ShortName1> <~~date~~ShortName2>~~2017-05-26~~RUS</~~date~~ShortName2> ~~<message>~~ </~~message~~country> <name>Адыгея республика</~~document~~name> </~~itemmovements~~city></~~itemlist~~regionlist>

</source>

== Справочник улиц ==''' ~~Описание полей ответа~~ Пример запроса справочника улиц:'''*'''code''' <source lang="xml"><?xml version="1.0" encoding="UTF- ~~внутренний код операции движения~~8"?><streetlist> <conditions> <town>Москва город</town> // ОБЯЗАТЕЛЬНОЕ ПОЛЕ! <namecontains>Хохло</namecontains> <namestarts>Академика Х</namestarts> <name>Академика Хохлова</name> <fullname>Академика Хохлова ул.</fullname> </conditions> <limit> <limitfrom>30</limitfrom> <limitcount>10</limitcount>*'''date''' - дата операции <countall>YES</countall>*'''retprice''' - цена товара </limit>*'''quantity''' - количество товара операции</streetlist>*'''delivered''' - количество доставленного товара</source>

*'''~~item~~conditions''' ~~- контейнер товара~~ — Задает условия поиска. Все вложенные элементы одновременно накладывают условие «И».:* '''~~code~~town''' ~~- внутренний~~ — Обязательное поле. Название или код ~~товара~~населенного пункта.:* '''namecontains''' — Поиск улиц, название которых содержит указанный текст.:* '''namestarts''' — Поиск улиц, название которых начинается с указанного текста.:* '''name''' ~~- наименование товара~~ — Поиск улиц, название которых соответствует указанному тексту.:* '''fullname''' — Поиск улиц, для которых название вместе с типом соответствует указанному тексту.

*'''~~status~~limit''' — Ограничивает вывод результата.:* '''limitfrom''' — Задает номер записи результата, начиная с которой выдавать ответ. По- ~~контейнер статуса операции~~умолчанию — 0.:* '''~~code~~limitcount''' - ~~код статуса~~Задает количество записей результата, которые нужно вернуть. По-умолчанию — 10000.:* '''~~name~~countall''' ~~- наименование~~ — YES указывает на необходимость подсчета общего количества найденных совпадений. Это может замедлять выполнение запроса. Если отключено, в ответе не указываются totalcount и totalpages.

*'''store''' - контейнер филиала, к которому относится операция~~:* '''code''' - код филиала:* '''name''' - наименование филиала~~ *'''order''' - контейнер корреспонденции~~:* '''ordercode''' - внутренний код заказа:* '''number''' - номер заказа:* '''date''' - дата заказа:* '''orderno''' - шифр:* '''barcode''' - штрих-код:* '''company''' - компания:* '''address''' - адрес:* '''delivereddate''' - дата вручения:* '''deliveredtime''' - время вручения:* '''deliveredto''' - данные о вручении, либо причина недоставки~~ *'''document''' - контейнер документа операции~~:* '''code''' - внутренний код документа:* '''number''' - номер документа:* '''date''' - дата документа:* '''message''' - комментарий~~ ~~== Справочник пунктов самовывоза ==~~ Для отображения списка пунктов выдачи (ПВЗ) есть '''готовый JavaScript модуль''': https://home.courierexe.ru/js/measoft_map.js Инструкция по использованию - внутри. '''Пример ~~запроса пунктов самовывоза~~ответа:'''

<?xml version="1.0" encoding="UTF-8" ?><~~pvzlist>~~ ~~<auth extra~~streetlist count="1" page="81" ~~login~~totalcount="~~login~~3" ~~pass~~totalpages="~~pass~~1"> <~~/auth~~street> <code>~~1234~~124</code> ~~<town>Нижний Тагил</town>~~ ~~<parentcode>6</parentcode>~~ ~~<acceptcash>YES</acceptcash>~~ ~~<acceptcard>YES</acceptcard>~~ ~~<acceptfitting>YES</acceptfitting>~~ ~~<maxweight>30</maxweight>~~ ~~<acceptindividuals>YES</acceptindividuals>~~ <ltname>57Академика Хохлова ул.~~924737~~</ltname> <lgshortname>~~59.940019~~Академика Хохлова</lgshortname> <rttypename>57ул.~~905682~~</rttypename> ~~<rg>59.984669</rg>~~ ~~<json>YES~~ </~~json~~street></~~pvzlist~~streetlist>

</source>

*'''auth''' - Атрибут '''extra''' - обязателен, В ответе улицы сортируются по нему определяется курьерская служба, '''login''' и '''pass''' позволяют авторизоваться под клиентом: для отдельного клиента могут быть ограничения по доступности некоторых ПВЗ, и в этом случае они будут учтеныалфавиту.*'''code''' - Внутренний код.*'''town''' - Город получателя.*'''parentcode''' - Фильтр по родительскому элементу*'''acceptcash''' - Фильтр по приему наличных YES/NO*'''acceptcard''' - Фильтр по приему банковских карт YES/NO*'''acceptfitting''' - Фильтр по наличию примерки YES/NO*'''maxweight''' - Фильтр по максимальному весу, с которым работает ПВЗ*'''acceptindividuals''' - Фильтр по доступности физическим лицам YES/NO*'''lt''' - Широта левого верхнего угла*'''lg''' - Долгота левого верхнего угла*'''rt''' - Широта правого нижнего угла*'''rg''' - Долгота правого нижнего угла*'''json''' - Признак вывода ответа в виде JSON YES/NO

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

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

<~~pvzlist count~~itemlist> <auth extra="8" login="login" pass="2pass"></auth> <~~pvz~~codesearch> <code>~~126~~123456</code> <~~clientcode~~article>3FD343</~~clientcode~~article> <~~name~~barcode>~~Нижний Тагил~~2345625213125</~~name~~barcode> <~~parentcode~~/codesearch>6 <~~/parentcode~~conditions> <~~parentname~~namecontains>~~Интеграция~~телевизор</~~parentname~~namecontains> <~~town code="124267" regioncode="66" regionname="Свердловская область"~~namestarts>~~Нижний Тагил город~~sony</~~town~~namestarts> <~~address~~name>~~622036, г. Нижний Тагил, ул. Циолковского, д. 17~~Sony KDL-55W905 ЖК-телевизор</~~address~~name> <~~phone~~quantity>~~+73435417709, +73435254989~~EXISTING_ONLY</~~phone~~quantity> <~~comment~~store>~~Новый пункт доставки~~2</~~comment~~store> <~~worktime~~/conditions>~~Вс 10:00-16:00, Сб 10:00-16:00, Пн-Пт 10:00-20:00~~ <~~/worktime~~except> <~~traveldescription~~code>~~Жилое 5-ти этажное здание, торцом к дороге, второе здание от перекрестка Пархоменко-Циолковского~~123478</~~traveldescription~~code> <~~maxweight~~/except>10 <~~/maxweight~~limit> <~~acceptcash~~limitfrom>~~YES~~30</~~acceptcash~~limitfrom> <~~acceptcard~~limitcount>~~YES~~10</~~acceptcard~~limitcount> <~~acceptfitting~~countall>YES</~~acceptfitting~~countall> <~~acceptindividuals~~/limit>~~YES~~</~~acceptindividuals~~itemlist> <~~latitude~~/source>57 Внутри контейнера itemlist все элементы могут как отсутствовать, так и комбинироваться. Поиск не чувствителен к регистру.* '''codesearch''' — Поиск по кодам. В случае использования — контейнеры conditions и limit игнорируются.:* '''code''' — Поиск по внутреннему коду системы.:* '''article''' — Поиск по артикулу.:* '''barcode''' — Поиск по штрихкоду. * '''conditions''' — Задает условия поиска. Все вложенные элементы одновременно накладывают условие «И».:* '''namecontains''' — Поиск товаров, название которых содержит указанный текст.~~93457~~:* '''namestarts''' — Поиск товаров, название которых начинается с указанного текста.:* '''name''' — Поиск товаров, название которых соответствует указанному тексту.:* '''quantity''' — Наличие на складе. Принимает значения EXISTING_ONLY — Только в наличии, NOT_EXISTING_ONLY — Только не в наличии, ALL — Все. ''Это поле может быть недоступным в некоторых установках.'':* '''store''' — Поиск товаров по определенному складу. * '''except''' — Описание исключений для корректного определения количества зарезервированной номенклатуры.:* '''code''' — Код заказа. * '''limit''' — Ограничивает вывод результата.:* '''limitfrom''' — Задает номер записи результата, начиная с которой выдавать ответ.:* '''limitcount''' — Задает количество записей результата, которые нужно вернуть. '''Пример ответа:'''<~~/latitude~~source lang="xml"> <~~longitude>59~~?xml version="1.~~95131</longitude~~0" encoding="UTF-8"?> <~~/pvz~~itemlist count="3" totalcount="3" page="1" totalpages="1"> <~~pvz~~item> <code>~~245~~123456</code> <~~clientcode~~article>FD343</article> <barcode>~~NTG1~~2345625213125</~~clientcode~~barcode> <name>~~На Красноармейской~~Sony KDL-55W905 ЖК-телевизор</name> <~~parentcode~~retprice>665000</~~parentcode~~retprice> <~~parentname~~purchprice>~~Интеграция~~50000</~~parentname~~purchprice> <~~town code="124267" regioncode="66" regionname="Свердловская область"~~weight>~~Нижний Тагил город~~5.1</~~town~~weight> <~~address~~length>~~КРАСНОАРМЕЙСКАЯ, д.79~~50</~~address~~length> <~~phone~~width>~~+7(3435)379-044~~30</~~phone~~width> <~~comment~~height>~~Возможность примерки отсутствует~~40</~~comment~~height> <~~worktime~~VATrate>~~Вс 10:00-16:00, Сб 10:00-16:00, Пн-Пт 10:00-~~20~~:00~~</~~worktime~~VATrate> <~~traveldescription~~CountInPallet>~~Напротив ТЦ Пирамида~~30</~~traveldescription~~CountInPallet> <~~maxweight~~CountInBox>202</~~maxweight~~CountInBox> <~~acceptcash~~HasSerials>~~YES~~1</~~acceptcash~~HasSerials> <~~acceptcard~~CountryOfOrigin>~~YES~~Малайзия</~~acceptcard~~CountryOfOrigin> (not yet supported) <~~acceptfitting~~Message>NOХороший телевизор</~~acceptfitting~~Message> <~~acceptindividuals~~Message2>~~YES~~Снова хороший телевизор</~~acceptindividuals~~Message2> <~~latitude~~quantity>~~57.93468~~12</~~latitude~~quantity> <~~longitude~~reserved>~~60.55476~~3</~~longitude~~reserved> <~~/pvz~~item> ...</~~pvzlist~~itemlist>

</source>

'''Описание полей:'''*'''code''' ~~- Код ПВЗ в системе~~ — Внутренний идентификатор, присвоенный системой.* '''article''' — Артикул, назначенный клиентом (поставщиком). ~~Используется в запросе [[API#Оформление заказа|оформления заказов]]~~*'''~~clientcode~~barcode''' ~~- Код ПВЗ используемый компанией-подрядчиком~~ — Штрихкод производителя.*'''name''' - — Наименование ~~ПВЗ~~.*'''~~parentcode~~retprice''' — Розничная цена по- ~~Код родительского элемента~~умолчанию. При оформлении заказа цена используется та, которая указана в заказе.* '''purchprice''' — Закупочная цена.*'''~~parentname~~weight''' ~~- Наименование родительского элемента~~ — Масса в килограммах.*'''~~town~~length''' - Населенный пункт с кодом из [[#Справочник городов|справочника городов]], а также с кодом и наименованием региона — Длина в сантиметрах.*'''~~address~~width''' ~~- Адрес ПВЗ~~ — Ширина в сантиметрах.*'''~~phone~~height''' ~~- Телефоны ПВЗ~~ — Высота в сантиметрах.*'''~~comment~~VATrate''' ~~- Дополнительная информация~~ — Ставка НДС, целое число процентов.*'''~~worktime~~CountInPallet''' ~~- Режим работы ПВЗ~~ — Количество штук в паллете.*'''~~traveldescription~~CountInBox''' ~~- Описание местонахождения ПВЗ или пути к нему~~ — Количество штук в упаковке.*'''~~maxweight~~HasSerials''' ~~- Максимальный вес~~ — Требует учета серийных номеров. Принимает значения 1 — да, ~~с которым работает ПВЗ~~0 — нет.*'''~~acceptcash~~CountryOfOrigin''' ~~- Признак приема наличных~~ — Наименование страны происхождения на русском языке.*'''~~acceptcard~~Message''' ~~- Признак приема банковских карт~~ — Комментарий.*'''~~acceptfitting~~Message2''' ~~- Наличие примерки~~ — Дополнительный комментарий.*'''~~latitude~~quantity''' — Количество на складе. Товары, уже собранные в заказы в этом количестве не присутствуют, считаются покинувшими товарный склад. ''Это поле может быть недоступным в некоторых установках.'' ~~- Широта~~*'''~~longitude~~reserved''' — Количество зарезервированного товара. Может превышать остаток на складе, если покупатели ждут следующей поставки. ''Это поле может быть недоступным в некоторых установках.'' ~~- Долгота~~

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

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

<~~services~~itemmovements> <auth extra="8"login="login" pass="pass"></auth> <code>4259</code> <datefrom>2020-10-01</datefrom> <dateto>2020-10-02</dateto></~~services~~itemmovements>

</source>

* '''code''' — внутренний код товара в справочнике номенклатуры.* '''datefrom''' — дата начала периода.* '''dateto''' — дата окончания периода.Может быть указан или код, или период, или код и период одновременно. '''Пример ответа ~~справочника Видов срочности~~движения номенклатуры:'''

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

<~~services~~ itemmovements count="216"> <~~service~~itemmovement> <code>151500</code> <date>2017-05-26</date> <retprice>0</retprice> <quantity>1</quantity> <delivered>0</delivered> <item> <code>4259</code> <name>~~Эконом~~Настольная игра Дженга</name> </~~service~~item> <~~service~~status> <code>25</code> <name>~~Срочно~~Возврат от покупателя</name> </~~service~~status> <store> <code>1</~~services~~code> <name>офис в Москве</~~source~~name> </store>~~== Расчет стоимости доставки ==~~ <order> <ordercode>3374830</ordercode>~~'''Пример запроса стоимости доставки:'''~~ <number>123660-0<~~source lang="xml"~~/number> <~~?xml version="1.0" encoding="UTF~~date>2017-05-~~8" ?~~24</date> <orderno>14123<~~calculator~~/orderno> <barcode>0000000670<~~auth extra="8" login="login" pass="pass"~~ /barcode> <company>ТОВАР<~~calc townfrom="Москва"~~ /company> ~~addressfrom="Ленинский проспект~~ <address>Кравченко ул., ~~95"~~1</address> ~~zipcode="664000"~~ <delivereddate>2017-05-29</delivereddate> ~~townto="3800000300000"~~ <deliveredtime>12:00:00</deliveredtime> ~~addressto="Ленина ул., 10"~~ <deliveredto /> ~~l="10"~~ </order> ~~w="20"~~ <document> ~~h="30"~~ <code>21991</code> ~~mass="3.7"~~ <number>318</number> ~~service="1"~~ <date>2017-05-26</date> ~~price="1200"~~ <message></message> ~~inshprice="1200"~~ </document> ~~paytype="CASH"~~ </itemmovements></~~calculator~~itemlist></source> ~~Параметры:~~''' Описание полей ответа '''* '''code''' — внутренний код операции движения* '''date''' — дата операции*'''~~townfrom~~retprice''' ~~- Город отправления~~ — цена товара*'''~~addressfrom~~quantity''' ~~- Адрес отправления~~ — количество товара операции*'''~~zipcode~~delivered''' ~~- Почтовый индекс города назначения~~ — количество доставленного товара *'''~~townto~~item''' ~~- Город назначения~~ — контейнер товара:*'''~~addressto~~code''' ~~- Адрес назначения~~ — внутренний код товара:*'''lname''' ~~- Длина в сантиметрах (не обязательный параметр)~~ — наименование товара *'''wstatus''' ~~- Ширина в сантиметрах (не обязательный параметр)~~ — контейнер статуса операции:*'''hcode''' ~~- Высота в сантиметрах (не обязательный параметр)~~ — код статуса:*'''~~mass~~name''' ~~- Масса в килограммах~~ — наименование *'''~~service~~store''' ~~- Режим доставки - число~~ — контейнер филиала, указывающее на запись в справочнике [[#Справочник Видов срочности|видов срочности]]. Если этот параметр опустить, система выдаст расчет для всех доступных видов срочности, передав много контейнеров <calc> в ответе.к которому относится операция:* '''code''' — код филиала:* '''name''' — наименование филиала * '''order''' — контейнер корреспонденции:* '''ordercode''' — внутренний код заказа:*'''~~price~~number''' ~~- Сумма наложенного платежа~~ — номер заказа:*'''~~inshprice~~date''' ~~- Сумма объявленной ценности~~ — дата заказа:*'''~~paytype~~orderno''' ~~- Тип оплаты~~ — шифр:* '''barcode''' — штрихкодСуммы НП и ОЦ, а также тип оплаты CARD имеют значение при настроенных в тарифе на вкладке Прочее долях (в процентах) от данных сумм.:* '''company''' — компания:* '''address''' — адресВ авторизации можно опустить параметры login и pass, тогда расчет будет производиться по стандартному тарифу курьерской службы, без учета возможных отличий для конкретного клиента.<br>:* '''delivereddate''' — дата вручения~~Объемный вес будет учитываться только при условии указания всех габаритов~~: ~~длины, ширины и высоты.<br>~~* '''deliveredtime''' — время вручения~~В полях город-отправитель и город-получатель можно указывать название города (не рекомендуется!)~~:* '''deliveredto''' — данные о вручении, либо причина недоставки * '''document''' — контейнер документа операции:* '''code''' — внутренний код ~~города из нашего справочника, либо 13-ти значный код КЛАДР, либо 36-ти значный код адресной системы ФИАС (AOID).~~документа:* '''number''' — номер документа:* '''extnumber''' — внешний номер документа:* '''date''' — дата документа:* '''message''' — комментарий

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

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

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

<~~calculator~~tariffs> <~~calc>~~ ~~<townfrom code~~auth extra="8" login="1login"~~>Москва город</townfrom>~~ ~~<townto code~~pass="~~56603~~pass"~~>Иркутск город<~~/~~townto~~> <~~mass~~townfrom>~~3.7~~Москва</~~mass~~townfrom> <service ~~name="Экспресс"~~>1</service> <~~zone~~mainonly>21</~~zone~~mainonly> ~~<price>1163~~</~~price~~tariffs> ~~<mindeliverydays>1~~</~~mindeliverydays~~source> ~~<maxdeliverydays>3</maxdeliverydays>~~ ~~<mindeliverydate>2020~~* '''auth''' — атрибут '''extra''' обязателен, по нему определяется курьерская служба.* '''townfrom''' — город-~~05-13</mindeliverydate>~~отправитель. Если не передан, то городом будет «Москва». ~~</calc>~~* '''service''' — режим доставки. Обязательный элемент.~~</calculator~~* '''mainonly''' — необязательный элемент. Если передан, то в ответе будут данные только по городам из справочника '''Межгород''' >'''Зоны'''.~~</source>~~

~~Параметры:~~

*'''townfrom''' - Город-отправитель так, как система его распознала и привязала к справочнику. Атрибут '''code''' - код из справочника городов системы.

*'''townto''' - Город-получатель так, как система его распознала и привязала к справочнику. Атрибут '''code''' - код из справочника городов системы.

*'''mass''' - Масса в килограммах

*'''service''' - Режим доставки - число, указывающее на запись в справочнике видов срочности (см описание на этой странице).

*'''zone''' - номер тарифной зоны, по которой рассчиталась стоимость. В зависимости от зоны выбирается тарифная сетка. Так же к цене могут применяться повышающие или понижающие коэффициенты при доставке не из/в региональный центр.

*'''price''' - рассчитанная стоимость доставки в валюте прайс-листа курьерской службы. Рекомендуется к использованию в отличие от одноименного атрибута родительского контейнера.

*'''maxdeliverydays''' - максимальный срок доставки в рабочих днях.

*'''mindeliverydate''' - минимальная дата доставки в учетом выходных дней.

'''Пример ответа справочника тарифов по городам''~~Обратите внимание~~'<source lang="json">{ "townfrom": "0c5b2444-70a0-4932-980c-b4dc0d3f02b5", "service": 1, "tariffs": [ { "towntofias": "0c5b2444-70a0-4932-980c-b4dc0d3f02b5", "towntocode": 1, "towntoname": "Москва город", "townregion": "Город Москва", "distance": 0, "pricedistance": 0, "pricesnew": { "before": [ { "price": 100, "every": 0, "mass":~~''''' В реальном ответе сервера в теге calc присутствует атрибут~~ 1 }, { "price": 150, "every": 0, "mass": 5 } ], "after": [ { "price": 0, "every": 1, "mass": 38. ~~Он оставлен для обратной совместимости~~01 }, ~~не используйте его. Пользуйтесь вложенным тегом~~ { "price": 15, "every": 1, "mass": 51.01 } ] }, "deliveryPeriodMin": 1, "deliveryPeriodMax": 2 } ]}</source>

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

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

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

<~~smalist~~itemdoc> <auth extra="8" login="login" pass="pass" /> ~~<datefrom>2016-02-10~~</~~datefrom~~auth> <~~dateto~~code>~~2016-03-10~~21991</~~dateto~~code></~~smalist~~itemdoc>

</source>

~~'''smalist''' - Корневой контейнер. Обязательный элемент.~~*'''auth''' - Авторизация. Обязательный элемент.*'''~~datefrom~~code''' ~~- Дата "с"~~ — внутренний код документа приходной накладной (см. ~~Необязательный элемент~~предыдущий запрос).*'''dateto''' - Дата "по". Необязательный элемент.~~Если интервал дат не указан, то возвращаются акты передачи денег за последний месяц.~~

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

<?xml version="1.0" encoding="UTF-8"?><~~smalist count="1"~~itemdoc> ~~<sma>~~ <code>~~6278~~21991</code> <number>~~3992~~318</number> <~~actdate~~date>~~2016~~2017-0205-1226</~~actdate~~date> <~~datepay~~message></~~datepay~~message> ~~<dateto>2016-02-12~~ <~~/dateto~~items> <~~promiseddatepay></promiseddatepay>~~ ~~<price>637.00</price>~~ ~~<pricecorr>113.00</pricecorr>~~ ~~<rur>13430.00</rur>~~ ~~<pricekur>570.00</pricekur>~~ ~~<priceag>67.00</priceag>~~ ~~<payno>42423</payno>~~ ~~<paytype>~~item code="4259" quantity="1~~</paytype>~~ ~~<paytypename>Безнал</paytypename>~~ ~~<signedcopyreceived~~" barcode="200300" article="123555">NOНастольная игра Дженга</~~signedcopyreceived~~item> </~~sma~~items></~~smalist~~itemdoc>

</source>

*'''~~code~~Описание полей ответа ''' ~~- Код акта~~*'''~~number~~code''' ~~- Номер акта в системе~~ — внутренний код приходной накладной*'''~~actdate''' - Дата акта~~*''number'~~datepay~~''~~' - Дата оплаты по акту~~ — номер документа*'''~~dateto'~~date'' ~~- Дата конечного периода для формирования АПД~~*'~~''promiseddatepay''' - Плановая~~ — дата ~~оплаты~~*'''price''' - Стоимость услуг*'''pricecorr''' - Сумма корректировки*'''rur''' - Сумма заказа*'''pricekur''' - Стоимость курьерской доставки*'''priceag''' - Агентское вознаграждение*'''payno''' - Номер платежного поручения*'''paytype''' - Тип оплаты: 1 - безнал, 2 - наличными курьером, 3 - наличными в офисе, 4 - перевод на карту*'''paytypename''' - Строковое представление типа оплатыдокумента*'''~~signedcopyreceived~~message''' ~~- Признак факта возврата акта YES/NO~~ — комментарий

~~== Детализация актов передачи денег ==~~* '''item''' — контейнер товара:* '''code''' — внутренний код товара:* '''barcode''' — штрихкод товара:* '''article''' — артикул товара:* '''quantity''' — количество поступившего товара

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

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

<~~smadetail~~storelist> <auth extra="8" ~~login~~></auth> <json>YES</json> <client_code>7890</client_code></storelist></source> * '''auth''' — Атрибут '''extra''' — обязателен, по нему определяется курьерская служба* '''json''' — Признак вывода ответа в виде JSON YES/NO* '''client_code''' — Код клиента курьерской службы '''Пример ответа:'''<source lang="xml"><?xml version="~~login~~1.0" ~~pass~~encoding="~~pass~~UTF-8" ?><storelist count="2"> <store> <code>123</code> <name>ABC</name> </store> <store> <code>~~6278~~456</code> <name>Филиал 2</name> </store></~~smadetail~~storelist>

</source>

* '''~~smadetail~~code''' ~~- Корневой контейнер~~ — Код филиала. ~~Обязательный элемент~~* '''name''' — Наименование филиала.*== Справочник пунктов самовывоза ==Для отображения списка пунктов выдачи (ПВЗ) есть '''~~auth~~готовый JavaScript модуль''' ~~- Авторизация~~: https://home.courierexe.ru/js/measoft_map.js Инструкция по использованию — внутри. Посмотреть пример работы можно [https://home.courierexe. ~~Обязательный элемент~~ru/pvz_test.html Здесь] Уникальные запросы списка ПВЗ кешируются на стороне личного кабинета и хранятся до 7 часов утра по московскому времени следующего дня. Например, если уникальный запрос с массой 2 кг был отправлен сегодня в 10 часов, то завтра в 7 утра он сбросится. Если сегодня в 18 часов в этом же запросе вы укажете массу 2 кг, в ответе вернется тот же список ПВЗ. Если передадите массу 3 кг, список может быть другим. *Обратите внимание, что если в выборке количество ПВЗ больше '''10000''' и не указаны параметры '''code''' ~~- Код акта передачи денег (см~~, '''json''' или '''limitcount''', то будет возвращаться ошибка. ~~запрос списка АПД). Обязательный элемент~~В этом случае необходимо использовать блок '''limit'''.

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

<?xml version="1.0" encoding="UTF-8"?><~~smadetail count~~pvzlist> <auth extra="8" login="2login" pass="pass"> <~~specialsma~~/auth> <code>~~42494~~1234</code> <client_code>7890</client_code> <city>Свердловская область</city> <town regioncode="66" country="RU">Нижний Тагил</town> <address>Щёлковское шоссе</address> <house>77</house> <parentcode>6</parentcode> <~~ordercode~~acceptcash>~~14424~~YES</~~ordercode~~acceptcash> <~~orderno~~acceptcard>~~11111~~YES</~~orderno~~acceptcard> <~~orderdate~~acceptfitting>~~2018-01-01~~YES</~~orderdate~~acceptfitting> <~~delivereddate~~maxweight>~~2018-10-01~~30</~~delivereddate~~maxweight> <~~company~~acceptindividuals>~~Компания~~YES</~~company~~acceptindividuals> <~~price~~lt>~~314~~57.00924737</~~price~~lt> <~~rur~~lg>~~8800~~59.00940019</~~rur~~lg> <~~inshprice~~rt>~~314~~57.00905682</~~inshprice~~rt> <~~pricekur~~rg>~~270~~59.00984669</~~pricekur~~rg> <~~priceag~~json>~~44.00~~YES</~~priceag~~json> <~~pricecalc~~with_coords>~~8486.00~~YES</~~pricecalc~~with_coords> <limit> <~~paytype~~limitfrom>230</~~paytype~~limitfrom> <~~paytypename~~limitcount>~~наличными курьером~~2</~~paytypename~~limitcount> <~~status~~countall>~~Доставлено~~YES</~~status~~countall> </~~specialsma~~limit></~~smadetail~~pvzlist>

</source>

*'''~~code~~auth''' ~~- Код записи.~~* — Атрибут '''~~ordercode~~extra''' ~~- Код заказа.~~* — обязателен, по нему определяется курьерская служба, '''~~orderno~~login''' ~~- Шифр заказа.~~*и '''~~orderdate~~pass''' ~~- Дата заказа~~позволяют авторизоваться под клиентом: для отдельного клиента могут быть ограничения по доступности некоторых ПВЗ, и в этом случае они будут учтены.*'''~~delivereddate~~code''' ~~- Дата доставки~~ — Внутренний код.*'''~~company~~client_code''' ~~- Получатель~~ — Код клиента курьерской службы.*'''~~price~~city''' ~~- Стоимость услуг~~ — Регион получателя. Можно указать код региона или полное наименование региона из [[#Справочник регионов|справочника регионов]].*'''~~rur~~town''' ~~- Сумма заказа~~ — Город получателя.*Для тега города '''town''~~inshprice~~'можно указать код региона в атрибуте '' ~~- Стоимость заказа.~~*'''~~pricekur~~regioncode''' ~~- Стоимость курьерской доставки.~~*''~~'priceag''' - Агентское вознаграждение~~из [[#Справочник регионов|справочника регионов]]. Поиск будет производиться в указанном регионе.*Также можно указать страну получателя в атрибуте '''~~pricecalc~~''~~' - Сумма для передачи агенту.~~*country''~~'paytype~~''' в соответствии с [https://ru.wikipedia.org/wiki/ISO_3166- ~~Тип оплаты:~~ 1 стандартом ISO_3166- ~~безнал~~1], ~~2 - наличными курьером~~например, ~~3 - наличными в офисе~~«RU», ~~4 - перевод на карту~~«RUS» или «643» для России.*'Для формата запроса JSON фильтрация по городу работает только в связке с фильтром по адресу. * '''~~paytypename~~address''' ~~- Строковое представление типа оплаты~~ — Фильтр по адресу, работает только в связке с фильтром по городу*'''~~status~~house''' ~~- Статус заказа.~~ — Фильтр по номеру дома, работает только в связке с фильтрами по адресу и городу* '''parentcode''' — Фильтр по родительскому [[#Справочник филиалов|филиалу]]~~== Генерация коротких ссылок ==~~* '''acceptcash''' — Фильтр по приему наличных YES/NO* '''acceptcard''' — Фильтр по приему банковских карт YES/NOВ некоторых случаях, например, при использовании в СМС, может потребоваться использование коротких ссылок на ЛК.* '''acceptfitting''' — Фильтр по наличию примерки YES/NO~~Для этого~~* '''maxweight''' — Фильтр по максимальному весу, ~~необходимо отправить запрос~~ с ~~полной ссылкой, в ответ на который придёт хэш-код для ссылки.~~которым работает ПВЗ* '''acceptindividuals''' — Фильтр по доступности физическим лицам YES/NO* '''lt''' — Широта левого верхнего угла* '''~~Пример запроса генерации коротких ссылок:~~lg''' — Долгота левого верхнего угла~~<source lang="xml">~~* '''rt''' — Широта правого нижнего угла* '''rg''' — Долгота правого нижнего угла~~<?xml version="1.0" encoding="UTF-8" ?>~~* '''json''' — Признак вывода ответа в виде JSON YES/NO~~<shortlink>~~* '''with_coords''' — Признак вывода ПВЗ только с наличием координат YES/NO* '''limit''' — Ограничивает вывод результата. ~~<link short="0"> https~~:~~//home~~* '''limitfrom''' — Задает номер записи результата, начиная с которой выдавать ответ.~~courierexe~~По-умолчанию — 0.~~ru/8/site/orders </link></shortlink></source>~~ :* '''~~shortlink~~limitcount''' - ~~Корневой контейнер~~Задает количество записей результата, которые нужно вернуть. ~~Обязательный элемент~~По-умолчанию — 100.:*'''~~link~~countall''' ~~- Полная ссылка, для которой необходимо получить код~~ — YES указывает на необходимость подсчета общего количества найденных совпадений. ~~Обязательный элемент~~Это может замедлять выполнение запроса. Если ~~атрибут~~ отключено — в ответе не указываeтся totalcount. '''~~short~~Пример ответа справочника пунктов самовывоза:''' ~~равен 1, то ответ не будет содержать XML, а только хэш~~<source lang="xml"><?xml version="1.0" encoding="UTF-~~код.~~8" ?> ~~'''Пример ответа на запрос генерации коротких ссылок~~<pvzlist count="2" totalcount="40465"> <pvz> <code>126</code> <clientcode>3</clientcode> <name>Нижний Тагил</name> <parentcode>6</parentcode> <parentname>Интеграция</parentname> <town code="124267" regioncode="66" regionname="Свердловская область">Нижний Тагил город</town> <address>622036, г. Нижний Тагил, ул. Циолковского, д. 17</address> <phone>+73435417709, +73435254989</phone> <comment>Новый пункт доставки</comment> <worktime>Вс 10:00-16:00, Сб 10:00-16:00, Пн-Пт 10:00-20:00</worktime> <traveldescription>Жилое 5-ти этажное здание, торцом к дороге, второе здание от перекрестка Пархоменко-Циолковского</traveldescription> <maxweight>10</maxweight> <acceptcash>YES</acceptcash> <acceptcard>YES</acceptcard> <acceptfitting>YES</acceptfitting> <acceptindividuals>YES</acceptindividuals> <latitude>57.93457</latitude> <longitude>59.95131</longitude> <uid>40606d00-9c51-11eb-b2c9-cfd6c1111392</uid> </pvz> <pvz> <code>245</code> <clientcode>NTG1</clientcode> <name>На Красноармейской</name> <parentcode>6</parentcode> <parentname>Интеграция</parentname> <town code="124267" regioncode="66" regionname="Свердловская область">Нижний Тагил город</town> <address>КРАСНОАРМЕЙСКАЯ, д.79</address> <phone>+7(3435)379-044</phone> <comment>Возможность примерки отсутствует</comment> <worktime>Вс 10:00-16:00, Сб 10:00-16:00, Пн-Пт 10:00-20:00</worktime> <traveldescription>Напротив ТЦ Пирамида</traveldescription> <maxweight>20</maxweight> <acceptcash>YES</acceptcash> <acceptcard>YES</acceptcard> <acceptfitting>NO</acceptfitting> <acceptindividuals>YES</acceptindividuals> <latitude>57.93468</latitude> <longitude>60.55476</longitude> <uid>41116853-9c51-11eb-b2c9-cfd6c1451392</uid> </pvz></pvzlist></source> * '''code''' — Код ПВЗ в системе. Используется в запросе [[API#Оформление заказа|оформления заказов]]* '''clientcode''' — Код ПВЗ используемый компанией-подрядчиком.* '''name''' — Наименование ПВЗ.* '''parentcode''' — Код родительского элемента.* '''parentname''' — Наименование родительского элемента.* '''town''' — Населенный пункт с кодом из [[#Справочник городов|справочника городов]], а также с кодом и наименованием региона.* '''address''' — Адрес ПВЗ.* '''phone''' — Телефоны ПВЗ.* '''comment''' — Дополнительная информация.* '''worktime''' — Режим работы ПВЗ.* '''traveldescription''' — Описание местонахождения ПВЗ или пути к нему.* '''maxweight''' — Максимальный вес, с которым работает ПВЗ.* '''acceptcash''' — Признак приема наличных* '''acceptcard''' — Признак приема банковских карт* '''acceptfitting''' — Наличие примерки* '''latitude''' — Широта* '''longitude''' — Долгота* '''uid''' — Уникальный идентификатор ПВЗ в системе Measoft* '''count''' — Количество записей в ответе* '''totalcount''' — Общее количество записей, отвечающее параметрам запроса == Получение фискальных данных заказа =='''Пример запроса получения фискальных данных:'''<source lang="xml"><?xml version="1.0" encoding="UTF-8"?><receiptdata> <auth extra="8" login="login" pass="pass" /> <orders> <order orderno="123456" /> <order orderno="890111C" /> </orders></receiptdata> </source> '''Пример ответа получения фискальных данных:'''<source lang="xml"> <?xml version="1.0" encoding="UTF-8"?><receipts count="1"> <receipt> <orderno>123456</orderno> <fdDatetime>2020-06-07 12:14:00</fdDatetime> <fdValue>123</fdValue> <fdNum>456</fdNum> <fnSn>789</fnSn> <kktNum>100</kktNum> <inn>222</inn> <ofdUrl>gate.ofd.ru</ofdUrl> <fullUrl>https://check.ofd.ru/123</fullUrl> <price>12345</price> <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"> <service> <code>1</code> <name>Эконом</name> </service> <service> <code>2</code> <name>Срочно</name> </service></services></source> == Справочник дополнительных услуг =='''Пример запроса дополнительных услуг:'''<source lang="xml"><?xml version="1.0" encoding="UTF-8"?><advprices> <auth extra="8" login="login" pass="pass" /></advprices></source> '''advprices''' — Корневой контейнер. Обязательный элемент. '''Пример ответа справочника дополнительных услуг:'''<source lang="xml"><?xml version="1.0" encoding="UTF-8" ?><advprices> <advprice> <code>1</code> <name>Этажей в доме</name> <type>int</type> </advprice> <advprice> <code>2</code> <name>Коэффициент надбавки</name> <type>float</type> </advprice> <advprice> <code>3</code> <name>Расписаться на упаковке</name> <type>bool</type> </advprice></advprices></source> Параметры:* '''code''' — внутренний код услуги* '''name''' — наименование услуги. Если поле «название в ЛК» в настройках услуги не пусто, то возвращает значение поля «название в ЛК».* '''hine''' — подсказка по доп услуге для пользователя* '''type''' — тип услуги. Может иметь значения::* '''bool''' — для услуг вида «чекбокс», «Да»:* '''float''' — для числа с плавающей точкой:* '''int''' — для целого числа == Расчет стоимости доставки =='''Пример запроса стоимости доставки:'''<source lang="xml"><?xml version="1.0" encoding="UTF-8" ?><calculator> <auth extra="8" login="login" pass="pass" /> <order> <pricetype>CUSTOMER</pricetype> <sender> <town>Санкт-Петербург</town> <address>Петровка 38 офис 35</address> <coords lat="55.680327" lon="37.604456"></coords> </sender> <receiver> <zipcode>125480</zipcode> <town regioncode="78" country="RU">Санкт-Петербург</town> <address>Петровка 38 офис 35</address> <pvz>124</pvz> <coords lat="55.680327" lon="37.604456"></coords> </receiver> <weight>5.1</weight> <service>2</service> <paytype>CASH</paytype> <price>387.5</price> <deliveryprice>150</deliveryprice> <inshprice>387.5</inshprice> <packages> <package mass="1" quantity="5"></package> <package mass="2.5" length="10" width="20" height="30"></package> </packages> <userid>user123</userid> <groupid>customer</groupid> </order></calculator></source> Параметры:Структура данных и заполнение полей аналогичны и совместимы с [[#Оформление заказа]]. Дополнительные поля:* '''pricetype''' — тип требуемой цены. Возможные значения: «CUSTOMER» (по-умолчанию) — [[Личный кабинет клиента#Цена доставки для получателя|цена для конечного получателя]], «CLIENT» — цена курьерской службы для клиента.* '''userid''' — Идентификатор пользователя, строковый или числовой тип. Виртуальное поле. Необязательное. Данное поле используется совместно с настройками «Цена доставки для получателя», определяя приоритет правила. Можно использовать в различных CMS/CRM системах, настраивая цены для определенного покупателя.* '''groupid''' — Идентификатор группы пользователя, строковый или числовой тип. Виртуальное поле. Необязательное. Данное поле используется совместно с настройками «Цена доставки для получателя», определяя приоритет правила. Можно использовать в различных CMS/CRM системах, настраивая цены для определенной группы покупателей. Суммы НП и ОЦ, а также тип оплаты CARD имеют значение при настроенных в тарифе на вкладке Прочее долях (в процентах) от данных сумм. В авторизации можно опустить параметры login и pass, тогда расчет будет производиться по стандартному тарифу курьерской службы, без учета возможных отличий для конкретного клиента.<br>Объемный вес будет учитываться только при условии указания всех габаритов: длины, ширины и высоты.<br>В полях город-отправитель и город-получатель можно указывать название города (не рекомендуется!), либо код города из нашего справочника, либо 13-ти значный код КЛАДР, либо 36-ти значный код адресной системы ФИАС (AOID). '''Пример ответа стоимости доставки:'''<source lang="xml"><?xml version="1.0" encoding="UTF-8"?><calculator> <calc> <townfrom code="1">Москва город</townfrom> <townto code="56603">Иркутск город</townto> <mass>3.7</mass> <service name="Экспресс">1</service> <zone>2</zone> <price>1113</price> <mindeliverydays>1</mindeliverydays> <maxdeliverydays>3</maxdeliverydays> <mindeliverydate>2020-05-13</mindeliverydate> <intervals> <workdays> <interval>10:00-16:00</interval> <interval>16:00-22:00</interval> </workdays> <holidays> <interval>12:00-16:00</interval> </holidays> </intervals> <deliveryprice> <advprice code="1" price="1000">База</advprice> <advprice code="4" price="100">Процент от суммы руб</advprice> <advprice code="5" price="63">Процент от объявленной стоимости</advprice> <advprice code="6" price="-50">Скидка при доставке</advprice> </deliveryprice> </calc></calculator></source> Параметры:* '''townfrom''' — Город-отправитель так, как система его распознала и привязала к справочнику. Атрибут '''code''' — код из справочника городов системы.* '''townto''' — Город-получатель так, как система его распознала и привязала к справочнику. Атрибут '''code''' — код из справочника городов системы.* '''mass''' — Масса в килограммах* '''service''' — Режим доставки — число, указывающее на запись в справочнике видов срочности (см описание на этой странице).* '''zone''' — номер тарифной зоны, по которой рассчиталась стоимость. В зависимости от зоны выбирается тарифная сетка. Так же к цене могут применяться повышающие или понижающие коэффициенты при доставке не из/в региональный центр.* '''price''' — рассчитанная стоимость доставки в валюте прайс-листа курьерской службы. Рекомендуется к использованию в отличие от одноименного атрибута родительского контейнера.* '''maxdeliverydays''' — максимальный срок доставки в рабочих днях.* '''mindeliverydate''' — минимальная дата доставки в учетом выходных дней.* '''intervals''' — список интервалов доставки для соответствующей зоны и режима срочности.* '''deliveryprice''' — Данные по составляющим ценам доставки '''''Обратите внимание:''''' В реальном ответе сервера в теге calc присутствует атрибут «price». Он оставлен для обратной совместимости, не используйте его. Пользуйтесь вложенным тегом price. == Получение информации о клиенте =='''Пример запроса получения информации о клиенте:'''<source lang="xml"><?xml version="1.0" encoding="UTF-8" ?><client> <auth extra="8" login="login" pass="pass" /> </client></source> '''client''' — Корневой контейнер. Обязательный элемент.* '''auth''' — Авторизация. Обязательный элемент. '''Пример ответа на запрос получения информации о клиенте:'''<source lang="xml"><?xml version="1.0" encoding="UTF-8" ?><client> <code>1082</code></client></source> * '''code''' — Код клиента == Список актов передачи денег =='''Пример запроса списка актов передачи денег:'''<source lang="xml"><?xml version="1.0" encoding="UTF-8" ?><smalist> <auth extra="8" login="login" pass="pass" /> <datefrom>2016-02-10</datefrom> <dateto>2016-03-10</dateto></smalist></source> '''smalist''' — Корневой контейнер. Обязательный элемент.* '''auth''' — Авторизация. Обязательный элемент.* '''datefrom''' — Дата «с». Необязательный элемент.* '''dateto''' — Дата «по». Необязательный элемент.Если интервал дат не указан, то возвращаются акты передачи денег за последний месяц. '''Пример ответа на запрос списка актов передачи денег:'''<source lang="xml"><?xml version="1.0" encoding="UTF-8"?><smalist count="1"> <sma> <code>6278</code> <number>3992</number> <actdate>2016-02-12</actdate> <datepay></datepay> <dateto>2016-02-12</dateto> <promiseddatepay></promiseddatepay> <price>637.00</price> <pricecorr>113.00</pricecorr> <rur>13430.00</rur> <pricekur>570.00</pricekur> <priceag>67.00</priceag> <payno>42423</payno> <paytype>1</paytype> <paytypename>Безнал</paytypename> <signedcopyreceived>NO</signedcopyreceived> </sma></smalist></source> * '''code''' — Код акта* '''number''' — Номер акта в системе* '''actdate''' — Дата акта* '''datepay''' — Дата оплаты по акту* '''dateto''' — Дата конечного периода для формирования АПД* '''promiseddatepay''' — Плановая дата оплаты* '''price''' — Стоимость услуг* '''pricecorr''' — Сумма корректировки* '''rur''' — Сумма заказа* '''pricekur''' — Стоимость курьерской доставки* '''priceag''' — Агентское вознаграждение* '''payno''' — Номер платежного поручения* '''paytype''' — Тип оплаты: 1 — безнал, 2 — наличными курьером, 3 — наличными в офисе, 4 — перевод на карту* '''paytypename''' — Строковое представление типа оплаты* '''signedcopyreceived''' — Признак факта возврата акта YES/NO == Детализация актов передачи денег =='''Пример запроса детализации актов передачи денег:'''<source lang="xml"><?xml version="1.0" encoding="UTF-8" ?><smadetail> <auth extra="8" login="login" pass="pass" /> <code>6278</code></smadetail></source> '''smadetail''' — Корневой контейнер. Обязательный элемент.* '''auth''' — Авторизация. Обязательный элемент.* '''code''' — Код акта передачи денег (см. запрос списка АПД). Обязательный элемент. '''Пример ответа на запрос детализации актов передачи денег:'''<source lang="xml"><?xml version="1.0" encoding="UTF-8"?><smadetail count="2"> <specialsma> <code>42494</code> <ordercode>14424</ordercode> <orderno>11111</orderno> <orderdate>2018-01-01</orderdate> <delivereddate>2018-10-01</delivereddate> <company>Компания</company> <price>314.00</price> <rur>8800.00</rur> <inshprice>314.00</inshprice> <pricekur>270.00</pricekur> <priceag>44.00</priceag> <pricecalc>8486.00</pricecalc> <paytype>2</paytype> <paytypename>наличными курьером</paytypename> <weight>0.400</weight> <distance>0.0</distance> <status>Доставлено</status> </specialsma></smadetail></source> * '''code''' — Код записи.* '''ordercode''' — Код заказа.* '''orderno''' — Шифр заказа.* '''orderdate''' — Дата заказа.* '''delivereddate''' — Дата доставки.* '''company''' — Получатель.* '''price''' — Стоимость услуг.* '''rur''' — Сумма заказа.* '''inshprice''' — Стоимость заказа.* '''pricekur''' — Стоимость курьерской доставки.* '''priceag''' — Агентское вознаграждение.* '''pricecalc''' — Сумма для передачи агенту.* '''paytype''' — Тип оплаты: 1 — безнал, 2 — наличными курьером, 3 — наличными в офисе, 4 — перевод на карту.* '''paytypename''' — Строковое представление типа оплаты* '''weight''' — Вес заказа.* '''distance''' — Дистанция по заказу* '''status''' — Статус заказа. == Генерация коротких ссылок ==В некоторых случаях, например, при использовании в СМС, может потребоваться использование коротких ссылок на ЛК.Для этого, необходимо отправить запрос с полной ссылкой, в ответ на который придёт хэш-код для ссылки. '''Пример запроса генерации коротких ссылок:'''<source lang="xml"><?xml version="1.0" encoding="UTF-8" ?><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~~- атрибут с текстом ошибки, если она была.

Бутусов

274

правки

Изменения

API

Навигация

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

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

Варианты

Просмотры

Ещё

Поиск

Навигация

Инструменты