Изменения

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

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

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

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

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

'''English version is [[API documentationDocumentation|HERE!]]'''

В системе "Курьерская служба 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]. Обязательно представьтесь, напишите Ваши ваши контактные данные (телефон, скайп) и название компании, с которой Вы вы хотите интегрироваться.

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

|style="text-align: center;"|[httphttps://marketplace.1c-bitrix.ru/solutions/measoft.courier/ Установить] <!-- [httphttps://courierexe.ru/download/api/bitrixmeasoft.zip Скачать Unicode]<br>[http://courierexe.ru/download/api/bitrix_ansicourier.zip Скачать ANSI] -->|Поддерживает версии 1420.5 .0 и выше. Подробнее см. [[Интеграция с другими системами#Bitrix1C-Битрикс|описание]].

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

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

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

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

|Компания PROMO разработала этот модуль и настраивает интеграцию КС 2008 MeaSoft с ADVANTSHOP своим клиентам.|- -->|[[Файл:insales.png|center|x80px]]|style="text-align: center;"|Настраивается в [[Личный кабинет клиента|ЛК пользователя]]|[[InSales|Инструкция по настройке]]

|[[Файл:insalesiiko.pngjpg|center|x44pxx80px]]|style="text-align: center;"|Настраивается в [[http://www.insales.ru/collection/all/product/kurierskaya-sluzhba-2008 УстановитьЛичный кабинет клиента|ЛК пользователя]]|[http://wiki.courierexe.ru/index.php?title=Интеграция_с_другими_системами#Insales Настраивается[Iiko|Инструкция по настройке]] в ЛК пользователя в системе

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

|[[Файл:Retailcrm.png|center|x44pxx30px]]

|[http://wiki.courierexe.ru/index.php?title=Интеграция_с_другими_системами#[RetailCRM |Настраивается]] в ЛК пользователя в системе

|[https://infostart.ru/public/692790/ Альтернативный модуль сторонних разработчиков(1 версия)] [https://infostart.ru/public/1531484/ Альтернативный модуль сторонних разработчиков (2 версия)]

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

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

|rowspan="2"|[[Файл:MoySclad.jpg|center|x44pxx30px]]|style="height:50px; text-align: center;"|[https://home.courierexe.ru/moysklad/step1 ПодключениеНастроить интеграцию с MeaSoft]|[[Интеграция с другими системами#Мой СкладМойСклад|Инструкция]]|-|style="height:50px; text-align: center;"|[https://itmdev.ru/ms/shipping/ Скачать модуль сторонних разработчиков]|Интеграция МойСклад с курьерскими службами от сторонних разработчиков

|style="text-align: center;"|[httphttps://courierexe.ru/download/apiwordpress/wordpress.zip php Скачать]|[[Интеграция с другими системами#Wordpress|Инструкция]]|-|[[Файл:Cscart.png|center|x60px]]|style="text-align: center;"|[https://marketplace.cs-cart.com/measoft-en.html Установить]|Поддерживает версии 4.10 и выше.<br>Внимание! Модуль новый, поэтому возможна некорректная передача данных[[CS-Cart|Инструкция]]|-|[[Файл:webhooks. Проверяйте, если что jpg|center|x100px]]|style="text- сообщайте, исправим!align: center;"|Читайте описание [[Webhook|на этой странице]]|Передача информации о статусах и заказах в вашу систему

'''Обратите внимание!''' В модулях систем PrestaShop и Joomla для отправки заказа в курьерскую службу зайдите в карточку заказа. В карточке отображается специальная форма отправки заказа, а если заказ отправлен, она позволяет проверить его статус:[[Файл:Form.png|150 400 px|мини|Форма отправки заказа|none]] Для отображения списка пунктов выдачи есть [https://home.courierexe.ru/js/measoft_map.js JavaScript модуль]. Инструкция по использованию — внутри. Посмотреть пример работы можно [https://home.courierexe.ru/pvz_test.html здесь].

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

<source lang=xml><auth extra= Тестовый аккаунт "8" login="login" pass="pass"></auth></source>

Для отладки Вы можете зайти в тестовый личный кабинет по адресу [httpsОписание параметров://home.courierexe* '''extra''' — экстра-код, уникальный идентификатор компании, с которой вы интегрируетесь.ru/8 https://home.courierexe.ru/8], * '''login''' — логин: test клиента;* '''pass''' — пароль: testm. Там на закладке "Автоматизация" Вы сможете увидеть свои запросы "глазами" нашей системы. Так же там есть интерфейс для выполнения запросов. На закладке "Отслеживание" Вы увидите созданные заказыклиента;* '''measoftid''' — системная переменная, используемая системой.

Для упрощения интеграции можно скачать Запросите эти данные у курьерской службы, к которой вы подключаетесь. Курьерская служба передает временный пароль, его нужно сменить после первого входа в [[http://courierexe.ru/download/api/php_sample.zip пример обращения к сервису на PHPЛичный кабинет клиента|ЛК клиента]].

== Рабочий аккаунт для подключения Авторизация курьерской службы ==Если курьерской службе требуется подключение под своими учетным данными, используйте строку вида:

1. Описание:* '''Параметр 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;amp; < на &amp;lt; > на &amp;gt; " на &amp;quot;

Наше API принципиально работает только по HTTPS, т.к. так как передает конфиденциальные данные. В некоторых системах с этим возникают проблемы. Если ваша система не может полноценно работать с шифрованием, мы рекомендуем развернуть http-сервер у себя локально, установить [http://courierexe.ru/download/api/proxy.zip прокси на PHP]. <spoiler text="Как запустить">Для теста можете запустить его на сервере следующей командой: php -S <IP>:8080 proxy.phpгде <IP> -  — это адрес вашего сервера, а 8080 порт, на котором будут приниматься запросы.

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

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

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

<item extcode="abc123" quantity="1" mass="0.2" retprice="37.5" VATrate="0" barcode="2345625213125" textArticle="1" article="1" volume="3" origincountry="AUT" GTD="321546654" excise="15.20" suppcompany="ООО &quot;Рога и копыта&quot;" suppphone="79161234567" suppINN="1112223334" govType="2" governmentCode="11223311" extraTags="">Мяч</item>

<item extcode="abc125" quantity="3" mass="0.3" retprice="50" inshprice="50" barcode="2345625213126" itemcode="44123" article="3" type="1">Погремушка желтая</item>

<package strbarcode="ORD0000001" mass="1" message="" quantity="3"></package>

*'''Обязательными на уровне системы являются только 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>

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

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

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

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

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

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

*'''company''' -  — Компания-получатель.*'''person''' -  — Контактное лицо. ''Должно быть заполнено хотя бы одно из полей - полей — company или person!''*'''phone''' -  — Телефон. Можно указывать несколько телефонов, E-mail в этом поле.*'''town''' -  — Город.* '''pvz''' — Код пункта самовывоза по справочнику. Кроме того, ПВЗ можно указать в строке '''''address''''' в виде::* код ПВЗ в нашей системе:* код ПВЗ в системе подрядчика:* наименование ПВЗ в виде строки "ПВЗ " + «Наименование ПВЗ»

Также можно указать страну получателя в атрибуте '''''country''''' в соответствии с [https://ru.wikipedia.org/wiki/ISO_3166-1 стандартом ISO_3166-1], например, "RU"«RU», "RUS" «RUS» или "643" «643» для России.

:* 36-ти значный код адресной системы <rspoiler text="ФИАС">Федеральная информационная адресная система — система — единый российский государственный адресный реестр</rspoiler> (AOID)

*'''coords''' -  — Координаты получателя. Если не указаны, система будет геокодировать самостоятельно.

* '''zipcode''' — Почтовый индекс.* '''price''' — Сумма заказа (наложенный платеж) - денежные средства, которые курьер должен забрать у получателя в пользу заказчика. В случае наличия контейнера items значение этого параметра будет проигнорировано и рассчитано автоматически.* '''inshprice''' — Объявленная ценность. Если явно не указана сумма — автоматически считается как сумма по товарам.* '''deliveryprice''' — Стоимость доставки, которая устанавливается заказчиком и будет взиматься с получателя в пользу заказчика. Не имеет отношения к стоимости доставки самой курьерской службы, которая рассчитывается в соответствии с тарифамии, не указывается при оформлении заказа и добавляется в заказ автоматически при его обработке курьерской службой. В случае наличия контейнера items в него будет добавлено вложение «Доставка».:* '''''VATrate''''' — Ставка НДС — целое число процентов.* '''discount''' — Сумма скидки. Скидка «размазывается» по товарным вложениям, сумма НП уменьшается на сумму скидки. При этом вложение Скидка не создается. ВНИМАНИЕ, при использовании этого тега общая сумма может расходиться на копейки из-за округления! Старайтесь не использовать этот тег, а указывать цену товаров уже с учетом скидок.*'''paytype''' -  — Тип оплаты заказа получателем. Принимает значения::* CASH - CASH — Наличными при получении (по-умолчанию):* CARD - CARD — Картой при получении:* NO - NO — Без оплаты. Этот тип оплаты передается, если заказ уже оплачен и не требует инкассации. API добавит к товарам строку предоплаты в сумму заказа, чтобы общая сумма была 0, однако в кассовом чеке будут все товары с ценами, и оплата предоплатой, как того требует 54-ФЗ.:* OTHER - OTHER — Прочее (Предусмотрен для того, чтобы оплата поступала непосредственно в курьерскую службу посредством прочих типов оплаты - оплаты — таких как: вебмани, яденьги, картой на сайте, прочие платежные системы и ти т.д д.):* OPTION - OPTION — На выбор получателя. Этот тип оплаты нельзя передавать с заказом. Он выставляется автоматически в зависимости от настройки клиента.* '''weight''' — Общий вес заказа в килограммах.* '''quantity''' — Количество мест.* '''service''' — Режим доставки (тип услуги) передается код из справочника «[[#Справочник Видов срочности|Виды срочности]]».* '''type''' — Тип корреспонденции (отправления) передается код из справочника «Типы корреспонденции».* '''return''' — Признак необходимости возврата. Принимает значения::* NO — Возврат не требуется:* YES — Требуется возврат, например, документов:* ONLY — Требуется забрать отправление у поставщика (см. раздел «[[Личный_кабинет_клиента#Привезти ко мне|Привезти ко мне]]»). * '''return_service''' — Режим возврата (тип услуги) передается код из справочника «Виды срочности».* '''return_type''' — Тип возвратной корреспонденции (отправления) передается код из справочника «Типы корреспонденции».* '''return_weight''' — Общий вес возврата заказа в килограммах.* '''enclosure''' — Вложение.* '''instruction''' — Поручение — Примечание.* '''courier''' — Запланированный курьер. Согласно коду курьера в КС2008.* '''receiverpays''' — Признак оплаты стоимости доставки — услуг службы доставки получателем, а не заказчиком YES/NO.* '''department''' — Подразделение, в котором оформляется заказ.* '''costcode''' — Кост-код сотрудника.* '''respstore''' — Код ответственного филиала. Для ответственного филиала в который передается заказ, требуется включение параметра "Разрешить клиенту передавать заказы в этот филиал"* '''pickup''' — Признак оформления забора YES/NO. Если стоит YES, то весь заказ считается заданием на забор груза, а не на доставку! Применяется для вызова курьера к отправителю для забора других отправлений. ''Внимание!'' при добавлении в забор складских товаров, их тип '''''type''''' всегда должен быть установлен как [7] Забор товара, если будет указан другой тип, то он будет исправлен в момент добавления заказа на [7] Забор товара* '''acceptpartially''' — Признак возможности частичного выкупа товаров отправления YES/NO.* '''uid''' - Универсальный идентификатор заказа на стороне отправителя. Не обязательный параметр, ограниченного по времени действия. Время хранения в системе, - сутки.

*'''zipcodeitems''' - Почтовый индекс — Контейнер для описания вложений. <rspoiler text="Необязательный контейнер">Если для поставщика товара в системе MeaSoft не указаны полное наименование компании и ИНН в карточке клиента, заполните параметры <code>suppcompany</code> и <code>suppINN</code> в этом контейнере. Отсутствие информации о поставщике приведет к [[Настройка модуля печати кассовых чеков#Ошибка фискализации (ошибка программирования реквизита 1226)|ошибке фискализации]].</rspoiler>.Атрибуты::*'''weight''item' - Общий вес заказа в килограммах'''' — Название вложения.:*'''return_weight''quantity''' - Общий вес возврата заказа в килограммах'' — Количество единиц товара.:*'''quantity''mass''''' - Количество мест — Масса единицы товара в килограммах.:*'''service''volume''''' - Режим доставки (тип услуги) передается код из справочника [[#Справочник Видов срочности|"Виды срочности"]] — Объемный вес единицы товара в килограммах.При указании объемного веса значение подставляется вместо массы:*'''return_service''length' - Режим возврата '''' — Длина единицы товара (тип услугив сантиметрах) передается код из справочника "Виды срочности".:*'''type''width''''' - Тип корреспонденции  — Ширина единицы товара (отправленияв сантиметрах) передается код из справочника "Типы корреспонденции".:*'''return_type''height' - Тип возвратной корреспонденции '''' — Высота единицы товара (отправленияв сантиметрах) передается код из справочника "Типы корреспонденции".:*'''price''retprice' - Сумма заказа'''' — Цена единицы товара. Округляется до копеек. Должна быть с учетом всех скидок и наценок. В случае наличия контейнера items значение данного параметра будет проигнорированоДля вложений типов 1, 2, и рассчитано автоматически3 не может быть отрицательной.<!-- , либо мы сами посчитаем скидку при указании тега order->discount -->:*'''deliveryprice''inshprice''''' - Сумма доставки — Объявленная ценность единицы товара. Округляется до копеек. В случае наличия контейнера items, в него будет добавлено вложение "Доставка"Если не указана принимается равной '''''retprice'''''.:* '''''VATrate''''' -  — Ставка НДС - НДС — целое число процентов.*Если товар хранится в КС (смотрите '''returnarticle''' ниже), значение берется из номенклатуры. Иначе, если значение указано, берется указанное значение, если нет - Признак необходимости возвратазначение из настроек фирмы КС. Значение «0» означает ставку «Без НДС», ставка «0%» на данный момент не поддерживается.:*'''return_service''barcode' - Режим возврата (тип услуги) передается код из справочника "Виды срочности"'''' — Штрихкод вложения.:*'''discount''article''''' - Сумма скидки — Артикул вложения. Скидка "размазывается" по товарным вложениям''Внимание!'' Указание артикула используется только тогда, сумма НП уменьшается когда товар хранится на сумму скидкиответственном хранении в службе доставки, и необходима комплектация. При В этом вложение Скидка случае система пытается привязать товар к [[API#Справочник номенклатуры|справочнику номенклатуры]]. Если товар в справочнике не создаетсянайден — система выдаст соответствующую ошибку. ВНИМАНИЕЕсли по артикулу найдено несколько товаров — система выберет один из них случайным образом, при использовании этого тега общая сумма что может расходиться привести к ошибочной комплектации! Если товар НЕ на копейки из-за округления! Старайтесь не использовать этот тег, а ответственном хранении — артикул указывать цену товаров уже с учетом скидокНЕ нужно. Позиция попадет в систему просто текстом.:*'''enclosure''itemcode''''' — Внутренний код товара, может использоваться вместо артикула. ''Внимание!'' - ВложениеУказание кода товара используется только тогда, когда товар хранится на ответственном хранении в службе доставки, и необходима комплектация. В этом случае система пытается привязать товар к [[API#Справочник номенклатуры|справочнику номенклатуры]]. Если товар в справочнике не найден — система выдаст соответствующую ошибку. Если товар НЕ на ответственном хранении — код товара указывать НЕ нужно.:*'''inshprice''type'''''  — Тип вложения. Принимает значения::: 1 — Товар. По- Объявленная ценностьумолчанию.:: 2 — Доставка. Такое вложение добавится автоматически, если заполнить order->deliveryprice:: 3 — Услуга:: 4 — Предоплата. Указывается сумма. Поле quantity игнорируется, всегда «1». Если явно не указана В заказе сумма будет отрицательной независимо от знака в запросе. Такое вложение добавится автоматически при указании order- автоматически считается как >paytype=NO.:: 6 — Оплата кредитом. Указывается сумма. Поле quantity игнорируется, всегда «1». В заказе сумма по товарамбудет отрицательной независимо от знака в запросе.:: 7 — Забор товара. Если товар нужно у получателя забрать, возможно — вернуть деньги, или его стоимость вычтется из суммы других товаров. У такого товара в заказе будет отрицательное количество независимо от знака в запросе.:* '''''extcode''''' — Внешний код строки. Используется для идентификации строк заказов при получении статусов. Необязательное поле.:*'''instruction''origincountry' '''' — Код страны-производителя в соответствии со [https://ru.wikipedia.org/wiki/ISO_3166- Поручение 1 стандартом ISO_3166- Примечание1], например, «RU», «RUS» или «643» для России.:*'''courier''GTD''' - Запланированный курьер'' — Номер ГТД.:* '''''excise''''' — Сумма акциза. Согласно коду курьера в КС2008:* '''''suppcompany''''' — Наименование компании поставщика, если отличается от заказчика.:*'''receiverpays''suppphone' - Признак оплаты стоимости доставки - услуг службы доставки получателем'''' — Номер телефона компании поставщика, а не заказчиком YES/NOесли отличается от заказчика.:*'''department''suppINN'''' - Подразделение' — ИНН компании поставщика, в котором оформляется заказесли отличается от заказчика.:*'''pickup''governmentCode''''' — Код товарной номенклатуры. Используется для [[Маркировка|маркированных товаров, например («Честный знак»)]]. Для кода '''Честный знак''' Нужно указывать все данные из нанесенного QR- Признак оформления забора YES/NOкода кроме не читаемых символов (#29). Если стоит YESкод не известен — укажите знак вопроса «?», то весь заказ тогда курьер отсканирует код фактически передаваемого покупателю товара. Для некоторых процессов может использоваться значение «!» — в этом случае курьер сканирует серийный номер товара, но это не считается заданием на забор грузакодом маркировки. При этом, а не на доставкуесли указано значение «?» или «! Применяется для вызова курьера к отправителю для забора других отправлений» и quantity больше 1, то такое вложение растиражируется quantity раз.:*'''acceptpartially''govType' '''' — Тип маркировки товара. В данный момент существуют следующие типы маркировки::: 1 — Честный знак. По- Признак возможности частичного выкупа товаров отправления YES/NOумолчанию.:: 2 — ГИИС ДМДК.:: 3 — Серийный номер.

*'''items''' - Контейнер для описания вложений. Необязательный контейнер. Атрибуты::* '''''item''''' - Название вложения.:* '''''quantity''''' - Количество единиц товара.:* '''''mass''''' - Масса единицы товара в килограммах.:* '''''volume''''' - Объемный вес единицы товара в килограммах. При указании объемного веса значение подставляется вместо массы:* '''''length''''' - Длина единицы товара (в сантиметрах).:* '''''width''''' - Ширина единицы товара (в сантиметрах).:* '''''height''''' - Высота единицы товара (в сантиметрах).:* '''''retprice''''' - Цена единицы товара. Округляется до копеек. Должна быть с учетом всех скидок и наценок. Для вложений типов 1, 2, 3 не может быть отрицательной. <!-- , либо мы сами посчитаем скидку при указании тега order->discount -->:* '''''inshprice''''' - Объявленная ценность единицы товара. Округляется до копеек. Если не указана принимается равной '''''retprice'''''.:* '''''VATrate''''' - Ставка НДС - целое число процентов. Если значение не указано, подставляется значение "20". Значение "0" означает ставку "Без НДС", ставка "0%" на данный момент не поддерживается.:* '''''barcode''''' - Штрих-код вложения. [[Файл:Article.png|thumb|100px|right]]:* '''''articleextraTags''''' - Артикул вложения. ''Внимание!'' Указание артикула используется только тогда, когда товар хранится на ответственном хранении  — Строка в службе доставки, и необходима комплектация. В этом случае система пытается привязать товар к [[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''''' - Код товарной номенклатуры. Используется формате JSON для [[Маркировка | маркированных товаров ("Честный знак")]]. Нужно указывать все данные из нанесенного QR-кода кроме не читаемых символов (#29). Если код не известен - укажите знак вопроса "?", тогда курьер отсканирует код фактически передаваемого покупателю товара. Для некоторых процессов может использоваться значение "!" - отправки в этом случае курьер сканирует серийный номер товара, но это не считается кодом маркировки. Если поле заполнено - поле quantity должно содержать только "1", иначе вернется ошибкаОФД.

*'''packages''' - Контейнер для описания мест. Необязательный контейнер. Атрибуты::* '''''package''''' - Название места.:* '''''code''''' - Внутренний код строки.:* '''''strbarcode''''' - ШтрихТэг 1265 -значение отраслевого реквизита = код места.:* '''''mass''''' - Масса места в килограммах.:* '''''message''''' - Строка сообщения.:* '''''length''''' - Длина единицы товара (в сантиметрах).:* '''''width''''' - Ширина единицы товара (в сантиметрах).:* '''''height''''' - Высота единицы товара (в сантиметрах).деятельности аптеки

* '''deliveryset''' - настройка [[Дифференциальная стоимость доставки | дифференциальной стоимости доставки]]. Атрибуты::* '''''above_price''''' - стоимость в случае полного выкупа заказа (действует как Тэг 1262 – идентификатор ФОИВ = "сумма от020" последней границы, указанной в теге below_sum(константа ФОИВ МИНЗДРАВа):* '''''return_price''''' - стоимость в случае возврата заказа:* '''''VATrate''''' - Ставка НДС - целое число процентов.

* '''below''' - граница стоимости настроек:* '''''below_sum''''' - граница стоимости выкупаемого заказа:* '''''price''''' Тэг 1263 - стоимость выкупаемого заказа до соответствующей границыдата нормативного акта федерального органа исполнительной власти = "14.12.2018" (константа)

* '''advprices''' - Контейнер для описания дополнительных услуг. Необязательный:* '''''code''''' - код услуги:* '''''value''''' Тэг 1264 - значение услуги. Если тип услуги bool, то в значении передаем trueномер нормативного акта федерального органа исполнительной власти = "1556"(константа)

*'''costcode''' :: Тэг 1212 - Кост-код сотрудника.Признак предмета расчета

<source lang="json">"item_industry_props":{"tag1262":"020","tag1263":"14.12.2018","tag1264":"1556","tag1265":"tm=mdlp&sid=00000000XXXXXX"},"tag1212": "1"</source>  * '''packages''' — Контейнер для описания мест. Необязательный контейнер. Атрибуты::* '''''package''''' — Название места.:* '''''code''''' — Внутренний код строки.:* '''''strbarcode''''' — Штрихкод места.:* '''''mass''''' — Масса места в килограммах.:* '''''message''''' — Строка сообщения.:* '''''length''''' — Длина товарного места (в сантиметрах).:* '''''width''''' — Ширина товарного места (в сантиметрах).:* '''''height''''' — Высота товарного места (в сантиметрах).:* '''''quantity''''' — Количество мест с данным набором параметров. Действует ограничение на общее количество мест в заказе. Общее количество мест в заказе не может быть больше 1000. * '''deliveryset''' — настройка [[Дифференцированная стоимость доставки|дифференцированной стоимости доставки]]. Атрибуты::* '''''above_price''''' — стоимость в случае полного выкупа заказа (действует как «сумма от» последней границы, указанной в теге below_sum):* '''''return_price''''' — стоимость в случае возврата заказа:* '''''VATrate''''' — Ставка НДС — целое число процентов. * '''below''' — граница стоимости настроек:* '''''below_sum''''' — граница стоимости выкупаемого заказа:* '''''price''''' — стоимость выкупаемого заказа до соответствующей границы * '''advprices''' — Контейнер для описания дополнительных услуг. Необязательный элемент. <span style="color: red;>Для обработки в API включите дополнительные услуги в настройках полей [[Личный кабинет курьерской службы#Настройка личного кабинета клиента|заказов и заборов]]</span>:* '''''code''''' — код услуги.:* '''''value''''' — значение услуги. Если тип услуги bool, то в значении передаем true. * '''overall_volume''' — Общий объем, м3. Виртуальное поле. Необязательное. Из этого поля рассчитывается длина/высота/ширина места. Расчет срабатывает только если в каждом месте есть нулевые значения длины или высоты или ширины. * '''userid''' — Идентификатор пользователя, строковый или числовой тип. Виртуальное поле. Необязательное. Данное поле используется совместно с настройками «Цена доставки для получателя», определяя приоритет правила. Можно использовать в различных CMS/CRM системах, настраивая цены для определенного покупателя. * '''groupid''' — Идентификатор группы пользователя, строковый или числовой тип. Виртуальное поле. Необязательное. Данное поле используется совместно с настройками «Цена доставки для получателя», определяя приоритет правила. Можно использовать в различных CMS/CRM системах, настраивая цены для определенной группы покупателей. <div style="color: #a94442; background-color: #f2dede; border: 1px solid #ebccd1; padding: 3px 10px 10px;">'''Обратите внимание!'''При передаче заказов, у которых плановая дата доставки/забора меньше ближайшей возможной, дата автоматически меняется на самую раннюю возможную. [[Личный кабинет курьерской службы#Как считается минимальная дата возможной доставки|Подробнее]]</div>  В случае необходимости указания, помимо товаров, дополнительных услуг (например, ДОСТАВКА, комплектация, подъем на этаж и ти т.д д.) -  — их нужно указать в том же контейнере items как товары, без артикула.

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

<createorder orderno="AB23541" barcode="67567#114" error="0" errormsg="successSuccess" errormsgru="Успешно" orderprice="5000"></createorder> <createorder orderno="55_6542AB23542" barcode="67567#115" error="0" errormsg="successSuccess" errormsgru="Успешно" orderprice="6000"></createorder> <createorder orderno="AB23542AB23543" barcode="67567#116" error="0" errormsg="successSuccess" errormsgru="Успешно" orderprice="0"></createorder>

<createorder orderno="AB23541" barcode="67567#114" error="1767" errormsg="Such number Order barcode already existsin the database." errormsgru="Такой штрихкод заказа уже есть в базе."></createorder> <createorder orderno="AB23542" barcode="67567#115" error="1317" errormsg="empty companyOrder number already exists in the database." errormsgru="Такой номер заказа уже есть в базе."></createorder> <createorder orderno="AB23543" barcode="67567#116" error="1467" errormsg="empty personOrder barcode already exists in the database." errormsgru="Такой штрихкод заказа уже есть в базе."></createorder>

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

'''Пример ответа если нет == Запрос статуса заказов'''==

<?xml version="1.0" encoding="utfUTF-8"?><statusreq count> <auth extra="8" login="login" pass="0pass"></auth> <client>CLIENT</client> <orderno>1234</statusreqorderno> <orderno2>5678</sourceorderno2> <ordercode>34234</ordercode>'''Пример ответа при ошибке авторизации''' <givencode>234534</givencode> <uid>af11c7c6-6645-4a20-9604-be911a75722d</uid> <datefrom>2016-07-21<source lang="xml"/datefrom> <?xml version="1.0" encoding="utfdateto>2016-07-8"?21</dateto> <target>Автозавод</target> <done>ONLY_NOT_DONE</done> <changes>ONLY_LAST</changes> <conditions> <requestnamecontains/> <error error="1" errormsg="authorization error"namestarts/> </errorconditions></requeststatusreq>

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

<source lang="xml"><?xml version="1* '''changes''' — может принимать значение только ONLY_LAST.0" encoding="UTF-8"?><request> <error>columnЕсли указан этот параметр, все остальные игнорируются. Описание данного режима приведено здесь:1 line:11 message:expected '>'</error></request></source>[[#Передача только изменившихся статусов|Передача только изменившихся статусов]]

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

* атрибут <div style="color: #a94442; background-color: #f2dede; border: 1px solid #ebccd1; padding: 3px 10px 10px;">'''Обратите внимание!'''got# Периода запроса статусов (контейнеры '''datefrom'' контейнера 'и ''package'dateto'' - признак принятого места YES / NO') ограничивается двумя месяцами — два месяца до даты '''«по»'''.# Если не указаны обе даты — '''dateto''' принимается равной текущей дате.# Если не указана дата '''dateto''' — она принимается равной '''datefrom''' плюс 2 месяца.:* # Если не указана дата '''datefrom''' — она принимается равной 'returns''dateto''' - количество данного товара, от которого отказался получательминус 2 месяца. Не нулевое # Поиск по '''conditions''' работает только для «Номер заказа(шифр)» и только в случае частичного отказа.от 4 символов</div><br>

* '''''coords''''' в контейнере '''receiver''' - координаты получателя.* '''currcoords''' - текущие координаты заказа. Атрибуты::* '''''lat''''' - широта:* '''''lon''''' - долгота:* '''''accuracy''''' - точность в метрах:* '''''RequestDateTime''''' - дата/время последнего обновления координат. * '''courier''' - Данные курьера, которому выдан заказ. Если заказ не выдан, то выводятся данные запланированного курьера.* '''waittime ''' - Время ожидания курьера.* '''deliveryprice''' - Стоимость услуг в валюте расчетов с клиентом. Атрибуты::* '''''total''''' - общая стоимость услуг:* '''''delivery''''' - стоимость доставки "Туда":* '''''return''''' - стоимость доставки "Обратно" (если order->return=YES)Тэг '''deliveryprice''' включает список дополнительных услуг (только для тарифа "Премиум")::* '''''advprice''''' - наименование дополнительной услуги:* '''''code''''' - код дополнительной услуги:* '''''price''''' - стоимость дополнительной услуги * '''status''' - статус доставки (список статусов см. ниже). Атрибуты (заполняются начиная с версии системы 2008.0.0.670)::* '''''eventstore''''' - филиал, к которому относится текущий статус:* '''''eventtime''''' - время события по часовому поясу места его наступления.:* '''''createtimegmt''''' - время по GMT создания записи о смене статуса в БД. Используется для сортировки записей, чтобы соблюсти хронологическую последовательность. <spoiler text="Подробнее">Большинство событий фиксируются в полях eventtime и createtimegmt на основании одного действия, тогда они отличаются только сдвигом от GMT. Однако, если курьер доставил отправление 10.10.2010 в 20:00, по какой-то причине не внес это в мобильное приложение, на следующий день сдал накладную, и в 9 утра оператор внесла, что он доставил вчера в 20:00. Тогда в createtimegmt будет сегодня 6 утра (для Москвы), а в eventtime - вчера в 20:00. При этом оператор по каким-то причинам может внести время вручения раньше, чем какое-то предыдущее событие, т.о. нарушится последовательность времени в eventtime, но при сортировке по createtimegmt все-равно все будет правильно.</spoiler>:* '''''message''''' - наименование филиала-получателя, при передаче между филиалами:* '''''title''''' - русское наименование статуса * '''statushistory''' - история статусов доставки. Содержит список контейнеров '''status'''. Заполняется только для тарифа "Премиум" начиная с версии системы 2008.0.0.670.* '''customstatecode''' - код внутреннего статуса курьерской службы. Значения уточняйте в курьерской службе. Назначаются курьерской службой в разделе "Справочники" - "Статусы" - "15 Статусы корреспонденции". Справочник не передается через API клиенту по причине возможного наличия в нем внутренних технологических статусов курьерской службы.* '''clientstatecode''' - код статуса клиента. Используется, если клиент предлагает свои коды статусов доставки/причин недоставки.* '''deliveredto''' - данные о вручении, либо причина недоставки.* '''delivereddate''' - дата вручения.* '''deliveredtime''' - время вручения. В случае недоставки может быть пустым.* '''outstrbarcode''' - код у подрядчика (код заказа во внешней системе). Используется в интеграциях с внешними системами.  Значения контейнеров '''status''' могут принимать следующие значения:: AWAITING_SYNC - Ожидает синхронизации. Данные заказа пока не появились в бэкофисе: NEW - Новый: PICKUP - Забран у отправителя: ACCEPTED - Получен складом: INVENTORY - Инвентаризация: DEPARTURING - Планируется отправка: DEPARTURE - Отправлено со склада: DELIVERY - Выдан курьеру на доставку: COURIERDELIVERED - Доставлен (предварительно): COMPLETE - Доставлен: PARTIALLY - Доставлен частично: COURIERRETURN - Возвращено курьером. Курьер не смог доставить до получателя, и вернул заказ обратно на склад. Это промежуточный статус, после которого менеджер выясняет, нужно ли пытаться заново доставить заказ, или это окончательная недоставка.: CANCELED - Не доставлен (Возврат/Отмена): RETURNING - Планируется возврат: RETURNED - Возвращен: WMSASSEMBLED - Скомплектован на складе: WMSDISASSEMBLED - Разукомплектован: CONFIRM - Согласована доставка: DATECHANGE - Перенос: NEWPICKUP - Создан забор: UNCONFIRM - Не удалось согласовать доставку: PICKUPREADY - Готов к выдаче: LOST - Утрачен/утерян: COURIERPARTIALLY - Частично со слов курьера: COURIERCANCELED - Отказ со слов курьера ''Примечание:'' В будущем возможно расширение и изменение используемого набора статусов. <div style="color: #a94442; background-color: #f2dede; border: 1px solid #ebccd1; padding: 3px 10px 10px;">Примеры ответов ==='''Обратите внимание!Пример успешного ответа'''

<?xml version="1.0" encoding="UTF-8" ?><statusreqcount="23"> <auth extraorder orderno="8111111" awb="qwerty" orderno2="123123" loginordercode="login34534234" passgivencode="pass2345334"></auth> <changesbarcode>ONLY_LAST111111</changesbarcode> </statusreqsender> <company>МВД</sourcecompany> <person>Иванов И.И.</person>Система выдает все заказы, в которых, с момента последнего запроса в этом режиме, изменилось хотя бы одно из полей: <phone>123-45-67</phone> orderno <contacts> status <phone>+74951234567</phone> delivereddate deliveredtime deliveredto receiver->date receiver->address price После успешной обработки ответа необходимо отметить полученные статусы успешно полученными, отправив запрос </contacts> <source langtown code="xml23432">Санкт-Петербург</town> <?xml version="1.0" encoding="UTF-8" ?address>Петровка 38 офис 35<commitlaststatus/address> <auth extra="8" login="login" pass="pass">date>2014-03-22</authdate> <clienttime_min>CLIENT09:00</clienttime_min> <time_max>14:00</commitlaststatustime_max> </sourcesender> <receiver>'''Описание полей запроса''' <company>МВД</company> <person>Иванов И.И.</person>*'''auth''' <phone>123-45- Авторизация. Обязательный элемент.*'''client''' 67 - Признак клиента или агентаИван (916)234. Необязательный элемент45.:* CLIENT - Признак клиента21 Петр, значение по умолчанию:* AGENT - Признак агентаmvd@mail. В ответ отдается информация по заказам, переданным агенту на доставкуru</phone> <contacts>В случае успеха Вы получите ответ <phone>+74951234567<source lang="xml"/phone> <?xml version="1.0" encoding="UTF-8" ?phone>+79162344521</phone> <commitlaststatus error="0"email>OKmvd@mail.ru</commitlaststatusemail> </sourcecontacts> <inn>1112223335</inn>Данный способ передачи статусов гарантирует полную корректную передачу статусов, даже в случае, если в нашей системе статус изменился в промежутке времени между запросом статусов и подтверждением их получения. Если система не получила подтверждение успешной передачи статуса, она будет считать информацию не переданной, и выдаст ее при повторном запросе. <zipcode>125480</zipcode> <div styletown code="color: #a94442; background153361" regioncode="78" regionname="Санкт-color: #f2dede; border: 1px solid #ebccd1; padding: 3px 10px 10px;Петербург город">'''Обратите внимание!''' # При данном способе передачи (<changes>ONLY_LASTСанкт-Петербург город</changestown> <address>Петровка 38 офис 35</address>) система просматривает заказы, оформленные за последние 3 месяца. Если заказ сделан ранее - изменение статуса по нему не попадет в результат выполнения данного запроса.# Система всегда выдает текущий статус. Т.е. Вы можете одним запросом получить статус "NEW", а следующим - "COMPLETE". В промежутке между запросами отправление могло пройти через несколько промежуточных статусов. Если нужна гарантия получения всех промежуточных статусов, нужно анализировать блок statushistory (может не заполняться в следствии ограничений версии или тарифа конкретной службы доставки). <area>Район 1</area> <pvz># Система никогда не гарантирует последовательность прохождения заказом набора статусов. Т.е. Вы можете получить статус "COMPLETE", а следующим запросом - "NEW" - такое может произойти, например, если оператор ошибочно отметил заказ выполненным, а затем исправил ошибку. <code>126</code> <clientcode>QWERTY</divclientcode> <br /pvz> <date>2014-03-22</date> <time_min>09:00</time_min> <time_max>14:00</time_max> <coords lat== Трекинг заказа по номеру == Запрос трекинга по номеру предназначен для выдачи минимальной обезличенной информации о конкретном заказе не авторизованному пользователю"55. Наша система имеет для этого интерфейс по адресу 680327" lon="home37.courierexe.ru604456"></{код экстра}coords> <deliveryPIN>1234</tracking". Вы можете либо сделать ссылку на такую страницу на своем сайте, либо разместить ее iframe'ом у себя, либо сделать свою и пользоваться нашим API. Этот интерфейс создан специально для выдачи информации живому пользователю сайта. Для получения статусов заказов в свою информационную систему нужно использовать запрос "statusreq", желательно с параметром changes=ONLY_LAST! '''Пример запроса:'''deliveryPIN> <source lang="xml"/receiver> <?xml version="1price>387.0" encoding="UTF-8"?>5<tracking/price> <extrainshprice>8387.5</extrainshprice> <ordernopaytype code="1">1234CASH</ordernopaytype> <weight>5.1</trackingweight> </sourcequantity>2</quantity> '''Пример ответа:''' <source lang="xml"service>2</service> <?xml version="1.0" encoding="UTF-8"?type>3<tracking/type> <order orderno="111111"return>NO</return> <barcodereturn_service>1111112</barcodeservice> <AWBreturn_type>1111113</AWBreturn_type> <senderreturn_weight>5.1</return_weight> <return_message>Доставлено в целости<town code="1" country="RU"/return_message> <pickup>Москва городNO</townpickup> <dateprint_check>2014-03-22YES</dateprint_check> <time_minwaittime>09:0012</time_minwaittime> <time_maxenclosure>14:00Детские игрушки</time_maxenclosure> </senderinstruction> Проверить при покупателе, подписать акт<receiver/instruction> <town codecurrcoords lat="155.680327" countrylon="RU37.604456" accuracy=">Москва город<50" RequestDateTime="2014-04-21 18:07:45"></towncurrcoords> <zipcodecourier>125480 </zipcodecode> <date>2014-03-2226</datecode> <time_minname>09:00Иванов Владимир Петрович</time_minname> <time_maxphone>14:00+79161234567</time_maxphone> </receivercourier> <price>387deliveryprice total="158.5</price> 6" delivery="100.00" return="58.6"> <inshpriceadvprice code="1" price="150">387.5База</inshpriceadvprice> <paytypeadvprice code="2" price="0">CASH% от объявленной стоимости</paytypeadvprice> <weight>5advprice code="3" price="8.16">Топливный сбор</weightadvprice> <quantityadvprice code="4" price="0">2Округление</quantityadvprice> <service>2</servicedeliveryprice> <typereceiverpays>3NO</typereceiverpays> <returnacceptpartially>NO</returnacceptpartially> <return_service>2</service> <return_date></return_date> <return_time></return_time> <return_message></return_messagestatus eventstore="филиал в Санкт-Петербурге" eventtime="2016-06-02 17:22:00" createtimegmt="2016-06-03 16:14:44" message="" title="Доставлен" eventtown="Санкт-Петербург город" color="16777215"> <waittime>12COMPLETE</waittimestatus> <enclosure>Детские игрушки</enclosurestatushistory> <instruction>Проверить при покупателе, подписать акт</instruction> <deliveryprice total=status eventstore="Офис в Москве"158.6" deliveryeventtime="100.002016-05-30 10:20:00" returncreatetimegmt="58.62016-06-03 16:14:44" /> <courier message="" title="Новый" eventtown="Москва город" country="RU"> <code>26NEW</codestatus> <name>Иванов Владимир Петрович</name> <phone>+79161234567</phone> </courier> <currcoords lat=status eventstore="Офис в Москве" eventtime="2016-06-01 17:38:00"55.680327" loncreatetimegmt="37.604456" accuracy="50" RequestDateTime="20142016-0406-21 1803 16:0714:4544" /> <status eventstore message="филиал в Санкт-Петербурге" eventtimetitle="2016-06-02 17:22:00Планируется отправка" createtimegmteventtown="2016-06-03 16:14:44Москва город" messagecountry="" title="ДоставленRU">COMPLETEDEPARTURING</status> <statushistory> <status eventstore="Офис в Москве" eventtime="2016-0506-30 1001 19:2053:00" createtimegmt="2016-06-03 16:14:44" message="филиал в Санкт-Петербурге" title="НовыйОтправлено со склада" eventtown="Москва город" country="RU">NEWDEPARTURE</status> <status eventstore="Офис филиал в МосквеСанкт-Петербурге" eventtime="2016-06-01 1702 07:3841:00" createtimegmt="2016-06-03 16:14:44" message="филиал в " title="Получен складом" eventtown="Санкт-ПетербургеПетербург город" titlecountry="Планируется отправкаRU">DEPARTURINGACCEPTED</status> <status eventstore="Офис филиал в МосквеСанкт-Петербурге" eventtime="2016-06-01 1902 09:5317:00" createtimegmt="2016-06-03 16:14:44" message="филиал в " title="Выдан курьеру на доставку" eventtown="Санкт-ПетербургеПетербург город" titlecountry="Отправлено со складаRU">DEPARTUREDELIVERY</status> <status eventstore="филиал в Санкт-Петербурге" eventtime="2016-06-02 0717:4122:00" createtimegmt="2016-06-03 16:14:44" message="" title="Получен складомДоставлен (предварительно)" eventtown="Санкт-Петербург город" country="RU">ACCEPTEDCOURIERDELIVERED</status> <status eventstore="филиал в Санкт-Петербурге" eventtime="2016-06-02 0917:1722:00" createtimegmt="2016-06-03 16:14:44" message="" title="Выдан курьеру на доставкуДоставлен" eventtown="Санкт-Петербург город" country="RU">DELIVERYCOMPLETE</status> </statushistory> <status eventstore="филиал в Санкт-Петербурге" eventtime="2016-06-02 17:22:00" createtimegmt="customstatecode>2<customstatecode> <clientstatecode></clientstatecode> <deliveredto>Иванова, секр.</deliveredto> <delivereddate>2016-06-03 16:1402</delivereddate> <deliveredtime>17:44" message="" title="Доставлен (предварительно)">COURIERDELIVERED22</statusdeliveredtime> <status eventstore="филиал в Санкт-Петербурге" eventtime="2016-06department>Отдел</department> <costcode>cc12345</costcode> <outstrbarcode>EXT123456</outstrbarcode> <respstore>14</respstore> <partner>Офис на Ленина</partner> <arrival>2016-02 1705-02 23:22:0021</arrival> <receipt fdNum="124555" createtimegmtfnSn="2016-06-03 16:14:449289000100295555" messagekktNum="0001611984048555" titleinn="Доставлен7722756555" fdValue="2899551555" summ="387.5" ofdUrl="gate.ofd.ru">COMPLETEhttps://ofd.ru/rec/7722756555/0001611984048555/9289000100295555/124555/2899551555</statusreceipt> </statushistoryitems> <deliveredto>Иванова, секрitem code="34533" extcode="abc123" quantity="1" mass="0.</deliveredto> <delivereddate>2016-06-02</delivereddate> <deliveredtime>17:22</deliveredtime> <outstrbarcode>EXT123456</outstrbarcode> <items> <item code2" retprice="37.5" VATrate="0" barcode="2345625213125" article="1" returns="0" origincountry="34533040" extcodeGTD="abc123" quantity="1" massexcise="0.200" retpricegovernmentCode="37.511223311" VATratesuppcompany="0Поставщик" barcodesuppINN="23456252131251112223334" articlesuppphone="179161234567" returns=>Мяч</item> <item code="034456" origincountryextcode="040abc124" GTDquantity="2" excisemass="0.002" governmentCoderetprice="11223311100" suppcompanyVATrate="10" barcode="4645625213138" article="Поставщик2" suppINNreturns="11122233340" suppphonegovernmentCode="79161234567">МячОбруч</item> <item code="3445634421" extcode="abc124abc125" quantity="23" mass="20.3" retprice="10050" VATrate="1018" barcode="46456252131382345625213126" itemcode="44123" article="23" returns="0" governmentCode="">ОбручПогремушка желтая</item> </items> <packages> <item package code="3442133331" extcodestrbarcode="abc125ORD0000001" quantitymass="31" massmessage="0.3" retpricegot="50YES" VATrate></package> <package code="1833332" barcodestrbarcode="2345625213126ORD0000002" articlemass="32.5" returnsmessage="0" governmentCodegot="NO">Погремушка желтая</itempackage> </itemspackages> </order></trackingstatusreq> </source> '''Пример ответа если нет заказов''' <source lang="xml"><?xml version="1.0" encoding="utf-8"?><statusreq count="0"></statusreq> </source> '''Пример ответа при ошибке авторизации''' <source lang="xml"><?xml version="1.0" encoding="utf-8"?><request><error error="1" errormsg="authorization error"></error></request>

<tracking17request> <extraerror>8</extra> <ordernocolumn:1 line:11 message:expected '>1234'</ordernoerror></tracking17request>

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

Функция ищет последний заказ по номеру среди заказов всех клиентов. Выдает неперсонализированную информацию о текущем состоянии заказаДля получения только изменившихся статусов отправьте запрос:<source lang="xml"><?xml version="1.0" encoding="UTF-8" ?><statusreq> <auth extra="8" login="login" pass="pass"></auth> <changes>ONLY_LAST</changes> <streamid>1234</streamid><br /statusreq>Описание контейнеров ответа аналогично описанию [[API#.D0.97.D0.B0.D0.BF.D1.80.D0.BE.D1.81_.D1.81.D1.82.D0.B0.D1.82.D1.83.D1.81.D0.B0_.D0.B7.D0.B0.D0.BA.D0.B0.D0.B7.D0.BE.D0.B2|Запроса статусов заказов]].</source>

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

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

=== Описание полей запроса изменения ===Все поля запроса соответствуют структуре order при создании заказа за исключением:* вместо корневого тэга '''neworderauth''' указывается  — авторизация. Обязательный элемент.* '''editorderstreamid''' — идентификатор потока. Если у вас несколько интеграций и каждая нуждается в получении статусов, вы можете передавать данный параметр и тем самым разделять получение и отметку об успешном получении статусов по заказам. Значение должно входить в промежуток от 100 до 10000, включительно. Необязательный элемент.* тэг штрих-кода '''barcodeclient''' не указывается — признак клиента или агента. Необязательный элемент.:* CLIENT — признак клиента, поскольку присваивается при создании заказазначение по умолчанию:* AGENT — признак агента.В ответ отдается информация по заказам, переданным агенту на доставку

В случае успеха вы получите ответ:<source lang="xml"><?xml version="1.0" encoding= Описание полей ответа изменения =="UTF-8" ?><commitlaststatus error="0">OK</commitlaststatus>Все поля ответа соответствуют ответу при создании заказа за исключением корневого тэга - вместо '''neworder''' возвращается '''editorder'''.</source>

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

При отмене == Трекинг заказа поле "Инфо по номеру ==Запрос трекинга по номеру предназначен для выдачи минимальной обезличенной информации о доставке" получает значение "Отменено заказчиком"конкретном заказе не авторизованному пользователю. Наша система имеет для этого интерфейс по адресу «home.courierexe.ru/{код экстра}/tracking». Вы можете либо сделать ссылку на такую страницу на своем сайте, поле "Дата доставки" - текущую датулибо разместить ее [[#Размещение страниц на своем сайте (iframe)|iframe’ом]] у себя, а "Вручил курьер" - системную запись "ОТМЕНА"либо сделать свою и пользоваться нашим API.Этот интерфейс создан специально для выдачи информации живому пользователю сайта. Для получения статусов заказов в свою информационную систему нужно использовать запрос «statusreq», желательно с параметром changes=ONLY_LAST!

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

<?xml version="1.0" encoding="UTF-8" ?><cancelordertracking> <auth extra=">8" login="login" pass="pass" </extra> <order orderno="" ordercode="123456" /> 1234<order /orderno="123aaa" ordercode="" /></cancelordertracking>

<?xml version="1.0" encoding="UTF-8" ?><cancelordertracking> <order orderno="123test111111" ordercode> <barcode>111111</barcode> <AWB>111111</AWB> <sender> <town code="1234561" errorcountry="0RU" errormsg>Москва город</town> <date>2014-03-22</date> <time_min>09:00</time_min> <time_max>14:00</time_max> </sender> <receiver> <town code="OK1" errormsgrucountry="УспешноRU" >Москва город</town> <zipcode>125480</zipcode> <date>2014-03-22</date> <time_min>09:00</time_min> <time_max>14:00</time_max> </receiver> <price>387.5</price> <inshprice>387.5</inshprice> <paytype>CASH</paytype> <weight>5.1</weight> <quantity>2</quantity> <service>2</service> <type>3</type> <return>NO</return> <return_service>2</return_service> <return_date></return_date> <return_time></return_time> <return_message></return_message> <waittime>12</waittime> <order ordernoenclosure>Детские игрушки</enclosure> <instruction>Проверить при покупателе, подписать акт</instruction> <deliveryprice total="123aaa158.6" ordercodedelivery="100.00" errorreturn="52" errormsg="order not found" errormsgru="Заказ не найден58.6" /> <courier> <code>26</code> <name>Иванов Владимир Петрович</cancelordername> <phone>+79161234567</sourcephone> </courier> <currcoords lat="55.680327" lon= Добавление вложений к накладной "37.604456" accuracy="50" RequestDateTime= '''Пример запроса"2014-04-21 18:07:'''45" /> <source langstatus eventstore="филиал в Санкт-Петербурге" eventtime="2016-06-02 17:22:00" createtimegmt="2016-06-03 16:14:44" message="xml"title="Доставлен">COMPLETE</status> <?xml versionstatushistory> <status eventstore="1.0Офис в Москве" eventtime="2016-05-30 10:20:00" encodingcreatetimegmt="UTF2016-806-03 16:14:44" message="" title="Новый" ?>NEW<addattachments/status> <auth extrastatus eventstore="Офис в Москве" eventtime="2016-06-01 17:38:00" createtimegmt="82016-06-03 16:14:44" loginmessage="loginфилиал в Санкт-Петербурге" passtitle="passПланируется отправка" >DEPARTURING</status> <ordernostatus eventstore="Офис в Москве" eventtime="2016-06-01 19:53:00" createtimegmt="2016-06-03 16:14:44" message="филиал в Санкт-Петербурге" title="Отправлено со склада">1234567DEPARTURE</ordernostatus> <status eventstore="филиал в Санкт-Петербурге" eventtime="2016-06-02 07:41:00" createtimegmt="2016-06-03 16:14:44" message="" title="Получен складом">ACCEPTED<attachments/status> <item namestatus eventstore="филиал в Санкт-Петербурге" eventtime="2016-06-02 09:17:00" createtimegmt="2016-06-03 16:14:44" message="" title="photo1.jpgВыдан курьеру на доставку">JVBERi0xLjMN1wb25lbnQgMQ JUBQREYwMTIzNDU2Nzg5IDI NMyAwIG9iag08PA0vVHlwZSA U3VidHlwZSAvSW1hZ2UNL1d pZHRoIDE4MDgNL0hlaWdodCA ggNCAwIFINL0JpdHNQZXJDb 21wb25lbnQgMQ0vRGVjb2RlU ENL0NvbHVtbnMgMTgwOA0+P g0vSW1hZ2VNYXNrIHRydWUNL XhEZWNvZGUNPj4Nc3RyZWFt DQDELIVERY</itemstatus> <item namestatus eventstore="филиал в Санкт-Петербурге" eventtime="2016-06-02 17:22:00" createtimegmt="2016-06-03 16:14:44" message="" title="photo2.jpgДоставлен (предварительно)">VBERi0xLjMNAwIG9iag0HRoJ JUBQREYwMTIzNDU2Nzg5IDI NMyAwIG9iag08PA0vVHlwZSA vWE9iamVjdA0vU3VidHlwZS AvSW1hZ2UNL1dpZHRoIDEzNj gNL0hlaWdodCAxMzMzDS9MZ W5ndGggNCAwIFINL0JpdHNQZ XJDb21wb25lbnQgMQ0vRGVj b2RlUGFybXMgPDwNL0sgLTEN L0NvbHVtbnMgMTM2OA0+Pg0 vSWCOURIERDELIVERED</itemstatus> <status eventstore="филиал в Санкт-Петербурге" eventtime="2016-06-02 17:22:00" createtimegmt="2016-06-03 16:14:44" message="" title="Доставлен">COMPLETE</attachmentsstatus> </addattachmentsstatushistory> <deliveredto>Иванова, секр.</sourcedeliveredto>  '''Описание полей:''' '''addattachments''' <delivereddate>2016- Корневой контейнер. Обязательный элемент.*'''auth''' 06- Авторизация. Обязательный элемент.02</delivereddate>*'''orderno''' - Номер заказа. Обязательный элемент. Может использоваться тэг <deliveredtime>17:22<ordercode/deliveredtime> с указанием внутреннего кода заказа.*'''attachments''' - Обязательный элемент, в котором перечисляются передаваемые данные файлов. <outstrbarcode>EXT123456</outstrbarcode>**'''item''' - Бинарные данные (файл), закодированные в base64. Обязательный элемент. <items>***'''name''' - Атрибут элемента ''' <item''', в котором передается имя файлаcode="34533" extcode="abc123" quantity="1" mass="0. Обязательный элемент2" retprice="37.  '''Пример ответа:'''<source lang5" VATrate="0" barcode="xml2345625213125"><?xml versionarticle="1" returns="0" origincountry="040" GTD="" excise="0.000" governmentCode="11223311" suppcompany="Поставщик" suppINN="1112223334" encodingsuppphone="UTF-879161234567"?>Мяч<addattachments/item> <attachments> <item namecode="34456" extcode="abc124" quantity="2" mass="2" retprice="100" VATrate="10" barcode="photo1.jpg4645625213138" errorarticle="02" errormsgreturns="OK0" errormsgrugovernmentCode="Успешно" >Обруч</item> <item namecode="34421" extcode="abc125" quantity="3" mass="photo20.jpg3" retprice="50" VATrate="18" errorbarcode="02345625213126" errormsgarticle="OK3" errormsgrureturns="Успешно0" governmentCode="">Погремушка желтая</item> </attachmentsitems> </order></addattachmentstracking>

== '''Получение вложений к накладной ==информации в формате 17 TRACK'''

<?xml version="1.0" encoding="UTF-8" ?><attachmentstracking17> <auth extra=">8" login="login" pass="pass" </extra> <orderno>12345671234</orderno></attachmentstracking17>

<source lang=pre>{ "number":"ExtNumber", "oriNumber":"1234", "oriCountry":"RU", "destCountry":"RU", "status":"Complete", "events":[ { "time":"2016-06-02 17:22:00", "location":"RU", "content":"xmlComplete" }, { ">time":"2016-06-02 17:22:00", "location":"RU", "content":"Courierdelivered" }, { "time":"2016-06-02 09:17:00", "location":"RU", "content":"Delivery" }, {<?xml version= "1.0time" encoding=:"UTF2016-806-02 07:41:00"?>, "location":"RU", "content":"Accepted" },<attachments> { <item name= "doc1.docxtime" size=:"356542016-06-01 19:53:00">JVBERi0xLjMN, JUBQREYwMTIzNDU2Nzg5IDI NMyAwIG9iag08PA0vVHlwZSA "location":"RU", U3VidHlwZSAvSW1hZ2UNL1d pZHRoIDE4MDgNL0hlaWdodCA "content":"Departure" ggNCAwIFINL0JpdHNQZXJDb 21wb25lbnQgMQ0vRGVjb2RlU }, ENL0NvbHVtbnMgMTgwOA0+P g0vSW1hZ2VNYXNrIHRydWUNL { XhEZWNvZGUNPj4Nc3RyZWFt DQ</item> "time":"2016-06-01 17:38:00", "location":"RU", <item name= "photo2.jpgcontent" size=:"74861Departuring">VBERi0xLjMN JUBQREYwMTIzNDU2Nzg5IDI NMyAwIG9iag08PA0vVHlwZSA }, { vWE9iamVjdA0vU3VidHlwZS AvSW1hZ2UNL1dpZHRoIDEzNj "time":"2016-05-30 10:20:00", gNL0hlaWdodCAxMzMzDS9MZ W5ndGggNCAwIFINL0JpdHNQZ "location":"RU", XJDb21wb25lbnQgMQ0vRGVj b2RlUGFybXMgPDwNL0sgLTEN "content":"New" L0NvbHVtbnMgMTM2OA0+Pg0 vSW</item> }</attachments> ]}</sourcepre> В тегах item возвращаются бинарные данные (файлы), закодированные в base64.

== Изменение заказа ==Запрос предназначен для изменения заказов. Изменять заказы могут курьерские службы с тарифами «Премиум» и «Максимум». Чтобы разрешить изменение заказов, в личном кабинете курьерской службы перейдите в '''Настройки''' > '''Заказы''' и в разделе '''Отмена и редактирование''' установите флажок '''Разрешить отмену и изменение заказов'''. Вы также можете пометить в списке '''Статусы для отмены и редактирования заказов''' галками статусы корреспонденции, для которых возможны отмена и изменение заказов. По умолчанию (когда в этом списке ничего не выбрано) редактирование и отмена разрешены для статуса «Новый» <div style="color: #a94442; background-color: #f2dede; border: 1px solid #ebccd1; padding: 3px 10px 10px;">'''Обратите внимание!'''# Данные запроса изменения указываются '''полностью''', как если бы заказ создавался впервые.# При отсутствии вложения в запросе изменения данное вложение '''не удаляется''' из заказа позволяет установить окончательный статус , но его количество становится равным 0.# При одновременном изменении заказа - "Доставлен" в API и системе курьерской службы приоритет отдается данным системы курьерской службы. То есть изменения в API приняты не будут.</div> При редактировании заказа может быть отменен запланированный курьер. Это зависит от значения переменной '''Справочники''' > '''Переменные''' > '''Корреспонденция''' > '''Автоматически устанавливать заплан. курьера по району''':* '''Нет''' — при редактировании заказа по АПИ курьер не изменяется;* '''Район''' — если изменен адрес доставки, курьер сбрасывается;* '''Район или дата план. доставки''' — если изменен адрес доставки или "Не доставлен (Возврат/Отмена)"плановая дата вручения, курьер сбрасывается.

Кроме этого=== Описание полей запроса изменения ===Все поля запроса соответствуют структуре order при создании заказа за исключением: * значение '''orderno''' данным методом изменить нельзя.* значение '''barcode''' изменяется в случае явного его указания. В случае отсутствия или пустого значения - остается прежним.* вместо корневого тэга '''neworder''' указывается '''editorder''';* тэг курьера '''courier''' можно изменить только при включенной настройке '''Разрешить изменение курьера по АПИ''';* для вложений '''item''' указывается внутренний код вложения в атрибуте '''code''', который можно получить при получении статуса заказа.* для мест '''package''' указывается внутренний код вложения в атрибуте '''code''', который можно получить при получении статуса заказа.  Необходимо иметь в виду, что: # Заказ нельзя изменить, устанавливается дата и время пока он не синхронизирован с системой (при необходимостипока предыдущие изменения не переданы в бэк-офис) изменения статуса# Удаление вложений и мест выполняется не моментально, а также сообщение в поле процессе синхронизации с бэк-офисом (для записей указываются метки Удалено) === Описание полей ответа изменения ===Все поля ответа соответствуют ответу при создании заказа за исключением корневого тэга — вместо '''neworder''Инфо о доставке'возвращается '''editorder'''. == Отмена заказа ==Запрос предназначен для отмены заказов. Отменять заказы могут курьерские службы с тарифами «Премиум» и «Максимум».Разрешения для отмены заказов и статусы в которых заказы можно отменять описаны в разделе '''Изменение заказов'''

При необходимости к заказу можно прикрепить изображенияотмене заказа поле «Инфо о доставке» получает значение «Отменено заказчиком», поле «Дата доставки» — текущую дату, а «Вручил курьер» — системную запись «ОТМЕНА».

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

<setorderinfocancelorder>

<order orderno="" ordercode="123456"> <message>Получил Иванов</message> </order> <order ordercodeorderno="234567123aaa"> <status>PICKUPREADY</status> <eventtime>2016-05-30 10:20:00</eventtime> <message>Клиент отказался от покупки</message> <paytype>CASH</paytype> <items> <item codeordercode="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></setorderinfocancelorder>

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

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

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

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

<waybilladdattachments>

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

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

<waybilladdattachments> <contentattachments>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</contentattachments></waybilladdattachments>

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

<townlistattachments> <auth extraitem 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</codesearchitem> <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> <limitfrom>30</limitfrom> <limitcount>10</limitcount> <countall>YES</countall>XJDb21wb25lbnQgMQ0vRGVj b2RlUGFybXMgPDwNL0sgLTEN L0NvbHVtbnMgMTM2OA0+Pg0 vSW</limititem></townlistattachments>

Внутри контейнера townlist все элементы могут как отсутствоватьВ тегах item возвращаются бинарные данные (файлы), так и комбинироваться. Поиск не чувствителен к региструзакодированные в base64.

*'''auth''' - Авторизация, необязательный элемент. Используется в случае включенного и настроенного ограничения по населенным пунктам в конкретной курьерской службе== Изменение статуса агентом ==Запрос изменения статуса заказа позволяет установить окончательный статус заказа — «Доставлен» или «Не доставлен (Возврат/Отмена)».

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

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

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

<?xml version="1.0" encoding="UTF-8"?><townlist countsetorderinfo> <auth extra="38" pagelogin="1login" totalcountpass="3" totalpages="1pass"/> <townorder ordercode="123456"> <codemessage>26379Получил Иванов</codemessage> <cityoutstrbarcode> <code>237654312</codeoutstrbarcode> <name>Краснодарский край </nameorder> </cityorder ordercode="234567"> <namestatus>Сочи городPICKUPREADY</namestatus> <fiascodeeventtime>79da737a2016-603b05-4c19-9b54-9114c96fb91230 10:20:00</fiascodeeventtime> <kladrcodemessage>2300000700000Клиент отказался от покупки</kladrcodemessage> <shortname paytype>CASH</paytype> (not yet supported) <typename storeprice>123</storeprice> (not yet supported) <coords latitems> <item code="34533" quantity="1" reason="43.58550" longovernmentCode="39.723111223311" /> <item code="34456" quantity="0" reason="0" /town> <townitem code="34421" quantity="2" reason="0" /> <code>40331</codeitems> <cityimage filename="filename1.jpg"> <code>32</code> <name>Брянская область<9j/name>4AAQSkZJRgA <BAQAAAQABAAD/city>2wBDAA0JCg sKCA0LCgsODg0PEyAVExISEy <name>Сочилов хутор</name>ccHhcgLikxMC4pLSwzOko+M zZGNywtQFdBRkxOUlNSMj5aY <fiascode>c9c96c67-2cc9-4f10-afde-fd32417ea216<VpQYEpRUk//fiascode>2wBDAQ4ODhMR EyYVFSZPNS01T09PT09PT09P <kladrcode>3201900011100</kladrcode>T09PT09PT09PT09PT09PT09 PT09PT09PT09PT09PT09PT09 PT09PT0//wAARCAYACAADAS IA<shortname /image> <typename /order> <coords lat="52.6407" lon="33.1724" /setorderinfo> </townsource> <town> <code>114016</code> <city>'''Описание полей запроса статуса:''' '''setorderinfo''' — Корневой контейнер. Обязательный элемент.* '''auth''' — Авторизация. Обязательный элемент.* '''order''' — Контейнер заказа. Обязательный элемент. Запрос может содержать более одного контейнера '''order'''. Атрибут '''''ordercode''''' — внутренний код заказа. <code>60</code>* '''status''' — Новый статус заказа. Доступны статусы из раздела [[#Описание полей ответа статусов]], кроме AWAITING_SYNC и NEW. <name>Псковская область</name>* '''eventtime''' — Дата и время изменения статуса. Обязательно при указании статуса. </city>* '''message''' — Текст сообщения ''Инфо о доставке''. <name>Сочихино деревня</name>* '''outstrbarcode''' — код у подрядчика (код заказа во внешней системе). Используется в интеграциях с внешними системами. <fiascode>10df7588-19c1-49d1-a387-9de1cf3eb26f<* '''paytype''' — Тип оплаты заказа. Допустимые значения CASH/fiascode>CARD. <kladrcode>6001900015400</kladrcode>* '''storeprice''' — Агентское вознаграждение. <shortname />* '''items''' — Контейнер для описания вложений '''item''' . Атрибуты: <typename />:* '''''code''''' — Код вложения. <coords lat="56:* '''''quantity''''' — Количество доставленных единиц вложения.6003" lon="29:* '''''reason''''' — Причина недоставки, выбирается из соответствующего списка статусов.3542" /> </town>:* '''''governmentCode''''' — Указание кода ТН для вложения при необходимости.</townlist>* '''image''' — Контейнер прикрепляемого изображения. Содержит текст файла изображения, закодированный по стандарту ''base64''. Контейнер '''order''' может содержать более одного контейнера '''image'''. Атрибут:</source>:* '''''filename''''' — Имя файла.

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

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

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

<?xml version="1.0" encoding="UTF-8"?><regionlist count="2"waybill> <city> <code>80<auth extra="8" login="login" pass="pass" /code> <country> <code>1</code> <name>Россия </name> <id>643</id> <ShortName1>RU</ShortName1> <ShortName2>RUS</ShortName2orders> <order orderno="1234567" ordercode="33331" /country> <name>Агинский Бурятский автономный округ<order orderno="1234568" ordercode="33332" /name> </cityorders> <city> <codeform>1</codeform> <country> <code>1</code> <name>Россия</name> <id>643</id> <ShortName1start>RU</ShortName1> <ShortName2>RUS</ShortName2> </country> <name>Адыгея республика</name> 5</citystart></regionlistwaybill>

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

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

<streetlistwaybill> <conditionscontent>EODIcaI8KSBlwQ 4MnEOR7Px8U8EBAyGICBnwpw <town>Москва город</town> IZhQgz0ZxuPs8EBM// ОБЯЗАТЕЛЬНОЕ ПОЛЕ!GcbjzB AwhBl8hwQYIO00GmEwg1CeEG <namecontains>Хохло</namecontains> mqYTChNU0wqf8l8nz4zgc+K fCno+zwU5GjOZmzXGcbEQYIM <namestarts>Академика Х</namestarts> <name>Академика Хохлова</name> <fullname>Академика Хохлова ул.</fullname> 4zkegRE40zWzONyoNNMIOIa cWnp6aDCGEGE9NQmoQd2mg00 <79U4f3hPTwnfp6Sdrafeqpa JDpFw/conditions>1aYT077VNNNdO00G3q <limit> <limitfrom>30</limitfrom> <limitcount>10<mqqvp9p2E7T0/limitcount> <countall>YES</countall> wiFemv8uG6 OM</limitcontent></streetlistwaybill>

*'''limit''' - Ограничивает вывод результатаВ тэге content возвращаются бинарные данные (файл pdf), закодированные в base64.:* '''limitfrom''' - Задает номер При записи результата, начиная с которой выдавать ответ. По-умолчанию - 0.:* '''limitcount'''- Задает количество записей результата, которые нужно вернуть. По-умолчанию - 10000.:* '''countall''' - YES указывает на необходимость подсчета общего количества найденных совпадений. Это может замедлять выполнение запроса. Если отключено - в ответе не указываются totalcount и totalpages.файл необходимо использовать двоичный формат записи!

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

<streetlist count="1" page="1" totalcount="3" totalpages="1"waybill> <streeterror> <name>Академика Хохлова ул.</name> <shortname>Академика Хохлова</shortname> <typename>ул.</typename> Текст ошибки</streeterror></streetlistwaybill>

В ответе улицы сортируются по алфавиту. == Справочник номенклатуры городов == '''Пример запроса справочника номенклатурыгородов:'''

<?xml version="1.0" encoding="UTF-8" ?><itemlisttownlist> <auth extra="8" login="login" pass="pass"/> </authcodesearch> <codesearchzipcode>110000</zipcode> <codekladrcode>1234560100000100800</codekladrcode> <articlefiascode>FD343bd21979d-46f8-49d0-9105-e8d65172a983</articlefiascode> <barcodecode>2345625213125123</barcodecode> </codesearch> <conditions> <conditionscity>Краснодарский край</city> <namecontains>телевизорновгород</namecontains> <namecontainsparts>молоково моск</namecontainsparts> <namestarts>sonyМоск</namestarts> <name>Sony KDL-55W905 ЖК-телевизорМосква</name> <quantityfullname>EXISTING_ONLYМосква город</quantityfullname> <storecountry>21</storecountry> </conditions> <limit> <limitfrom>30</limitfrom> <limitcount>10</limitcount> <countall>YES</countall> </limit></itemlisttownlist>

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

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

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

<itemlist townlist count="3" totalcountpage="31" pagetotalcount="13" totalpages="1"> <itemtown> <code>12345626379</code> <articlecity> <code>23</code> <name>Краснодарский край</name>FD343 </articlecity> <barcodename>2345625213125Сочи город</barcodename> <namefiascode>Sony KDL79da737a-603b-55W905 ЖК4c19-телевизор9b54-9114c96fb912</namefiascode> <kladrcode>2300000700000</kladrcode> <shortname /> (not yet supported) <typename /> (not yet supported) <retpricecoords lat="43.5855" lon="39.7231" />65000 </retpricetown> <town> <purchpricecode>5000040331</purchpricecode> <weightcity> <code>32</code>5.1 <name>Брянская область</name> </weightcity> <lengthname>50Сочилов хутор</lengthname> <widthfiascode>30c9c96c67-2cc9-4f10-afde-fd32417ea216</widthfiascode> <heightkladrcode>403201900011100</heightkladrcode> <CountInPalletshortname />30 <typename /CountInPallet> <HasSerialscoords lat="52.6407" lon="33.1724" />1 </HasSerialstown> <town> <CountryOfOrigincode>Малайзия114016</CountryOfOrigincode> (not yet supported) <Messagecity> <code>60</code> <name>Хороший телевизорПсковская область</Messagename> <Message2/city>Снова хороший телевизор <name>Сочихино деревня</Message2name> <quantityfiascode>1210df7588-19c1-49d1-a387-9de1cf3eb26f</quantityfiascode> <reservedkladrcode>36001900015400</kladrcode> <shortname /reserved> <itemtypename /> . <coords lat="56.6003" lon="29.3542" /> </town></itemlisttownlist>

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

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

<?xml version="1.0" encoding="UTF-8" ?><itemmovementsregionlist> <auth extra="8" login="login" pass="pass"codesearch> <code>77</code> </codesearch> <conditions> <namecontains>край</authnamecontains> <codenamestarts>4259Моск</codenamestarts> <datefromfullname>2020-10-01Московская область</datefromfullname> <country>RU<dateto/country>2020-10-02 </datetoconditions></itemmovementsregionlist>

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

<?xml version="1.0" encoding="UTF-8" ?><itemmovements regionlist count="162"> <itemmovementcity> <code>15150080</code> <date>2017-05-26</date> <retprice>0</retprice> <quantity>1</quantity> <delivered>0</delivered> <item> <code>4259</code> <name>Настольная игра Дженга</name> </item> <status> <code>5</code> <name>Возврат от покупателя</name> </status> <storecountry>

<name>офис в МосквеРоссия</name> </storeid> 643<order/id> <ordercodeShortName1>3374830RU</ordercodeShortName1> <numberShortName2>123660-0RUS</numberShortName2> <date>2017-05-24 </datecountry> <ordernoname>14123Агинский Бурятский автономный округ</ordernoname> <barcode>0000000670 </barcodecity> <company>ТОВАР</companycity> <addresscode>Кравченко ул., 1</addresscode> <delivereddate>2017-05-29</delivereddatecountry> <deliveredtimecode>12:00:001</deliveredtimecode> <deliveredto /name> Россия</order> <documentname> <codeid>21991643</codeid> <numberShortName1>318RU</numberShortName1> <dateShortName2>2017-05-26RUS</dateShortName2> <message> </messagecountry> <name>Адыгея республика</documentname> </itemmovementscity></itemlistregionlist>

== Справочник улиц ==''' Описание полей ответа Пример запроса справочника улиц:'''*'''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>

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

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

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

<?xml version="1.0" encoding="UTF-8" ?><itemdoc> <auth extrastreetlist count="1" page="81" logintotalcount="login3" passtotalpages="pass1"> </authstreet> <code>21991124</code> <name>Академика Хохлова ул.</name> <shortname>Академика Хохлова</shortname> <typename>ул.</typename> </street></itemdocstreetlist>

*'''code''' - внутренний код документа приходной накладной (см. предыдущий запрос)В ответе улицы сортируются по алфавиту.

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

<itemdocitemlist> <auth extra="8" login="login" pass="pass"></auth> <codesearch> <code>21991123456</code> <article>FD343</article> <barcode>2345625213125</barcode> </codesearch> <conditions> <namecontains>телевизор</namecontains> <numbernamestarts>318sony</numbernamestarts> <datename>2017Sony KDL-0555W905 ЖК-26телевизор</name> <quantity>EXISTING_ONLY</datequantity> <messagestore>2</messagestore> <items/conditions> <item except> <code>123478</code="4259" quantity="1" barcode="200300" article="123555">Настольная игра Дженга </except> <limit> <limitfrom>30</limitfrom> <limitcount>10</limitcount> <countall>YES</itemcountall> </itemslimit></itemdocitemlist>

''' Описание полей ответа '''* '''code''' - внутренний код приходной накладнойВнутри контейнера itemlist все элементы могут как отсутствовать, так и комбинироваться. Поиск не чувствителен к регистру.* '''numbercodesearch''' - номер документа* '''date''' - дата документа* '''message''' - комментарий *'''item''' - контейнер товара — Поиск по кодам. В случае использования — контейнеры conditions и limit игнорируются.:* '''code''' - внутренний код товара:* '''barcode''' - штрих-код товара — Поиск по внутреннему коду системы.:* '''article''' - артикул товара — Поиск по артикулу.:* '''quantitybarcode''' - количество поступившего товара — Поиск по штрихкоду.

* '''Пример запроса списка филиаловexcept''' — Описание исключений для корректного определения количества зарезервированной номенклатуры.:* '''code'''<source lang="xml"><?xml version="1 — Код заказа.0" encoding="UTF-8" ?><storelist> <auth extra="8"></auth> <json>YES</json> <client_code>7890</client_code></storelist></source>

*'''authlimit''' - Атрибут '''extra''' - обязателен, по нему определяется курьерская служба — Ограничивает вывод результата.:*'''jsonlimitfrom''' - Признак вывода ответа в виде JSON YES/NO — Задает номер записи результата, начиная с которой выдавать ответ.:*'''client_codelimitcount''' - Код клиента курьерской службы — Задает количество записей результата, которые нужно вернуть.

<?xml version="1.0" encoding="UTF-8" ?><storelist itemlist count="23" totalcount="3" page="1" totalpages="1"> <storeitem> <code>123123456</code> <article>FD343</article> <barcode>2345625213125</barcode> <name>ABCSony KDL-55W905 ЖК-телевизор</name> <retprice>65000</retprice> <purchprice>50000</purchprice> <weight>5.1</weight> <length>50</length> <width>30</width> <height>40</storeheight> <storeVATrate>20</VATrate> <codeCountInPallet>45630</codeCountInPallet> <nameCountInBox>Филиал 2</nameCountInBox> <HasSerials>1</HasSerials> <CountryOfOrigin>Малайзия</CountryOfOrigin> (not yet supported) <Message>Хороший телевизор</Message> <Message2>Снова хороший телевизор</Message2> <quantity>12</quantity> <reserved>3</reserved> </storeitem> ...</storelistitemlist>

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

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

<pvzlistitemmovements>

<code>12344259</code> <client_codedatefrom>78902020-10-01</client_codedatefrom> <towndateto>Нижний Тагил2020-10-02</town> <parentcode>6</parentcode> <acceptcash>YES</acceptcash> <acceptcard>YES</acceptcard> <acceptfitting>YES</acceptfitting> <maxweight>30</maxweight> <acceptindividuals>YES</acceptindividuals> <lt>57.924737</lt> <lg>59.940019</lg> <rt>57.905682</rt> <rg>59.984669</rg> <json>YES</jsondateto></pvzlistitemmovements>

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

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

<pvzlist itemmovements count="216"> <pvzitemmovement> <code>126151500</code> <clientcodedate>32017-05-26</clientcodedate> <nameretprice>Нижний Тагил0</nameretprice> <parentcodequantity>61</parentcodequantity> <parentnamedelivered>Интеграция0</parentnamedelivered> <town code="124267" regioncode="66" regionname="Свердловская область">Нижний Тагил город</townitem> <addresscode>622036, г. Нижний Тагил, ул. Циолковского, д. 174259</addresscode> <phonename>+73435417709, +73435254989Настольная игра Дженга</phonename> <comment>Новый пункт доставки</commentitem> <worktime>Вс 10:00-16:00, Сб 10:00-16:00, Пн-Пт 10:00-20:00</worktimestatus> <traveldescriptioncode>Жилое 5-ти этажное здание, торцом к дороге, второе здание от перекрестка Пархоменко-Циолковского</traveldescriptioncode> <maxweightname>10Возврат от покупателя</maxweightname> <acceptcash>YES</acceptcashstatus> <acceptcard>YES</acceptcardstore> <acceptfittingcode>YES1</acceptfittingcode> <acceptindividualsname>YESофис в Москве</acceptindividualsname> <latitude>57.93457</latitudestore> <longitude>59.95131</longitude> </pvz> <pvzorder> <codeordercode>2453374830</codeordercode> <clientcodenumber>NTG1123660-0</clientcodenumber> <namedate>На Красноармейской2017-05-24</namedate> <parentcodeorderno>614123</parentcodeorderno> <parentnamebarcode>Интеграция0000000670</parentnamebarcode> <town code="124267" regioncode="66" regionname="Свердловская область"company>Нижний Тагил городТОВАР</towncompany> <address>КРАСНОАРМЕЙСКАЯКравченко ул., д.791</address> <phonedelivereddate>+7(3435)3792017-04405-29</phonedelivereddate> <commentdeliveredtime>Возможность примерки отсутствует</comment> <worktime>Вс 10:00-16:00, Сб 10:00-16:00, Пн-Пт 1012:00-20:00</worktimedeliveredtime> <traveldescription>Напротив ТЦ Пирамида <deliveredto /traveldescription> <maxweight>20</maxweightorder> <acceptcash>YES</acceptcashdocument> <acceptcardcode>YES21991</acceptcardcode> <acceptfittingnumber>NO318</acceptfittingnumber> <acceptindividualsdate>YES2017-05-26</acceptindividualsdate> <latitudemessage>57.93468</latitudemessage> <longitude>60.55476</longitudedocument> </pvzitemmovements></pvzlistitemlist>

*'''codeОписание полей ответа ''' - Код ПВЗ в системе. Используется в запросе [[API#Оформление заказа|оформления заказов]]*'''clientcodecode''' - Код ПВЗ используемый компанией-подрядчиком. — внутренний код операции движения*'''namedate''' - Наименование ПВЗ. — дата операции*'''parentcoderetprice''' - Код родительского элемента. — цена товара*'''parentnamequantity''' - Наименование родительского элемента. — количество товара операции*'''towndelivered''' - Населенный пункт с кодом из [[#Справочник городов|справочника городов]], а также с кодом и наименованием региона. — количество доставленного товара*'''address''' - Адрес ПВЗ.*'''phoneitem''' - Телефоны ПВЗ. — контейнер товара:*'''commentcode''' - Дополнительная информация. — внутренний код товара:*'''worktimename''' - Режим работы ПВЗ. — наименование товара*'''traveldescription''' - Описание местонахождения ПВЗ или пути к нему.*'''maxweightstatus''' - Максимальный вес, с которым работает ПВЗ. — контейнер статуса операции:*'''acceptcashcode''' - Признак приема наличных — код статуса:*'''acceptcard''' - Признак приема банковских карт*'''acceptfitting''' - Наличие примерки*'''latitude''' - Широта*'''longitudename''' - Долгота — наименование

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

<receiptdatatariffs> <auth extra="8" login="testlogin" pass="testmpass" /> <townfrom>Москва<orders/townfrom> <service>1<order orderno="123456" /service> <mainonly>1<order orderno="890111C" /mainonly> </orderstariffs></receiptdatasource> * '''auth''' — атрибут '''extra''' обязателен, по нему определяется курьерская служба.* '''townfrom''' — город-отправитель. Если не передан, то городом будет «Москва».* '''service''' — режим доставки. Обязательный элемент.* '''mainonly''' — необязательный элемент. Если передан, то в ответе будут данные только по городам из справочника '''Межгород''' >'''Зоны'''. 

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

'''Пример ответа движения номенклатуры:'''<source lang="xml"><?xml version="1.0" encoding="UTF-8"?><receipts count="1"itemdoc> <receiptcode> <orderno>12345621991</ordernocode> <fdDatetimenumber>2020-06-07 12:14:00318</fdDatetimenumber> <fdValuedate>1232017-05-26</fdValuedate> <fdNummessage>456</fdNummessage> <fnSn>789</fnSnitems> <kktNum>100</kktNum> <inn>222</inn> <ofdUrl>gate.ofd.ru</ofdUrl> <fullUrl>https://check.ofd.ru/123</fullUrl> <price>12345</price> <lines countitem code="4259" quantity="1" barcode="200300" article="123555"> <line> <item>1111764Настольная игра Дженга</item> <name>Сапоги </nameitems> <qty>1</qtyitemdoc> <price>1000</pricesource> <vatRate>20</vatRate> <governmentCode>Z16513LK2</governmentCode> <itemType>1</itemType> </line>''' Описание полей ответа ''' </lines>* '''code''' — внутренний код приходной накладной </receipt>* '''number''' — номер документа</receipts>* '''date''' — дата документа</source>* '''message''' — комментарий

Параметры ответа:*'''orderno''' - Номер заказа*'''fdDatetime''' - Дата и время пробития фискального чека*'''fdValue''' - ФПД (фискальный признак документа)*'''fdNum''' - ФИСКАЛЬНЫЙ ДОКУМЕНТ (фискальный номер чека)*'''fnSn''' - ФН (номер фискального накопителя)*'''kktNum''' - РН (регистрационный номер кассы)*'''inn''' - ИНН*'''ofdUrl''' - URL адрес (доменное имя) ОФД*'''price''' - Сумма чека*'''fullUrl''' - URL чека для просмотра онлайн*'''lines''' - Позиции чека:*'''item''' - код  — контейнер товара:*'''namecode''' - наименование  — внутренний код товара:*'''qtybarcode''' - количество  — штрихкод товара:*'''pricearticle''' - цена  — артикул товара:*'''governmentCodequantity''' - считанная последовательность, которая в дальнейшем преобразуется по алгоритму тега 1162:*'''vatRate''' - НДС товара:*'''itemType''' - тип  — количество поступившего товара (товар, доставка и т.д.)

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

<servicesstorelist> <auth extra="8"></auth> <json>YES</json> <client_code>7890</client_code></servicesstorelist>

* '''auth''' — Атрибут '''extra''' — обязателен, по нему определяется курьерская служба* '''json''' — Признак вывода ответа в виде JSON YES/NO* '''client_code''' — Код клиента курьерской службы '''Пример ответа справочника Видов срочности:'''

<services storelist count="2"> <servicestore> <code>1123</code> <name>ЭкономABC</name> </servicestore> <servicestore> <code>2456</code> <name>СрочноФилиал 2</name> </servicestore></servicesstorelist>

== Справочник дополнительных услуг пунктов самовывоза ==Для отображения списка пунктов выдачи (ПВЗ) есть '''готовый 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"?><advpricespvzlist> <auth extra="8" login="login" pass="pass" ></auth> <code>1234</code> <client_code>7890</client_code> <city>Свердловская область</city> <town regioncode="66" country="RU">Нижний Тагил</town> <address>Щёлковское шоссе</address> <house>77</house> <parentcode>6</parentcode> <acceptcash>YES</acceptcash> <acceptcard>YES</acceptcard> <acceptfitting>YES</acceptfitting> <maxweight>30</maxweight> <acceptindividuals>YES</acceptindividuals> <lt>57.924737</lt> <lg>59.940019</lg> <rt>57.905682</rt> <rg>59.984669</rg> <json>YES</json> <with_coords>YES</with_coords> <limit> <limitfrom>30</limitfrom> <visiblelimitcount>NO2</limitcount> <countall>YES</countall> </visiblelimit></advpricespvzlist>

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

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

<advpricespvzlist count="2" totalcount="40465"> <advpricepvz> <code>1126</code> <clientcode>3</clientcode> <name>Этажей в домеНижний Тагил</name> <typeparentcode>int6</typeparentcode> <parentname>Интеграция</advpriceparentname> <advpricetown code="124267" regioncode="66" regionname="Свердловская область">Нижний Тагил город</town> <codeaddress>2622036, г. Нижний Тагил, ул. Циолковского, д. 17</codeaddress> <namephone>Коэффициент надбавки+73435417709, +73435254989</namephone> <typecomment>floatНовый пункт доставки</typecomment> <worktime>Вс 10:00-16:00, Сб 10:00-16:00, Пн-Пт 10:00-20:00</advpriceworktime> <traveldescription>Жилое 5-ти этажное здание, торцом к дороге, второе здание от перекрестка Пархоменко-Циолковского<advprice/traveldescription> <codemaxweight>310</codemaxweight> <nameacceptcash>Расписаться на упаковкеYES</nameacceptcash> <typeacceptcard>boolYES</typeacceptcard> <acceptfitting>YES</advpriceacceptfitting> <acceptindividuals>YES</advpricesacceptindividuals> <latitude>57.93457</sourcelatitude> Параметры:*'''code''' - внутренний код услуги*'''name''' - наименование услуги. Если поле "название в ЛК" в настройках услуги не пусто, то возвращает значение поля "название в ЛК" <longitude>59.95131</longitude>*'''hine''' <uid>40606d00- подсказка по доп услуге для пользователя*'''type''' 9c51- тип услуги. Может иметь значения::*'''bool''' 11eb- для услуг вида "чекбокс", "Да":*'''float''' b2c9- для числа с плавающей точкойcfd6c1111392</uid>:*'''int''' - для целого числа </pvz> <pvz>== Расчет стоимости доставки == <code>245</code> <clientcode>NTG1</clientcode>'''Пример запроса стоимости доставки:''' <name>На Красноармейской</name> <parentcode>6<source lang="xml"/parentcode> <?xml version="1.0" encoding="UTF-8" ?parentname>Интеграция<calculator/parentname> <auth extratown code="8124267" loginregioncode="login66" passregionname="passСвердловская область" >Нижний Тагил город</town> <address>КРАСНОАРМЕЙСКАЯ, д.79<calc /address> pricetype="CLIENT" <phone>+7(3435)379-044</phone> townfrom="Москва" <comment>Возможность примерки отсутствует</comment> addressfrom="Ленинский проспект <worktime>Вс 10:00-16:00, Сб 10:00-16:00, 95"Пн-Пт 10:00-20:00</worktime> zipcode="664000" <traveldescription>Напротив ТЦ Пирамида</traveldescription> townto="3800000300000" <maxweight>20</maxweight> addressto="Ленина ул., 10" <acceptcash>YES</acceptcash> pvz="123" <acceptcard>YES</acceptcard> l="10" <acceptfitting>NO</acceptfitting> w="20" <acceptindividuals>YES</acceptindividuals> h="30" <latitude>57.93468</latitude> mass="3 <longitude>60.7"55476</longitude> service="1" <uid>41116853-9c51-11eb-b2c9-cfd6c1451392</uid> price="1200" inshprice="1200" paytype="CASH" </pvz></calculatorpvzlist>

Параметры:* '''code''' — Код ПВЗ в системе. Используется в запросе [[API#Оформление заказа|оформления заказов]]*'''pricetypeclientcode'''  — Код ПВЗ используемый компанией- тип требуемой ценыподрядчиком.* '''name''' — Наименование ПВЗ. Возможные значения: "CLIENT" (по-умолчанию) - цена для клиента* '''parentcode''' — Код родительского элемента. "CUSTOMER" - цена для конечного получателя* '''parentname''' — Наименование родительского элемента. (пока не поддерживается)*'''townfromtown''' - Город отправления — Населенный пункт с кодом из [[#Справочник городов|справочника городов]], а также с кодом и наименованием региона.*'''addressfromaddress''' -  — Адрес отправленияПВЗ.* '''phone''' — Телефоны ПВЗ.*'''zipcodecomment''' - Почтовый индекс города назначения — Дополнительная информация.*'''towntoworktime''' - Город назначения — Режим работы ПВЗ.*'''addresstotraveldescription''' - Адрес назначения — Описание местонахождения ПВЗ или пути к нему.*'''pvzmaxweight''' - Код пункта самовывоза по справочнику — Максимальный вес, с которым работает ПВЗ.*'''lacceptcash''' - Длина в сантиметрах (не обязательный параметр) — Признак приема наличных*'''wacceptcard''' - Ширина в сантиметрах (не обязательный параметр) — Признак приема банковских карт*'''hacceptfitting''' - Высота в сантиметрах (не обязательный параметр) — Наличие примерки*'''masslatitude''' - Масса в килограммах — Широта*'''servicelongitude''' - Режим доставки - число, указывающее на запись в справочнике [[#Справочник Видов срочности|видов срочности]]. Если этот параметр опустить, система выдаст расчет для всех доступных видов срочности, передав много контейнеров <calc> в ответе. — Долгота*'''priceuid''' - Сумма наложенного платежа — Уникальный идентификатор ПВЗ в системе Measoft*'''inshpricecount''' - Сумма объявленной ценности — Количество записей в ответе*'''paytypetotalcount''' - Тип оплаты — Общее количество записей, отвечающее параметрам запроса

Суммы НП и ОЦ, а также тип оплаты CARD имеют значение при настроенных в тарифе на вкладке Прочее долях (в процентах) от == Получение фискальных данных сумм. В авторизации можно опустить параметры login и pass, тогда расчет будет производиться по стандартному тарифу курьерской службы, без учета возможных отличий для конкретного клиента.<br>Объемный вес будет учитываться только при условии указания всех габаритов: длины, ширины и высоты.<br>В полях город-отправитель и город-получатель можно указывать название города (не рекомендуется!), либо код города из нашего справочника, либо 13-ти значный код КЛАДР, либо 36-ти значный код адресной системы ФИАС (AOID). заказа =='''Пример ответа стоимости доставкизапроса получения фискальных данных:'''

<calculatorreceiptdata> <calc> <townfrom codeauth extra="8" login="1login">Москва город</townfrom> <townto codepass="56603pass">Иркутск город</townto> <mass>3.7 </massorders> <service nameorder orderno="Экспресс123456">1</service> <zone>2 <order orderno="890111C" /zone> <price>1163 </priceorders> <mindeliverydays>1</mindeliverydaysreceiptdata> <maxdeliverydays>3</maxdeliverydays> <mindeliverydate>2020-05-13</mindeliverydate> </calc></calculator>

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

== Получение информации о клиенте == '''Пример запроса получения информации о клиенте:'''<source lang="xml"><?xml version="1.0" encoding="UTF-8" ?><clientreceipts count="1"> <receipt> <orderno>123456</orderno> <fdDatetime>2020-06-07 12:14:00</fdDatetime> <fdValue>123</fdValue> <fdNum>456<auth extra="8" login="test" pass="testm" /fdNum> <fnSn>789</clientfnSn> <kktNum>100</sourcekktNum> <inn>222</inn>'''client''' - Корневой контейнер <ofdUrl>gate. Обязательный элементofd.ru</ofdUrl>*'''auth''' - Авторизация <fullUrl>https://check. Обязательный элементofd.ru/123</fullUrl> <price>12345</price>'''Пример ответа на запрос получения информации о клиенте:''' <source langlines count="xml1"> <line> <item>1111764</item> <name>Сапоги</name> <qty>1</qty> <price>1000</price> <vatRate>20</vatRate> <?xml version="governmentCode>Z16513LK2</governmentCode> <itemType>1.0" encoding="UTF-8" ?</itemType> <client/line> <code/lines>1082 </codereceipt></clientreceipts>

Параметры ответа:*'''codeorderno''' - Код клиента — Номер заказа* '''fdDatetime''' — Дата и время пробития фискального чека* '''fdValue''' — ФПД (фискальный признак документа)* '''fdNum''' — ФИСКАЛЬНЫЙ ДОКУМЕНТ (фискальный номер чека)* '''fnSn''' — ФН (номер фискального накопителя)* '''kktNum''' — РН (регистрационный номер кассы)* '''inn''' — ИНН* '''ofdUrl''' — URL адрес (доменное имя) ОФД* '''price''' — Сумма чека* '''fullUrl''' — URL чека для просмотра онлайн* '''lines''' — Позиции чека:* '''item''' — код товара:* '''name''' — наименование товара:* '''qty''' — количество товара:* '''price''' — цена товара:* '''governmentCode''' — считанная последовательность, которая в дальнейшем преобразуется по алгоритму тега 1162:* '''vatRate''' — НДС товара:* '''itemType''' — тип товара (товар, доставка и т. д.)

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

<smalistservices> <auth extra="8" login="login" pass="pass" /> <datefrom>2016-02-10</datefrom> <dateto>2016-03-10</dateto></smalistservices>

'''smalistПример ответа справочника видов срочности:''' - Корневой контейнер. Обязательный элемент.*'''auth''' - Авторизация<source lang="xml"><?xml version="1. Обязательный элемент.*'''datefrom''' 0" encoding="UTF- Дата 8"с". Необязательный элемент.?>*'''dateto''' - Дата <services count="по2". Необязательный элемент.> <service> <code>1</code> <name>Эконом</name> </service> <service> <code>2</code> <name>Срочно</name> </service></services>Если интервал дат не указан, то возвращаются акты передачи денег за последний месяц.</source>

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

<smalist countadvprices> <auth extra="8" login="login" pass="1pass"> <sma> <code>6278</code> <number>3992</numberadvprices> <actdate>2016-02-12</actdate> <datepay></datepay> <dateto>2016-02-12</datetosource> <promiseddatepay></promiseddatepay> <price>637'''advprices''' — Корневой контейнер.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 == Детализация актов передачи денег == '''Пример запроса детализации актов передачи денег:'''

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

Параметры:* '''code''' — внутренний код услуги* '''smadetailname''' - Корневой контейнер — наименование услуги. Обязательный элементЕсли поле «название в ЛК» в настройках услуги не пусто, то возвращает значение поля «название в ЛК».*'''authhine''' — подсказка по доп услуге для пользователя* '''type''' - Авторизация. Обязательный элемент — тип услуги.Может иметь значения::* '''bool''' — для услуг вида «чекбокс», «Да»:* '''float''' — для числа с плавающей точкой:*'''codeint''' - Код акта передачи денег (см. запрос списка АПД). Обязательный элемент. — для целого числа

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

<?xml version="1.0" encoding="UTF-8"?><smadetail countcalculator> <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> <specialsmacalc> <townfrom code="1">42494Москва город</townfrom> <townto code="56603">Иркутск город</townto> <ordercodemass>144243.7</ordercodemass> <ordernoservice name="Экспресс">111111</ordernoservice> <orderdatezone>2018-01-012</orderdatezone> <delivereddateprice>2018-10-011113</delivereddateprice> <companymindeliverydays>Компания1</companymindeliverydays> <pricemaxdeliverydays>314.003</pricemaxdeliverydays> <rurmindeliverydate>8800.002020-05-13</rurmindeliverydate> <inshpriceintervals> <workdays> <interval>314.10:00-16:00</inshpriceinterval> <pricekurinterval>270.16:00-22:00</pricekurinterval> </workdays> <holidays> <priceaginterval>44.12:00-16:00</priceaginterval> </holidays> <pricecalc/intervals> <deliveryprice> <advprice code="1" price="1000">База</advprice> <advprice code="4" price="100">Процент от суммы руб</advprice>8486.00 <advprice code="5" price="63">Процент от объявленной стоимости</advprice> <advprice code="6" price="-50">Скидка при доставке</pricecalcadvprice> <paytype/deliveryprice> </calc></calculator>2</paytypesource> Параметры:* '''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" ?> <paytypenameclient>наличными курьером <auth extra="8" login="login" pass="pass" /paytypename> <status/client>Доставлено</statussource> '''client''' — Корневой контейнер. Обязательный элемент.* '''auth''' — Авторизация. Обязательный элемент. '''Пример ответа на запрос получения информации о клиенте:'''<source lang="xml"><?xml version="1.0" encoding="UTF-8" ?><client> <code>1082</specialsmacode></smadetailclient>

 *'''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 - 1 — безнал, 2 - 2 — наличными курьером, 3 - 3 — наличными в офисе, 4 - 4 — перевод на карту.*'''paytypename''' -  — Строковое представление типа оплаты* '''weight''' — Вес заказа.* '''distance''' — Дистанция по заказу*'''status''' -  — Статус заказа. == Генерация коротких ссылок == В некоторых случаях, например, при использовании в СМС, может потребоваться использование коротких ссылок на ЛК.Для этого, необходимо отправить запрос с полной ссылкой, в ответ на который придёт хэш-код для ссылки. '''Пример запроса генерации коротких ссылок:'''<source lang="xml"><?xml version="1.0" encoding="UTF-8" ?><shortlink> <link short="0"> https://home.courierexe.ru/8/site/orders </link></shortlink></source> '''shortlink''' -  — Корневой контейнер. Обязательный элемент.*'''link''' -  — Полная ссылка, для которой необходимо получить код. Обязательный элемент. Если атрибут '''short''' равен 1, то ответ не будет содержать XML, а только хэш-код. '''Пример ответа на запрос генерации коротких ссылок:'''<source lang="xml"><?xml version="1.0" encoding="UTF-8"?><shortlink> <hash>35AF350C</hash></shortlink></source> * '''hash''' — Хэш-код ссылки. Далее, можно использовать ссылку на ЛК: <nowiki>https://home.courierexe.ru/35AF350C или curie.ru/35AF350C</nowiki>  '''Примечание!''' Сервис коротких ссылок работает только для ресурсов компании MeaSoft. == Проверка надежности покупателя ==Проверка надежности работает только для тарифа «Максимум» личного кабинета. <source lang="xml"><?xml version="1.0" encoding="UTF-8" ?><mcheck> <auth extra="8" login="login" pass="pass" /> <phones> <phone>89161147992</phone> </phones></mcheck></source> Ответ: <source lang="xml"><?xml version="1.0" encoding="UTF-8" ?><mcheck> <phones> <phone rate="90">89161147992</phone> </phones></mcheck></source>  == Размещение страниц на своем сайте (iframe) == В некоторых случаях имеет смысл разметить те или иные страницы на своем сайте. Например, чтобы клиенты могли рассчитать стоимость доставки не переходя по внешней ссылке, а там же, на сайте, калькулятор можно разместить прямо на странице такого сайта посредством так называемого фрейма — '''iframe'''. [https://ya.ru/search/?text=iframe Фрейм] — контейнер внутри обычной страницы, который позволяет загружать сторонние страницы. Пример загрузки калькулятора: <source lang="html"><iframe id="frame" src="https://home.courierexe.ru/8/calculator"> Здесь должен отобразиться калькулятор</iframe></source> Для удобства пользователей вашего сайта можно указать язык интерфейса (который переключается непосредственно на сайте) параметром '''lang''': <source lang="html"><iframe id="frame" src="https://home.courierexe.ru/8/calculator?lang=2"> Здесь должен отобразиться калькулятор</iframe></source> Обратите внимание! Если язык не указать, то на страницах калькулятора и трекинга отображается свой переключатель языка. Если язык указан, то переключатель не отоборажается. Поддерживаемые языки и их коды::'''1''' — русский:'''2''' — английский:'''4''' — узбекский == Оформление манифеста == '''Пример запроса на создание манифеста:'''<source lang="xml"><?xml version="1.0" encoding="UTF-8" ?><manifest> <auth extra="8" login="login" pass="pass" /> <store_from>1</store_from> <store_to>2</store_to> <trn_code>3</trn_code> <addresses> <address> <code>456</code> </address> </addresses></manifest></source>  '''manifest''' - Корневой контейнер. Обязательный элемент.*'''auth''' - Авторизация. Обязательный элемент.*'''store_from''' - код филиала отправителя. Обязательный элемент.*'''store_to''' - код филиала получателя. Обязательный элемент.*'''trn_code''' - код перевозчика. Обязательный элемент.  '''Пример успешного ответа'''<source lang="xml"><?xml version="1.0" encoding="UTF-8"?><manifest> <result>OK</result></manifest></source>  '''Пример ответа с ошибкой'''

<shortlinkmanifest> <hashresult error="Текст ошибки">35AF350CERROR</hashresult></shortlinkmanifest>

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