Изменения

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

|[[Файл:prestashop.png|center|x44pxx60px]]|style="text-align: center;"|1.4.5 от 10.10.2018|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;"|[https://courierexe.ru/download/api/opencart.zip Скачать для версии 1.75.5 от 10.08.20181]<br>2.0.0 от 01.12.2018<br>3.1.1 от 28.02.2019|style="text-align: center;"|[httphttps://courierexe.ru/download/api/opencartmeasoft_oc2.ocmod.zip Скачатьдля версии 2.0]<br><br>[httphttps://courierexe.ru/download/api/opencart_2measoft_oc2.3.ocmod.zip Скачатьдля версии 2.3]<br><br>[httphttps://courierexe.ru/download/api/opencart_3measoft_oc3.ocmod.zip Скачатьдля версии 3.0]|Поддерживает версии с 1.5.5.1.<br>Версия 2.0.0 поддерживает Скачивайте модули для своей версии с 2OpenCart.0<br>Подробнее см. [https://opencartforum[OpenCart|описание]].com/files/file/2906-avtomatizaciya-otpravki-i-otslezhivanie-dostavok-courierexe-dlya-opencart-15x/ Альтернативный модуль сторонних разработчиков]

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

<!--|[[Файл:insalesadvantshop.png|center|x44px]]|style="text-align: center;"|1[https://promo-z.2ru/ Сайт компании PROMO]|Компания PROMO разработала этот модуль и настраивает интеграцию MeaSoft с ADVANTSHOP своим клиентам.1 от 06|- -->|[[Файл:insales.09.2017png|center|x80px]]|style="text-align: center;"|Настраивается в [http://www.insales.ru/collection/all/product/kurierskaya-sluzhba[Личный кабинет клиента|ЛК пользователя]]|[[InSales|Инструкция по настройке]]|-2008 Установить]|[http[Файл://wikiiiko.courierexe.ru/index.php?titlejpg|center|x80px]]|style=Интеграция_с_другими_системами#Insales "text-align: center;"|Настраивается] в [[Личный кабинет клиента|ЛК пользователя в системе]]|[[Iiko|Инструкция по настройке]]

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

|[[Файл:Retailcrm.png|center|x44pxx30px]]|style="text-align: center;"|1.0 от 11.01.2018

|[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;"|1.0.0 от 12.11.2018|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://home.courierexeitmdev.ru/moyskladms/shipping/step1 ПодключениеСкачать модуль сторонних разработчиков] [[|Интеграция МойСклад с другими системами#Мой Склад|Инструкция]]|Ожидается в ближайшее время в магазине Мой Складкурьерскими службами от сторонних разработчиков

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

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

'''Обратите внимание!''' В модулях систем '''PrestaShop''', '''OpenCart''', '''OCStore''', '''Webasyst''', '''InSales''' и '''Joomla''' для отправки заказа Для отображения списка пунктов выдачи есть [https://home.courierexe.ru/js/measoft_map.js JavaScript модуль]. Инструкция по использованию — внутри. Посмотреть пример работы можно [https://home.courierexe.ru/pvz_test.html здесь]. == Тестовый аккаунт ==Для отладки зайдите в курьерскую службу необходимо зайти в карточку заказа, в которой должна отображаться форма (смтестовый личный кабинет по адресу [https://home.courierexe.ru/8 https://home. изображение)courierexe. Форма позволяет отправить заказru/8], а если заказ отправлен - проверить его статуслогин: login пароль: pass.

Для отображения списка пунктов выдачи есть '''готовый JavaScript модуль''': упрощения интеграции можно скачать [https://home.courierexe.ru/jsdownload/api/measoft_mapphp_sample.js Инструкция по использованию - внутри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="abc124" quantity="2" mass="2" retprice="100" inshprice="100" VATrate="10" barcode="4645625213138" article="2" length="10" width="20" height="30" origincountry="004">Обруч</item> <item extcode="abc125" quantity="3" mass="0.3" retprice="50" inshprice="50" barcode="2345625213126" itemcode="44123" article="3" type="1">Погремушка желтая</item>

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

<deliveryset above_price="100" return_price="1000" VATrate="10">

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

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

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

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

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

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

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

<source lang="json">"item_industry_props":{"tag1262":"020","tag1263":"14.12.2018","tag1264":"1556","tag1265":"tm=mdlp&sid=00000000XXXXXX"},"tag1212": "1"</source>  *'''paytypepackages''' - Тип оплаты заказа получателем — Контейнер для описания мест. Необязательный контейнер. Принимает значенияАтрибуты::* CASH - Наличными при получении (по-умолчанию)'''''package''''' — Название места.:* CARD - Картой при получении'''''code''''' — Внутренний код строки.:* NO - Без оплаты'''''strbarcode''''' — Штрихкод места.:* '''''mass''''' — Масса места в килограммах. Этот тип оплаты передается, если заказ уже оплачен и не требует инкассации:* '''''message''''' — Строка сообщения. API добавит к товарам строку предоплаты :* '''''length''''' — Длина товарного места (в сумму заказа, чтобы общая сумма была 0, однако сантиметрах).:* '''''width''''' — Ширина товарного места (в кассовом чеке будут все товары с ценами, и оплата предоплатой, как того требует 54-ФЗсантиметрах).:* OTHER - Прочее '''''height''''' — Высота товарного места (Предусмотрен для того, чтобы оплата поступала непосредственно в курьерскую службу посредством прочих типов оплаты - таких каксантиметрах).: вебмани, яденьги, картой * '''''quantity''''' — Количество мест с данным набором параметров. Действует ограничение на сайте, прочие платежные системы и тобщее количество мест в заказе. Общее количество мест в заказе не может быть больше 1000.д * '''deliveryset''' — настройка [[Дифференцированная стоимость доставки|дифференцированной стоимости доставки]].Атрибуты::* '''''above_price''''' — стоимость в случае полного выкупа заказа (действует как «сумма от» последней границы, указанной в теге below_sum):* OPTION - На выбор получателя. Этот тип оплаты нельзя передавать с заказом. Он выставляется автоматически '''''return_price''''' — стоимость в зависимости от настройки клиентаслучае возврата заказа:* '''''VATrate''''' — Ставка НДС — целое число процентов. * '''below''' — граница стоимости настроек:* '''''below_sum''''' — граница стоимости выкупаемого заказа:* '''''price''''' — стоимость выкупаемого заказа до соответствующей границы

*'''zipcodeadvprices''' - Почтовый индекс — Контейнер для описания дополнительных услуг.*'''weight''' - Общий вес заказа в килограммахНеобязательный элемент.*'''return_weight''' - Общий вес возврата заказа <span style="color: red;>Для обработки в килограммах.*'''quantity''' - Количество мест.*'''service''' - Режим доставки (тип API включите дополнительные услуги) передается код из справочника в настройках полей [[Личный кабинет курьерской службы#Справочник Видов срочностиНастройка личного кабинета клиента|"Виды срочности"заказов и заборов]].</span>:*'''return_service''' - Режим возврата (тип услуги) передается код из справочника "Виды срочности".*'code''type''' - Тип корреспонденции (отправления) передается  — код из справочника "Типы корреспонденции"услуги.:*'''return_type''' - Тип возвратной корреспонденции (отправления) передается код из справочника "Типы корреспонденции".*value'''price''' - Сумма заказа. В случае наличия контейнера items  — значение данного параметра будет проигнорировано, и рассчитано автоматическиуслуги.*'''deliveryprice''' - Сумма доставки. В случае наличия контейнера items, в него будет добавлено вложение "Доставка".*'''return''' - Признак необходимости возврата.*'''return_service''' - Режим возврата (Если тип услуги) передается код из справочника "Виды срочности".*'''discount''' - Сумма скидки. Скидка "размазывается" по товарным вложениямbool, сумма НП уменьшается на сумму скидки. При этом вложение Скидка не создается. ВНИМАНИЕ, при использовании этого тега общая сумма может расходиться на копейки из-за округления! Старайтесь не использовать этот тег, а указывать цену товаров уже с учетом скидок.*'''enclosure''' - Вложение.*'''inshprice''' - Объявленная ценность. Если явно не указана сумма - автоматически считается как сумма по товарам.*'''instruction''' - Поручение - Примечание.*'''courier''' - Запланированный курьер. Согласно коду курьера то в КС2008.*'''receiverpays''' - Признак оплаты стоимости доставки - услуг службы доставки получателем, а не заказчиком YES/NO.*'''department''' - Подразделение, в котором оформляется заказ.*'''pickup''' - Признак оформления забора YES/NO. Если стоит YES, то весь заказ считается заданием на забор груза, а не на доставку! Применяется для вызова курьера к отправителю для забора других отправлений.*'''acceptpartially''' - Признак возможности частичного выкупа товаров отправления YES/NOзначении передаем true.

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

*'''packagesuserid''' - Контейнер для описания мест — Идентификатор пользователя, строковый или числовой тип. Необязательный контейнерВиртуальное поле. Атрибуты::* '''''package''''' - Название местаНеобязательное.:* '''''code''''' - Внутренний код строки.:* '''''strbarcode''''' - Штрих-код местаДанное поле используется совместно с настройками «Цена доставки для получателя», определяя приоритет правила.:* '''''mass''''' - Масса места Можно использовать в килограммах.:* '''''message''''' - Строка сообщения.:* '''''length''''' - Длина единицы товара (в сантиметрах).:* '''''width''''' - Ширина единицы товара (в сантиметрах).:* '''''height''''' - Высота единицы товара (в сантиметрах)различных CMS/CRM системах, настраивая цены для определенного покупателя.

* '''deliverysetgroupid''' - настройка [[Дифференциальная стоимость  — Идентификатор группы пользователя, строковый или числовой тип. Виртуальное поле. Необязательное. Данное поле используется совместно с настройками «Цена доставки | дифференциальной стоимости доставки]]для получателя», определяя приоритет правила. Атрибуты::* '''''above_price''''' - стоимость Можно использовать в случае полного выкупа заказа (действует как "сумма от" последней границыразличных CMS/CRM системах, указанной в теге below_sum):* '''''return_price''''' - стоимость в случае возврата заказанастраивая цены для определенной группы покупателей.

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

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

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

=== Описание полей запроса статуса ==='''Пример ответа 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 error="1" errormsg="authorization error"></error></request></source>Если указан этот параметр, все остальные игнорируются. Описание данного режима приведено здесь: [[#Передача только изменившихся статусов|Передача только изменившихся статусов]]

* '''Пример ответа при ошибке синтаксисаconditions''' <source lang="xml"><?xml version="1 — Задает условия фильтрации по «orderno».0" encoding="UTF-8"?><request> <error>column:1 line:11 message:expected '>'</error></request></source> === Описание полей ответа статусов ===Все поля ответа соответствуют структуре order при создании заказа, с некоторыми добавлениями: * Атрибуты контейнера '''order'''::* '''''awb''''' - Номер накладной в системе курьерской службы.:* '''''orderno2''''' - Номер накладной в подсистеме срочной доставки курьерской службывложенные элементы одновременно накладывают условие «И».Минимум 5 символов!:* '''''ordercodenamecontains''''' - внутренний код  — Поиск по номеру заказа в системе(шифр), применяется для некоторых внутренних операцийкоторый содержит «orderno».:* '''''givencode''namestarts''' - внутренний код  — Поиск по номеру заказа в системе(шифр), применяется для некоторых внутренних операций. * атрибут '''''code''''' контейнера '''item''' - внутренний код строки заказа в системе, применяется для некоторых внутренних операций.:* '''''returns''''' - количество данного товара, от которого отказался получатель. Не нулевое только в случае частичного отказа. * атрибут '''''got''''' контейнера '''package''' - признак принятого места YES / NO.:* '''''returns''''' - количество данного товара, от которого отказался получатель. Не нулевое только в случае частичного отказа. * '''''coords''''' в контейнере '''receiver''' - координаты получателя.* '''currcoords''' - текущие координаты заказа. Атрибуты::* '''''lat''''' - широта:* '''''lon''''' - долгота:* '''''accuracy''''' - точность в метрах:* '''''RequestDateTime''''' - дата/время последнего обновления координаткоторый начинается с «orderno».

 # Атрибуты контейнера Периода запроса статусов (контейнеры '''datefrom''' и '''dateto'''status) ограничивается двумя месяцами — два месяца до даты ''' заполняются для версий системы «по»'''2008.0# Если не указаны обе даты — '''dateto''' принимается равной текущей дате.0.670# Если не указана дата '''dateto''' — она принимается равной '''datefrom''' и новееплюс 2 месяца.# Контейнер Если не указана дата '''statushistorydatefrom''' заполняется для тарифа "[[Личный_кабинет#.D0.9F.D0.BE.D0.B4.D0.BA.D0.BB.D1.8E.D1.87.D0.B5.D0.BD.D0.B8.D0.B5|Премиум]]" и версий системы  — она принимается равной '''2008.0.0.670dateto''' и новееминус 2 месяца.# Контейнер Поиск по '''deliverypriceconditions''' заполняется работает только для тарифа "[[Личный_кабинет#.D0.9F.D0.BE.D0.B4.D0.BA.D0.BB.D1.8E.D1.87.D0.B5.D0.BD.D0.B8.D0.B5|Премиум]]".«Номер заказа(шифр)» и только от 4 символов

<br />

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

<?xml version="1.0" encoding="UTF-8" ?><statusreqcount="23"> <auth extraorder orderno="111111" awb="8qwerty" orderno2="123123" loginordercode="login34534234" passgivencode="pass2345334"> <barcode>111111</authbarcode> <sender> <changescompany>ONLY_LASTМВД</changescompany> <person>Иванов И.И.</statusreqperson> <phone>123-45-67</sourcephone> <contacts>Система выдает все заказы, в которых, с момента последнего запроса в этом режиме, изменилось хотя бы одно из полей: <phone>+74951234567</phone> orderno </contacts> status delivereddate deliveredtime deliveredto receiver <town code="23432">Санкт-Петербург</town>date receiver-> <address price После успешной обработки ответа необходимо отметить полученные статусы успешно полученными, отправив запрос>Петровка 38 офис 35<source lang="xml"/address> <?xml version="1.0" encoding="UTF-8" ?date>2014-03-22</date> <commitlaststatustime_min>09:00</time_min> <auth extra="8" login="login" pass="pass"time_max>14:00</time_max> </authsender> <receiver> <clientcompany>CLIENTМВД</clientcompany> <person>Иванов И.И.</commitlaststatusperson> </sourcephone> '''Описание полей запроса''' *'''auth''' 123-45-67 - АвторизацияИван (916)234. Обязательный элемент45.21 Петр,mvd@mail.ru</phone>*'''client''' - Признак клиента или агента. Необязательный элемент.:* CLIENT - Признак клиента, значение по умолчанию:* AGENT - Признак агента. В ответ отдается информация по заказам, переданным агенту на доставку В случае успеха Вы получите ответ <source lang="xml"contacts> <?xml version="1.0" encoding="UTF-8" ?phone>+74951234567</phone> <commitlaststatus error="0"phone>OK+79162344521</commitlaststatusphone> </sourceemail>mvd@mail.ru</email> </contacts>Данный способ передачи статусов гарантирует полную корректную передачу статусов, даже в случае, если в нашей системе статус изменился в промежутке времени между запросом статусов и подтверждением их получения. Если система не получила подтверждение успешной передачи статуса, она будет считать информацию не переданной, и выдаст ее при повторном запросе. <inn>1112223335</inn> <zipcode>125480</zipcode> <div styletown code="153361" regioncode="78" regionname="color: #a94442; backgroundСанкт-color: #f2dede; border: 1px solid #ebccd1; padding: 3px 10px 10px;Петербург город">Санкт-Петербург город</town>'''Обратите внимание!''' <address>Петровка 38 офис 35</address> # При данном способе передачи ( <changesarea>ONLY_LASTРайон 1</changesarea> <pvz>) система просматривает заказы, оформленные за последние 3 месяца. Если заказ сделан ранее - изменение статуса по нему не попадет в результат выполнения данного запроса.# Система всегда выдает текущий статус. Т.е. Вы можете одним запросом получить статус "NEW", а следующим - "COMPLETE". В промежутке между запросами отправление могло пройти через несколько промежуточных статусов. Если нужна гарантия получения всех промежуточных статусов, нужно анализировать блок statushistory (может не заполняться в следствии ограничений версии или тарифа конкретной службы доставки). <code>126</code># Система никогда не гарантирует последовательность прохождения заказом набора статусов. Т.е. Вы можете получить статус "COMPLETE", а следующим запросом - "NEW" - такое может произойти, например, если оператор ошибочно отметил заказ выполненным, а затем исправил ошибку. <clientcode>QWERTY</clientcode> </divpvz> <date>2014-03-22<br /date> <time_min>09:00</time_min>  <time_max>14:00</time_max> <coords lat="55.680327" lon= Трекинг заказа по номеру == Запрос трекинга по номеру предназначен для выдачи минимальной обезличенной информации о конкретном заказе не авторизованному пользователю"37. Наша система имеет для этого интерфейс по адресу 604456"home.courierexe.ru></{код экстра}coords> <deliveryPIN>1234</tracking"deliveryPIN> </receiver> <price>387. Вы можете либо сделать ссылку на такую страницу на своем сайте, либо разместить ее iframe'ом у себя, либо сделать свою и пользоваться нашим API5</price> <inshprice>387. Этот интерфейс создан специально для выдачи информации живому пользователю сайта. Для получения статусов заказов в свою информационную систему нужно использовать запрос 5</inshprice> <paytype code="statusreq1", желательно с параметром changes=ONLY_LAST!>CASH</paytype> <weight>5.1</weight>'''Пример запроса:''' <source lang="xml"quantity>2</quantity> <?xml version="1.0" encoding="UTF-8"?service>2<tracking/service> <extratype>83</extratype> <ordernoreturn>1234NO</ordernoreturn> <return_service>2</trackingservice> <return_type>3</sourcereturn_type> '''Пример ответа:''' <return_weight>5.1<source lang="xml"/return_weight> <?xml version="1.0" encoding="UTF-8"?return_message>Доставлено в целости</return_message> <trackingpickup>NO</pickup> <print_check>YES<order orderno="1234"/print_check> <waittime>12<sender/waittime> <town code="1" country="RU"enclosure>Москва городДетские игрушки</townenclosure> <dateinstruction>Проверить при покупателе, подписать акт</dateinstruction> </sender> <receiver> <town codecurrcoords lat="155.680327" countrylon="RU37.604456">Москва город</town> <date>2015accuracy="50" RequestDateTime="2014-04-21 18:07:45"></datecurrcoords> <courier> <code>26</receivercode> <AWBname>BarCodeИванов Владимир Петрович</AWBname> <weightphone>0+79161234567</weightphone> <quantity>1 </quantitycourier> <currcoords latdeliveryprice total="158.6" londelivery="100.00" return=" accuracy58.6"> <advprice code="1" RequestDateTimeprice="150" >База</advprice> <status eventstoreadvprice code="филиал в Санкт-Петербурге2" eventtimeprice="2016-06-02 17:22:000" createtimegmt>% от объявленной стоимости</advprice> <advprice code="2016-06-03 16:14:44" message3" price="8.6" title>Топливный сбор</advprice> <advprice code="Доставлен4" countryprice="RU0">COMPLETEОкругление</statusadvprice> </deliveryprice> <receiverpays>NO</receiverpays> <acceptpartially>NO<statushistory/acceptpartially> <status eventstore="Офис филиал в МосквеСанкт-Петербурге" eventtime="2016-0506-30 1002 17:2022:00" createtimegmt="2016-06-03 16:14:44" message="" title="НовыйДоставлен" eventtown="Санкт-Петербург город" countrycolor="RU16777215">NEWCOMPLETE</status> <statushistory> <status eventstore="Офис в Москве" eventtime="2016-0605-01 1730 10:3820:00" createtimegmt="2016-06-03 16:14:44" message="филиал в Санкт-Петербурге" title="Планируется отправкаНовый" eventtown="Москва город" country="RU">DEPARTURINGNEW</status> <status eventstore="Офис в Москве" eventtime="2016-06-01 1917:5338:00" createtimegmt="2016-06-03 16:14:44" message="филиал в Санкт-Петербурге" title="Отправлено со складаПланируется отправка" eventtown="Москва город" country="RU">DEPARTUREDEPARTURING</status> <status eventstore="филиал Офис в Санкт-ПетербургеМоскве" eventtime="2016-06-02 0701 19:4153:00" createtimegmt="2016-06-03 16:14:44" message="" titleфилиал в Санкт-Петербурге" title="Отправлено со склада" eventtown="Получен складомМосква город" country="RU">ACCEPTEDDEPARTURE</status> <status eventstore="филиал в Санкт-Петербурге" eventtime="2016-06-02 0907:1741:00" createtimegmt="2016-06-03 16:14:44" message="" title="Выдан курьеру на доставкуПолучен складом" eventtown="Санкт-Петербург город" country="RU">DELIVERYACCEPTED</status> <status eventstore="филиал в Санкт-Петербурге" eventtime="2016-06-02 09:17:22:00" createtimegmt="2016-06-03 16:14:44" message="" title="Доставлен (предварительно)Выдан курьеру на доставку" countryeventtown="RUСанкт-Петербург город" country="RU">COURIERDELIVEREDDELIVERY</status> <status eventstore="филиал в Санкт-Петербурге" eventtime="2016-06-02 17:22:00" createtimegmt="2016-06-03 16:14:44" message="" title="Доставлен(предварительно)" eventtown="Санкт-Петербург город" country="RU">COMPLETECOURIERDELIVERED</status> </statushistory> </order></tracking></source>  '''Получение информации status eventstore="филиал в формате 17 TRACK''' '''Пример запроса:'''<source langСанкт-Петербурге" eventtime="xml"><?xml version=2016-06-02 17:22:00"1.0" encodingcreatetimegmt="UTF2016-8"?>06-03 16:14:44"<tracking17 message="" title="Доставлен" eventtown="Санкт-Петербург город" country="RU"> COMPLETE<extra/status>8 </extrastatushistory> <ordernocustomstatecode>12342</ordernocustomstatecode> <clientstatecode></tracking17clientstatecode> <deliveredto>Иванова, секр.</sourcedeliveredto> <delivereddate>2016-06-02</delivereddate>'''Пример ответа:''' <predeliveredtime>{ "number"17:"ExtNumber",22</deliveredtime> "oriNumber":"1234", <department>Отдел</department> "oriCountry":"RU", <costcode>cc12345</costcode> "destCountry":"RU", <outstrbarcode>EXT123456</outstrbarcode> "status":"Complete", <respstore>14</respstore> "events":[ <partner>Офис на Ленина</partner> { "time":" <arrival>2016-0605-02 1723:22:0021</arrival> <receipt fdNum=", 124555"locationfnSn=":9289000100295555"RUkktNum=", 0001611984048555"contentinn=":7722756555"CompletefdValue=" }, { 2899551555"timesumm=":387.5"2016-06-02 17:22:00ofdUrl=", "locationgate.ofd.ru">https://ofd.ru/rec/7722756555/0001611984048555/9289000100295555/124555/2899551555</receipt> <items> <item code="RU", "content34533":extcode="Courierdeliveredabc123" }, { quantity="time1":mass="2016-06-02 09:17:000.2", retprice="location37.5":VATrate="RU0", barcode="content2345625213125":article="Delivery1" }, { returns="time0":origincountry="2016-06-02 07:41:00040", GTD="location":excise="RU0.00", governmentCode="content11223311":suppcompany="AcceptedПоставщик" }, { suppINN="time1112223334":suppphone="2016-06-01 19:53:0079161234567",>Мяч</item> "location <item code=":34456" extcode="RUabc124", quantity="content2":mass="Departure2" }, { retprice="100"timeVATrate=":10"2016-06-01 17:38:00barcode=", 4645625213138"locationarticle=":2"RUreturns=", 0"contentgovernmentCode=":"Departuring">Обруч</item> }, { <item code="time34421":extcode="2016-05-30 10:20:00abc125", quantity="location3":mass="RU0.3", retprice="50" VATrate="18" barcode="2345625213126" itemcode="44123" article="3"contentreturns=":0" governmentCode="New" } ]}>Погремушка желтая</preitem> </items> <packages> <package code="33331" strbarcode="ORD0000001" mass="1" message="" got="YES"></package> <package code="33332" strbarcode="ORD0000002" mass="2.5" message="" got="NO"></package> </packages> </order></statusreq> </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></source>

Функция ищет последний заказ по номеру среди заказов всех клиентов. Выдает неперсонализированную информацию о текущем состоянии заказа.<br />Описание контейнеров '''Пример ответа аналогично описанию [[API#.D0.97.D0.B0.D0.BF.D1.80.D0.BE.D1.81_.D1.81.D1.82.D0.B0.D1.82.D1.83.D1.81.D0.B0_.D0.B7.D0.B0.D0.BA.D0.B0.D0.B7.D0.BE.D0.B2|Запроса статусов заказов]].при ошибке синтаксиса'''

== Изменение заказа = Описание полей ответа статусов ===Все поля ответа соответствуют структуре order при создании заказа, с некоторыми добавлениями:

Запрос предназначен для изменения заказов, находящихся * Атрибуты контейнера '''order'''::* '''''awb''''' — Номер накладной в системе курьерской службы.:* '''''orderno2''''' — Номер накладной в статусах "Ожидает синхронизации" или "Новый", а также по которым не было произведено изменений - статуса корреспонденции, времени подсистеме срочной доставки - то есть заказовкурьерской службы.:* '''''ordercode''''' — внутренний код заказа в системе, которые ещё не находятся применяется для некоторых внутренних операций.:* '''''givencode''''' — внутренний код заказа в работесистеме, применяется для некоторых внутренних операций.

<div style="color*'''paytype''' - Тип оплаты заказа получателем. Принимает значения::: CASH - Наличными при получении (по-умолчанию):: CARD - Картой при получении:: #a94442; backgroundNO -colorБез оплаты.: #f2dede; border: 1px solid #ebccd1; paddingOTHER - Прочее (Предусмотрен для того, чтобы оплата поступала непосредственно в курьерскую службу посредством прочих типов оплаты - таких как: 3px 10px 10px;">вебмани, яденьги, картой на сайте, прочие платежные системы и т.д.)* Атрибуты контейнера '''Обратите внимание!paytype''':# Данные запроса изменения указываются ** '''''code''полностью''', как если бы заказ создавался впервые- (integer) внутренний код типа оплаты заказа в системном справочнике "Типы оплаты корреспонденции". Не обязательный элемент.# При отсутствии вложения в запросе изменения данное вложение  * атрибут '''''code''''' контейнера '''не удаляетсяitem''' из  — внутренний код строки заказав системе, но его применяется для некоторых внутренних операций.:* '''''returns''''' — количество становится равным 0данного товара, от которого отказался получатель. Не нулевое только в случае частичного отказа.</div><br />

=== Описание полей запроса изменения ===Все поля запроса соответствуют структуре order при создании заказа за исключением:* вместо корневого тэга атрибут '''''got''neworder''' указывается контейнера '''editorderpackage''' — признак принятого места YES / NO.:* тэг штрих-кода '''barcode''returns''''' не указывается — количество данного товара, поскольку присваивается при создании заказаот которого отказался получатель. Не нулевое только в случае частичного отказа.

=== Описание полей ответа изменения ===* '''''area''''' в контейнере '''receiver''' — район/метро получателя.* '''''coords''''' в контейнере '''receiver''' — координаты получателя.Все поля ответа соответствуют ответу при создании * '''''deliveryPIN''''' в контейнере '''receiver''' — Пин-код.* '''pickup''' — признак оформления забора, возможные значения: '''YES''', '''NO'''. Если указано '''YES''', то весь заказ считается заданием на забор груза, а не на доставку.* '''currcoords''' — текущие координаты заказа за исключением корневого тэга - вместо . Атрибуты::* '''''lat''''' — широта:* '''''lon''''' — долгота:* '''''accuracy''''' — точность в метрах:* 'neworder''' возвращается 'RequestDateTime''editorder''' — дата/время последнего обновления координат.

* '''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''' — время вручения. В случае недоставки может быть пустым.* '''arrival''' — плановая дата прибытия в формате гггг-мм- текущую датудд чч: мм: сс. Заполняется только при использовании автоматических систем планирования (Максоптра, а "Вручил курьер" Яндекс доставка), во всех остальных случаях - системную запись "ОТМЕНА"пустое.* '''outstrbarcode''' — код у подрядчика (код заказа во внешней системе). Используется в интеграциях с внешними системами.* '''partner''' — текущий филиал/подрядчик.* '''return_message''' — информация о возврате* '''department''' — Подразделение, в котором оформляется заказ.

: '''COMPLETE''Пример запроса отмены заказа' — Доставлен.:'''<source lang="xml"><?xml version="1PARTIALLY''' — Доставлен частично.0" encoding="UTF-8" ?><cancelorder> <auth extra="8" login="login" pass="pass" : '''CANCELED''' — Не доставлен (Возврат/> <order orderno="" ordercode="123456" /> <order orderno="123aaa" ordercode="" /></cancelorder></source>Отмена). После этого статуса отправление должны вернуть заказчику, будут статусы RETURNING и RETURNED

'''Описание полей запроса статуса:'''PARTLYRETURNING — Планируется возврат остатков.: PARTLYRETURNED — Остаток возвращен.: TRANSACCEPTED — Прибыл на склад перевозчика.: PICKUPTRANS — Забран у перевозчика.

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

<cancelorderstatusreq> <order ordernoauth extra="123test8" ordercodelogin="123456login" errorpass="0" errormsg="OK" errormsgru="Успешноpass" ></auth> <changes>ONLY_LAST</changes> <order orderno="123aaa" ordercode="" error="52" errormsg="order not found" errormsgru="Заказ не найден" streamid>1234</streamid></cancelorderstatusreq>

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

<addattachmentscommitlaststatus> <auth extra="8" login="login" pass="pass" /> <orderno>1234567</ordernoauth> <attachmentsclient> <item name="photo1.jpg">JVBERi0xLjMN1wb25lbnQgMQ JUBQREYwMTIzNDU2Nzg5IDI NMyAwIG9iag08PA0vVHlwZSA U3VidHlwZSAvSW1hZ2UNL1d pZHRoIDE4MDgNL0hlaWdodCA ggNCAwIFINL0JpdHNQZXJDb 21wb25lbnQgMQ0vRGVjb2RlU ENL0NvbHVtbnMgMTgwOA0+P g0vSW1hZ2VNYXNrIHRydWUNL XhEZWNvZGUNPj4Nc3RyZWFt DQCLIENT</itemclient> <item name="photo2.jpg"streamid>VBERi0xLjMNAwIG9iag0HRoJ JUBQREYwMTIzNDU2Nzg5IDI NMyAwIG9iag08PA0vVHlwZSA vWE9iamVjdA0vU3VidHlwZS AvSW1hZ2UNL1dpZHRoIDEzNj gNL0hlaWdodCAxMzMzDS9MZ W5ndGggNCAwIFINL0JpdHNQZ XJDb21wb25lbnQgMQ0vRGVj b2RlUGFybXMgPDwNL0sgLTEN L0NvbHVtbnMgMTM2OA0+Pg0 vSW</item> 1234</attachmentsstreamid></addattachmentscommitlaststatus>

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

'''addattachments''' - Корневой контейнер. Обязательный элемент.В случае успеха вы получите ответ:*'''auth''' - Авторизация. Обязательный элемент.<source lang="xml">*'''orderno''' - Номер заказа. Обязательный элемент. Может использоваться тэг <ordercode> с указанием внутреннего кода заказа?xml version="1.*'''attachments''' 0" encoding="UTF- Обязательный элемент, в котором перечисляются передаваемые данные файлов.8" ?>**'''item''' - Бинарные данные (файл), закодированные в base64. Обязательный элемент.<commitlaststatus error="0">OK</commitlaststatus>***'''name''' - Атрибут элемента '''item''', в котором передается имя файла. Обязательный элемент.</source>

'''Пример ответа:'''<source langdiv style="xml"><?xml version="1.0" encoding="UTFcolor: #a94442; background-8color: #f2dede; border: 1px solid #ebccd1; padding: 3px 10px 10px;"?># При этом способе передачи (<addattachmentschanges> ONLY_LAST<attachments/changes>) система просматривает заказы, оформленные за последние 3 месяца. Если заказ сделан ранее, изменение статуса по нему не попадет в результат выполнения запроса. <item name="photo1# Система всегда выдает текущий статус. Вы можете одним запросом получить статус «NEW», а следующим — «COMPLETE». Между запросами отправление могло пройти через несколько промежуточных статусов. Если нужна гарантия получения всех промежуточных статусов, нужно анализировать блок statushistory (может не заполняться вследствие ограничений версии или тарифа конкретной службы доставки).jpg" error="0" errormsg="OK" errormsgru="Успешно" /> <item name="photo2# Система не гарантирует последовательность прохождения заказом набора статусов. Вы можете получить статус «COMPLETE», а следующим запросом «NEW» — такое может произойти, например, если оператор ошибочно отметил заказ выполненным, а затем исправил ошибку.jpg" error="0" errormsg="OK" errormsgru="Успешно" /> </attachmentsdiv></addattachments></sourcebr>

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

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

<attachmentstracking> <item nameorder orderno="111111"> <barcode>111111</barcode> <AWB>111111</AWB> <sender> <town code="doc1.docx1" sizecountry="35654RU">JVBERi0xLjMNМосква город</town> JUBQREYwMTIzNDU2Nzg5IDI NMyAwIG9iag08PA0vVHlwZSA <date>2014-03-22</date> U3VidHlwZSAvSW1hZ2UNL1d pZHRoIDE4MDgNL0hlaWdodCA <time_min>09:00</time_min> ggNCAwIFINL0JpdHNQZXJDb 21wb25lbnQgMQ0vRGVjb2RlU <time_max>14:00</time_max> ENL0NvbHVtbnMgMTgwOA0+P g0vSW1hZ2VNYXNrIHRydWUNL </sender> XhEZWNvZGUNPj4Nc3RyZWFt DQ </itemreceiver> <item nametown code="photo2.jpg1" sizecountry="74861RU">VBERi0xLjMN Москва город</town> JUBQREYwMTIzNDU2Nzg5IDI NMyAwIG9iag08PA0vVHlwZSA <zipcode>125480</zipcode> vWE9iamVjdA0vU3VidHlwZS AvSW1hZ2UNL1dpZHRoIDEzNj <date>2014-03-22</date> gNL0hlaWdodCAxMzMzDS9MZ W5ndGggNCAwIFINL0JpdHNQZ <time_min>09:00</time_min> XJDb21wb25lbnQgMQ0vRGVj b2RlUGFybXMgPDwNL0sgLTEN <time_max>14:00</time_max> L0NvbHVtbnMgMTM2OA0+Pg0 vSW </itemreceiver> <price>387.5</attachmentsprice> <inshprice>387.5</sourceinshprice> <paytype>CASH</paytype>В тегах item возвращаются бинарные данные (файлы), закодированные в base64 <weight>5.1</weight> <quantity>2</quantity> <service>2</service> <type>3</type> <return>NO</return> <return_service>2</return_service>== Изменение статуса агентом == <return_date></return_date> <return_time></return_time>Запрос изменения статуса заказа позволяет установить окончательный статус заказа - "Доставлен" или "Не доставлен (Возврат <return_message></return_message> <waittime>12</Отмена)".waittime> <enclosure>Детские игрушки</enclosure>Кроме этого, устанавливается дата и время ( <instruction>Проверить при необходимости) изменения статусапокупателе, а также сообщение в поле ''Инфо о доставке''подписать акт</instruction> <deliveryprice total="158.6" delivery="100.00" return="58.6" /> <courier>При необходимости к заказу можно прикрепить изображения. <code>26</code> <name>Иванов Владимир Петрович</name> <phone>+79161234567</phone>'''Пример запроса изменения статуса:''' </courier> <source langcurrcoords lat="55.680327" lon="37.604456" accuracy="50" RequestDateTime="xml2014-04-21 18:07:45"/> <?xml versionstatus eventstore="1.0филиал в Санкт-Петербурге" eventtime="2016-06-02 17:22:00" encodingcreatetimegmt="UTF2016-06-803 16:14:44" ?message="" title="Доставлен">COMPLETE</status> <setorderinfostatushistory> <auth extrastatus eventstore="Офис в Москве" eventtime="82016-05-30 10:20:00" createtimegmt="2016-06-03 16:14:44" loginmessage="login" passtitle="passНовый" >NEW</status> <order ordercodestatus eventstore="Офис в Москве" eventtime="2016-06-01 17:38:00" createtimegmt="2016-06-03 16:14:44" message="филиал в Санкт-Петербурге" title="123456Планируется отправка">DEPARTURING</status> <status eventstore="Офис в Москве" eventtime="2016-06-01 19:53:00" createtimegmt="2016-06-03 16:14:44" message="филиал в Санкт-Петербурге" title="Отправлено со склада">Получил ИвановDEPARTURE</status> <status eventstore="филиал в Санкт-Петербурге" eventtime="2016-06-02 07:41:00" createtimegmt="2016-06-03 16:14:44" message="" title="Получен складом"> ACCEPTED</orderstatus> <order ordercodestatus eventstore="филиал в Санкт-Петербурге" eventtime="2016-06-02 09:17:00" createtimegmt="2016-06-03 16:14:44" message="" title="234567Выдан курьеру на доставку">DELIVERY</status> <statuseventstore="филиал в Санкт-Петербурге" eventtime="2016-06-02 17:22:00" createtimegmt="2016-06-03 16:14:44" message="" title="Доставлен (предварительно)">PICKUPREADYCOURIERDELIVERED</status> <status eventstore="филиал в Санкт-Петербурге" eventtime>="2016-0506-30 1002 17:2022:00" createtimegmt="2016-06-03 16:14:44" message="" title="Доставлен">COMPLETE</status> </statushistory> <deliveredto>Иванова, секр.</eventtimedeliveredto> <delivereddate>2016-06-02</delivereddate> <messagedeliveredtime>Клиент отказался от покупки17:22</messagedeliveredtime> <paytypeoutstrbarcode>CASHEXT123456</paytypeoutstrbarcode> <items> <item code="34533" extcode="abc123" quantity="1" reasonmass="0.2" retprice="37.5" VATrate="0" barcode="2345625213125" article="1" returns="0" origincountry="040" GTD="" excise="0.00" governmentCode="11223311" suppcompany="Поставщик" suppINN="1112223334" suppphone="79161234567">Мяч</item> <item code="34456" extcode="abc124" quantity="2" mass="2" retprice="100" VATrate="10" barcode="4645625213138" article="2" returns="0" reasongovernmentCode="0" >Обруч</item> <item code="34421" extcode="abc125" quantity="23" mass="0.3" retprice="50" VATrate="18" barcode="2345625213126" article="3" reasonreturns="0" /> </items> <image filenamegovernmentCode="filename1.jpg"> Погремушка желтая</9j/4AAQSkZJRgAitem> BAQAAAQABAAD/2wBDAA0JCg sKCA0LCgsODg0PEyAVExISEy ccHhcgLikxMC4pLSwzOko+M zZGNywtQFdBRkxOUlNSMj5aY VpQYEpRUk//2wBDAQ4ODhMR EyYVFSZPNS01T09PT09PT09P T09PT09PT09PT09PT09PT09 PT09PT09PT09PT09PT09PT09 PT09PT0//wAARCAYACAADAS IA </imageitems> </order></setorderinfotracking>

'''Описание полей запроса статуса:Получение информации в формате 17 TRACK'''

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

<setorderinfotracking17> <order ordercode="123456" error="0" errormsg="OK" errormsgru="Успешно" extra>8</extra> <order ordercode="234567" error="59" errormsg="value [date_put] is already set" errormsgru="Значение [Дата доставки] уже указано" orderno>1234</orderno></setorderinfotracking17>

== Получение документов для печати == '''Пример запроса получения печатных формответа:'''<source lang=pre>{ "xmlnumber">:"ExtNumber", "oriNumber":"1234",<?xml version= "1.0oriCountry" encoding=:"UTF-8RU" ?>,<waybill> "destCountry":"RU", <auth extra= "8status" login=:"loginComplete" pass=, "passevents" />:[ <orders> { <order orderno= "1234567time" ordercode=:"333312016-06-02 17:22:00" />, <order orderno= "1234568location" ordercode=:"33332RU" />, </orders> "content":"Complete" <form>1</form> },</waybill> {</source> "time":"2016-06-02 17:22:00", "location":"RU",'''Описание полей "content":'''"Courierdelivered" },'''waybill''' - Корневой контейнер. Обязательный элемент {*'''auth''' "time":"2016- Авторизация. Обязательный элемент*'''orders''' 06- Список заказов для получения печатных форм. Содержит тэги '''order''' с атрибутами02 09:17:00", "location":* '''''orderno''''' - шифр заказа"RU", "content":* '''''ordercode''''' - внутренний код заказа. Указывать необходимо один из атрибутов для всех заказов. Приоритет имеет атрибут '''''ordercode'''''"Delivery" },*'''form''' - Формат накладной. Не обязательный элемент. Принимает значения: { "time":* 1 "2016- Подробная накладная (по06-умолчанию)02 07:41:00", "location":* 2 - Наклейки Zebra"RU", "content":* 3 - Наклейки на страницу формата А4"Accepted" }, { "time":* 4 "2016- Акты приема06-передачи01 19:53:00", "location":"RU", '''Пример ответа "content":'''<source lang="xmlDeparture"><?xml version= }, { "1.0time" encoding=:"UTF2016-806-01 17:38:00"?>,<waybill> "location":"RU", < "content>EODIcaI8KSBlwQ 4MnEOR7Px8U8EBAyGICBnwpw ":"Departuring" IZhQgz0ZxuPs8EBM/GcbjzB AwhBl8hwQYIO00GmEwg1CeEG }, mqYTChNU0wqf8l8nz4zgc+K fCno+zwU5GjOZmzXGcbEQYIM { 4zkegRE40zWzONyoNNMIOIa cWnp6aDCGEGE9NQmoQd2mg00 "time":"2016-05-30 10:20:00", 79U4f3hPTwnfp6Sdrafeqpa JDpFw/1aYT077VNNNdO00G3q "location":"RU", mqqvp9p2E7T0/wiFemv8uG6 OM</ "content>":"New" }</waybill> ]}</sourcepre>

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

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

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

<?xml version="1.0" encoding="UTF-8"?><townlistcancelorder> <auth extra="8" login="login" pass="pass" /> <codesearch> <zipcode>110000</zipcode> <kladrcode>0100000100800<order orderno="" ordercode="123456" /kladrcode> <fiascode>bd21979d-46f8-49d0-9105-e8d65172a983</fiascode> <code>123</code> </codesearch> <conditions> <city>Краснодарский край</city> <namecontains>новгород</namecontains> <namestarts>Моск</namestarts> <name>Москва</name> <fullname>Москва город</fullname> <country>1</country> </conditions> <limit> <limitfrom>30</limitfrom> <limitcount>10</limitcount> <countall>YES</countall> <order orderno="123aaa" ordercode="" /limit></townlistcancelorder>

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

'''cancelorder''' — Корневой контейнер. Обязательный элемент.*'''codesearchauth''' - Поиск по кодам — Авторизация. В случае использования - контейнеры conditions и limit игнорируютсяОбязательный элемент.:* '''zipcodeorder''' - Поиск по индексу — Контейнер отменяемого заказа. Обратите внимание на то, что один почтовый индекс Обязательный элемент. Запрос может распространяться на несколько населенных пунктов. В этом случае система вернет несколько записейсодержать более одного контейнера '''order'''.Атрибуты::* '''kladrcode''orderno'' - Поиск по 13-ти значному коду КЛАДР''' — Шифр заказа.:* '''fiascode''ordercode' - Поиск по коду ФИАС (AOGUID)'''' — Внутренний код заказа.:* Обратите внимание, что должен быть указан хотя бы один из атрибутов ''orderno''или 'code'ordercode'' - Поиск по коду в системе.!

<?xml version="1.0" encoding="UTF-8"?><townlist countcancelorder> <order orderno="123test" ordercode="3123456" pageerror="10" totalcounterrormsg="3OK" totalpageserrormsgru="1Успешно"/> <townorder orderno="123aaa" ordercode="" error="52" errormsg="order not found" errormsgru="Заказ не найден" /> <code>26379</codecancelorder> <city/source> <code>23</code> <name>Краснодарский край</name>== Добавление вложений к накладной == </city> <name>Сочи город</name>Метод позволяет прикрепить файлы к корреспонденции. <fiascode>79da737a-603b-4c19-9b54-9114c96fb912</fiascode>Размер загружаемого файла не должен превышать 1 Мб. <kladrcode>2300000700000</kladrcode> <shortname /> (not yet supported)'''Пример запроса:''' <typename /source lang="xml"> (not yet supported) <coords lat?xml version="431.58550" lonencoding="39.7231UTF-8" /?> </townaddattachments> <town> <code>40331<auth extra="8" login="login" pass="pass" /code> <cityorderno> <code>321234567</codeorderno> <name>Брянская область</nameattachments> </cityitem name="photo1.jpg">JVBERi0xLjMN1wb25lbnQgMQ <name>Сочилов хутор</name>JUBQREYwMTIzNDU2Nzg5IDI NMyAwIG9iag08PA0vVHlwZSA <fiascode>c9c96c67-2cc9-4f10-afde-fd32417ea216</fiascode>U3VidHlwZSAvSW1hZ2UNL1d pZHRoIDE4MDgNL0hlaWdodCA <kladrcode>3201900011100</kladrcode>ggNCAwIFINL0JpdHNQZXJDb 21wb25lbnQgMQ0vRGVjb2RlU <shortname />ENL0NvbHVtbnMgMTgwOA0+P g0vSW1hZ2VNYXNrIHRydWUNL XhEZWNvZGUNPj4Nc3RyZWFt DQ<typename /item> <coords latitem name="52photo2.6407jpg" lon="33.1724" /> </town> <town> <code>114016</code> <city> <code>60</code> <name>Псковская область</name>VBERi0xLjMNAwIG9iag0HRoJ </city>JUBQREYwMTIzNDU2Nzg5IDI NMyAwIG9iag08PA0vVHlwZSA <name>Сочихино деревня</name>vWE9iamVjdA0vU3VidHlwZS AvSW1hZ2UNL1dpZHRoIDEzNj <fiascode>10df7588-19c1-49d1-a387-9de1cf3eb26f</fiascode>gNL0hlaWdodCAxMzMzDS9MZ W5ndGggNCAwIFINL0JpdHNQZ <kladrcode>6001900015400</kladrcode>XJDb21wb25lbnQgMQ0vRGVj b2RlUGFybXMgPDwNL0sgLTEN L0NvbHVtbnMgMTM2OA0+Pg0 vSW<shortname /> <typename /> <coords lat="56.6003" lon="29.3542" /item> </townattachments></townlistaddattachments>

== Справочник регионов =='''Описание полей:''' '''addattachments''' — Корневой контейнер. Обязательный элемент.* '''auth''' — Авторизация. Обязательный элемент.* '''orderno''' — Номер заказа. Обязательный элемент. Может использоваться тэг <ordercode> с указанием внутреннего кода заказа.* '''attachments''' — Обязательный элемент, в котором перечисляются передаваемые данные файлов.** '''item''' — Бинарные данные (файл), закодированные в base64. Обязательный элемент.*** '''name''' — Атрибут элемента '''item''', в котором передается имя файла. Обязательный элемент. 

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

<regionlistaddattachments> <codesearchattachments> <code>77</code> </codesearch> <conditions> <namecontains>край<item name="photo1.jpg" error="0" errormsg="OK" errormsgru="Успешно" /namecontains> <namestarts>Моск</namestarts> <fullname>Московская область</fullname> <country>1<item name="photo2.jpg" error="0" errormsg="OK" errormsgru="Успешно" /country> </conditionsattachments></regionlistaddattachments>

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

<?xml version="1.0" encoding="UTF-8"?><regionlist count="2"> <city> <code>80</code> <country> <code>1</code> <name>Россия</name> <id>643</id> <ShortName1>RU</ShortName1> <ShortName2>RUS</ShortName2> </country> <name>Агинский Бурятский автономный округ</nameattachments> <auth extra="8" login="login" pass="pass" /city> <city> <code>1</code> <country> <code>1</code> <name>Россия</name> <id>643</id> <ShortName1orderno>RU</ShortName1> <ShortName2>RUS</ShortName2> </country> <name>Адыгея республика</name> 1234567</cityorderno></regionlistattachments>

== Справочник улиц == '''Пример запроса справочника улицОписание полей:'''<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> <countall>YES</countall> </limit></streetlist></source> *'''conditionsattachments''' - Задает условия поиска — Корневой контейнер. Все вложенные элементы одновременно накладывают условие "И"Обязательный элемент.:* '''townauth''' - Обязательное поле — Авторизация. Название или код населенного пунктаОбязательный элемент.:* '''namecontainsorderno''' - Поиск населенных пунктов, название которых содержит указанный текст — Номер/код заказа.:* '''namestarts''' - Поиск населенных пунктов, название которых начинается с указанного текстаОбязательный элемент.:* '''name''' - Поиск населенных пунктов, название которых соответствует указанному тексту.:* '''fullname''' - Поиск населенных пунктов, название вместе с типом населенного пункта которых соответствует указанному тексту. *'''limit''' - Ограничивает вывод результата.:* '''limitfrom''' - Задает номер записи результата, начиная с которой выдавать ответ. По-умолчанию - 0.:* '''limitcount'''- Задает количество записей результата, которые нужно вернуть. По-умолчанию - 10000.:* '''countall''' - YES указывает на необходимость подсчета общего количества найденных совпадений. Это может замедлять выполнение запроса. Если отключено - в ответе не указываются totalcount и totalpages.

<streetlist countattachments> <item name="1doc1.docx" pagesize="135654" totalcount>JVBERi0xLjMN JUBQREYwMTIzNDU2Nzg5IDI NMyAwIG9iag08PA0vVHlwZSA U3VidHlwZSAvSW1hZ2UNL1d pZHRoIDE4MDgNL0hlaWdodCA ggNCAwIFINL0JpdHNQZXJDb 21wb25lbnQgMQ0vRGVjb2RlU ENL0NvbHVtbnMgMTgwOA0+P g0vSW1hZ2VNYXNrIHRydWUNL XhEZWNvZGUNPj4Nc3RyZWFt DQ</item> <item name="3photo2.jpg" totalpagessize="174861">VBERi0xLjMN <street>JUBQREYwMTIzNDU2Nzg5IDI NMyAwIG9iag08PA0vVHlwZSA <name>Академика Хохлова ул.</name> vWE9iamVjdA0vU3VidHlwZS AvSW1hZ2UNL1dpZHRoIDEzNj <shortname>Академика Хохлова</shortname> gNL0hlaWdodCAxMzMzDS9MZ W5ndGggNCAwIFINL0JpdHNQZ <typename>ул.</typename> XJDb21wb25lbnQgMQ0vRGVj b2RlUGFybXMgPDwNL0sgLTEN L0NvbHVtbnMgMTM2OA0+Pg0 vSW</streetitem></streetlistattachments>

В ответе улицы сортируются по алфавитутегах item возвращаются бинарные данные (файлы), закодированные в base64. == Изменение статуса агентом ==Запрос изменения статуса заказа позволяет установить окончательный статус заказа — «Доставлен» или «Не доставлен (Возврат/Отмена)». Кроме этого, устанавливается дата и время (при необходимости) изменения статуса, а также сообщение в поле ''Инфо о доставке''. При необходимости к заказу можно прикрепить изображения.

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

<itemlistsetorderinfo> <auth extra="8" login="login" pass="pass"></auth> <codesearchorder ordercode="123456"> <codemessage>123456Получил Иванов</codemessage> <articleoutstrbarcode>FD3437654312</articleoutstrbarcode> <barcode>2345625213125 </barcodeorder> </codesearchorder ordercode="234567"> <conditions> <namecontainsstatus>телевизорPICKUPREADY</namecontainsstatus> <namestartseventtime>sony2016-05-30 10:20:00</namestartseventtime> <namemessage>Sony KDL-55W905 ЖК-телевизорКлиент отказался от покупки</namemessage> <quantitypaytype>EXISTING_ONLYCASH</quantitypaytype> <storeprice>123</conditionsstoreprice> <limititems> <limitfromitem code="34533" quantity="1" reason="0" governmentCode="11223311" />30 <item code="34456" quantity="0" reason="0" /limitfrom> <limitcountitem code="34421" quantity="2" reason="0" />10 </limitcountitems> <countallimage filename="filename1.jpg">YES/9j/4AAQSkZJRgA BAQAAAQABAAD/2wBDAA0JCg sKCA0LCgsODg0PEyAVExISEy ccHhcgLikxMC4pLSwzOko+M zZGNywtQFdBRkxOUlNSMj5aY VpQYEpRUk//2wBDAQ4ODhMR EyYVFSZPNS01T09PT09PT09P T09PT09PT09PT09PT09PT09 PT09PT09PT09PT09PT09PT09 PT09PT0//wAARCAYACAADAS IA</countallimage> </limitorder></itemlistsetorderinfo>

'''Описание полей запроса статуса:''' '''setorderinfo''' — Корневой контейнер. Обязательный элемент.* '''auth''' — Авторизация. Обязательный элемент.*'''conditionsorder''' — Контейнер заказа. Обязательный элемент. Запрос может содержать более одного контейнера '''order''' - Задает условия поиска. Все вложенные элементы одновременно накладывают условие "И"Атрибут '''''ordercode''''' — внутренний код заказа.:* '''namecontainsstatus''' - Поиск товаров — Новый статус заказа. Доступны статусы из раздела [[#Описание полей ответа статусов]], название которых содержит указанный тексткроме AWAITING_SYNC и NEW.* '''eventtime''' — Дата и время изменения статуса. Обязательно при указании статуса.* '''message''' — Текст сообщения ''Инфо о доставке''.:* '''namestartsoutstrbarcode''' - Поиск товаров, название которых начинается  — код у подрядчика (код заказа во внешней системе). Используется в интеграциях с указанного текставнешними системами.* '''paytype''' — Тип оплаты заказа. Допустимые значения CASH/CARD.* '''storeprice''' — Агентское вознаграждение.* '''items''' — Контейнер для описания вложений '''item''' .Атрибуты::* '''name''code''''' - Поиск товаров, название которых соответствует указанному тексту — Код вложения.:* '''''quantity''' - Наличие на складе'' — Количество доставленных единиц вложения. Принимает значения EXISTING_ONLY - Только в наличии:* '''''reason''''' — Причина недоставки, NOT_EXISTING_ONLY - Только не в наличиивыбирается из соответствующего списка статусов.:* '''''governmentCode''''' — Указание кода ТН для вложения при необходимости.* '''image''' — Контейнер прикрепляемого изображения. Содержит текст файла изображения, ALL - Всезакодированный по стандарту ''base64''. Контейнер '''order'''Это поле может быть недоступным в некоторых установкахсодержать более одного контейнера '''image'''.Атрибут::* '''''filename''''' — Имя файла. 

<itemlist countsetorderinfo> <order ordercode="3123456" totalcounterror="30" pageerrormsg="1OK" totalpageserrormsgru="1Успешно"/> <item> <code>123456</code> <article>FD343</article> <barcode>2345625213125</barcode> <name>Sony KDL-55W905 ЖК-телевизор</name> <retprice>65000</retprice> <purchprice>50000</purchprice> <weight>5.1</weight> <length>50</length> <width>30</width> <height>40</height> <CountInPallet>30</CountInPallet> <HasSerials>1<order ordercode="234567" error="59" errormsg="value [date_put] is already set" errormsgru="Значение [Дата доставки] уже указано" /HasSerials> <CountryOfOrigin>Малайзия</CountryOfOrigin> (not yet supported) <Message>Хороший телевизор</Message> <Message2>Снова хороший телевизор</Message2> <quantity>12</quantity> <reserved>3</reserved> <item> ...</itemlistsetorderinfo>

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

<itemmovementswaybill> <auth extra="8" login="login" pass="pass"/> <orders> <order orderno="1234567" ordercode="33331" /> <order orderno="1234568" ordercode="33332" /> </orders> <form>1</authform> <codestart>42595</codestart></itemmovementswaybill>

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

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

<?xml version="1.0" encoding="UTF-8" ?><itemmovements count="16"waybill> <itemmovementcontent>EODIcaI8KSBlwQ 4MnEOR7Px8U8EBAyGICBnwpw <code>151500< IZhQgz0ZxuPs8EBM/code>GcbjzB AwhBl8hwQYIO00GmEwg1CeEG <date>2017-05-26</date> mqYTChNU0wqf8l8nz4zgc+K fCno+zwU5GjOZmzXGcbEQYIM <retprice>0</retprice> 4zkegRE40zWzONyoNNMIOIa cWnp6aDCGEGE9NQmoQd2mg00 <quantity>1< 79U4f3hPTwnfp6Sdrafeqpa JDpFw/quantity>1aYT077VNNNdO00G3q <delivered>0</delivered> <item> <code>4259</code> <name>Настольная игра Дженга< mqqvp9p2E7T0/name> wiFemv8uG6 OM</item> <statuscontent> <code>5</codewaybill> <name>Возврат от покупателя</namesource> </status> <store> <code>1</code>В тэге content возвращаются бинарные данные (файл pdf), закодированные в base64. <name>офис При записи в Москве</name>файл необходимо использовать двоичный формат записи! </store> <order> <ordercode>3374830</ordercode>'''Обратите внимание''', что печатные формы для заборов не формируются. <number>123660-0</number> <date>2017-05-24</date> <orderno>14123</orderno>'''Пример ответа с ошибкой:''' <barcode>0000000670</barcodesource lang="xml"> <company>ТОВАР</company> <address>Кравченко ул?xml version="1., 1</address> <delivereddate>20170" encoding="UTF-05-29</delivereddate8"?> <deliveredtime>12:00:00</deliveredtimewaybill> <deliveredto /> </order> <document> <code>21991</code> <number>318</number> <date>2017-05-26 </dateerror> <message></message> </document> Текст ошибки</itemmovementserror></itemlistwaybill>

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

<?xml version="1.0" encoding="UTF-8" ?><pvzlisttownlist> <auth extra="8" login="login" pass="pass"/> <codesearch> <zipcode>110000</zipcode> <kladrcode>0100000100800</kladrcode> <fiascode>bd21979d-46f8-49d0-9105-e8d65172a983</authfiascode> <code>1234123</code> <town/codesearch>Нижний Тагил </townconditions> <parentcodecity>6Краснодарский край</parentcodecity> <acceptcashnamecontains>YESновгород</acceptcashnamecontains> <acceptcardnamecontainsparts>YESмолоково моск</acceptcardnamecontainsparts> <acceptfittingnamestarts>YESМоск</acceptfittingnamestarts> <maxweightname>30Москва</maxweightname> <acceptindividualsfullname>YESМосква город</acceptindividualsfullname> <ltcountry>57.9247371</ltcountry> <lg/conditions>59.940019 </lglimit> <rtlimitfrom>57.90568230</rtlimitfrom> <rglimitcount>59.98466910</rglimitcount> <jsoncountall>YES</jsoncountall> </limit></pvzlisttownlist>

Внутри контейнера townlist все элементы могут как отсутствовать, так и комбинироваться. Поиск не чувствителен к регистру. *'''auth''' - Атрибут '''extra''' - обязателен — Авторизация, по нему определяется курьерская служба, '''login''' необязательный элемент. Используется в случае включенного и '''pass''' позволяют авторизоваться под клиентом: для отдельного клиента могут быть настроенного ограничения по доступности некоторых ПВЗ, и населенным пунктам в этом случае они будут учтеныконкретной курьерской службе. *'''codecodesearch''' - Внутренний код — Поиск по кодам.*'''town''' - Город получателяВ случае использования — контейнеры conditions и limit игнорируются.:*'''parentcodezipcode''' - Фильтр  — Поиск по родительскому элементу*'''acceptcash''' - Фильтр по приему наличных YES/NOиндексу. Обратите внимание на то, что один почтовый индекс может распространяться на несколько населенных пунктов. В этом случае система вернет несколько записей.:*'''acceptcardkladrcode''' - Фильтр  — Поиск по приему банковских карт YES/NO*'''acceptfitting''' 13- Фильтр по наличию примерки YES/NOти значному коду КЛАДР.:*'''maxweightfiascode''' - Фильтр  — Поиск по максимальному весу, с которым работает ПВЗкоду ФИАС (AOGUID).:*'''acceptindividualscode''' - Фильтр  — Поиск по доступности физическим лицам YES/NO*'''lt''' - Широта левого верхнего угла*'''lg''' - Долгота левого верхнего угла*'''rt''' - Широта правого нижнего угла*'''rg''' - Долгота правого нижнего угла*'''json''' - Признак вывода ответа коду в виде JSON YES/NOсистеме.

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

<?xml version="1.0" encoding="UTF-8" ?><pvzlist townlist count="23" page="1" totalcount="3" totalpages="1"> <pvztown> <code>12626379</code> <clientcode>3</clientcodecity> <namecode>Нижний Тагил23</namecode> <parentcodename>6Краснодарский край</parentcodename> <parentname>Интеграция</parentnamecity> <town code="124267"name>Нижний Тагил Сочи город</townname> <addressfiascode>622036, г. Нижний Тагил, ул. Циолковского, д. 1779da737a-603b-4c19-9b54-9114c96fb912</addressfiascode> <phonekladrcode>+73435417709, +734352549892300000700000</phonekladrcode> <comment>Новый пункт доставки<shortname /comment> (not yet supported) <worktime>Вс 10:00-16:00, Сб 10:00-16:00, Пн-Пт 10:00-20:00<typename /worktime> (not yet supported) <traveldescription>Жилое 5-ти этажное здание, торцом к дороге, второе здание от перекрестка Пархоменко-Циолковского<coords lat="43.5855" lon="39.7231" /traveldescription> <maxweight>10 </maxweighttown> <acceptcash>YES</acceptcashtown> <acceptcardcode>YES40331</acceptcardcode> <acceptfitting>YES</acceptfittingcity> <acceptindividualscode>YES32</acceptindividualscode> <latitudename>57.93457Брянская область</latitudename> <longitude>59.95131</longitude> </pvz> <pvzcity> <codename>245Сочилов хутор</codename> <clientcodefiascode>NTG1c9c96c67-2cc9-4f10-afde-fd32417ea216</clientcodefiascode> <namekladrcode>На Красноармейской3201900011100</namekladrcode> <parentcode>6<shortname /parentcode> <parentname>Интеграция<typename /parentname> <town codecoords lat="52.6407" lon="12426733.1724"/>Нижний Тагил город </town> <address>КРАСНОАРМЕЙСКАЯ, д.79</addresstown> <phonecode>+7(3435)379-044114016</phonecode> <comment>Возможность примерки отсутствует</commentcity> <worktimecode>Вс 10:00-16:00, Сб 10:00-16:00, Пн-Пт 10:00-20:0060</worktimecode> <traveldescriptionname>Напротив ТЦ ПирамидаПсковская область</traveldescriptionname> <maxweight>20</maxweightcity> <acceptcashname>YESСочихино деревня</acceptcashname> <acceptcardfiascode>YES10df7588-19c1-49d1-a387-9de1cf3eb26f</acceptcardfiascode> <acceptfittingkladrcode>NO6001900015400</acceptfittingkladrcode> <acceptindividuals>YES<shortname /acceptindividuals> <latitude>57.93468<typename /latitude> <longitude>60coords lat="56.6003" lon="29.55476<3542" /longitude> </pvztown></pvzlisttownlist>

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

== Справочник Видов срочности регионов =='''Пример запроса справочника:'''<source lang="xml"><?xml version="1.0" encoding="UTF-8"?><regionlist> <codesearch> <code>77</code> </codesearch> <conditions> <namecontains>край</namecontains> <namestarts>Моск</namestarts> <fullname>Московская область</fullname> <country>RU</country> </conditions></regionlist></source>

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

<?xml version="1.0" encoding="UTF-8" ?><servicesregionlist count="2"> <city> <code>80</code> <country> <code>1<auth extra="8"/code> <name>Россия</servicesname> <id>643</sourceid> <ShortName1>RU</ShortName1>'''Пример ответа справочника Видов срочности:''' <ShortName2>RUS</ShortName2> <source lang="xml"/country> <name>Агинский Бурятский автономный округ<?xml version="1.0" encoding="UTF-8" ?/name> <services count="2"/city> <servicecity> <code>1</code> <country> <code>1</code> <name>ЭкономРоссия</name> <id>643</serviceid> <ShortName1>RU<service/ShortName1> <codeShortName2>RUS</ShortName2>2 </codecountry> <name>СрочноАдыгея республика</name> </servicecity></servicesregionlist>

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

<?xml version="1.0" encoding="UTF-8" ?><calculatorstreetlist> <auth extra="8" login="login" pass="pass" /conditions> <calc townfrom="town>Москва" город</town> // ОБЯЗАТЕЛЬНОЕ ПОЛЕ! addressfrom="Ленинский проспект, 95" <namecontains>Хохло</namecontains> zipcode="664000" <namestarts>Академика Х</namestarts> townto="3800000300000" <name>Академика Хохлова</name> addressto="Ленина <fullname>Академика Хохлова ул., 10"</fullname> l="10" </conditions> w="20" <limit> h=" <limitfrom>30"</limitfrom> mass="3.7" <limitcount>10</limitcount> service="1" <countall>YES</countall> rur="1200" inshprice="1200" paytype="CASH" </limit></calculatorstreetlist>

Параметры:*'''townfromconditions''' - Город отправления — Задает условия поиска. Все вложенные элементы одновременно накладывают условие «И».:*'''addressfromtown''' - Адрес отправления — Обязательное поле. Название или код населенного пункта.:*'''zipcodenamecontains''' - Почтовый индекс города назначения — Поиск улиц, название которых содержит указанный текст.:*'''towntonamestarts''' - Город назначения — Поиск улиц, название которых начинается с указанного текста.:*'''addresstoname''' - Адрес назначения*'''l''' - Длина в сантиметрах (не обязательный параметр)*'''w''' - Ширина в сантиметрах (не обязательный параметр)*'''h''' - Высота в сантиметрах (не обязательный параметр) — Поиск улиц, название которых соответствует указанному тексту.:*'''mass''fullname' - Масса в килограммах*'''service''' - Режим доставки - число — Поиск улиц, указывающее на запись в справочнике [[#Справочник Видов срочности|видов срочности]]. Если этот параметр опустить, система выдаст расчет для всех доступных видов срочности, передав много контейнеров <calc> в ответекоторых название вместе с типом соответствует указанному тексту.*'''rur''' - Сумма наложенного платежа*'''inshprice''' - Сумма объявленной ценности*'''paytype''' - Тип оплаты

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

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

<calculator> <calc> <townfrom codestreetlist count="1">Москва город</townfrom> <townto codepage="566031" totalcount=">Иркутск город</townto> <mass>3.7</mass> <service name" totalpages="Экспресс1">1 </servicestreet> <zonecode>2124</zonecode> <pricename>1163Академика Хохлова ул.</pricename> <mindeliverydaysshortname>1Академика Хохлова</mindeliverydaysshortname> <maxdeliverydaystypename>3ул.</maxdeliverydaystypename> </calcstreet></calculatorstreetlist>

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

'''''Обратите внимание:''''' В реальном ответе сервера в теге calc присутствует атрибут "price". Он оставлен для обратной совместимости, не используйте его. Пользуйтесь вложенным тегом price. == Список актов передачи денег Справочник номенклатуры == '''Пример запроса списка актов передачи денегсправочника номенклатуры:'''

<smalistitemlist> <auth extra="8" login="login" pass="pass" ></auth> <codesearch> <code>123456</code> <article>FD343</article> <barcode>2345625213125</barcode> </codesearch> <conditions> <namecontains>телевизор</namecontains> <namestarts>sony</namestarts> <datefromname>2016Sony KDL-0255W905 ЖК-телевизор</name> <quantity>EXISTING_ONLY</quantity> <store>2</store> </conditions> <except> <code>123478</code> </except> <limit> <limitfrom>30</limitfrom> <limitcount>10</datefromlimitcount> <countall>YES<dateto/countall>2016-03-10 </datetolimit></smalistitemlist>

Внутри контейнера itemlist все элементы могут как отсутствовать, так и комбинироваться. Поиск не чувствителен к регистру.* '''smalistcodesearch''' - Корневой контейнер — Поиск по кодам. Обязательный элементВ случае использования — контейнеры conditions и limit игнорируются.:*'''authcode''' - Авторизация — Поиск по внутреннему коду системы. Обязательный элемент:* '''article''' — Поиск по артикулу.:* '''barcode''' — Поиск по штрихкоду. *'''datefromconditions''' - Дата "с" — Задает условия поиска. Необязательный элементВсе вложенные элементы одновременно накладывают условие «И».:*'''datetonamecontains''' - Дата "по" — Поиск товаров, название которых содержит указанный текст.:* '''namestarts''' — Поиск товаров, название которых начинается с указанного текста. Необязательный элемент:* '''name''' — Поиск товаров, название которых соответствует указанному тексту.Если интервал дат :* '''quantity''' — Наличие на складе. Принимает значения EXISTING_ONLY — Только в наличии, NOT_EXISTING_ONLY — Только не указанв наличии, то возвращаются акты передачи денег за последний месяцALL — Все. ''Это поле может быть недоступным в некоторых установках.'':* '''store''' — Поиск товаров по определенному складу.

* '''except''' — Описание исключений для корректного определения количества зарезервированной номенклатуры.:* '''code''' — Код заказа. * '''limit''' — Ограничивает вывод результата.:* '''limitfrom''' — Задает номер записи результата, начиная с которой выдавать ответ.:* '''limitcount''' — Задает количество записей результата, которые нужно вернуть. '''Пример ответа на запрос списка актов передачи денег:'''

<smalist itemlist count="3" totalcount="3" page="1" totalpages="1"> <smaitem> <code>6278123456</code> <numberarticle>FD343</article> <barcode>39922345625213125</numberbarcode> <actdatename>2016Sony KDL-0255W905 ЖК-12телевизор</actdatename> <datepayretprice>65000</datepayretprice> <datetopurchprice>2016-02-1250000</datetopurchprice> <promiseddatepayweight>5.1</promiseddatepayweight> <pricelength>637.0050</pricelength> <pricecorrwidth>113.0030</pricecorrwidth> <rurheight>13430.0040</rurheight> <pricekurVATrate>570.0020</pricekurVATrate> <priceagCountInPallet>67.0030</priceagCountInPallet> <paynoCountInBox>424232</paynoCountInBox> <paytypeHasSerials>1</paytypeHasSerials> <CountryOfOrigin>Малайзия</CountryOfOrigin> (not yet supported) <Message>Хороший телевизор</Message> <Message2>Снова хороший телевизор</Message2> <paytypenamequantity>Безнал12</paytypenamequantity> <signedcopyreceivedreserved>NO3</signedcopyreceivedreserved> </smaitem> ...</smalistitemlist>

'''Описание полей:'''*'''code''' - Код акта — Внутренний идентификатор, присвоенный системой.*'''numberarticle''' - Номер акта в системе — Артикул, назначенный клиентом (поставщиком).*'''actdatebarcode''' - Дата акта — Штрихкод производителя.*'''datepayname''' - Дата оплаты по акту — Наименование.*'''datetoretprice'''  — Розничная цена по- Дата конечного периода для формирования АПДумолчанию. При оформлении заказа цена используется та, которая указана в заказе.*'''promiseddatepaypurchprice''' - Плановая дата оплаты — Закупочная цена.*'''priceweight''' - Стоимость услуг — Масса в килограммах.*'''pricecorrlength''' - Сумма корректировки — Длина в сантиметрах.*'''rurwidth''' - Сумма заказа — Ширина в сантиметрах.*'''pricekurheight''' - Стоимость курьерской доставки — Высота в сантиметрах.*'''priceagVATrate''' - Агентское вознаграждение — Ставка НДС, целое число процентов.*'''paynoCountInPallet''' - Номер платежного поручения — Количество штук в паллете.*'''paytypeCountInBox''' - Тип оплаты: 1 - безнал, 2 - наличными курьером, 3 - наличными  — Количество штук в офисеупаковке.* '''HasSerials''' — Требует учета серийных номеров. Принимает значения 1 — да, 4 - перевод 0 — нет.* '''CountryOfOrigin''' — Наименование страны происхождения на картурусском языке.* '''Message''' — Комментарий.* '''Message2''' — Дополнительный комментарий.*'''paytypenamequantity''' — Количество на складе. Товары, уже собранные в заказы в этом количестве не присутствуют, считаются покинувшими товарный склад. ''Это поле может быть недоступным в некоторых установках.'' - Строковое представление типа оплаты*'''signedcopyreceivedreserved''' - Признак факта возврата акта YES/NO — Количество зарезервированного товара. Может превышать остаток на складе, если покупатели ждут следующей поставки. ''Это поле может быть недоступным в некоторых установках.''

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

<smadetailitemmovements> <auth extra="8" login="login" pass="pass" ></auth> <code>62784259</code> <datefrom>2020-10-01</datefrom> <dateto>2020-10-02</dateto></smadetailitemmovements>

* '''smadetailcode''' - Корневой контейнер. Обязательный элемент — внутренний код товара в справочнике номенклатуры.*'''authdatefrom''' - Авторизация. Обязательный элемент — дата начала периода.*'''codedateto''' - Код акта передачи денег (см — дата окончания периода. запрос списка АПД). Обязательный элементМожет быть указан или код, или период, или код и период одновременно. 

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

<?xml version="1.0" encoding="UTF-8"?><smadetail itemmovements count="216"> <specialsmaitemmovement> <code>42494151500</code> <ordercodedate>144242017-05-26</ordercodedate> <ordernoretprice>111110</ordernoretprice> <orderdatequantity>2018-01-011</orderdatequantity> <delivereddatedelivered>2018-10-010</delivereddatedelivered> <companyitem> <code>4259</code> <name>Настольная игра Дженга</name>Компания </companyitem> <pricestatus> <code>5</code> <name>Возврат от покупателя</name>314.00 </pricestatus> <rurstore> <code>1</code>8800.00 <name>офис в Москве</name> </rurstore> <inshpriceorder>314 <ordercode>3374830</ordercode> <number>123660-0</number> <date>2017-05-24</date> <orderno>14123</orderno> <barcode>0000000670</barcode> <company>ТОВАР</company> <address>Кравченко ул.00, 1</address> <delivereddate>2017-05-29</inshpricedelivereddate> <pricekurdeliveredtime>270.12:00:00</pricekurdeliveredtime> <priceagdeliveredto />44.00 </priceagorder> <pricecalcdocument>8486.00 <code>21991</pricecalccode> <paytypenumber>2318</paytypenumber> <paytypenamedate>наличными курьером2017-05-26</paytypenamedate> <message><status/message>Доставлено </statusdocument> </specialsmaitemmovements></smadetailitemlist>

*'''codeОписание полей ответа ''' - Код записи.*'''ordercodecode''' - Код заказа. — внутренний код операции движения*'''ordernodate''' - Шифр заказа. — дата операции*'''orderdateretprice''' - Дата заказа. — цена товара*'''delivereddatequantity''' - Дата доставки. — количество товара операции*'''companydelivered''' - Получатель. — количество доставленного товара *'''priceitem''' - Стоимость услуг. — контейнер товара:*'''rurcode''' - Сумма заказа. — внутренний код товара:*'''inshpricename''' - Стоимость заказа. — наименование товара *'''pricekurstatus''' - Стоимость курьерской доставки. — контейнер статуса операции:*'''priceagcode''' - Агентское вознаграждение. — код статуса:*'''pricecalcname''' - Сумма для передачи агенту. — наименование *'''paytypestore''' - Тип оплаты: 1 - безнал — контейнер филиала, 2 - наличными курьером, 3 - наличными в офисе, 4 - перевод на карту.к которому относится операция:*'''paytypenamecode''' - Строковое представление типа оплаты — код филиала:*'''statusname''' - Статус заказа. — наименование филиала == Генерация коротких ссылок ==* '''order''' — контейнер корреспонденции:* '''ordercode''' — внутренний код заказаВ некоторых случаях, например, при использовании в СМС, может потребоваться использование коротких ссылок на ЛК.:* '''number''' — номер заказаДля этого, необходимо отправить запрос с полной ссылкой, в ответ на который придёт хэш-код для ссылки.:* '''date''' — дата заказа:* '''orderno''' — шифр:* '''Пример запроса генерации коротких ссылок:barcode''' — штрихкод<source lang="xml">:* '''company''' — компания<?xml version="1.0" encoding="UTF-8" ?>:* '''address''' — адрес<shortlink>:* '''delivereddate''' — дата вручения:* '''deliveredtime''' — время вручения <link short="0"> https://home.courierexe.ru/8/site/orders </link></shortlink></source>* '''deliveredto''' — данные о вручении, либо причина недоставки * '''shortlinkdocument''' - Корневой  — контейнер. Обязательный элемент.документа операции:*'''linkcode''' - Полная ссылка, для которой необходимо получить код. Обязательный элемент. Если атрибут  — внутренний код документа:* '''shortnumber''' равен 1, то ответ не будет содержать XML, а только хэш-код. — номер документа:* '''extnumber'Пример ответа на запрос генерации коротких ссылок'' — внешний номер документа:* '''date''' — дата документа:* '''message''' — комментарий == Получение справочника тарифов по городам == '''Пример запроса справочника тарифов по городам'''<source lang="xml"><?xml version="1.0" encoding="UTF-8"?><tariffs> <auth extra="8" login="login" pass="pass" /> <townfrom>Москва</townfrom> <service>1</service> <mainonly>1</mainonly> </tariffs></source> * '''auth''' — атрибут '''extra''' обязателен, по нему определяется курьерская служба.* '''townfrom''' — город-отправитель. Если не передан, то городом будет «Москва».* '''service''' — режим доставки. Обязательный элемент.* '''mainonly''' — необязательный элемент. Если передан, то в ответе будут данные только по городам из справочника '''Межгород''' > '''Зоны'''.   '''Пример ответа справочника тарифов по городам'''<source lang="json">{ "townfrom": "0c5b2444-70a0-4932-980c-b4dc0d3f02b5", "service": 1, "tariffs": [ { "towntofias": "0c5b2444-70a0-4932-980c-b4dc0d3f02b5", "towntocode": 1, "towntoname": "Москва город", "townregion": "Город Москва", "distance": 0, "pricedistance": 0, "pricesnew": { "before": [ { "price": 100, "every": 0, "mass": 1 }, { "price": 150, "every": 0, "mass": 5 } ], "after": [ { "price": 0, "every": 1, "mass": 38.01 }, { "price": 15, "every": 1, "mass": 51.01 } ] }, "deliveryPeriodMin": 1, "deliveryPeriodMax": 2 } ]}</source> ''' Описание полей ответа '''* '''townfrom''' — код ФИАС города-отправителя.* '''service''' — режим доставки.* '''tariffs''' — cписок тарифов по городу.:* '''townregion''' — регион города-получателя.:* '''towntofias''' — код ФИАС города-получателя.:* '''towntocode''' — внутренний код города-получателя.:* '''towntoname''' — наименование города-получателя.:* '''distance''' — дистанция в км до города от МКАД, если в запросе townfrom — Москва.:* '''pricedistance''' — сумма за километраж до города от МКАД, если в запросе townfrom — Москва.:* '''pricesnew''' — ваши настройки тарифов из справочника '''Межгород''' > '''Тарифы по зонам'''.::* '''before/after''' — контейнеры ДО/ОТ.:::* '''price''' — цена. Если ответ идет по «before», то в цену также плюсуется сумма pricedistance:::* '''every''' — за каждые.:::* '''mass''' — масса.:* '''prices''' — устаревший элемент, не используется.:* '''deliveryPeriodMin''' — минимальный срок доставки.:* '''deliveryPeriodMax''' — максимальный срок доставки. == Номенклатура приходной накладной =='''Пример запроса номенклатуры приходной накладной:'''<source lang="xml"><?xml version="1.0" encoding="UTF-8" ?><itemdoc> <auth extra="8" login="login" pass="pass"></auth> <code>21991</code></itemdoc></source> * '''code''' — внутренний код документа приходной накладной (см. предыдущий запрос).  '''Пример ответа движения номенклатуры:'''<source lang="xml"><?xml version="1.0" encoding="UTF-8" ?><itemdoc> <code>21991</code> <number>318</number> <date>2017-05-26</date> <message></message> <items> <item code="4259" quantity="1" barcode="200300" article="123555">Настольная игра Дженга</item> </items></itemdoc></source> ''' Описание полей ответа '''* '''code''' — внутренний код приходной накладной* '''number''' — номер документа* '''date''' — дата документа* '''message''' — комментарий * '''item''' — контейнер товара:* '''code''' — внутренний код товара:* '''barcode''' — штрихкод товара:* '''article''' — артикул товара:* '''quantity''' — количество поступившего товара == Справочник филиалов =='''Пример запроса списка филиалов:'''<source lang="xml"><?xml version="1.0" encoding="UTF-8" ?><storelist> <auth extra="8"></auth> <json>YES</json> <client_code>7890</client_code></storelist></source> * '''auth''' — Атрибут '''extra''' — обязателен, по нему определяется курьерская служба* '''json''' — Признак вывода ответа в виде JSON YES/NO* '''client_code''' — Код клиента курьерской службы '''Пример ответа:'''<source lang="xml"><?xml version="1.0" encoding="UTF-8" ?><storelist count="2"> <store> <code>123</code> <name>ABC</name> </store> <store> <code>456</code> <name>Филиал 2</name> </store></storelist></source> * '''code''' — Код филиала.* '''name''' — Наименование филиала. == Справочник пунктов самовывоза ==Для отображения списка пунктов выдачи (ПВЗ) есть '''готовый JavaScript модуль''': https://home.courierexe.ru/js/measoft_map.js Инструкция по использованию — внутри. Посмотреть пример работы можно [https://home.courierexe.ru/pvz_test.html Здесь] Уникальные запросы списка ПВЗ кешируются на стороне личного кабинета и хранятся до 7 часов утра по московскому времени следующего дня. Например, если уникальный запрос с массой 2 кг был отправлен сегодня в 10 часов, то завтра в 7 утра он сбросится. Если сегодня в 18 часов в этом же запросе вы укажете массу 2 кг, в ответе вернется тот же список ПВЗ. Если передадите массу 3 кг, список может быть другим. Обратите внимание, что если в выборке количество ПВЗ больше '''10000''' и не указаны параметры '''code''', '''json''' или '''limitcount''', то будет возвращаться ошибка. В этом случае необходимо использовать блок '''limit'''. '''Пример запроса пунктов самовывоза:'''<source lang="xml"><?xml version="1.0" encoding="UTF-8" ?><pvzlist> <auth extra="8" login="login" pass="pass"></auth> <code>1234</code> <client_code>7890</client_code> <city>Свердловская область</city> <town regioncode="66" country="RU">Нижний Тагил</town> <address>Щёлковское шоссе</address> <house>77</house> <parentcode>6</parentcode> <acceptcash>YES</acceptcash> <acceptcard>YES</acceptcard> <acceptfitting>YES</acceptfitting> <maxweight>30</maxweight> <acceptindividuals>YES</acceptindividuals> <lt>57.924737</lt> <lg>59.940019</lg> <rt>57.905682</rt> <rg>59.984669</rg> <json>YES</json> <with_coords>YES</with_coords> <limit> <limitfrom>30</limitfrom> <limitcount>2</limitcount> <countall>YES</countall> </limit></pvzlist></source> * '''auth''' — Атрибут '''extra''' — обязателен, по нему определяется курьерская служба, '''login''' и '''pass''' позволяют авторизоваться под клиентом: для отдельного клиента могут быть ограничения по доступности некоторых ПВЗ, и в этом случае они будут учтены.* '''code''' — Внутренний код.* '''client_code''' — Код клиента курьерской службы.* '''city''' — Регион получателя. Можно указать код региона или полное наименование региона из [[#Справочник регионов|справочника регионов]].* '''town''' — Город получателя.Для тега города '''town''' можно указать код региона в атрибуте '''''regioncode''''' из [[#Справочник регионов|справочника регионов]]. Поиск будет производиться в указанном регионе. Также можно указать страну получателя в атрибуте '''''country''''' в соответствии с [https://ru.wikipedia.org/wiki/ISO_3166-1 стандартом ISO_3166-1], например, «RU», «RUS» или «643» для России.Для формата запроса JSON фильтрация по городу работает только в связке с фильтром по адресу. * '''address''' — Фильтр по адресу, работает только в связке с фильтром по городу* '''house''' — Фильтр по номеру дома, работает только в связке с фильтрами по адресу и городу* '''parentcode''' — Фильтр по родительскому [[#Справочник филиалов|филиалу]]* '''acceptcash''' — Фильтр по приему наличных YES/NO* '''acceptcard''' — Фильтр по приему банковских карт YES/NO* '''acceptfitting''' — Фильтр по наличию примерки YES/NO* '''maxweight''' — Фильтр по максимальному весу, с которым работает ПВЗ* '''acceptindividuals''' — Фильтр по доступности физическим лицам YES/NO* '''lt''' — Широта левого верхнего угла* '''lg''' — Долгота левого верхнего угла* '''rt''' — Широта правого нижнего угла* '''rg''' — Долгота правого нижнего угла* '''json''' — Признак вывода ответа в виде JSON YES/NO* '''with_coords''' — Признак вывода ПВЗ только с наличием координат YES/NO* '''limit''' — Ограничивает вывод результата.:* '''limitfrom''' — Задает номер записи результата, начиная с которой выдавать ответ. По-умолчанию — 0.:* '''limitcount'''- Задает количество записей результата, которые нужно вернуть. По-умолчанию — 100.:* '''countall''' — YES указывает на необходимость подсчета общего количества найденных совпадений. Это может замедлять выполнение запроса. Если отключено — в ответе не указываeтся totalcount.  '''Пример ответа справочника пунктов самовывоза:'''<source lang="xml"><?xml version="1.0" encoding="UTF-8" ?><pvzlist count="2" totalcount="40465"> <pvz> <code>126</code> <clientcode>3</clientcode> <name>Нижний Тагил</name> <parentcode>6</parentcode> <parentname>Интеграция</parentname> <town code="124267" regioncode="66" regionname="Свердловская область">Нижний Тагил город</town> <address>622036, г. Нижний Тагил, ул. Циолковского, д. 17</address> <phone>+73435417709, +73435254989</phone> <comment>Новый пункт доставки</comment> <worktime>Вс 10:00-16:00, Сб 10:00-16:00, Пн-Пт 10:00-20:00</worktime> <traveldescription>Жилое 5-ти этажное здание, торцом к дороге, второе здание от перекрестка Пархоменко-Циолковского</traveldescription> <maxweight>10</maxweight> <acceptcash>YES</acceptcash> <acceptcard>YES</acceptcard> <acceptfitting>YES</acceptfitting> <acceptindividuals>YES</acceptindividuals> <latitude>57.93457</latitude> <longitude>59.95131</longitude> <uid>40606d00-9c51-11eb-b2c9-cfd6c1111392</uid> </pvz> <pvz> <code>245</code> <clientcode>NTG1</clientcode> <name>На Красноармейской</name> <parentcode>6</parentcode> <parentname>Интеграция</parentname> <town code="124267" regioncode="66" regionname="Свердловская область">Нижний Тагил город</town> <address>КРАСНОАРМЕЙСКАЯ, д.79</address> <phone>+7(3435)379-044</phone> <comment>Возможность примерки отсутствует</comment> <worktime>Вс 10:00-16:00, Сб 10:00-16:00, Пн-Пт 10:00-20:00</worktime> <traveldescription>Напротив ТЦ Пирамида</traveldescription> <maxweight>20</maxweight> <acceptcash>YES</acceptcash> <acceptcard>YES</acceptcard> <acceptfitting>NO</acceptfitting> <acceptindividuals>YES</acceptindividuals> <latitude>57.93468</latitude> <longitude>60.55476</longitude> <uid>41116853-9c51-11eb-b2c9-cfd6c1451392</uid> </pvz></pvzlist></source> * '''code''' — Код ПВЗ в системе. Используется в запросе [[API#Оформление заказа|оформления заказов]]* '''clientcode''' — Код ПВЗ используемый компанией-подрядчиком.* '''name''' — Наименование ПВЗ.* '''parentcode''' — Код родительского элемента.* '''parentname''' — Наименование родительского элемента.* '''town''' — Населенный пункт с кодом из [[#Справочник городов|справочника городов]], а также с кодом и наименованием региона.* '''address''' — Адрес ПВЗ.* '''phone''' — Телефоны ПВЗ.* '''comment''' — Дополнительная информация.* '''worktime''' — Режим работы ПВЗ.* '''traveldescription''' — Описание местонахождения ПВЗ или пути к нему.* '''maxweight''' — Максимальный вес, с которым работает ПВЗ.* '''acceptcash''' — Признак приема наличных* '''acceptcard''' — Признак приема банковских карт* '''acceptfitting''' — Наличие примерки* '''latitude''' — Широта* '''longitude''' — Долгота* '''uid''' — Уникальный идентификатор ПВЗ в системе Measoft* '''count''' — Количество записей в ответе* '''totalcount''' — Общее количество записей, отвечающее параметрам запроса == Получение фискальных данных заказа =='''Пример запроса получения фискальных данных:'''<source lang="xml"><?xml version="1.0" encoding="UTF-8"?><receiptdata> <auth extra="8" login="login" pass="pass" /> <orders> <order orderno="123456" /> <order orderno="890111C" /> </orders></receiptdata>  </source> '''Пример ответа получения фискальных данных:'''<source lang="xml">  <?xml version="1.0" encoding="UTF-8"?><receipts count="1"> <receipt> <orderno>123456</orderno> <fdDatetime>2020-06-07 12:14:00</fdDatetime> <fdValue>123</fdValue> <fdNum>456</fdNum> <fnSn>789</fnSn> <kktNum>100</kktNum> <inn>222</inn> <ofdUrl>gate.ofd.ru</ofdUrl> <fullUrl>https://check.ofd.ru/123</fullUrl> <price>12345</price> <lines count="1"> <line> <item>1111764</item> <name>Сапоги</name> <qty>1</qty> <price>1000</price> <vatRate>20</vatRate> <governmentCode>Z16513LK2</governmentCode> <itemType>1</itemType> </line> </lines> </receipt></receipts></source> Параметры ответа:* '''orderno''' — Номер заказа* '''fdDatetime''' — Дата и время пробития фискального чека* '''fdValue''' — ФПД (фискальный признак документа)* '''fdNum''' — ФИСКАЛЬНЫЙ ДОКУМЕНТ (фискальный номер чека)* '''fnSn''' — ФН (номер фискального накопителя)* '''kktNum''' — РН (регистрационный номер кассы)* '''inn''' — ИНН* '''ofdUrl''' — URL адрес (доменное имя) ОФД* '''price''' — Сумма чека* '''fullUrl''' — URL чека для просмотра онлайн* '''lines''' — Позиции чека:* '''item''' — код товара:* '''name''' — наименование товара:* '''qty''' — количество товара:* '''price''' — цена товара:* '''governmentCode''' — считанная последовательность, которая в дальнейшем преобразуется по алгоритму тега 1162:* '''vatRate''' — НДС товара:* '''itemType''' — тип товара (товар, доставка и т. д.) == Справочник Виды срочности =='''Пример запроса видов срочности:'''<source lang="xml"><?xml version="1.0" encoding="UTF-8" ?><services><auth extra="8"/></services></source> '''Пример ответа справочника видов срочности:'''<source lang="xml"><?xml version="1.0" encoding="UTF-8" ?><services count="2"> <service> <code>1</code> <name>Эконом</name> </service> <service> <code>2</code> <name>Срочно</name> </service></services></source> == Справочник дополнительных услуг =='''Пример запроса дополнительных услуг:'''<source lang="xml"><?xml version="1.0" encoding="UTF-8"?><advprices> <auth extra="8" login="login" pass="pass" /></advprices></source> '''advprices''' — Корневой контейнер. Обязательный элемент.  '''Пример ответа справочника дополнительных услуг:'''<source lang="xml"><?xml version="1.0" encoding="UTF-8" ?><advprices> <advprice> <code>1</code> <name>Этажей в доме</name> <type>int</type> </advprice> <advprice> <code>2</code> <name>Коэффициент надбавки</name> <type>float</type> </advprice> <advprice> <code>3</code> <name>Расписаться на упаковке</name> <type>bool</type> </advprice></advprices></source> Параметры:* '''code''' — внутренний код услуги* '''name''' — наименование услуги. Если поле «название в ЛК» в настройках услуги не пусто, то возвращает значение поля «название в ЛК».* '''hine''' — подсказка по доп услуге для пользователя* '''type''' — тип услуги. Может иметь значения::* '''bool''' — для услуг вида «чекбокс», «Да»:* '''float''' — для числа с плавающей точкой:* '''int''' — для целого числа == Расчет стоимости доставки =='''Пример запроса стоимости доставки:'''<source lang="xml"><?xml version="1.0" encoding="UTF-8" ?><calculator> <auth extra="8" login="login" pass="pass" /> <order> <pricetype>CUSTOMER</pricetype> <sender> <town>Санкт-Петербург</town> <address>Петровка 38 офис 35</address> <coords lat="55.680327" lon="37.604456"></coords> </sender> <receiver> <zipcode>125480</zipcode> <town regioncode="78" country="RU">Санкт-Петербург</town> <address>Петровка 38 офис 35</address> <pvz>124</pvz> <coords lat="55.680327" lon="37.604456"></coords> </receiver> <weight>5.1</weight> <service>2</service> <paytype>CASH</paytype> <price>387.5</price> <deliveryprice>150</deliveryprice> <inshprice>387.5</inshprice> <packages> <package mass="1" quantity="5"></package> <package mass="2.5" length="10" width="20" height="30"></package> </packages> <userid>user123</userid> <groupid>customer</groupid> </order></calculator></source>  Параметры:Структура данных и заполнение полей аналогичны и совместимы с [[#Оформление заказа]]. Дополнительные поля:* '''pricetype''' — тип требуемой цены. Возможные значения: «CUSTOMER» (по-умолчанию) — [[Личный кабинет клиента#Цена доставки для получателя|цена для конечного получателя]], «CLIENT» — цена курьерской службы для клиента.* '''userid''' — Идентификатор пользователя, строковый или числовой тип. Виртуальное поле. Необязательное. Данное поле используется совместно с настройками «Цена доставки для получателя», определяя приоритет правила. Можно использовать в различных CMS/CRM системах, настраивая цены для определенного покупателя.* '''groupid''' — Идентификатор группы пользователя, строковый или числовой тип. Виртуальное поле. Необязательное. Данное поле используется совместно с настройками «Цена доставки для получателя», определяя приоритет правила. Можно использовать в различных CMS/CRM системах, настраивая цены для определенной группы покупателей. Суммы НП и ОЦ, а также тип оплаты CARD имеют значение при настроенных в тарифе на вкладке Прочее долях (в процентах) от данных сумм. В авторизации можно опустить параметры login и pass, тогда расчет будет производиться по стандартному тарифу курьерской службы, без учета возможных отличий для конкретного клиента.<br>Объемный вес будет учитываться только при условии указания всех габаритов: длины, ширины и высоты.<br>В полях город-отправитель и город-получатель можно указывать название города (не рекомендуется!), либо код города из нашего справочника, либо 13-ти значный код КЛАДР, либо 36-ти значный код адресной системы ФИАС (AOID).  '''Пример ответа стоимости доставки:'''<source lang="xml"><?xml version="1.0" encoding="UTF-8"?><calculator> <calc> <townfrom code="1">Москва город</townfrom> <townto code="56603">Иркутск город</townto> <mass>3.7</mass> <service name="Экспресс">1</service> <zone>2</zone> <price>1113</price> <mindeliverydays>1</mindeliverydays> <maxdeliverydays>3</maxdeliverydays> <mindeliverydate>2020-05-13</mindeliverydate> <intervals> <workdays> <interval>10:00-16:00</interval> <interval>16:00-22:00</interval> </workdays> <holidays> <interval>12:00-16:00</interval> </holidays> </intervals> <deliveryprice> <advprice code="1" price="1000">База</advprice> <advprice code="4" price="100">Процент от суммы руб</advprice> <advprice code="5" price="63">Процент от объявленной стоимости</advprice> <advprice code="6" price="-50">Скидка при доставке</advprice> </deliveryprice> </calc></calculator></source> Параметры:* '''townfrom''' — Город-отправитель так, как система его распознала и привязала к справочнику. Атрибут '''code''' — код из справочника городов системы.* '''townto''' — Город-получатель так, как система его распознала и привязала к справочнику. Атрибут '''code''' — код из справочника городов системы.* '''mass''' — Масса в килограммах* '''service''' — Режим доставки — число, указывающее на запись в справочнике видов срочности (см описание на этой странице).* '''zone''' — номер тарифной зоны, по которой рассчиталась стоимость. В зависимости от зоны выбирается тарифная сетка. Так же к цене могут применяться повышающие или понижающие коэффициенты при доставке не из/в региональный центр.* '''price''' — рассчитанная стоимость доставки в валюте прайс-листа курьерской службы. Рекомендуется к использованию в отличие от одноименного атрибута родительского контейнера.* '''maxdeliverydays''' — максимальный срок доставки в рабочих днях.* '''mindeliverydate''' — минимальная дата доставки в учетом выходных дней.* '''intervals''' — список интервалов доставки для соответствующей зоны и режима срочности.* '''deliveryprice''' — Данные по составляющим ценам доставки '''''Обратите внимание:''''' В реальном ответе сервера в теге calc присутствует атрибут «price». Он оставлен для обратной совместимости, не используйте его. Пользуйтесь вложенным тегом price. == Получение информации о клиенте =='''Пример запроса получения информации о клиенте:'''<source lang="xml"><?xml version="1.0" encoding="UTF-8" ?><client> <auth extra="8" login="login" pass="pass" /> </client></source> '''client''' — Корневой контейнер. Обязательный элемент.* '''auth''' — Авторизация. Обязательный элемент. '''Пример ответа на запрос получения информации о клиенте:'''<source lang="xml"><?xml version="1.0" encoding="UTF-8" ?><client> <code>1082</code></client></source> * '''code''' — Код клиента == Список актов передачи денег =='''Пример запроса списка актов передачи денег:'''<source lang="xml"><?xml version="1.0" encoding="UTF-8" ?><smalist> <auth extra="8" login="login" pass="pass" /> <datefrom>2016-02-10</datefrom> <dateto>2016-03-10</dateto></smalist></source> '''smalist''' — Корневой контейнер. Обязательный элемент.* '''auth''' — Авторизация. Обязательный элемент.* '''datefrom''' — Дата «с». Необязательный элемент.* '''dateto''' — Дата «по». Необязательный элемент.Если интервал дат не указан, то возвращаются акты передачи денег за последний месяц. '''Пример ответа на запрос списка актов передачи денег:'''<source lang="xml"><?xml version="1.0" encoding="UTF-8"?><smalist count="1"> <sma> <code>6278</code> <number>3992</number> <actdate>2016-02-12</actdate> <datepay></datepay> <dateto>2016-02-12</dateto> <promiseddatepay></promiseddatepay> <price>637.00</price> <pricecorr>113.00</pricecorr> <rur>13430.00</rur> <pricekur>570.00</pricekur> <priceag>67.00</priceag> <payno>42423</payno> <paytype>1</paytype> <paytypename>Безнал</paytypename> <signedcopyreceived>NO</signedcopyreceived> </sma></smalist></source> * '''code''' — Код акта* '''number''' — Номер акта в системе* '''actdate''' — Дата акта* '''datepay''' — Дата оплаты по акту* '''dateto''' — Дата конечного периода для формирования АПД* '''promiseddatepay''' — Плановая дата оплаты* '''price''' — Стоимость услуг* '''pricecorr''' — Сумма корректировки* '''rur''' — Сумма заказа* '''pricekur''' — Стоимость курьерской доставки* '''priceag''' — Агентское вознаграждение* '''payno''' — Номер платежного поручения* '''paytype''' — Тип оплаты: 1 — безнал, 2 — наличными курьером, 3 — наличными в офисе, 4 — перевод на карту* '''paytypename''' — Строковое представление типа оплаты* '''signedcopyreceived''' — Признак факта возврата акта YES/NO == Детализация актов передачи денег =='''Пример запроса детализации актов передачи денег:'''<source lang="xml"><?xml version="1.0" encoding="UTF-8" ?><smadetail> <auth extra="8" login="login" pass="pass" /> <code>6278</code></smadetail></source> '''smadetail''' — Корневой контейнер. Обязательный элемент.* '''auth''' — Авторизация. Обязательный элемент.* '''code''' — Код акта передачи денег (см. запрос списка АПД). Обязательный элемент. '''Пример ответа на запрос детализации актов передачи денег:'''<source lang="xml"><?xml version="1.0" encoding="UTF-8"?><smadetail count="2"> <specialsma> <code>42494</code> <ordercode>14424</ordercode> <orderno>11111</orderno> <orderdate>2018-01-01</orderdate> <delivereddate>2018-10-01</delivereddate> <company>Компания</company> <price>314.00</price> <rur>8800.00</rur> <inshprice>314.00</inshprice> <pricekur>270.00</pricekur> <priceag>44.00</priceag> <pricecalc>8486.00</pricecalc> <paytype>2</paytype> <paytypename>наличными курьером</paytypename> <weight>0.400</weight> <distance>0.0</distance> <status>Доставлено</status> </specialsma></smadetail></source> * '''code''' — Код записи.* '''ordercode''' — Код заказа.* '''orderno''' — Шифр заказа.* '''orderdate''' — Дата заказа.* '''delivereddate''' — Дата доставки.* '''company''' — Получатель.* '''price''' — Стоимость услуг.* '''rur''' — Сумма заказа.* '''inshprice''' — Стоимость заказа.* '''pricekur''' — Стоимость курьерской доставки.* '''priceag''' — Агентское вознаграждение.* '''pricecalc''' — Сумма для передачи агенту.* '''paytype''' — Тип оплаты: 1 — безнал, 2 — наличными курьером, 3 — наличными в офисе, 4 — перевод на карту.* '''paytypename''' — Строковое представление типа оплаты* '''weight''' — Вес заказа.* '''distance''' — Дистанция по заказу* '''status''' — Статус заказа. == Генерация коротких ссылок ==В некоторых случаях, например, при использовании в СМС, может потребоваться использование коротких ссылок на ЛК.Для этого, необходимо отправить запрос с полной ссылкой, в ответ на который придёт хэш-код для ссылки. '''Пример запроса генерации коротких ссылок:'''<source lang="xml"><?xml version="1.0" encoding="UTF-8" ?><shortlink> <link short="0"> https://home.courierexe.ru/8/site/orders </link></shortlink></source> '''shortlink''' — Корневой контейнер. Обязательный элемент.* '''link''' — Полная ссылка, для которой необходимо получить код. Обязательный элемент. Если атрибут '''short''' равен 1, то ответ не будет содержать XML, а только хэш-код. '''Пример ответа на запрос генерации коротких ссылок:'''<source lang="xml"><?xml version="1.0" encoding="UTF-8"?><shortlink> <hash>35AF350C</hash></shortlink></source> * '''hash''' — Хэш-код ссылки. Далее, можно использовать ссылку на ЛК: <nowiki>https://home.courierexe.ru/35AF350C или curie.ru/35AF350C</nowiki>  '''Примечание!''' Сервис коротких ссылок работает только для ресурсов компании MeaSoft. == Проверка надежности покупателя ==Проверка надежности работает только для тарифа «Максимум» личного кабинета. <source lang="xml"><?xml version="1.0" encoding="UTF-8" ?><mcheck> <auth extra="8" login="login" pass="pass" /> <phones> <phone>89161147992</phone> </phones></mcheck></source> Ответ: <source lang="xml"><?xml version="1.0" encoding="UTF-8" ?><mcheck> <phones> <phone rate="90">89161147992</phone> </phones></mcheck></source>  == Размещение страниц на своем сайте (iframe) == В некоторых случаях имеет смысл разметить те или иные страницы на своем сайте. Например, чтобы клиенты могли рассчитать стоимость доставки не переходя по внешней ссылке, а там же, на сайте, калькулятор можно разместить прямо на странице такого сайта посредством так называемого фрейма — '''iframe'''. [https://ya.ru/search/?text=iframe Фрейм] — контейнер внутри обычной страницы, который позволяет загружать сторонние страницы. Пример загрузки калькулятора: <source lang="html"><iframe id="frame" src="https://home.courierexe.ru/8/calculator"> Здесь должен отобразиться калькулятор</iframe></source> Для удобства пользователей вашего сайта можно указать язык интерфейса (который переключается непосредственно на сайте) параметром '''lang''': <source lang="html"><iframe id="frame" src="https://home.courierexe.ru/8/calculator?lang=2"> Здесь должен отобразиться калькулятор</iframe></source> Обратите внимание! Если язык не указать, то на страницах калькулятора и трекинга отображается свой переключатель языка. Если язык указан, то переключатель не отоборажается. Поддерживаемые языки и их коды::'''1''' — русский:'''2''' — английский:'''4''' — узбекский == Оформление манифеста == '''Пример запроса на создание манифеста:'''<source lang="xml"><?xml version="1.0" encoding="UTF-8" ?><manifest> <auth extra="8" login="login" pass="pass" /> <store_from>1</store_from> <store_to>2</store_to> <trn_code>3</trn_code> <addresses> <address> <code>456</code> </address> </addresses></manifest></source>  '''manifest''' - Корневой контейнер. Обязательный элемент.*'''auth''' - Авторизация. Обязательный элемент.*'''store_from''' - код филиала отправителя. Обязательный элемент.*'''store_to''' - код филиала получателя. Обязательный элемент.*'''trn_code''' - код перевозчика. Обязательный элемент.  '''Пример успешного ответа'''<source lang="xml"><?xml version="1.0" encoding="UTF-8"?><manifest> <result>OK</result></manifest></source>  '''Пример ответа с ошибкой'''

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

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