Изменения

Перейти к: навигация, поиск

API

41 815 байт добавлено, 8 май
м
→‎Коды и описание ошибок
<div style="font-size: 24px; color: #2424a9; background-color: #deffde; border: 1px solid #ebccd1; padding: 3px 10px 10px; text-align: center">
'''English version is [[API documentationDocumentation|HERE!]]'''
</div>
Вы можете настроить интегацию интеграцию с MeaSoft средствами XML API по протоколу HTTP POST.
API предназначено для интеграции клиентов (интернет-магазинов и прочих компаний-заказчиков доставки) с [http://courierexe.ru/our_clients.htm курьерскими службами], работающими под управлением системы [https://curie.ru/ MeaSoft].
Если вы '''агрегатор''', передающий данные от клиентов, возможно, вам придется последовательно подключаться под разными пользователями, если курьерская служба должна вести раздельный учет взаиморасчетов по клиентам.
== Готовые интеграции ==
Для работы с популярными CMS и CRM-системами разработаны модули интеграции, перечисленные в таблице ниже.
Для работы с популярными CMS и CRM-системами разработаны модули интеграции, перечисленные в таблице ниже.  '''Модули распространяются бесплатно, без гарантий со стороны разработчика''', и не являются средством полной автоматизации взаимодействия с курьерской службой. Модули — Модули — это помощь разработчикам интернет-магазинов в построении интеграции с курьерскими службами. '''Ответственность за корректность передачи данных лежит на интернет-магазине.'''Модули сторонних разработчиков обслуживаются и разрабатываются сторонними компаниями. Все вопросы по их приобретению и поддержке необходимо задавать им.
Сообщайте нам свои пожелания по работе наших модулей. Мы учтем их в новых версиях.
|-
|[[Файл:bitrix.png|center|x44px]]
|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|x60px]]
|style="text-align: center;"|[httphttps://courierexe.ru/download/api/prestashop.zip Скачать]|Поддерживает версии 1.5.2.0 и выше (2.x Инструкция в том числе)архиве
|-
|[[Файл:OpencartOCStore.png|center|x60px]]
|style="text-align: center;"|[httphttps://courierexe.ru/download/api/opencart.zip Скачать для версии 1.5.5.1]<br>[httphttps://courierexe.ru/download/api/measoft_oc2.ocmod.zip Скачать для версии 2.0]<br>[httphttps://courierexe.ru/download/api/measoft_oc2.3.ocmod.zip Скачать для версии 2.3]<br>[httphttps://courierexe.ru/download/api/measoft_ос3measoft_oc3.ocmod.zip Скачать для версии 3.0]|Поддерживает версии с 1.5.5.1.<br>Скачивайте модули для своей версии OpenCart.<br>Подробнее см. [[Интеграция с другими системами#OpenCart 1.5.5.1|описание]].<br>[https://opencartforum.com/files/file/2906-avtomatizaciya-otpravki-i-otslezhivanie-dostavok-courierexe-dlya-opencart-15x/ Альтернативный модуль сторонних разработчиков]
|-
|[[Файл:webasyst-shopscript.png|center|x44px]]
|style="text-align: center;"|[httphttps://www.webasyst.ru/store/plugin/shop/measoftcourier/ Установить модуль]<br>[https://www.webasyst.ru/store/plugin/shipping/measoftcourier/ Установить плагин]|Модуль предназначен для отправки заявок в КС, а плагин для расчета стоимости доставки при оформлении заказа.Инструкции в маркете
|-
<!--|[[Файл:advantshop.png|center|x44px]]
|style="text-align: center;"|[https://promo-z.ru/ Сайт компании PROMO]
|Компания PROMO разработала этот модуль и настраивает интеграцию MeaSoft с ADVANTSHOP своим клиентам.
|- -->
|[[Файл:insales.png|center|x80px]]
|style="text-align: center;"|Настраивается в [[Личный кабинет клиента|ЛК пользователя]]
|[[InSales|Инструкция по настройке]]
|-
|[[Файл:insalesiiko.pngjpg|center|x80px]]
|style="text-align: center;"|Настраивается в [[Личный кабинет клиента|ЛК пользователя]]
|[[Интеграция с другими системами#InSalesIiko|Инструкция по настройке]]
|-
|[[Файл:Leadvertex.png|center|x44px]]
|style="text-align: center;"|[httphttps://blog.leadvertex.ru/news/2110-integraciya-s-kurerkami-na-platforme-measoft Настраивается] в ЛК [https://Leadvertex.ru Leadvertex]|[[Интеграция с другими системами#LeadVertex|Инструкция по настройке]]<br>Модуль разработан и поддерживается компанией LeadVertex.
|-
|[[Файл:Retailcrm.png|center|x30px]]
|style="text-align: center;"|[https://www.retailcrm.ru/ RetailCRM]
|[http://wiki.courierexe.ru/index.php?title=Интеграция_с_другими_системами#[RetailCRM |Настраивается]] в ЛК пользователя в системе
|-
|[[Файл:1C.jpg|center|x44px]]
|style="text-align: center;"|-
|[https://infostart.ru/public/692790/ Альтернативный модуль сторонних разработчиков(1 версия)] [https://infostart.ru/public/1531484/ Альтернативный модуль сторонних разработчиков (2 версия)]
|-
|[[Файл:Joomla2.jpg|center|x60px]]
|style="text-align: center;"|[httphttps://courierexe.ru/download/api/com_measoft.zip Скачать]|Работает только с компонентом Virtuemart.Инструкция в архиве
|-
|[[Файл:Amocrm.png|center|x44px]]
|style="text-align: center;"|[https://www.amocrm.ru/extensions/courier2008 Установить]
|Подробнее см. [[Интеграция с другими системами#amoCRM|описание]].
|-
|rowspan="2"|[[Файл:MoySclad.jpg|center|x30px]]
|style="height:50px; text-align: center;"|[https://home.courierexe.ru/moysklad/step1 Настроить интеграцию с MeaSoft]
|[[Интеграция с другими системами#МойСклад|Инструкция]]
|-
|style="height:50px; text-align: center;"|[https://itmdev.ru/ms/shipping/ Скачать модуль сторонних разработчиков]
|-
|[[Файл:wordpress.jpg|center|x80px]]
|style="text-align: center;"|[httphttps://courierexe.ru/download/apiwordpress/wordpress.zip php Скачать]|[[Интеграция с другими системами#Wordpress|Инструкция]]
|-
|[[Файл:Cscart.png|center|x60px]]
|style="text-align: center;"|[https://marketplace.cs-cart.com/measoft-en.html Установить]
|Поддерживает версии 4.10 и выше.<br>[[Интеграция с другими системами#CS-Cart|Инструкция]]|-|[[Файл:webhooks.jpg|center|x100px]]|style="text-align: center;"|Читайте описание [[Webhook|на этой странице]]|Передача информации о статусах и заказах в вашу систему
|-
|}
'''Обратите внимание!''' В модулях систем PrestaShop и Joomla для отправки заказа в курьерскую службу зайдите в карточку заказа. В карточке отображается специальная форма отправки заказа, а если заказ отправлен, она позволяет проверить его статус:[[Файл:Form.png|400 px|Форма отправки заказа|none]]
Для отображения списка пунктов выдачи есть [https://home.courierexe.ru/js/measoft_map.js JavaScript модуль]. Инструкция по использованию — использованию — внутри. Посмотреть пример работы можно [https://home.courierexe.ru/pvz_test.html здесь].
== Тестовый аккаунт ==
Для отладки зайдите в тестовый личный кабинет по адресу [https://home.courierexe.ru/8 https://home.courierexe.ru/8], логин: login пароль: pass.
Для отладки Вы На вкладке '''Интеграция''' > '''Отладка''' вы можете зайти в тестовый личный кабинет по адресу [https://home.courierexe.ru/8 https://home.courierexe.ru/8], логин: test пароль: testm. Там на закладке "Автоматизация" Вы сможете увидеть свои пробовать выполнять запросы "глазами" нашей системы. Так же там есть интерфейс к API для выполнения отладки, а также видеть историю отправленных запросов. На закладке "Созданные заказы появятся в пункте основного меню '''Отслеживание" Вы увидите созданные заказы'''.
Для упрощения интеграции можно скачать [https://courierexe.ru/download/api/php_sample.zip пример обращения к сервису на PHP].
== Рабочий аккаунт для подключения ==
Строка подключения выглядит следующим образом:
Для подключения к площадке Вашего клиента необходимо иметь три параметра: <source lang=xml><auth extra="8" login="login" pass="pass"></auth></source>
1. Описание параметров:* '''Параметр extra''' (Цифровой  — экстра-код, уникальный идентификатор компании. Запросите этот параметр у компании, с которой Вы вы интегрируетесь). Посмотреть этот код можно в интерфейсе программы КС2008 через основное меню * '''login''' — логин клиента;* '''pass''' — пароль клиента;* '''"Справочники - Дополнительные возможности"measoftid''' — системная переменная, используемая системой. Цифровое значение будет указано во второй гиперссылке (на скриншоте ниже отмечено "звездочкой"):
Запросите эти данные у курьерской службы, к которой вы подключаетесь. Курьерская служба передает временный пароль, его нужно сменить после первого входа в [[Файл:extra1.pngЛичный кабинет клиента|750pxЛК клиента]].
2. '''Логин''' - параметр учетной записи для ЛК клиента и API== Авторизация курьерской службы ==Если курьерской службе требуется подключение под своими учетным данными, указывается в карточке клиента на вкладке '''"Прочее"''' в поле '''"Имя пользователя"'''. Возможно, что в программе КС2008 понадобится создать новую карточку клиента (на скриншоте ниже).используйте строку вида:
3. <source lang=xml><auth extra="8" login="login" pass="pass" clientcode="123"></auth></source> Описание:* '''Парольextra''' - параметр учетной записи для ЛК клиента и API, указывается в карточке клиента на вкладке  — уникальный идентификатор компании;* '''login''' — логин курьерской службы;* '''"Прочее"pass''' в поле  — пароль курьерской службы;* '''"Пароль"clientcode'''  — внутренний код клиента (на скриншоте нижевкладка '''Клиенты''', столбец «Внутренний код»).
Вы можете узнать код экстра, логин и пароль курьерской службы в офисном приложении MeaSoft в справочнике '''Дополнительные возможности'''. Подробнее см. раздел «[[Файл:33_client.pngЛичный кабинет курьерской службы#Подключение|500pxПодключение]]».
== Общие понятия ==
На стороне курьерской службы имеется веб-сервис по адресу: https://home.courierexe.ru/api/. <rspoiler text="Еще есть порт 8443.">Некоторые маршрутизаторы, используемые провайдерами, РНК и прочее, в попытке глубокого анализа могут повреждать трафик на стандартный порт 443. Сделано по тикету 10964.</rspoiler> Обратите внимание на символ '''"«/"»''' (slash) в конце адреса! . Тестовые авторизационные данные: логин: test login пароль: testmpass, параметр extra: 8. Обратите внимание, что тестовая площадка для всех одна. Не нужно передавать в нее заказы с конфиденциальными данными, их смогут увидеть другие участники.
Для использования интеграции в «боевом» режиме, запросите '''логин''', '''пароль''', и параметр '''extra''' у той компании, с которой интегрируетесь.
== Ограничения ==
С целью защиты от нецелевого использования сервисов и DDoS-атак действуют следующие ограничения:
*30 запросов tracking с одного IP-адреса за 1 минуту (используйте statusreq!);*150 запросов с одного IP-адреса/акаунта за 1 минуту;*1500 запросов с одного IP-адреса/акаунта за 20 минут;*3000 запросов с одного аккаунта за 1 час;*200 Мб скачанных текстовых данных за 3 часа.* Превышение количества запросов статусов несуществующих заказов над существующими
В случае превышения IP-адрес или аккаунт блокируется на время до 3-х часов.
Чтобы не происходило блокировок:
* не нужно «бомбить» наше API запросами статусов, последовательно перебирая номера всех ваших заказов, особенно запросами "tracking"«tracking», они предназначены не для этого (смотрите описание). Особенно ровно в 00 минут каждого часа;
* не нужно каждые 5 минут делать запросы «Покажите статусы всех заказов за последние 3 месяца»;
* для проверки статусов заказов лучше всего использовать запросы [[#Передача только изменившихся статусов|измененных статусов changes=ONLY_LAST]];
* при запросе измененных статусов ОБЯЗАТЕЛЬНО нужно подтверждать успешное получение запросом [[#Передача только изменившихся статусов|commitlaststatus]].
* вы должны знать номера заказов, которые вы отправили. Не нужно перебирать номера всех заказов или брутфорсом перебирать все возможные номера.
Мы абсолютно уверены, что данные ограничения на порядки превосходят необходимые объемы предоставления сервиса для решения любых задач. Если у вас возникают проблемы, вы не знаете, как уложиться в эти рамки — рамки — спросите у нас, мы обязательно поможем!
== Оформление заказа ==
 
=== Пример оформления заказа ===
 
<source lang=xml>
<?xml version="1.0" encoding="UTF-8"?>
<coords lat="55.680327" lon="37.604456"></coords>
</receiver>
<returnprice>NO387.5</returnprice> <inshprice>387.5</inshprice> <deliveryprice VATrate="20">150</deliveryprice> <discount>120</discount> <paytype>CASH</paytype>
<weight>5.1</weight>
<return_weight>5.1</return_weight>
<quantity>2</quantity>
<paytype>CASH</paytype>
<service>2</service>
<type>3</type>
<return>NO</return>
<return_service>1</return_service>
<type>3</type>
<return_type>3</return_type>
<return_weight>5.1</return_weight>
<courier>22</courier>
<price>387.5</price>
<deliveryprice VATrate="20">150</deliveryprice>
<inshprice>387.5</inshprice>
<receiverpays>NO</receiverpays>
<discount>120</discount>
<enclosure>Детские игрушки</enclosure>
<instruction>Проверить при покупателе, подписать акт</instruction>
<acceptpartially>NO</acceptpartially>
<costcode>cc12345</costcode>
<respstore>4</respstore>
<uid>af11c7c6-6645-4a20-9604-be911a75722d</uid>
<items>
<item extcode="abc123" quantity="1" mass="0.2" retprice="37.5" VATrate="0" barcode="2345625213125" textArticle="1" article="1" volume="3" origincountry="AUT" GTD="321546654" excise="15.20" suppcompany="ООО &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>
</items>
<packages>
<package strbarcode="ORD0000001" mass="1" message="" quantity="3"></package>
<package strbarcode="ORD0000002" mass="2.5" message="" length="10" width="20" height="30"></package>
</packages>
</advprices>
<overall_volume>81</overall_volume>
<userid>user123</userid>
<groupid>customer</groupid>
</order>
</neworder>
<?xml version="1.0" encoding="UTF-8"?>
<neworder>
<auth extra="8" login="testlogin" pass="testmpass" />
<order>
<receiver>
'''Описание полей'''
*'''neworder''' -  — Корневой контейнер, обязательный элемент. :* '''''newfolder''''' — Признак нового заказа YES/NO. Если стоит YES, то в системе курьерской службы для данной корреспонденции создастся новый заказ. Необязательный элемент. * '''order''' — Контейнер для описания одного заказа, обязательный элемент. В одном контейнере '''neworder''' может быть много контейнеров '''order''' для создания нескольких заказов одним запросом. :* '''''orderno''''' — Номер заказа. Если присваивается клиентом — указывается здесь. Если не присваивается — можно оставить пустым, система сгенерирует свой номер, и вернет его в ответе. Система проверяет наличие заказов с указанным номером в пределах текущего календарного года, и в случае их существования — заказ создан не будет, а в ответе вернется ошибка 17 «Such number exists». Если не указан штрихкод (поле barcode), и значение поля подходит для использования его в качестве штрихкода, данное значение будет скопировано в поле «Штрихкод». Это накладывает ограничения в частности, на длину указанного поля (25 знаков, чтобы работали стандартные печатные формы). * '''barcode''' — Штрихкод заказа. Если клиент штрихкодирует свои отправления и штрихкод отличается от номера заказа, в этом поле указывается штрихкод. Если ШК содержит кириллицу или малое количество символов, то формируется ШК в формате EAN13. <spoiler text="Заполнение номера заказа (шифра) и штрих-кода">Шифр и штрих-код заполняются исходя из начальных значений:
:* '''''newfolder''''' # Если шифр и ШК пустые - оба поля заполняются автоматически значением вида XXX#YYY, а после ШК проверяется на корректность (валидируется)# Если ШК пустой, а шифр заполнен - Признак нового заказа YES/NO. ШК заполняется значением из шифра и валидируется# Если стоит YESшифр пустой, а ШК заполнен - шифр заполняется значением из ШК, после чего ШК валидируется# Если оба непустые - валидируется ШК, то в системе курьерской службы для данной корреспонденции создастся новый заказ. Необязательный элемент.шифр не проверяется
Корректный (валидный) ШК отвечает следующим требованиям:*'''order''' длина не меньше 5 символов* значение не меньше значения переменной <mparam code="MinPrePrintedNum"/>* содержит символы, которые можно использовать для формирования штрих- Контейнер для описания одного заказа, обязательный элементкод а формате Code128 (т. В одном контейнере '''neworder''' может быть много контейнеров '''order''' для создания нескольких заказов одним запросоме.все печатные символы, кроме кириллицы)
:* '''''orderno''''' - Номер заказа. Если присваивается клиентом - указывается здесь. Если ШК не присваивается - можно оставить пустымпрошел проверку, система сгенерирует свой номер, и вернет его в ответе. Система проверяет наличие заказов с указанным номером в пределах текущего календарного года, и в случае их существования - заказ создан не будет, а в ответе вернется ошибка 17 то:* если переменная <mparam code="Such number existsStoreInvLength". Если не указан штрих-код /> равна 0, ШК заполняются автоматически значением вида XXX#YYY (поле barcodeили приравнивается шифру в том же формате), и значение поля подходит для использования его в качестве штрих-кода, данное значение будет скопировано в поле * если переменная <mparam code="Штрих-кодStoreInvLength". Это накладывает ограничения в частности/> больше 0, на длину указанного поля ШК заполняются автоматически сквозным номером (25 знаковесли шифр в формате XXX#YYY, чтобы работали стандартные печатные формыто шифр приравнивается ШК).</spoiler>
*'''barcode''' - Штрих-код заказа. В случае, если клиент штрих-кодирует свои отправления, и штрих-код отличается от номера заказа, в этом поле указывается штрих-код. В случае наличия нескольких мест, и раздельной их маркировки, в этом поле допустимы маски в виде символов подчеркивания, говорящие о позициях штрих-кодаштрихкода, переменных для разных мест в рамках одного заказа.<br />''Например'': В заказе номер 123 имеется 20 товарных вложений, которые упакованы в 3 транспортных места. Клиент формирует 3 штрих-кода штрихкода на транспортные места: CLNT0012301, CLNT0012302, CLNT0012303, где CLNT - CLNT — префикс клиента, 00123 - 00123 — номер заказа, 01-03 - 03 — номер транспортного места в заказе. В поле barcode нужно указать CLNT00123__ (система поймет, что 2 последних символа могут быть любыми, и будут отражать штрих-коды штрихкоды к одному заказу). Если вы не сами печатаете накладные с указанным штрих-кодомштрихкодом, то указанный штрих-код штрихкод не должен быть длиннее 25 знаков, иначе он не поместится на стандартных печатных формах.
*'''sender''' -  — Информация о отправителе заказа. Необязательный контейнер.
<source lang="xml">
<sender>
</source>
*'''receiver''' -  — Информация о получателе заказа. Обязательный контейнер.
<source lang="xml">
<receiver>
</source>
*'''company''' -  — Компания-получатель.*'''person''' -  — Контактное лицо. ''Должно быть заполнено хотя бы одно из полей - полей — company или person!''*'''phone''' -  — Телефон. Можно указывать несколько телефонов, E-mail в этом поле.*'''town''' -  — Город.* '''pvz''' — Код пункта самовывоза по справочнику. Кроме того, ПВЗ можно указать в строке '''''address''''' в виде::* код ПВЗ в нашей системе:* код ПВЗ в системе подрядчика:* наименование ПВЗ в виде строки "ПВЗ " + «Наименование ПВЗ»
Для тега города '''town''' можно указать код региона в атрибуте '''''regioncode''''' из [[#Справочник регионов|справочника регионов]]. Поиск будет производиться в указанном регионе.
Также можно указать страну получателя в атрибуте '''''country''''' в соответствии с [https://ru.wikipedia.org/wiki/ISO_3166-1 стандартом ISO_3166-1], например, "RU"«RU», "RUS" «RUS» или "643" «643» для России.
Кроме того, поиск города осуществляется с учетом почтового индекса, указанного в теге '''zipcode'''.
:* код населенного пункта из [[#Справочник городов|справочника городов]]
:* 13-ти значный код адресного классификатора КЛАДР
:* 36-ти значный код адресной системы <rspoiler text="ФИАС">Федеральная информационная адресная система — система — единый российский государственный адресный реестр</rspoiler> (AOID)
:* название города (не рекомендуется!)
*'''coords''' -  — Координаты получателя. Если не указаны, система будет геокодировать самостоятельно.
* '''zipcode''' — Почтовый индекс.* '''price''' — Сумма заказа (наложенный платеж) - денежные средства, которые курьер должен забрать у получателя в пользу заказчика. В случае наличия контейнера items значение этого параметра будет проигнорировано и рассчитано автоматически.* '''inshprice''' — Объявленная ценность. Если явно не указана сумма — автоматически считается как сумма по товарам.* '''deliveryprice''' — Стоимость доставки, которая устанавливается заказчиком и будет взиматься с получателя в пользу заказчика. Не имеет отношения к стоимости доставки самой курьерской службы, которая рассчитывается в соответствии с тарифамии, не указывается при оформлении заказа и добавляется в заказ автоматически при его обработке курьерской службой. В случае наличия контейнера items в него будет добавлено вложение «Доставка».:* '''''VATrate''''' — Ставка НДС — целое число процентов.* '''discount''' — Сумма скидки. Скидка «размазывается» по товарным вложениям, сумма НП уменьшается на сумму скидки. При этом вложение Скидка не создается. ВНИМАНИЕ, при использовании этого тега общая сумма может расходиться на копейки из-за округления! Старайтесь не использовать этот тег, а указывать цену товаров уже с учетом скидок.*'''paytype''' -  — Тип оплаты заказа получателем. Принимает значения::* CASH - CASH — Наличными при получении (по-умолчанию):* CARD - CARD — Картой при получении:* NO - NO — Без оплаты. Этот тип оплаты передается, если заказ уже оплачен и не требует инкассации. API добавит к товарам строку предоплаты в сумму заказа, чтобы общая сумма была 0, однако в кассовом чеке будут все товары с ценами, и оплата предоплатой, как того требует 54-ФЗ.:* OTHER - OTHER — Прочее (Предусмотрен для того, чтобы оплата поступала непосредственно в курьерскую службу посредством прочих типов оплаты - оплаты — таких как: вебмани, яденьги, картой на сайте, прочие платежные системы и ти т.д д.):* OPTION - OPTION — На выбор получателя. Этот тип оплаты нельзя передавать с заказом. Он выставляется автоматически в зависимости от настройки клиента.* '''weight''' — Общий вес заказа в килограммах.* '''quantity''' — Количество мест.* '''service''' — Режим доставки (тип услуги) передается код из справочника «[[#Справочник Видов срочности|Виды срочности]]».* '''type''' — Тип корреспонденции (отправления) передается код из справочника «Типы корреспонденции».* '''return''' — Признак необходимости возврата. Принимает значения::* NO — Возврат не требуется:* YES — Требуется возврат, например, документов:* ONLY — Требуется забрать отправление у поставщика (см. раздел «[[Личный_кабинет_клиента#Привезти ко мне|Привезти ко мне]]»). * '''return_service''' — Режим возврата (тип услуги) передается код из справочника «Виды срочности».* '''return_type''' — Тип возвратной корреспонденции (отправления) передается код из справочника «Типы корреспонденции».* '''return_weight''' — Общий вес возврата заказа в килограммах.* '''enclosure''' — Вложение.* '''instruction''' — Поручение — Примечание.* '''courier''' — Запланированный курьер. Согласно коду курьера в КС2008.* '''receiverpays''' — Признак оплаты стоимости доставки — услуг службы доставки получателем, а не заказчиком YES/NO.* '''department''' — Подразделение, в котором оформляется заказ.* '''costcode''' — Кост-код сотрудника.* '''respstore''' — Код ответственного филиала. Для ответственного филиала в который передается заказ, требуется включение параметра "Разрешить клиенту передавать заказы в этот филиал"* '''pickup''' — Признак оформления забора YES/NO. Если стоит YES, то весь заказ считается заданием на забор груза, а не на доставку! Применяется для вызова курьера к отправителю для забора других отправлений. ''Внимание!'' при добавлении в забор складских товаров, их тип '''''type''''' всегда должен быть установлен как [7] Забор товара, если будет указан другой тип, то он будет исправлен в момент добавления заказа на [7] Забор товара* '''acceptpartially''' — Признак возможности частичного выкупа товаров отправления YES/NO.* '''uid''' - Универсальный идентификатор заказа на стороне отправителя. Не обязательный параметр, ограниченного по времени действия. Время хранения в системе, - сутки. * '''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 - Признак предмета расчета :: Пример:
*'''zipcode''' - Почтовый индекс.*'''weight''' - Общий вес заказа в килограммах.*'''return_weight''' - Общий вес возврата заказа в килограммах.*'''quantity''' - Количество мест.*'''service''' - Режим доставки (тип услуги) передается код из справочника [[#Справочник Видов срочности|<source lang="Виды срочностиjson"]].>*'''return_service''' - Режим возврата (тип услуги) передается код из справочника "Виды срочностиitem_industry_props".*'''type''' - Тип корреспонденции (отправления) передается код из справочника :{"Типы корреспонденцииtag1262".*'''return_type''' - Тип возвратной корреспонденции (отправления) передается код из справочника :"Типы корреспонденции020".*'''price''' - Сумма заказа. В случае наличия контейнера items значение данного параметра будет проигнорировано, и рассчитано автоматически"tag1263":"14.*'''deliveryprice''' - Сумма доставки12. В случае наличия контейнера items2018", в него будет добавлено вложение "Доставкаtag1264".:* '''''VATrate''''' - Ставка НДС - целое число процентов.*'''return''' - Признак необходимости возврата.*'''return_service''' - Режим возврата (тип услуги) передается код из справочника "Виды срочности1556","tag1265".*'''discount''' - Сумма скидки. Скидка :"размазываетсяtm=mdlp&sid=00000000XXXXXX" по товарным вложениям}, сумма НП уменьшается на сумму скидки. При этом вложение Скидка не создается. ВНИМАНИЕ, при использовании этого тега общая сумма может расходиться на копейки из-за округления! Старайтесь не использовать этот тег, а указывать цену товаров уже с учетом скидок.*'''enclosure''' - Вложение."tag1212": "1"*'''inshprice''' - Объявленная ценность. Если явно не указана сумма - автоматически считается как сумма по товарам.*'''instruction''' - Поручение - Примечание.*'''courier''' - Запланированный курьер. Согласно коду курьера в КС2008.*'''receiverpays''' - Признак оплаты стоимости доставки - услуг службы доставки получателем, а не заказчиком YES</NO.*'''department''' - Подразделение, в котором оформляется заказ.*'''pickup''' - Признак оформления забора YES/NO. Если стоит YES, то весь заказ считается заданием на забор груза, а не на доставку! Применяется для вызова курьера к отправителю для забора других отправлений.*'''acceptpartially''' - Признак возможности частичного выкупа товаров отправления YES/NO.source>
*'''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''''' - Ставка НДС - целое число процентов. Если значение не указано, подставляется значение "20". Значение "0" означает ставку "Без НДС", ставка "0%" на данный момент не поддерживается.
:* '''''barcode''''' - Штрих-код вложения. [[Файл:Article.png|thumb|100px|right]]
:* '''''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", иначе вернется ошибка.
*'''packages''' -  — Контейнер для описания мест. Необязательный контейнер. Атрибуты::* '''''package''''' -  — Название места.:* '''''code''''' -  — Внутренний код строки.:* '''''strbarcode''''' - Штрих-код  — Штрихкод места.:* '''''mass''''' -  — Масса места в килограммах.:* '''''message''''' -  — Строка сообщения.:* '''''length''''' -  — Длина товарного места (в сантиметрах).:* '''''width''''' -  — Ширина товарного места (в сантиметрах).:* '''''height''''' -  — Высота товарного места (в сантиметрах).:* '''''quantity''''' — Количество мест с данным набором параметров. Действует ограничение на общее количество мест в заказе. Общее количество мест в заказе не может быть больше 1000.
* '''deliveryset''' -  — настройка [[Дифференциальная Дифференцированная стоимость доставки | дифференциальной дифференцированной стоимости доставки]]. Атрибуты::* '''''above_price''''' -  — стоимость в случае полного выкупа заказа (действует как "сумма от" «сумма от» последней границы, указанной в теге below_sum):* '''''return_price''''' -  — стоимость в случае возврата заказа:* '''''VATrate''''' -  — Ставка НДС - НДС — целое число процентов.
* '''below''' -  — граница стоимости настроек:* '''''below_sum''''' -  — граница стоимости выкупаемого заказа:* '''''price''''' -  — стоимость выкупаемого заказа до соответствующей границы
* '''advprices''' -  — Контейнер для описания дополнительных услуг. Необязательный элемент. <span style="color: red;>Для обработки в API включите дополнительные услуги в настройках полей [[Личный_кабинет_курьерской_службыЛичный кабинет курьерской службы#Настройка личного кабинета клиента|заказов и заборов]]</span>:* '''''code''''' -  — код услуги.:* '''''value''''' -  — значение услуги. Если тип услуги bool, то в значении передаем true.
*'''costcodeoverall_volume''' - Кост-код сотрудника — Общий объем, м3. Виртуальное поле. Необязательное. Из этого поля рассчитывается длина/высота/ширина места. Расчет срабатывает только если в каждом месте есть нулевые значения длины или высоты или ширины.
*'''overall_volumeuserid''' - Общий объем — Идентификатор пользователя, м3строковый или числовой тип. Виртуальное поле. Необязательное. Из этого поля рассчитывается длина/высота/ширина местаДанное поле используется совместно с настройками «Цена доставки для получателя», определяя приоритет правила. Расчет срабатывает только если Можно использовать в каждом месте есть нулевые значения длины или высоты или шириныразличных CMS/CRM системах, настраивая цены для определенного покупателя.
* '''groupid''' — Идентификатор группы пользователя, строковый или числовой тип. Виртуальное поле. Необязательное. Данное поле используется совместно с настройками «Цена доставки для получателя», определяя приоритет правила. Можно использовать в различных CMS/CRM системах, настраивая цены для определенной группы покупателей.
<div style="color: #a94442; background-color: #f2dede; border: 1px solid #ebccd1; padding: 3px 10px 10px;">
'''Обратите внимание!'''
При передаче заказов, у которых плановая дата доставки/забора меньше ближайшей возможной, дата автоматически меняется на самую раннюю возможную. [[Личный_кабинет_курьерской_службыЛичный кабинет курьерской службы#Как считается минимальная дата возможной доставки|Подробнее]]</div>
В случае необходимости указания, помимо товаров, дополнительных услуг (например, ДОСТАВКА, комплектация, подъем на этаж и ти т.д д.) -  — их нужно указать в том же контейнере items как товары, без артикула.
=== Примеры ответов ===
При успешном выполнении запроса, создании заказа, возвращается сумма заказа в атрибуте orderprice, а также ошибка 0. При не успешном - успешном — номер ошибки и текст ее на английском языке в атрибуте errormsg, для некоторых ошибок выводится перевод на русский в атрибуте errormsgru.В атрибут orderno помещается номер заказа, в атрибут barcode - barcode — штрихкод заказа.
'''Пример успешного ответа'''
</source>
== Запрос статуса заказов = Коды и описание ошибок ==={|class=wikitable!Код ошибки=== Пример запроса статуса заказа ===!Английское описание!Русское описание<source lang="xml">|-<?xml version="1.|0" encoding="UTF||Success||Успешно|-8" ?><statusreq>|1||Wrong XML||Некорректный файл XML.|- <auth extra="8" login="login" pass="pass"></auth>|2||Lat is empty||Укажите широту. <client>CLIENT</client>|- <orderno>1234</orderno>|3||Specify a valid «Price» field value.||Укажите корректное значение поля «Сумма». <orderno2>5678</orderno2>|- <ordercode>34234</ordercode>|4||Specify a valid «Weight» field value.||Укажите корректное значение поля «Вес».|- <givencode>234534<|5||Recepient city/givencode>town not found.||Город назначения не найден. <datefrom>2016-07|-21</datefrom> <dateto>2016-07-21<|6||Sender city/dateto>town not found.||Город отправления не найден. <target>Автозавод</target>|- <done>ONLY_NOT_DONE</done>|7||Specify the «Recipient address» field value.||Укажите значение поля «Адрес получателя». <changes>ONLY_LAST</changes>|-|8||Specify the «Recipient phone» field value.||Укажите значение поля «Телефон получателя».</statusreq>|-</source>|9||Specify the «Recipient name» field value.||Укажите значение поля «ФИО получателя».|-=== Описание полей запроса статуса ===|10||Specify a valid «Quantity» field value.||Укажите корректное значение поля «Количество». '''statusreq''' |- Корневой контейнер. Обязательный элемент.*'''auth''' - Авторизация|11||Specify a valid «Declared value» field value. Обязательный элемент||Укажите корректное значение поля «Объявленная ценность».*'''client''' |- Признак клиента или агента|12||Supplier SKU ID not found. Необязательный элемент||Артикул не найден.:* CLIENT |- Признак клиента, значение по умолчанию:* AGENT - Признак агента|17||Order number already exists in the database. В ответ отдается информация по заказам, переданным агенту на доставку*'''orderno''' - Номер ||Такой номер заказа. Необязательный элементуже есть в базе.*'''ordercode''' - Внутренний |-|18||Order code already exists in the database.||Такой код заказа. Необязательный элементуже есть в базе.*'''orderno2''' |- Номер заказа из срочных. Необязательный элемент.*'''datefrom''' |19||The delivery date format is not valid. Specify a date in YYYY-MM- Дата заказа "с"DD format. Необязательный элемент||Укажите значение поля «Дата доставки» в формате гггг-мм-дд.*'''dateto''' |- Дата заказа "по"|20||Specify a valid «Delivery mode» field value. Необязательный элемент||Укажите корректное значение поля «Режим доставки».*'''target''' |- Строка поиска. Позволяет указать текст, который содержится в названии компании или адресе получателя|21||Specify a valid «Return trip mode» field value.||Укажите корректное значение поля «Режим возврата».*'''done''' |- Может принимать значения: :* ONLY_DONE - Только доставленные (имеются в виду успешные статусы, например, '''Доставлен''' или '''Частично доставлен''')|22||Specify a valid «Delivery type» field value.||Укажите корректное значение поля «Тип доставки».:* ONLY_NOT_DONE |- Только не доставленные (заказы, которые не являются доставленными, например, '''Не доставлен''' или '''Утерян'''):* ONLY_NEW |23||Specify a valid «Return shipment type» field value.||Укажите корректное значение поля «Тип возврата».|- Только новые:* ONLY_DELIVERY - Только заказы в обработке - заказы, находящиеся в любом статусе, кроме конечных: Доставлено, Не доставлено, Отменён и т|30||Specify the «Order number» field value.д||Укажите значение поля «Номер заказа».:* ''Пусто'' |- все корреспонденции *'''changes''' - может принимать |31||Specify the «Barcode» field value.||Укажите значение только ONLY_LASTполя «Штрихкод». Если указан этот параметр, все остальные игнорируются. Описание данного режима приведено здесь: [[#Передача только изменившихся статусов|Передача только изменившихся статусов]]-|32||Specify the «Sender company» field value.||Укажите значение поля «Компания-отправитель».|-<div style="color: #a94442; background|33||Specify the «Sender name» field value.||Укажите значение поля «ФИО отправителя».|-color: #f2dede; border: 1px solid #ebccd1; padding: 3px 10px 10px;">'''Обратите внимание!'''|34||Specify the «Sender phone» field value.||Укажите значение поля «Телефон отправителя».|-# Периода запроса статусов (контейнеры '''datefrom''' и '''dateto''') ограничивается двумя месяцами &mdash; два месяца до даты '''"по"'''|35||Specify the «Sender city/town» field value.||Укажите значение поля «Город отправителя».# Если не указаны обе даты &mdash; '''dateto''' принимается равной текущей дате|-|36||Specify the «Sender address» field value.# Если не указана дата '''dateto''' &mdash; она принимается равной '''datefrom''' плюс 2 месяца||Укажите значение поля «Адрес отправителя».# Если не указана дата '''datefrom''' &mdash; она принимается равной '''dateto''' минус 2 месяца|-|37||Specify the «Pickup date» field value.||Укажите значение поля «Дата забора».</div>|-<br />|38||Specify the «Pickup time from» field value.||Укажите значение поля «Время забора с».|-=== Примеры ответов === |39||Specify the «Pickup time to» field value.||Укажите значение поля «Время забора до».|-'''Пример успешного ответа'''|40||Specify the «Recipient company» field value.||Укажите значение поля «Компания-получатель».|-<source lang="xml"><?xml version="1|41||Specify the «Recipient name» field value.||Укажите значение поля «ФИО получателя».0" encoding="UTF|-8"?><statusreq count="23">|42||Specify the «Recipient phone» field value.||Укажите значение поля «Телефон получателя». <order orderno="111111" awb="qwerty" orderno2="123123" ordercode="34534234" givencode="2345334">|- <barcode>111111<|43||Specify the «Recipient city/barcode> <sender> <company>МВД</company> <person>Иванов Иtown» field value.И||Укажите значение поля «Город получателя».</person> <phone>123-45|-67</phone> <contacts>|44||Specify the «Recipient address» field value.||Укажите значение поля «Адрес получателя». <phone>+74951234567</phone>|- </contacts>|45||Specify the «Delivery date» field value.||Укажите значение поля «Дата доставки». <town code="23432">Санкт|-Петербург</town> <address>Петровка 38 офис 35</address>|46||Specify the «Delivery time from» field value.||Укажите значение поля «Время доставки с». <date>2014-03|-22</date> <time_min>09:00</time_min> <time_max>14:00</time_max> </sender> <receiver> <company>МВД</company> <person>Иванов И|47||Specify the «Delivery time to» field value.И||Укажите значение поля «Время доставки до».</person> <phone>123|-45-67 - Иван (916)234|48||Specify the «Recipient postcode» field value.45||Укажите значение поля «Индекс получателя».21 Петр,mvd@mail.ru</phone> <contacts>|- <phone>+74951234567</phone>|49||Specify the «Weight» field value.||Укажите значение поля «Вес». <phone>+79162344521</phone>|- <email>mvd@mail|50||Specify the «Payment type» field value.||Укажите значение поля «Тип оплаты».ru</email> </contacts>|- <inn>1112223335</inn> <zipcode>125480</zipcode>|51||Specify the «Quantity» field value.||Укажите значение поля «Количество». <town code="153361" regioncode="78" regionname="Санкт|-Петербург город">Санкт-Петербург город</town> <address>Петровка 38 офис 35</address>|52||Specify the «Amount» field value.||Укажите значение поля «Сумма». <pvz>|- <code>126</code>|53||Specify the «Declared value» field value.||Укажите значение поля «Объявленная стоимость». <clientcode>QWERTY</clientcode>|- </pvz> <date>2014|54||Specify the «Description» field value.||Укажите значение поля «Описание».|-03-22</date> <time_min>09:00</time_min> <time_max>14:00</time_max> <coords lat="|55||Specify the «Instruction» field value.680327" lon="37||Укажите значение поля «Поручение».604456"></coords> <deliveryPIN>1234</deliveryPIN>|- </receiver>|56||Specify the «Delivery mode» field value.||Укажите значение поля «Режим доставки». <pickup>NO</pickup>|- <weight>5|57||Specify the «Shipment type» field value.1</weight> <return_weight>5||Укажите значение поля «Тип отправления».1</return_weight> <quantity>2</quantity>|- <paytype>CASH</paytype>|58||Specify whether return trip is required.||Укажите значение поля «Необходимость возврата». <service>2</service>|- <return_service>2</service>|59||Specify the «Return trip mode» field value.||Укажите значение поля «Режим возврата» <type>3</type>|- <return_type>3</return_type>|60||Specify the «Return shipment type» field value.||Укажите значение поля «Тип возврата». <waittime>12</waittime>|- <price>387|61||Specify barcode.||Укажите штрихкод.5</price> <print_check>YES</print_check>|- <inshprice>387.5</inshprice>|62||Specify item weight.||Укажите массу единицы товара. <enclosure>Детские игрушки</enclosure>|- <instruction>Проверить при покупателе, подписать акт</instruction> |63||Specify item quantity.||Укажите количество товара. <currcoords lat="55|-|64||Specify item price.680327" lon="37||Укажите цену единицы товара.604456" accuracy="50" RequestDateTime="2014|-04-21 18:07:45"></currcoords> <courier>|65||Specify item name.||Укажите название товара.|- <code>26</code> <name>Иванов Владимир Петрович</name>|66||Wrong XLS file||Некорректный файл XLS. <phone>+79161234567</phone>|- </courier> <deliveryprice total="158|67||Order barcode already exists in the database.6" delivery="100||Такой штрихкод заказа уже есть в базе.00" return="58|-|68||Select the «Payment by recipient» field value.||Укажите значение поля «Оплата получателем».6"> <advprice code="1" price="150">База</advprice>|-|69||Specify department.||Укажите отдел.|- <advprice |70||Specify service partner code="2" price="0">% от объявленной стоимости</advprice>.||Укажите значение поля «Код подрядчика». <advprice code="3" price="8.6">Топливный сбор</advprice>|- <advprice code="4" price="0">Округление</advprice>|71||Date cannot be earlier than tomorrow.||Дата не может быть раньше чем завтра. </deliveryprice>|- <receiverpays>NO</receiverpays>|72||Date cannot be later than 15 days from now.||Дата не может быть позже чем через 15 дней.|- <acceptpartially>NO</acceptpartially>|73||Date cannot be earlier than today.||Дата не может быть раньше чем сегодня. <status eventstore="филиал в Санкт|-Петербурге" eventtime="2016|74||Date cannot be later than {0} days from now.||Дата не может быть позже, чем через {0} дней.|-06-02 17:22:00" createtimegmt="2016-06|75||Specify a valid «Item weight» field value.||Укажите корректное значение поля «Масса единицы товара».|-03 16:14:44" message="" title="Доставлен">COMPLETE</status> <statushistory> <status eventstore="Офис в Москве" eventtime="2016|76||Specify a valid «Quantity» field value.||Укажите корректное значение поля «Количество товара».|-05|77||Specify a valid «Item price» field value.||Укажите корректное значение поля «Цена единицы товара».|-30 10:20:00" createtimegmt="2016|78||Specify a valid «Delivery time from» field value.||Укажите корректное значение поля «Время доставки с».|-06|79||Specify a valid «Delivery time to» field value.||Укажите корректное значение поля «Время доставки до».|-03 16:14:44" message="" title="Новый">NEW</status> <status eventstore="Офис в Москве" eventtime="2016|80||Specify a valid «Pickup time from» field value.||Укажите корректное значение поля «Время забора с».|-06-01 17:38:00" createtimegmt="2016|81||Specify a valid «Pickup time to» field value.||Укажите корректное значение поля «Время забора до».|-06|82||Specify a valid «Pickup point» field value.||Укажите корректное значение поля «ПВЗ».|-03 16:14:44" message="филиал |83||Duplicate number in the registry.||Дублирование номера в Санктреестре.|-Петербурге" title="Планируется отправка">DEPARTURING</status> <status eventstore="Офис в Москве" eventtime="2016-06-01 19:53:00" createtimegmt="2016-06-03 16:14:44" message="филиал |84||Duplicate barcode in the registry.||Дублирование штрихкода в Санктреестре.|-Петербурге" title="Отправлено со склада">DEPARTURE</status> <status eventstore="филиал в Санкт|85||Specify a valid «Weight at return trip» field value.||Укажите корректное значение поля «Вес возврата».|-Петербурге" eventtime="2016-06-02 07:41:00" createtimegmt="2016-06|86||Specify the «Weight at return trip» field value.||Укажите значение поля «Вес возврата».|-03 16:14:44" message="" title="Получен складом">ACCEPTED</status> <status eventstore="филиал в Санкт|87||Order weight exceeds the allowed maximum for the pickup point.||Вес превышает допустимое значение для этого ПВЗ.|-Петербурге" eventtime="2016|88||Pickup date cannot be earlier than today.||Дата забора не может быть раньше чем сегодня.|-06|89||Specify a later delivery date.||Укажите более позднюю дату доставки.|-02 09:17:00" createtimegmt="2016-06-03 16:14:44" message="" title="Выдан курьеру на доставку">DELIVERY</status> <status eventstore="филиал в Санкт|90||Inappropriate «Weight» or «Pay type» field value for the selected city or town. Please review and correct the values.||Значение поля «Масса» или «Тип оплаты» для выбранного города указано некорректно или отсутствует. Проверьте значения и исправьте.|-Петербурге" eventtime="2016|91||{deliverytype} {deliverydate} is {holidaytype}. Select another date.||{deliverytype} {deliverydate} является {holidaytype}. Выберите другую дату.|-06|92||{deliverytype} {deliverydate} is {holidaytype}. Select another date.||{deliverytype} {deliverydate} является {holidaytype}. Выберите другую дату.|-02 17:22:00" createtimegmt="2016|93||Add items.||Добавьте товары.|-06|95||The selected pickup point only allows paid orders.||Выбранный ПВЗ выдает только предоплаченные заказы.|-03 16:14:44" message="" title="Доставлен |96||Order barcode exceeds the allowed maximum (25) symbols.||Длина штрихкода заказа превышает максимально допустимую (предварительно25 символов)">COURIERDELIVERED</status>. <status eventstore="филиал в Санкт|-Петербурге" eventtime="2016|97||The pickup date format is not valid. Specify a date in YYYY-06MM-02 17:22:00" createtimegmt="2016DD format.||Укажите значение поля «Дата забора» в формате гггг-06мм-дд.|-03 16:14:44" message="" title="Доставлен">COMPLETE</status> </statushistory>|98||Specify the cost code.||Укажите значение поля «Кост-код». <customstatecode>2<customstatecode>|- <clientstatecode></clientstatecode> <costcode>cc12345</costcode> <receipt fdNum="124555" fnSn="9289000100295555" kktNum="0001611984048555" inn="7722756555" fdValue="2899551555" summ="387|99||The item is not in stock.5" ofdUrl="gate||Товар отсутствует на складе.ofd.ru">https://ofd|-|100||Set the quantity of the item marked with Chestny ZNAK to one.ru/rec/7722756555/0001611984048555/9289000100295555/124555/2899551555</receipt> <deliveredto>Иванова||Укажите количество товара, маркированного кодом «Честный ЗНАК», секрравным единице.</deliveredto> <delivereddate>2016|-06-02</delivereddate> <deliveredtime>17:22</deliveredtime>|101||Quantity of item Delivery cannot be greater than 1||Количество вложений типа «Доставка» не может быть более 1. <arrival>2016-05|-02 23:21</arrival> <outstrbarcode>EXT123456</outstrbarcode> <return_message>Доставлено в целости</return_message>|102||А database error occurred. Please try later again.||Ошибка базы данных. Попробуйте позже.|- <department>Отдел</department>|103||Order not found.||Заказ не найден. <items>|- <item code="34533" extcode="abc123" quantity="1" mass="0|104||Cannot edit order in the current status.2" retprice="37||Невозможно изменить заказ в текущем статусе.5" VATrate="0" barcode="2345625213125" article="1" returns="0" origincountry="040" GTD="" excise="0|-|105||Discount cannot be greater than the order amount. Specify a smaller value.||Размер скидки не может превышать сумму заказа. Укажите меньшее значение скидки.|-|106||Specify the correct additional service code.||Укажите корректный код дополнительной услуги.00" governmentCode="11223311" suppcompany="Поставщик" suppINN="1112223334" suppphone="79161234567">Мяч</item> <item code="34456" extcode="abc124" quantity="2" mass="2" retprice="100" VATrate="10" barcode="4645625213138" article="2" returns="0" governmentCode="">Обруч</item>|-|107||Specify the correct additional service name.||Укажите корректное значение поля [advprice][value]. <item code="34421" extcode="abc125" quantity="3" mass="0|-|108||Specify the «Additional services» field value.||Укажите значение поля «Дополнительные услуги».|-|110||Specify the correct TIN.||Укажите корректный ИНН.|-|111||Specify the correct IIN (KZ).||Укажите корректный ИИН (КЗ).3" retprice="50" VATrate="18" barcode="2345625213126" itemcode="44123" article="3" returns="0" governmentCode="">Погремушка желтая</item> </items>|-|112||Specify the overall volume.||Укажите общий объем. <packages>|- <package code="33331" strbarcode="ORD0000001" mass="1" message="" got="YES"></package>|113||Cannot apply the delivery mode. Select another delivery mode.||Режим доставки не подходит для заказа. Выберите другой режим.|- <package code="33332" strbarcode="ORD0000002" mass="2|114||The pickup point does not support the selected delivery mode. Specify another pickup point.||ПВЗ не подходит для выбранного режима доставки. Укажите другой ПВЗ.5" message="" got="NO"></package> </packages>|- </order>|115||Specify a valid recipient phone number.||Укажите корректный телефон получателя.|-</statusreq> |116||Specify recipient PIN code.||Укажите пин-код получателя.<|-|117||Order date cannot be earlier than {0}. Specify another date.||Дата заказа не может быть раньше {0}. Укажите другую дату.|-|118||Pickup date cannot be earlier than {0}. Specify another date.||Дата забора не может быть раньше {0}. Укажите другую дату.|-|119||Specify the correct item type.||Укажите корректный тип вложения.|-|120||The pickup point does not accept payment by card.||В выбранном ПВЗ оплата картой не принимается.|-|121||Invalid item code format||Неверный формат кода товарной номенклатуры|-|122||Pickup time cannot be earlier than {0} hours.||Время забора не может быть раньше чем через {0} часа.|-|123||Pickup interval cannot be less than {0} minutes.||Интервал времени забора не может быть менее {0} минут. Укажите корректный интервал.|-|124||Specify a valid "Payment type" field value.||Укажите корректное значение поля «Тип оплаты».|-|125||Recepient city/source>town by postcode not found.||Город получателя по его индексу не найден.|-|126||Incorrect items prepayment and pickup.||Заказ не может содержать только вложения «Предоплата» и «Забор».|-|127||Package limit exceeded||Превышен лимит количества мест|-|128||Quantity of item Prepayment cannot be greater than 1||Количество вложений типа «Предоплата» не может быть больше 1.|-|129||Sum of cod must be equal sum of items||Объявленная стоимость должна быть равна сумме вложений.|-|130||Specify a valid respstore code.||Укажите код ответственного филиала.|-|131||Cannot edit, order has not been synchronized.||Невозможно изменить заказ пока он не синхронизирован.|-|132||Specify a valid "Recipient city/town" field value.||Укажите город получателя|-|133||Specify a valid "weight" for the town.||Укажите корректный вес для города|-|134||Specify a valid "paytype" for the town.||Укажите тип оплаты для города|-|135||Specify the correct SKU ID/code for item.||Укажите артикул/код вложения|-|136||Specify warehouse goods in the order.||Укажите вложения в заказе|-|137||The order's date of creation is more than 60 days ago.||Заказ создан более 60 дней назад|-|138||Specify a valid "Package dimension" field value.||Укажите корректные габариты места|-|139||Wrong type of XML query||Ошибка запроса|-|140||Duplicate item code in the order.||Дублирование кода вложения в заказе|-|141||Duplicate additional service in the order.||Дублирование кода дополнительной услуги в заказе|-|}
'''Пример ответа если нет заказов'''=== Передача значений полей в форме создания заказа в Личном Кабинете через GET параметры ===Если вам требуется передавать значения полей в форме создания заказа в Личном Кабинете через GET параметры, то вы можете подробно ознакомиться с этим на данной странице - [[Личный_кабинет_клиента#Передача и подстановка значений полей формы создания заказа через GET параметры]]
== Запрос статуса заказов ==
 
=== Пример запроса статуса заказа ===
<source lang="xml">
<?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>
</source>
=== Описание полей запроса статуса ==='''Пример ответа statusreq''' — Корневой контейнер. Обязательный элемент.* '''auth''' — Авторизация. Обязательный элемент.* '''client''' — Признак клиента или агента. Необязательный элемент.:* CLIENT — Признак клиента, значение по умолчанию:* AGENT — Признак агента. В ответ отдается информация по заказам, переданным агенту на доставку* '''orderno''' — Идентификатор заказа у клиента (шифр). Необязательный элемент.* '''ordercode''' — Внутренний код заказа. Необязательный элемент.* '''orderno2''' — Номер заказа из срочных. Необязательный элемент. * '''uid''' — Уникальный идентификатор, если он был добавлен при ошибке авторизациисоздании заказа. Необязательный элемент. Запрос информации по uid возможен в течении суток после создания заказа* '''datefrom''' — Дата заказа «с». Необязательный элемент.* '''dateto''' — Дата заказа «по». Необязательный элемент.* '''target''' — Строка поиска. Позволяет указать текст, который содержится в названии компании или адресе получателя.* '''done''' — Может принимать значения::* ONLY_DONE — Только доставленные (имеются в виду успешные статусы, например, '''Доставлен''' или '''Частично доставлен'''):* ONLY_NOT_DONE — Только не доставленные (заказы, которые не являются доставленными, например, '''Не доставлен''' или '''Утерян'''):* ONLY_NEW — Только новые:* ONLY_DELIVERY — Только заказы в обработке — заказы, находящиеся в любом статусе, кроме конечных: Доставлено, Не доставлено, Отменён и т. д.:* ''Пусто'' — все корреспонденции * '''changes''' — может принимать значение только ONLY_LAST. Если указан этот параметр, все остальные игнорируются. Описание данного режима приведено здесь: [[#Передача только изменившихся статусов|Передача только изменившихся статусов]] * '''conditions''' — Задает условия фильтрации по «orderno». Все вложенные элементы одновременно накладывают условие «И». Минимум 5 символов!:* '''namecontains''' — Поиск по номеру заказа(шифр), который содержит «orderno».:* '''namestarts''' — Поиск по номеру заказа(шифр), который начинается с «orderno».
<source lang="xml">
<?xml version="1.0" encoding="utf-8"?>
<request>
<error error="1" errormsg="authorization error"></error>
</request>
</source>
 <div style="color: #a94442; background-color: #f2dede; border: 1px solid #ebccd1; padding: 3px 10px 10px;">'''Обратите внимание!'''# Периода запроса статусов (контейнеры '''datefrom''' и '''dateto''') ограничивается двумя месяцами — два месяца до даты '''«по»'''.# Если не указаны обе даты — '''dateto''' принимается равной текущей дате.# Если не указана дата '''dateto''' — она принимается равной '''datefrom''' плюс 2 месяца.# Если не указана дата '''datefrom''' — она принимается равной '''dateto''' минус 2 месяца.# Поиск по '''conditions''' работает только для «Номер заказа(шифр)» и только от 4 символов</div><br> === Примеры ответов ==='''Пример успешного ответа при ошибке синтаксиса'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<requeststatusreq count="23"> <order orderno="111111" awb="qwerty" orderno2="123123" ordercode="34534234" givencode="2345334"> <barcode>111111</barcode> <errorsender>column:1 line:11 message:expected ' <company>МВД</company> <person>'Иванов И.И.</errorperson> <phone>123-45-67</requestphone> <contacts> <phone>+74951234567</sourcephone> </contacts> <town code=== Описание полей ответа статусов ==="23432">Санкт-Петербург</town>Все поля ответа соответствуют структуре order при создании заказа, с некоторыми добавлениями: <address>Петровка 38 офис 35</address> <date>2014-03-22</date>* Атрибуты контейнера '''order''' <time_min>09:00</time_min> <time_max>14:* '''''awb''''' - Номер накладной в системе курьерской службы00</time_max> </sender> <receiver> <company>МВД</company> <person>Иванов И.И.</person>:* '''''orderno2''''' <phone>123-45-67 - Номер накладной в подсистеме срочной доставки курьерской службыИван (916)234.45.21 Петр,mvd@mail.ru</phone> <contacts> <phone>+74951234567</phone> <phone>+79162344521</phone>:* '''''ordercode''''' - внутренний код заказа в системе, применяется для некоторых внутренних операций <email>mvd@mail.ru</email> </contacts> <inn>1112223335</inn> <zipcode>125480</zipcode>:* '''''givencode''''' <town code="153361" regioncode="78" regionname="Санкт-Петербург город">Санкт- внутренний код заказа в системе, применяется для некоторых внутренних операций.Петербург город</town> <address>Петровка 38 офис 35</address> <area>Район 1</area>* атрибут ''''' <pvz> <code''''' контейнера '''item''' >126</code> <clientcode>QWERTY</clientcode> </pvz> <date>2014-03- внутренний код строки заказа в системе, применяется для некоторых внутренних операций.22</date> <time_min>09:00</time_min> <time_max>14:* '''''returns''''' - количество данного товара, от которого отказался получатель00</time_max> <coords lat="55. Не нулевое только в случае частичного отказа680327" lon="37.604456"></coords> <deliveryPIN>1234</deliveryPIN>* атрибут '''''got''''' контейнера '''package''' - признак принятого места YES </ NOreceiver> <price>387.5</price>:* '''''returns''''' - количество данного товара, от которого отказался получатель <inshprice>387. Не нулевое только в случае частичного отказа5</inshprice> <paytype code="1">CASH</paytype> <weight>5.1</weight> <quantity>2</quantity> <service>2</service> <type>3</type> <return>NO</return> <return_service>2</service>* '''''coords''''' в контейнере '''receiver''' - координаты получателя <return_type>3</return_type> <return_weight>5.1</return_weight>* '''''deliveryPIN''''' <return_message>Доставлено в контейнере '''receiver''' - Пин-код.целости</return_message>* ''' <pickup''' - признак оформления забора, возможные значения: '''YES''', '''>NO'''. Если указано '''</pickup> <print_check>YES'''</print_check> <waittime>12</waittime> <enclosure>Детские игрушки</enclosure> <instruction>Проверить при покупателе, то весь заказ считается заданием на забор груза, а не на доставку.подписать акт</instruction> * ''' <currcoords''' lat="55.680327" lon="37.604456" accuracy="50" RequestDateTime="2014-04- текущие координаты заказа. Атрибуты21 18:07:* '''''lat''''' - широта45"></currcoords>:* '''''lon''''' - долгота <courier>:* '''''accuracy''''' - точность в метрах <code>26</code>:* '''''RequestDateTime''''' - дата <name>Иванов Владимир Петрович</время последнего обновления координат.name> <phone>+79161234567</phone>* ''' </courier''' - Данные курьера, которому выдан заказ. Если заказ не выдан, то выводятся данные запланированного курьера.>* '''waittime ''' - Время ожидания курьера.* ''' <deliveryprice''' - Стоимость услуг в валюте расчетов с клиентомtotal="158. Атрибуты::* '''''total''''' - общая стоимость услуг:* '''''6" delivery''''' - стоимость доставки ="Туда100.00":* '''''return''''' - стоимость доставки ="Обратно58.6" (если order->return <advprice code="1" price=YES)"150">База</advprice>Тэг '''deliveryprice''' включает список дополнительных услуг (только для тарифа <advprice code="2" price="Премиум0"):>% от объявленной стоимости</advprice>:* ''''' <advprice code="3" price="8.6">Топливный сбор</advprice''''' - наименование дополнительной услуги>:* ''''' <advprice code''''' - код дополнительной услуги="4" price="0">Округление</advprice> </deliveryprice>:* '''''price''''' - стоимость дополнительной услуги <receiverpays>NO</receiverpays> <acceptpartially>NO</acceptpartially>* ''' <status''' eventstore="филиал в Санкт-Петербурге" eventtime="2016- статус доставки (список статусов см. ниже). Атрибуты (заполняются начиная с версии системы 2008.0.0.670)06-02 17:22:* '''''eventstore''''' 00" createtimegmt="2016-06- филиал, к которому относится текущий статус03 16:* '''''eventtime''''' - время события по часовому поясу места его наступления.14:* '''''createtimegmt''''' 44" message="" title="Доставлен" eventtown="Санкт- время по GMT создания записи о смене статуса в БД. Используется для сортировки записей, чтобы соблюсти хронологическую последовательность. <spoiler textПетербург город" color="Подробнее16777215">Большинство событий фиксируются COMPLETE</status> <statushistory> <status eventstore="Офис в полях Москве" eventtime и createtimegmt на основании одного действия, тогда они отличаются только сдвигом от GMT. Однако, если курьер доставил отправление ="2016-05-30 10.10.2010 в 20:00, по какой-то причине не внес это в мобильное приложение, на следующий день сдал накладную, и в 9 утра оператор внесла, что он доставил вчера в 20:00. Тогда в " createtimegmt будет сегодня 6 утра (для Москвы), а в eventtime ="2016-06- вчера в 2003 16:14:00. При этом оператор по каким-то причинам может внести время вручения раньше, чем какое-то предыдущее событие, т.о. нарушится последовательность времени в eventtime, но при сортировке по createtimegmt все-равно все будет правильно.44" message="" title="Новый" eventtown="Москва город" country="RU">NEW</spoilerstatus>:* '''''message''''' <status eventstore="Офис в Москве" eventtime="2016- наименование филиала06-получателя, при передаче между филиалами01 17:38:* '''''title''''' 00" createtimegmt="2016- русское наименование статуса * '''statushistory''' 06- история статусов доставки. Содержит список контейнеров '''status'''. Заполняется только для тарифа 03 16:14:44"Премиум message=" начиная с версии системы 2008.0.0.670.* '''customstatecode''' филиал в Санкт- код внутреннего статуса курьерской службы. Значения уточняйте в курьерской службе. Назначаются курьерской службой в разделе Петербурге" title="СправочникиПланируется отправка" - eventtown="СтатусыМосква город" - country="15 Статусы корреспонденцииRU". Справочник не передается через API клиенту по причине возможного наличия в нем внутренних технологических статусов курьерской службы.* '''clientstatecode''' - код статуса клиента. Используется, если клиент предлагает свои коды статусов доставки>DEPARTURING</причин недоставки.status>* '''deliveredto''' - данные о вручении, либо причина недоставки.* '''delivereddate''' - дата вручения.* '''deliveredtime''' - время вручения. В случае недоставки может быть пустым.* '''arrival''' - плановая дата прибытия <status eventstore="Офис в формате ггггМоскве" eventtime="2016-мм06-дд чч01 19:мм53:сс* '''outstrbarcode''' 00" createtimegmt="2016- код у подрядчика (код заказа во внешней системе). Используется в интеграциях с внешними системами.* '''return_message''' - информация о возврате* '''department''' 06- Подразделение, в котором оформляется заказ. Контейнер '''status''' может принимать следующие значения03 16:14: AWAITING_SYNC — Ожидает синхронизации. Данные заказа пока не появились в службе доставки.44": '''NEW''' — Успешно создан, передан message="филиал в службу доставки.: NEWPICKUP — Создан забор.: PICKUP — Забран у отправителя.: WMSASSEMBLED — Скомплектован на складе фулфилмента.: WMSDISASSEMBLED — Разукомплектован на склад фулфилмента.: '''ACCEPTED''' — Получен складом.: CUSTOMSPROCESS — Производится таможенный контроль.: CUSTOMSFINISHED — Таможенный контроль произведен.: CONFIRM — Согласована доставка.: UNCONFIRM — Не удалось согласовать доставку.: DEPARTURING — Планируется отправка Санкт-Петербурге" title="Отправлено со склада на другой склад.: " eventtown="Москва город" country="RU">DEPARTURE — Отправлено со склада на другой склад.</status>: INVENTORY — Инвентаризация. Убедились <status eventstore="филиал в наличии отправления на складе.Санкт-Петербурге" eventtime="2016-06-02 07: PICKUPREADY — Готов к выдаче в ПВЗ.41: '''DELIVERY''' — Выдан курьеру на доставку.00" createtimegmt="2016-06-03 16: COURIERDELIVERED — Доставлен (предварительно, ождает подтверждения менеджером, чтобы перейти в статус COMPLETE).14: COURIERPARTIALLY — Частично доставлен (предварительно, ождает подтверждения менеджером, чтобы перейти в статус PARTIALLY).44": COURIERCANCELED — Отказ (предварительно, после этого ожидается COURIERRETURN).: COURIERRETURN — Возвращено курьером. Курьер не смог доставить до получателя и вернул заказ обратно на склад. Это промежуточный статус, после которого менеджер выясняет, нужно ли повторно доставлять (статусы DATECHANGE message="" title="Получен складом" eventtown="Санкт-Петербург город" country="RU">ACCEPTED</DELIVERY) или это окончательная недоставка (CANCELED).status> <status eventstore="филиал в Санкт-Петербурге" eventtime="2016-06-02 09: DATECHANGE — Перенос даты доставки. 17: '''COMPLETE''' — Доставлен.: '''PARTIALLY''' — Доставлен частично.: '''CANCELED''' — Не доставлен (Возврат/Отмена). После этого статуса отправление должны вернуть заказчику, будут статусы RETURNING и RETURNED : RETURNING — Планируется возврат заказчику (после CANCELED).: RETURNED — Возвращен заказчику.: LOST — Утрачен/утерян. '''Примечание.''' В будущем возможно дополнение используемого набора статусов. <div style00" createtimegmt="color: #a94442; background2016-06-color03 16: #f2dede; border14: 1px solid #ebccd1; padding: 3px 10px 10px;44">'''Обратите внимание!''' # Контейнер '''statushistory''' и '''deliveryprice''' заполняется для тарифов [[Личный кабинет курьерской службы#Функции личного кабинета|Премиум и Максимум]].# Система никогда не гарантирует последовательность прохождения заказом набора статусов. Т.е. Вы можете получить статус message="" title="Выдан курьеру на доставку"COMPLETEeventtown=", а следующим запросом Санкт- Петербург город"NEWcountry="RU" - такое может произойти, например, если оператор ошибочно отметил заказ выполненным, а затем исправил ошибку.>DELIVERY</divstatus> <br /> status eventstore="филиал в Санкт-Петербурге" eventtime="2016-06-02 17:22:00" createtimegmt= Передача только изменившихся статусов ="2016-06-03 16:14:44" message==В нашем API предусмотрено очень удобное средство получения статусов всех заказов, без необходимости "бомбить" сервер запросами статусов по каждому заказу. Работает это так: раз в какое-то время, например, в 10 минут, вы посылаете запрос title="А покажите все изменившиеся статусы". Пример запроса ниже. Система вам отдает ВСЕ заказы, статусы Доставлен (или некоторые другие поля, см нижепредварительно) которых изменились с момента последнего запроса. Вы разбираете полученный документ, по каждому заказу сохраняете его актуальный статус в своей системе, и если все хорошо, у вас все получилось, ваша система неожиданно не упала от наплыва информации, посылаете нам запрос подтверждения получения статусов (commitlaststatus). Мы у себя отмечаем, что эти статусы вами получены, и их не надо передавать повторно. Т.о. сколько бы заказов у вас не было, статусы по ним всем почти в реальном времени вы можете получать всего 2" eventtown="Санкт-мя запросами. Для получения только изменившихся статусов отправьте запрос<source langПетербург город" country="xmlRU">COURIERDELIVERED</status> <?xml versionstatus eventstore="филиал в Санкт-Петербурге" eventtime="1.02016-06-02 17:22:00" encodingcreatetimegmt="UTF2016-806-03 16:14:44" ?><statusreq> <auth extra message="" title="8Доставлен" logineventtown="loginСанкт-Петербург город" passcountry="passRU">COMPLETE</authstatus> </statushistory> <customstatecode>2<customstatecode> <changesclientstatecode>ONLY_LAST</changesclientstatecode> <deliveredto>Иванова, секр.</statusreqdeliveredto> <delivereddate>2016-06-02</sourcedelivereddate> Система выдает все заказы, в которых, с момента последнего запроса в этом режиме, изменилось хотя бы одно из полей <deliveredtime>17:22</deliveredtime> orderno <department>Отдел</department> status <costcode>cc12345</costcode> delivereddate <outstrbarcode>EXT123456</outstrbarcode> deliveredtime <respstore>14</respstore> deliveredto <partner>Офис на Ленина</partner> receiver <arrival>2016->date receiver05-02 23:21</arrival>address price После успешной обработки ответа необходимо отметить полученные статусы успешно полученными, отправив запрос <source langreceipt fdNum="124555" fnSn="9289000100295555" kktNum="0001611984048555" inn="7722756555" fdValue="2899551555" summ="387.5" ofdUrl="xmlgate.ofd.ru">https://ofd.ru/rec/7722756555/0001611984048555/9289000100295555/124555/2899551555</receipt> <items> <?xml versionitem code="34533" extcode="abc123" quantity="1" mass="0.2" retprice="37.5" VATrate="0" encodingbarcode="UTF-82345625213125" article="1" returns="0" origincountry="040" GTD="" excise="0.00" governmentCode="11223311" suppcompany="Поставщик" suppINN="1112223334" suppphone="79161234567" ?>Мяч<commitlaststatus/item> <auth extraitem code="34456" extcode="abc124" quantity="2" mass="2" retprice="100" VATrate="10" barcode="4645625213138" article="82" loginreturns="login0" passgovernmentCode="pass">Обруч</authitem> <clientitem code="34421" extcode="abc125" quantity="3" mass="0.3" retprice="50" VATrate="18" barcode="2345625213126" itemcode="44123" article="3" returns="0" governmentCode="">CLIENTПогремушка желтая</clientitem> </commitlaststatusitems> </sourcepackages> '''Описание полей запроса''' *'''auth''' - Авторизация. Обязательный элемент.*'''client''' - Признак клиента или агента. Необязательный элемент.:* CLIENT - Признак клиента, значение по умолчанию:* AGENT - Признак агента. В ответ отдается информация по заказам, переданным агенту на доставку В случае успеха Вы получите ответ <source langpackage code="33331" strbarcode="ORD0000001" mass="1" message="" got="xmlYES"></package> <?xml versionpackage code="133332" strbarcode="ORD0000002" mass="2.05" encodingmessage="UTF-8" ?><commitlaststatus errorgot="0NO">OK</commitlaststatuspackage> </sourcepackages> </order>Данный способ передачи статусов гарантирует полную корректную передачу статусов, даже в случае, если в нашей системе статус изменился в промежутке времени между запросом статусов и подтверждением их получения. Если система не получила подтверждение успешной передачи статуса, она будет считать информацию не переданной, и выдаст ее при повторном запросе. </statusreq> <div style="color: #a94442; background-color: #f2dede; border: 1px solid #ebccd1; padding: 3px 10px 10px;"/source>'''Обратите внимание!'''
# При данном способе передачи (<changes>ONLY_LAST</changes>) система просматривает заказы, оформленные за последние 3 месяца. Если заказ сделан ранее - изменение статуса по нему не попадет в результат выполнения данного запроса.# Система всегда выдает текущий статус. Т.е. Вы можете одним запросом получить статус "NEW", а следующим - "COMPLETE". В промежутке между запросами отправление могло пройти через несколько промежуточных статусов. Если нужна гарантия получения всех промежуточных статусов, нужно анализировать блок statushistory (может не заполняться в следствии ограничений версии или тарифа конкретной службы доставки).# Система никогда не гарантирует последовательность прохождения заказом набора статусов. Т.е. Вы можете получить статус "COMPLETE", а следующим запросом - "NEW" - такое может произойти, например, '''Пример ответа если оператор ошибочно отметил заказ выполненным, а затем исправил ошибку.</div><br />нет заказов'''
<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>
Запрос трекинга по номеру предназначен для выдачи минимальной обезличенной информации о конкретном заказе не авторизованному пользователю. Наша система имеет для этого интерфейс по адресу "home.courierexe.ru/{код экстра}/tracking". Вы можете либо сделать ссылку на такую страницу на своем сайте, либо разместить ее iframe'ом у себя, либо сделать свою и пользоваться нашим API. Этот интерфейс создан специально для выдачи информации живому пользователю сайта. Для получения статусов заказов в свою информационную систему нужно использовать запрос "statusreq", желательно с параметром changes=ONLY_LAST!''Пример ответа при ошибке синтаксиса'''
'''Пример запроса:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<trackingrequest> <extraerror>8</extra> <ordernocolumn:1 line:11 message:expected '>1234'</ordernoerror></trackingrequest>
</source>
=== Описание полей ответа статусов ===Все поля ответа соответствуют структуре order при создании заказа, с некоторыми добавлениями: * Атрибуты контейнера '''order'''::* '''''awb''''Пример ответа' — Номер накладной в системе курьерской службы.:* '''''orderno2''''' — Номер накладной в подсистеме срочной доставки курьерской службы.<source lang="xml">:* '''''ordercode''''' — внутренний код заказа в системе, применяется для некоторых внутренних операций.<?xml version="1:* '''''givencode''''' — внутренний код заказа в системе, применяется для некоторых внутренних операций.0" encoding="UTF *'''paytype''' -8"?>Тип оплаты заказа получателем. Принимает значения:<tracking>:: CASH - Наличными при получении (по-умолчанию) <order orderno="111111">:: CARD - Картой при получении <barcode>111111</barcode>:: NO - Без оплаты. <AWB>111111</AWB>:: OTHER - Прочее (Предусмотрен для того, чтобы оплата поступала непосредственно в курьерскую службу посредством прочих типов оплаты - таких как: вебмани, яденьги, картой на сайте, прочие платежные системы и т.д.) <sender>* Атрибуты контейнера '''paytype''': <town ** '''''code=''''' - (integer) внутренний код типа оплаты заказа в системном справочнике "1Типы оплаты корреспонденции" country="RU">Москва город</town>. Не обязательный элемент.   <date>2014-03-22</date>* атрибут '''''code''''' контейнера '''item''' — внутренний код строки заказа в системе, применяется для некоторых внутренних операций. <time_min>09:00<* '''''returns''''' — количество данного товара, от которого отказался получатель. Не нулевое только в случае частичного отказа. * атрибут '''''got''''' контейнера '''package''' — признак принятого места YES /time_min>NO. <time_max>14:00<* '''''returns''''' — количество данного товара, от которого отказался получатель. Не нулевое только в случае частичного отказа. * '''''area''''' в контейнере '''receiver''' — район/time_max>метро получателя. </sender>* '''''coords''''' в контейнере '''receiver''' — координаты получателя. <* '''''deliveryPIN''''' в контейнере '''receiver>''' — Пин-код.* '''pickup''' — признак оформления забора, возможные значения: '''YES''', '''NO'''. Если указано '''YES''', то весь заказ считается заданием на забор груза, а не на доставку. <town code="1" country="RU">Москва город</town>* '''currcoords''' — текущие координаты заказа. Атрибуты: <zipcode>125480</zipcode>:* '''''lat''''' — широта <date>2014-03-22</date>:* '''''lon''''' — долгота <time_min>09:00</time_min>* '''''accuracy''''' — точность в метрах <time_max>14:00<* '''''RequestDateTime''''' — дата/time_max>время последнего обновления координат. </receiver> <price>387* '''courier''' — Данные курьера, которому выдан заказ. Если заказ не выдан, то выводятся данные запланированного курьера.5</price> <inshprice>387* '''waittime ''' — Время ожидания курьера.5</inshprice> <paytype>CASH</paytype> <weight>5* '''deliveryprice''' — Стоимость услуг в валюте расчетов с клиентом.1</weight>Атрибуты: <quantity>2</quantity>:* '''''total''''' — общая стоимость услуг <service>2</service>:* '''''delivery''''' — стоимость доставки «Туда» <type>3</type> <:* '''''return''''' — стоимость доставки «Обратно» (если order->NO</return>=YES) <return_service>2</service>Тэг '''deliveryprice''' включает список дополнительных услуг (только для тарифа «Премиум»): <return_date></return_date>:* '''''advprice''''' — наименование дополнительной услуги <return_time></return_time>:* '''''code''''' — код дополнительной услуги <return_message></return_message>:* '''''price''''' — стоимость дополнительной услуги <waittime>12</waittime> <enclosure>Детские игрушки</enclosure>* '''status''' — статус доставки (список статусов см. ниже). Атрибуты (заполняются начиная с версии системы 2008.0.0.670): <instruction>Проверить при покупателе:* '''''eventstore''''' — филиал, подписать акт</instruction>к которому относится текущий статус:* '''''eventtime''''' — время события по часовому поясу места его наступления. :* '''''createtimegmt''''' — время по GMT создания записи о смене статуса в БД. Используется для сортировки записей, чтобы соблюсти хронологическую последовательность. <deliveryprice totalspoiler text="158Подробнее">Большинство событий фиксируются в полях eventtime и createtimegmt на основании одного действия, тогда они отличаются только сдвигом от GMT.6" delivery="100Однако, если курьер доставил отправление 10.10.2010 в 20:00, по какой-то причине не внес это в мобильное приложение, на следующий день сдал накладную, и в 9 утра оператор внесла, что он доставил вчера в 20:00" return="58.Тогда в createtimegmt будет сегодня 6" утра (для Москвы), а в eventtime — вчера в 20:00. При этом оператор по каким-то причинам может внести время вручения раньше, чем какое-то предыдущее событие, т.о. нарушится последовательность времени в eventtime, но при сортировке по createtimegmt все-равно все будет правильно.</spoiler> <courier>:* '''''message''''' — наименование филиала-получателя, при передаче между филиалами:* '''''title''''' — русское наименование статуса * '''statushistory''' — история статусов доставки. Содержит список контейнеров '''status'''. Заполняется только для тарифа «Премиум» начиная с версии системы 2008.0.0.670. <code>26</code>* '''customstatecode''' — код внутреннего статуса курьерской службы. Значения уточняйте в курьерской службе. Назначаются курьерской службой в разделе «Справочники» — «Статусы» — «15 Статусы корреспонденции». Справочник не передается через API клиенту по причине возможного наличия в нем внутренних технологических статусов курьерской службы. <name>Иванов Владимир Петрович<* '''clientstatecode''' — код статуса клиента. Используется, если клиент предлагает свои коды статусов доставки/name>причин недоставки. <phone>+79161234567</phone>* '''deliveredto''' — данные из поля «Инфо. о доставке» (может быть информация о доставке, причина недоставки и т. п.). </courier>* '''delivereddate''' — дата вручения. <currcoords lat="55* '''deliveredtime''' — время вручения.680327" lon="37В случае недоставки может быть пустым.604456" accuracy="50" RequestDateTime="2014* '''arrival''' — плановая дата прибытия в формате гггг-04мм-21 18дд чч:07мм:45" сс. Заполняется только при использовании автоматических систем планирования (Максоптра, Яндекс доставка), во всех остальных случаях - пустое.* '''outstrbarcode''' — код у подрядчика (код заказа во внешней системе). Используется в интеграциях с внешними системами.* '''partner''' — текущий филиал/>подрядчик.* '''return_message''' — информация о возврате* '''department''' — Подразделение, в котором оформляется заказ.  <Контейнер '''status eventstore="филиал в Санкт-Петербурге" eventtime="2016-06-02 17''' может принимать следующие значения:22:00" createtimegmt="2016-06-03 16AWAITING_SYNC — Ожидает синхронизации. Данные заказа пока не появились в службе доставки.:14'''NEW''' — Успешно создан, передан в службу доставки.:44" message="" title="Доставлен">COMPLETE</status>NEWPICKUP — Создан забор. <statushistory>: PICKUP — Забран у отправителя. <status eventstore="Офис в Москве" eventtime="2016-05-30 10:20WMSASSEMBLED — Скомплектован на складе фулфилмента.:00" createtimegmt="2016-06-03 16WMSDISASSEMBLED — Разукомплектован на склад фулфилмента.:14'''ACCEPTED''' — Получен складом.:44" message="" title="Новый">NEW</status>CUSTOMSPROCESS — Производится таможенный контроль. <status eventstore="Офис в Москве" eventtime="2016-06-01 17:38CUSTOMSFINISHED — Таможенный контроль произведен.:00" createtimegmt="2016-06-03 16CONFIRM — Согласована доставка.:14UNCONFIRM — Не удалось согласовать доставку.:44" message="филиал в Санкт-Петербурге" title="DEPARTURING — Планируется отправка">DEPARTURING</status>со склада на другой склад.: DEPARTURE — Отправлено со склада на другой склад. <status eventstore="Офис : INVENTORY — Инвентаризация. Убедились в Москве" eventtime="2016-06-01 19наличии отправления на складе.:53PICKUPREADY — Готов к выдаче в ПВЗ.:00" createtimegmt="2016-06-03 16'''DELIVERY''' — Выдан курьеру на доставку.:14COURIERDELIVERED — Доставлен (предварительно, ожидает подтверждения менеджером, чтобы перейти в статус COMPLETE).:44" message="филиал COURIERPARTIALLY — Частично доставлен (предварительно, ожидает подтверждения менеджером, чтобы перейти в Санкт-Петербурге" title="Отправлено со склада">DEPARTURE<статус PARTIALLY).: COURIERCANCELED — Отказ (предварительно, после этого ожидается COURIERRETURN).: COURIERRETURN — Возвращено курьером. Курьер не смог доставить до получателя и вернул заказ обратно на склад. Это промежуточный статус, после которого менеджер выясняет, нужно ли повторно доставлять (статусы DATECHANGE/status>DELIVERY) или это окончательная недоставка (CANCELED).: DATECHANGE — Перенос даты доставки. : '''COMPLETE''' — Доставлен.: '''PARTIALLY''' — Доставлен частично. <status eventstore="филиал в Санкт-Петербурге" eventtime="2016-06-02 07:41'''CANCELED''' — Не доставлен (Возврат/Отмена). После этого статуса отправление должны вернуть заказчику, будут статусы RETURNING и RETURNED :00" createtimegmt="2016-06-03 16RETURNING — Планируется возврат заказчику (после CANCELED).:14RETURNED — Возвращен заказчику.:44" message="" title="Получен складом">ACCEPTED<LOST — Утрачен/status>утерян. : PARTLYRETURNING — Планируется возврат остатков.: PARTLYRETURNED — Остаток возвращен.: TRANSACCEPTED — Прибыл на склад перевозчика.: PICKUPTRANS — Забран у перевозчика.  '''Примечание.''' В будущем возможно дополнение используемого набора статусов.  <status eventstorediv style="филиал в Санкт-Петербурге" eventtime="2016-06color: #a94442; background-02 09color:17#f2dede; border:00" createtimegmt="2016-06-03 161px solid #ebccd1; padding:14:44" message="" title="Выдан курьеру на доставку3px 10px 10px;">DELIVERY'''Обратите внимание!''' # Контейнер '''statushistory''' и '''deliveryprice''' заполняется для тарифов [[Личный кабинет курьерской службы#Функции личного кабинета|Премиум и Максимум]].# Система никогда не гарантирует последовательность прохождения заказом набора статусов. То есть Вы можете получить статус «COMPLETE», а следующим запросом — «NEW» — такое может произойти, например, если оператор ошибочно отметил заказ выполненным, а затем исправил ошибку.</statusdiv> <status eventstorebr> === Передача только изменившихся статусов =="филиал в Санкт-Петербурге" eventtime="2016-06-02 17В нашем API предусмотрено удобное средство получения статусов всех заказов, без необходимости «бомбить» сервер запросами статусов по каждому заказу. Работает это так:22раз, например, в 10 минут, вы посылаете запрос «покажите все изменившиеся статусы». Пример запроса ниже. Система вам отдает ВСЕ заказы, статусы (или некоторые другие поля, см. ниже) которых изменились с момента последнего запроса. Вы разбираете полученный документ, по каждому заказу сохраняете его актуальный статус в своей системе, и если все хорошо, у вас все получилось, ваша система неожиданно не упала от наплыва информации, посылаете нам запрос подтверждения получения статусов (commitlaststatus). Мы у себя отмечаем, что эти статусы вами получены и их не надо передавать повторно. Таким образом, сколько бы заказов у вас ни было, статусы по ним всем почти в реальном времени вы можете получать всего двумя запросами. Для получения только изменившихся статусов отправьте запрос:00" createtimegmt<source lang="2016-06-03 16:14:44xml" message><?xml version="1.0" titleencoding="Доставлен (предварительно)UTF-8"?>COURIERDELIVERED</statusstatusreq> <status eventstoreauth extra="филиал в Санкт-Петербурге" eventtime="2016-06-02 17:22:00" createtimegmt=8"2016-06-03 16:14:44" messagelogin="login" titlepass="Доставленpass">COMPLETE</statusauth> <changes>ONLY_LAST</statushistorychanges> <deliveredtostreamid>Иванова, секр.1234</deliveredtostreamid> <delivereddate/statusreq>2016-06-02</delivereddatesource> <deliveredtime>17Система выдает все заказы, в которых с момента последнего запроса в этом режиме изменилось хотя бы одно из полей:22</ orderno status delivereddate deliveredtime deliveredto receiver->date <outstrbarcode>EXT123456</outstrbarcode receiver->address price  <items>После успешной обработки ответа необходимо отметить полученные статусы успешно полученными, отправив запрос: <item codesource lang="34533xml" extcode="abc123" quantity><?xml version="1" mass="0.2" retprice="37.5" VATrate="0" barcodeencoding="2345625213125" article="1" returns="0" origincountry="040" GTD="" excise="0.00" governmentCode="11223311" suppcompany="Поставщик" suppINN="1112223334" suppphone="79161234567UTF-8"?>Мяч</itemcommitlaststatus> <item codeauth extra="34456" extcode="abc124" quantity="2" mass="2" retprice="100" VATrate="10" barcode="46456252131388" articlelogin="2login" returns="0" governmentCodepass="pass">Обруч</itemauth> <item code="34421" extcode="abc125" quantity="3" mass="0.3" retprice="50" VATrate="18" barcode="2345625213126" article="3" returns="0" governmentCode=""client>Погремушка желтаяCLIENT</itemclient> </itemsstreamid> 1234</orderstreamid></trackingcommitlaststatus>
</source>
'''Описание полей запроса'''
* '''Получение информации auth''' — авторизация. Обязательный элемент.* '''streamid''' — идентификатор потока. Если у вас несколько интеграций и каждая нуждается в получении статусов, вы можете передавать данный параметр и тем самым разделять получение и отметку об успешном получении статусов по заказам. Значение должно входить в формате 17 TRACKпромежуток от 100 до 10000, включительно. Необязательный элемент.* '''client''' — признак клиента или агента. Необязательный элемент.:* CLIENT — признак клиента, значение по умолчанию:* AGENT — признак агента. В ответ отдается информация по заказам, переданным агенту на доставку
'''Пример запросаВ случае успеха вы получите ответ:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?><tracking17commitlaststatus error="0">OK</commitlaststatus></source> Такой способ передачи статусов гарантирует полную корректную передачу статусов, даже если в нашей системе статус изменился между запросом статусов и подтверждением их получения. Если система не получила подтверждение передачи статуса, она будет считать информацию непереданной и выдаст ее при повторном запросе. <div style="color: #a94442; background-color: #f2dede; border: 1px solid #ebccd1; padding: 3px 10px 10px;"># При этом способе передачи (<changes>ONLY_LAST</changes>) система просматривает заказы, оформленные за последние 3 месяца. Если заказ сделан ранее, изменение статуса по нему не попадет в результат выполнения запроса.# Система всегда выдает текущий статус. Вы можете одним запросом получить статус «NEW», а следующим — «COMPLETE». Между запросами отправление могло пройти через несколько промежуточных статусов. Если нужна гарантия получения всех промежуточных статусов, нужно анализировать блок statushistory (может не заполняться вследствие ограничений версии или тарифа конкретной службы доставки).# Система не гарантирует последовательность прохождения заказом набора статусов. Вы можете получить статус «COMPLETE», а следующим запросом «NEW» — такое может произойти, например, если оператор ошибочно отметил заказ выполненным, а затем исправил ошибку.</div><br> == Трекинг заказа по номеру ==Запрос трекинга по номеру предназначен для выдачи минимальной обезличенной информации о конкретном заказе не авторизованному пользователю. Наша система имеет для этого интерфейс по адресу «home.courierexe.ru/{код экстра}/tracking». Вы можете либо сделать ссылку на такую страницу на своем сайте, либо разместить ее [[#Размещение страниц на своем сайте (iframe)|iframe’ом]] у себя, либо сделать свою и пользоваться нашим API. Этот интерфейс создан специально для выдачи информации живому пользователю сайта. Для получения статусов заказов в свою информационную систему нужно использовать запрос «statusreq», желательно с параметром changes=ONLY_LAST! '''Пример запроса:'''<source lang="xml"><?xml version="1.0" encoding="UTF-8"?><tracking>
<extra>8</extra>
<orderno>1234</orderno>
</tracking17tracking>
</source>
'''Пример ответа:'''
<presource lang="xml">{ <?xml version="1.0" encoding="numberUTF-8":?><tracking> <order orderno="ExtNumber111111",> <barcode>111111</barcode> <AWB>111111</AWB> <sender> <town code="oriNumber1":country="1234RU",>Москва город</town> <date>2014-03-22</date> <time_min>09:00</time_min> <time_max>14:00</time_max> </sender> <receiver> <town code="oriCountry1":country="RU">Москва город</town> <zipcode>125480</zipcode> <date>2014-03-22</date> <time_min>09:00</time_min> <time_max>14:00</time_max> </receiver> <price>387.5</price> <inshprice>387.5</inshprice> <paytype>CASH</paytype> <weight>5.1</weight> <quantity>2</quantity> <service>2</service> <type>3</type> <return>NO</return> <return_service>2</return_service> <return_date></return_date> <return_time></return_time> <return_message></return_message> <waittime>12</waittime> <enclosure>Детские игрушки</enclosure> <instruction>Проверить при покупателе,подписать акт</instruction> <deliveryprice total="158.6" delivery="destCountry100.00":return="RU58.6",/> <courier> <code>26</code> <name>Иванов Владимир Петрович</name> <phone>+79161234567</phone> </courier> <currcoords lat="55.680327"statuslon=":37.604456"Completeaccuracy=", 50"eventsRequestDateTime="2014-04-21 18:07:[45" /> { <status eventstore="timeфилиал в Санкт-Петербурге":eventtime="2016-06-02 17:22:00",createtimegmt="2016-06-03 16:14:44" message="" title="Доставлен">COMPLETE</status> <statushistory> <status eventstore="locationОфис в Москве"eventtime="2016-05-30 10:20:00" createtimegmt="RU2016-06-03 16:14:44", message="content":title="CompleteНовый">NEW</status> }, { <status eventstore="timeОфис в Москве":eventtime="2016-06-02 01 17:2238:00", "locationcreatetimegmt="2016-06-03 16:14:44"RUmessage=", филиал в Санкт-Петербурге"content":title="CourierdeliveredПланируется отправка">DEPARTURING</status> }, { <status eventstore="timeОфис в Москве":eventtime="2016-06-02 0901 19:1753:00", "locationcreatetimegmt="2016-06-03 16:14:44"RUmessage=", филиал в Санкт-Петербурге"contenttitle=":"DeliveryОтправлено со склада">DEPARTURE</status> }, { <status eventstore="timeфилиал в Санкт-Петербурге":eventtime="2016-06-02 07:41:00", "locationcreatetimegmt="2016-06-03 16:14:44"RUmessage=", "contenttitle=":"AcceptedПолучен складом">ACCEPTED</status> }, { <status eventstore="timeфилиал в Санкт-Петербурге":eventtime="2016-06-01 1902 09:5317:00", "locationcreatetimegmt="2016-06-03 16:14:44"RUmessage=", "contenttitle=":"DepartureВыдан курьеру на доставку">DELIVERY</status> }, { <status eventstore="timeфилиал в Санкт-Петербурге":eventtime="2016-06-01 02 17:3822:00", "locationcreatetimegmt="2016-06-03 16:14:44"RU", message="content":title="DeparturingДоставлен (предварительно)">COURIERDELIVERED</status> }, { <status eventstore="timeфилиал в Санкт-Петербурге":eventtime="2016-0506-30 1002 17:2022:00", "locationcreatetimegmt="2016-06-03 16:14:44"RUmessage=", "contenttitle=":"NewДоставлен">COMPLETE</status> } </statushistory> ] <deliveredto>Иванова, секр.</deliveredto>} <delivereddate>2016-06-02</predelivereddate> <deliveredtime>17:22</deliveredtime>Функция ищет последний заказ по номеру среди заказов всех клиентов. Выдает неперсонализированную информацию о текущем состоянии заказа. <outstrbarcode>EXT123456<br /outstrbarcode> <items>Описание контейнеров ответа аналогично описанию [[API# <item code="34533" extcode="abc123" quantity="1" mass="0.D02" retprice="37.97.D0.B0.D0.BF.D1.80.D0.BE.D1.81_.D1.81.D1.82.D0.B0.D1.82.D1.83.D1.81.D0.B0_.D0.B7.D0.B0.D0.BA.D0.B0.D0.B7.D0.BE.D0.B2|Запроса статусов заказов]]5" VATrate="0" barcode="2345625213125" article="1" returns="0" origincountry="040" GTD="" excise="0.00" governmentCode="11223311" suppcompany="Поставщик" suppINN="1112223334" suppphone="79161234567">Мяч</item> <item code="34456" extcode="abc124" quantity="2" mass="2" retprice="100" VATrate="10" barcode="4645625213138" article="2" returns="0" governmentCode="">Обруч</item> <item code="34421" extcode= Изменение заказа "abc125" quantity="3" mass="0.3" retprice="50" VATrate="18" barcode="2345625213126" article="3" returns="0" governmentCode="">Погремушка желтая</item> </items>Запрос предназначен для изменения заказов, по которым не было произведено изменений статуса корреспонденции, времени доставки — то есть заказов, которые ещё не в работе. </order></tracking>Изменять заказы могут курьерские службы с тарифами «Премиум» и «Максимум». Чтобы разрешить изменение заказов, в личном кабинете курьерской службы перейдите в '''Параметры''' </source> '''Расширенные''' и установите флажок '''Разрешить отмену и изменение заказов'''.
<div style="color: #a94442; background-color: #f2dede; border: 1px solid #ebccd1; padding: 3px 10px 10px;">
'''Обратите внимание!'''
# Данные запроса изменения указываются '''полностью''', как если бы заказ создавался впервые.
# При отсутствии вложения в запросе изменения данное вложение '''не удаляется''' из заказа, но его количество становится равным 0.
# При одновременном изменении заказа в API и системе курьерской службы приоритет отдается данным системы курьерской службы. То есть изменения в API приняты не будут!
</div>
<br>
=== Описание полей запроса изменения ===Все поля запроса соответствуют структуре order при создании заказа за исключением:* вместо корневого тэга '''neworder''' указывается '''editorder'''* тэг штрих-кода '''barcode''' не указывается, поскольку присваивается при создании заказа.* для вложений '''item''' указывается внутренний код вложения Получение информации в атрибуте '''codeформате 17 TRACK''', который можно получить при получении статуса заказа.
=== Описание полей ответа изменения ===Все поля ответа соответствуют ответу при создании заказа за исключением корневого тэга — вместо '''neworder''' возвращается '''editorder'''. == Отмена заказа ==Запрос предназначен для отмены заказов, по которым не было произведено изменений статуса доставки, статуса корреспонденции, времени доставки, то есть заказов, которые ещё не в работе. Отменять заказы могут курьерские службы с тарифами «Премиум» и «Максимум». Чтобы разрешить отмену заказов, в личном кабинете курьерской службы перейдите в '''Параметры''' > '''Расширенные''' и установите флажок '''Разрешить отмену и изменение заказов'''. При отмене заказа поле «Инфо о доставке» получает значение «Отменено заказчиком», поле «Дата доставки» — текущую дату, а «Вручил курьер» — системную запись «ОТМЕНА».  '''Пример запроса отмены заказа:'''<source lang="xml"><?xml version="1.0" encoding="UTF-8" ?><cancelordertracking17> <auth extra=">8" login="login" pass="pass" </extra> <order orderno="" ordercode="123456" /> 1234<order /orderno="123aaa" ordercode="" /></cancelordertracking17>
</source>
 
 
'''Описание полей запроса статуса:'''
 
'''cancelorder''' — Корневой контейнер. Обязательный элемент.
* '''auth''' — Авторизация. Обязательный элемент.
* '''order''' — Контейнер отменяемого заказа. Обязательный элемент. Запрос может содержать более одного контейнера '''order'''. Атрибуты:
:* '''''orderno''''' — Шифр заказа.
:* '''''ordercode''''' — Внутренний код заказа.
Обратите внимание, что должен быть указан хотя бы один из атрибутов ''orderno'' или ''ordercode''!
 
'''Пример ответа:'''
<source lang=pre>{ "number":"ExtNumber", "oriNumber":"xml1234">,<?xml version= "1.0oriCountry" encoding=:"UTF-8RU" ?>,<cancelorder> "destCountry":"RU", <order orderno= "123teststatus" ordercode=:"123456Complete" error=, "0events" errormsg=:[ { "OKtime" errormsgru=:"Успешно2016-06-02 17:22:00" />, <order orderno= "location":"123aaaRU" ordercode=, "content" error=:"52Complete" errormsg= }, { "order not foundtime" errormsgru=:"Заказ не найден2016-06-02 17:22:00" />,</cancelorder> "location":"RU",</source> "content":"Courierdelivered" },== Добавление вложений к накладной == { "time":"2016-06-02 09:17:00",'''Пример запроса "location":'''"RU",<source lang= "content":"xmlDelivery"><?xml version= }, { "1.0time" encoding=:"UTF2016-06-802 07:41:00" ?>, "location":"RU", "content":"Accepted" }, {<addattachments> "time":"2016-06-01 19:53:00", <auth extra= "location":"8RU" login=, "logincontent" pass=:"passDeparture" /> <orderno>1234567</orderno> }, <attachments> { <item name= "time":"photo1.jpg2016-06-01 17:38:00">JVBERi0xLjMN1wb25lbnQgMQ, JUBQREYwMTIzNDU2Nzg5IDI NMyAwIG9iag08PA0vVHlwZSA "location":"RU", U3VidHlwZSAvSW1hZ2UNL1d pZHRoIDE4MDgNL0hlaWdodCA "content":"Departuring" ggNCAwIFINL0JpdHNQZXJDb 21wb25lbnQgMQ0vRGVjb2RlU }, ENL0NvbHVtbnMgMTgwOA0+P g0vSW1hZ2VNYXNrIHRydWUNL { XhEZWNvZGUNPj4Nc3RyZWFt DQ</item> "time":"2016-05-30 10:20:00", <item name= "location":"photo2.jpgRU">VBERi0xLjMNAwIG9iag0HRoJ, JUBQREYwMTIzNDU2Nzg5IDI NMyAwIG9iag08PA0vVHlwZSA vWE9iamVjdA0vU3VidHlwZS AvSW1hZ2UNL1dpZHRoIDEzNj "content":"New" gNL0hlaWdodCAxMzMzDS9MZ W5ndGggNCAwIFINL0JpdHNQZ } XJDb21wb25lbnQgMQ0vRGVj b2RlUGFybXMgPDwNL0sgLTEN ] L0NvbHVtbnMgMTM2OA0+Pg0 vSW}</itempre> Функция ищет последний заказ по номеру среди заказов всех клиентов. Выдает неперсонализированную информацию о текущем состоянии заказа.</attachmentsbr></addattachments>Описание контейнеров ответа аналогично описанию [[API#.D0.97.D0.B0.D0.BF.D1.80.D0.BE.D1.81 .D1.81.D1.82.D0.B0.D1.82.D1.83.D1.81.D0.B0 .D0.B7.D0.B0.D0.BA.D0.B0.D0.B7.D0.BE.D0.B2|Запроса статусов заказов]]. == Изменение заказа ==</source>Запрос предназначен для изменения заказов.
Изменять заказы могут курьерские службы с тарифами «Премиум» и «Максимум». Чтобы разрешить изменение заказов, в личном кабинете курьерской службы перейдите в '''Настройки''' > '''Заказы''' и в разделе '''Отмена и редактирование''' установите флажок '''Разрешить отмену и изменение заказов'''. Вы также можете пометить в списке '''Статусы для отмены и редактирования заказов''' галками статусы корреспонденции, для которых возможны отмена и изменение заказов. По умолчанию (когда в этом списке ничего не выбрано) редактирование и отмена разрешены для статуса «Новый»
<div style="color: #a94442; background-color: #f2dede; border: 1px solid #ebccd1; padding: 3px 10px 10px;">'''Описание полей:Обратите внимание!'''# Данные запроса изменения указываются '''полностью''', как если бы заказ создавался впервые.# При отсутствии вложения в запросе изменения данное вложение '''не удаляется'''из заказа, но его количество становится равным 0.# При одновременном изменении заказа в API и системе курьерской службы приоритет отдается данным системы курьерской службы. То есть изменения в API приняты не будут.</div>
При редактировании заказа может быть отменен запланированный курьер. Это зависит от значения переменной '''addattachmentsСправочники''' - Корневой контейнер. Обязательный элемент.*> '''authПеременные''' - Авторизация. Обязательный элемент.*> '''ordernoКорреспонденция''' - Номер заказа. Обязательный элемент. Может использоваться тэг <ordercode> с указанием внутреннего кода заказа.*'''attachmentsАвтоматически устанавливать заплан. курьера по району''' - Обязательный элемент, в котором перечисляются передаваемые данные файлов.:**'''itemНет''' - Бинарные данные (файл), закодированные в base64. Обязательный элемент. — при редактировании заказа по АПИ курьер не изменяется;***'''nameРайон''' - Атрибут элемента  — если изменен адрес доставки, курьер сбрасывается;* '''itemРайон или дата план. доставки''' — если изменен адрес доставки или плановая дата вручения, в котором передается имя файла. Обязательный элементкурьер сбрасывается.
=== Описание полей запроса изменения ===
Все поля запроса соответствуют структуре order при создании заказа за исключением:
* значение '''Пример ответа:orderno'''данным методом изменить нельзя.<source lang="xml"><?xml version="1* значение '''barcode''' изменяется в случае явного его указания.0" encoding="UTFВ случае отсутствия или пустого значения -8"?>остается прежним.<addattachments>* вместо корневого тэга '''neworder''' указывается '''editorder'''; <attachments>* тэг курьера '''courier''' можно изменить только при включенной настройке '''Разрешить изменение курьера по АПИ'''; <* для вложений '''item name="photo1''' указывается внутренний код вложения в атрибуте '''code''', который можно получить при получении статуса заказа.jpg" error="0" errormsg="OK" errormsgru="Успешно" /> <item name="photo2* для мест '''package''' указывается внутренний код вложения в атрибуте '''code''', который можно получить при получении статуса заказа.jpg" error="0" errormsg="OK" errormsgru="Успешно" /> </attachments></addattachments></source>Необходимо иметь в виду, что: # Заказ нельзя изменить, пока он не синхронизирован с системой (пока предыдущие изменения не переданы в бэк-офис)# Удаление вложений и мест выполняется не моментально, а в процессе синхронизации с бэк-офисом (для записей указываются метки Удалено)
== Получение вложений к накладной =Описание полей ответа изменения ===Все поля ответа соответствуют ответу при создании заказа за исключением корневого тэга — вместо '''neworder''' возвращается '''editorder'''.
'''Пример запроса:'''<source lang="xml"><?xml version="1.0" encoding="UTF-8" ?><attachments> <auth extra="8" loginОтмена заказа ="login" pass="pass" /> <orderno>1234567</orderno></attachments></source>Запрос предназначен для отмены заказов.
Отменять заказы могут курьерские службы с тарифами «Премиум» и «Максимум». Разрешения для отмены заказов и статусы в которых заказы можно отменять описаны в разделе '''Описание полей:Изменение заказов'''
'''attachments''' - Корневой контейнер. Обязательный элемент.*'''auth''' - Авторизация. Обязательный элемент.*'''orderno''' - Номер/код При отмене заказа. Обязательный элементполе «Инфо о доставке» получает значение «Отменено заказчиком», поле «Дата доставки» — текущую дату, а «Вручил курьер» — системную запись «ОТМЕНА».
'''Пример ответазапроса отмены заказа:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?><attachmentscancelorder> <item nameauth extra="doc1.docx8" sizelogin="35654login"pass="pass" />JVBERi0xLjMN JUBQREYwMTIzNDU2Nzg5IDI NMyAwIG9iag08PA0vVHlwZSA U3VidHlwZSAvSW1hZ2UNL1d pZHRoIDE4MDgNL0hlaWdodCA ggNCAwIFINL0JpdHNQZXJDb 21wb25lbnQgMQ0vRGVjb2RlU ENL0NvbHVtbnMgMTgwOA0+P g0vSW1hZ2VNYXNrIHRydWUNL XhEZWNvZGUNPj4Nc3RyZWFt DQ<order orderno="" ordercode="123456" /item> <item nameorder orderno="photo2.jpg123aaa" sizeordercode="74861">VBERi0xLjMN JUBQREYwMTIzNDU2Nzg5IDI NMyAwIG9iag08PA0vVHlwZSA vWE9iamVjdA0vU3VidHlwZS AvSW1hZ2UNL1dpZHRoIDEzNj gNL0hlaWdodCAxMzMzDS9MZ W5ndGggNCAwIFINL0JpdHNQZ XJDb21wb25lbnQgMQ0vRGVj b2RlUGFybXMgPDwNL0sgLTEN L0NvbHVtbnMgMTM2OA0+Pg0 vSW</item></attachmentscancelorder>
</source>
В тегах item возвращаются бинарные данные (файлы), закодированные в base64.
== Изменение статуса агентом =='''Описание полей:'''
'''cancelorder''' — Корневой контейнер. Обязательный элемент.* '''auth''' — Авторизация. Обязательный элемент.* '''order''' — Контейнер отменяемого заказа. Обязательный элемент. Запрос изменения статуса может содержать более одного контейнера '''order'''. Атрибуты::* '''''orderno''''' — Шифр заказа позволяет установить окончательный статус .:* '''''ordercode''''' — Внутренний код заказа - "Доставлен" .Обратите внимание, что должен быть указан хотя бы один из атрибутов ''orderno'' или "Не доставлен (Возврат/Отмена)".''ordercode''!
Кроме этого, устанавливается дата и время (при необходимости) изменения статуса, а также сообщение в поле ''Инфо о доставке''.
При необходимости '''Пример ответа:'''<source lang="xml"><?xml version="1.0" encoding="UTF-8" ?><cancelorder> <order orderno="123test" ordercode="123456" error="0" errormsg="OK" errormsgru="Успешно" /> <order orderno="123aaa" ordercode="" error="52" errormsg="order not found" errormsgru="Заказ не найден" /></cancelorder></source> == Добавление вложений к заказу можно прикрепить изображения.накладной ==
Метод позволяет прикрепить файлы к корреспонденции.
Размер загружаемого файла не должен превышать 1 Мб.
'''Пример запроса изменения статуса:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8" ?>
<setorderinfoaddattachments>
<auth extra="8" login="login" pass="pass" />
<order ordercode="123456"orderno> <message>Получил Иванов1234567</message> <outstrbarcode>7654312</outstrbarcodeorderno> </orderattachments> <order ordercodeitem name="234567photo1.jpg">JVBERi0xLjMN1wb25lbnQgMQ <status>PICKUPREADY</status>JUBQREYwMTIzNDU2Nzg5IDI NMyAwIG9iag08PA0vVHlwZSA <eventtime>2016-05-30 10:20:00</eventtime>U3VidHlwZSAvSW1hZ2UNL1d pZHRoIDE4MDgNL0hlaWdodCA <message>Клиент отказался от покупки</message>ggNCAwIFINL0JpdHNQZXJDb 21wb25lbnQgMQ0vRGVjb2RlU <paytype>CASH</paytype>ENL0NvbHVtbnMgMTgwOA0+P g0vSW1hZ2VNYXNrIHRydWUNL XhEZWNvZGUNPj4Nc3RyZWFt DQ<items> <item code="34533" quantity="1" reason="0" /> <item code="34456" quantity="0" reason="0" /> <item code="34421" quantity="2" reason="0" /> </items> <image filenamename="filename1photo2.jpg"> /9j/4AAQSkZJRgAVBERi0xLjMNAwIG9iag0HRoJ BAQAAAQABAAD/2wBDAA0JCg sKCA0LCgsODg0PEyAVExISEyJUBQREYwMTIzNDU2Nzg5IDI NMyAwIG9iag08PA0vVHlwZSA ccHhcgLikxMC4pLSwzOko+M zZGNywtQFdBRkxOUlNSMj5aYvWE9iamVjdA0vU3VidHlwZS AvSW1hZ2UNL1dpZHRoIDEzNj VpQYEpRUk//2wBDAQ4ODhMR EyYVFSZPNS01T09PT09PT09PgNL0hlaWdodCAxMzMzDS9MZ W5ndGggNCAwIFINL0JpdHNQZ T09PT09PT09PT09PT09PT09 PT09PT09PT09PT09PT09PT09XJDb21wb25lbnQgMQ0vRGVj b2RlUGFybXMgPDwNL0sgLTEN PT09PT0//wAARCAYACAADAS IAL0NvbHVtbnMgMTM2OA0+Pg0 vSW</imageitem> </orderattachments></setorderinfoaddattachments>
</source>
'''Описание полей запроса статуса:''' '''setorderinfo''' - Корневой контейнер. Обязательный элемент.*'''auth''' - Авторизация. Обязательный элемент.*'''order''' - Контейнер заказа. Обязательный элемент. Запрос может содержать более одного контейнера '''order'''. Атрибут '''''ordercode''''' - внутренний код заказа.*'''status''' - Новый статус заказа. Доступны статусы из раздела [[#Описание полей ответа статусов]], кроме AWAITING_SYNC и NEW.*'''eventtime''' - Дата и время изменения статуса. Обязательно при указании статуса.*'''message''' - Текст сообщения ''Инфо о доставке''.*'''outstrbarcode''' - код у подрядчика (код заказа во внешней системе). Используется в интеграциях с внешними системами.*'''paytype''' - Тип оплаты заказа. Допустимые значения CASH/CARD.*'''items''' - Контейнер для описания вложений '''item''' . Атрибуты::* '''''code''''' - Код вложения.:* '''''quantity''''' - Количество доставленных единиц вложения.:* '''''reason''''' - Причина недоставки, выбирается из соответствующего списка статусов.*'''image''' - Контейнер прикрепляемого изображения. Содержит текст файла изображения, закодированный по стандарту ''base64''. Контейнер '''order''' может содержать более одного контейнера '''image'''. Атрибут::* '''''filename''''' - Имя файла.
'''addattachments''' — Корневой контейнер. Обязательный элемент.
* '''auth''' — Авторизация. Обязательный элемент.
* '''orderno''' — Номер заказа. Обязательный элемент. Может использоваться тэг <ordercode> с указанием внутреннего кода заказа.
* '''attachments''' — Обязательный элемент, в котором перечисляются передаваемые данные файлов.
** '''item''' — Бинарные данные (файл), закодированные в base64. Обязательный элемент.
*** '''name''' — Атрибут элемента '''item''', в котором передается имя файла. Обязательный элемент.
<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<setorderinfoaddattachments> <order ordercodeattachments> <item name="123456photo1.jpg" error="0" errormsg="OK" errormsgru="Успешно" /> <order ordercodeitem name="234567photo2.jpg" error="590" errormsg="value [date_put] is already setOK" errormsgru="Значение [Дата доставки] уже указаноУспешно" /> </attachments></setorderinfoaddattachments>
</source>
== Получение документов для печати вложений к накладной == '''Пример запроса получения печатных форм:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8" ?>
<waybillattachments>
<auth extra="8" login="login" pass="pass" />
<ordersorderno> 1234567<order orderno="1234567" ordercode="33331" /> <order orderno="1234568" ordercode="33332" /> </orders> <form>1</form></waybillattachments>
</source>
'''Описание полей:'''
'''waybillattachments''' -  — Корневой контейнер. Обязательный элемент.*'''auth''' -  — Авторизация. Обязательный элемент*'''orders''' - Список заказов для получения печатных форм. Содержит тэги '''order''' с атрибутами::* '''''orderno''''' - шифр заказа:* '''''ordercode''''' - внутренний  — Номер/код заказа. Указывать необходимо один из атрибутов для всех заказов. Приоритет имеет атрибут '''''ordercode'''''*'''form''' - Формат накладной. Не обязательный Обязательный элемент. Принимает значения::* 1 - Подробная накладная (по-умолчанию):* 2 - Наклейки Zebra:* 3 - Наклейки на страницу формата А4:* 4 - Акты приема-передачи
<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<waybillattachments> <contentitem name="doc1.docx" size="35654">EODIcaI8KSBlwQ 4MnEOR7Px8U8EBAyGICBnwpw JVBERi0xLjMN IZhQgz0ZxuPs8EBMJUBQREYwMTIzNDU2Nzg5IDI NMyAwIG9iag08PA0vVHlwZSA U3VidHlwZSAvSW1hZ2UNL1d pZHRoIDE4MDgNL0hlaWdodCA ggNCAwIFINL0JpdHNQZXJDb 21wb25lbnQgMQ0vRGVjb2RlU ENL0NvbHVtbnMgMTgwOA0+P g0vSW1hZ2VNYXNrIHRydWUNL XhEZWNvZGUNPj4Nc3RyZWFt DQ</GcbjzB AwhBl8hwQYIO00GmEwg1CeEG item> <item name="photo2.jpg" size="74861">VBERi0xLjMN mqYTChNU0wqf8l8nz4zgc+K fCno+zwU5GjOZmzXGcbEQYIM JUBQREYwMTIzNDU2Nzg5IDI NMyAwIG9iag08PA0vVHlwZSA vWE9iamVjdA0vU3VidHlwZS AvSW1hZ2UNL1dpZHRoIDEzNj 4zkegRE40zWzONyoNNMIOIa cWnp6aDCGEGE9NQmoQd2mg00 gNL0hlaWdodCAxMzMzDS9MZ W5ndGggNCAwIFINL0JpdHNQZ 79U4f3hPTwnfp6Sdrafeqpa JDpFw/1aYT077VNNNdO00G3q XJDb21wb25lbnQgMQ0vRGVj b2RlUGFybXMgPDwNL0sgLTEN mqqvp9p2E7T0/wiFemv8uG6 OML0NvbHVtbnMgMTM2OA0+Pg0 vSW</contentitem></waybillattachments>
</source>
В тегах item возвращаются бинарные данные (файлы), закодированные в base64.
В тэге content возвращаются бинарные данные == Изменение статуса агентом ==Запрос изменения статуса заказа позволяет установить окончательный статус заказа — «Доставлен» или «Не доставлен (файл pdfВозврат/Отмена), закодированные в base64».
Кроме этого, устанавливается дата и время (при необходимости) изменения статуса, а также сообщение в поле ''Инфо о доставке''.
'''Обратите внимание''', что печатные формы для заборов не формируютсяПри необходимости к заказу можно прикрепить изображения.
== Справочник городов == '''Пример запроса справочника городовизменения статуса:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?><townlistsetorderinfo> <auth extra="8" login="login" pass="pass" /> <codesearch> <zipcode>110000</zipcodeorder ordercode="123456"> <kladrcodemessage>0100000100800Получил Иванов</kladrcodemessage> <fiascodeoutstrbarcode>bd21979d-46f8-49d0-9105-e8d65172a9837654312</fiascode> <code>123</codeoutstrbarcode> </codesearchorder> <conditionsorder ordercode="234567"> <citystatus>Краснодарский крайPICKUPREADY</citystatus> <namecontainseventtime>новгород2016-05-30 10:20:00</namecontainseventtime> <namestartsmessage>МоскКлиент отказался от покупки</namestartsmessage> <namepaytype>МоскваCASH</namepaytype> <fullnamestoreprice>Москва город123</fullnamestoreprice> <countryitems> <item code="34533" quantity="1<" reason="0" governmentCode="11223311" /country> <item code="34456" quantity="0" reason="0" /conditions> <limititem code="34421" quantity="2" reason="0" /> <limitfrom>30</limitfromitems> <limitcountimage filename="filename1.jpg">10</limitcount>9j/4AAQSkZJRgA BAQAAAQABAAD/2wBDAA0JCg sKCA0LCgsODg0PEyAVExISEy ccHhcgLikxMC4pLSwzOko+M zZGNywtQFdBRkxOUlNSMj5aY VpQYEpRUk//2wBDAQ4ODhMR EyYVFSZPNS01T09PT09PT09P T09PT09PT09PT09PT09PT09 PT09PT09PT09PT09PT09PT09 <countall>YESPT09PT0//wAARCAYACAADAS IA</countallimage> </limitorder></townlistsetorderinfo>
</source>
Внутри контейнера townlist все элементы могут как отсутствовать, так и комбинироваться. Поиск не чувствителен к регистру.
*'''authОписание полей запроса статуса:''' - Авторизация, необязательный элемент. Используется в случае включенного и настроенного ограничения по населенным пунктам в конкретной курьерской службе.
'''setorderinfo''' — Корневой контейнер. Обязательный элемент.*'''codesearchauth''' — Авторизация. Обязательный элемент.* '''order''' — Контейнер заказа. Обязательный элемент. Запрос может содержать более одного контейнера '''order''' - Поиск по кодам. В случае использования - контейнеры conditions и limit игнорируютсяАтрибут '''''ordercode''''' — внутренний код заказа.:* '''zipcodestatus''' - Поиск по индексу — Новый статус заказа. Обратите внимание на тоДоступны статусы из раздела [[#Описание полей ответа статусов]], что один почтовый индекс может распространяться на несколько населенных пунктовкроме AWAITING_SYNC и NEW.* '''eventtime''' — Дата и время изменения статуса. В этом случае система вернет несколько записейОбязательно при указании статуса.:* '''kladrcodemessage''' — Текст сообщения ''Инфо о доставке'' - Поиск по 13-ти значному коду КЛАДР.:* '''fiascodeoutstrbarcode''' - Поиск по коду ФИАС  — код у подрядчика (AOGUIDкод заказа во внешней системе). Используется в интеграциях с внешними системами.* '''paytype''' — Тип оплаты заказа. Допустимые значения CASH/CARD.* '''storeprice''' — Агентское вознаграждение.* '''items''' — Контейнер для описания вложений '''item''' . Атрибуты::* '''''code''' - Поиск '' — Код вложения.:* '''''quantity''''' — Количество доставленных единиц вложения.:* '''''reason''''' — Причина недоставки, выбирается из соответствующего списка статусов.:* '''''governmentCode''''' — Указание кода ТН для вложения при необходимости.* '''image''' — Контейнер прикрепляемого изображения. Содержит текст файла изображения, закодированный по коду в системестандарту ''base64''. Контейнер '''order''' может содержать более одного контейнера '''image'''. Атрибут::* '''''filename''''' — Имя файла.
*'''conditions''' - Задает условия поиска. Все вложенные элементы одновременно накладывают условие "И".
:* '''city''' - Поиск по всем населенным пунктам региона.
:* '''namecontains''' - Поиск населенных пунктов, название которых содержит указанный текст.
:* '''namestarts''' - Поиск населенных пунктов, название которых начинается с указанного текста.
:* '''name''' - Поиск населенных пунктов, название которых соответствует указанному тексту.
:* '''fullname''' - Поиск населенных пунктов, название вместе с типом населенного пункта которых соответствует указанному тексту.
:* '''country''' - Поиск только по стране с указанным кодом.
*'''limit''' - Ограничивает вывод результата.
:* '''limitfrom''' - Задает номер записи результата, начиная с которой выдавать ответ. По-умолчанию - 0.
:* '''limitcount'''- Задает количество записей результата, которые нужно вернуть. По-умолчанию - 10000.
:* '''countall''' - YES указывает на необходимость подсчета общего количества найденных совпадений. Это может замедлять выполнение запроса. Если отключено - в ответе не указываются totalcount и totalpages.
'''Пример ответа:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<townlist countsetorderinfo> <order ordercode="3123456" pageerror="10" totalcounterrormsg="3OK" totalpageserrormsgru="1Успешно"/> <town> <code>26379<order ordercode="234567" error="59" errormsg="value [date_put] is already set" errormsgru="Значение [Дата доставки] уже указано" /code> <city> <code>23</codesetorderinfo> <name>Краснодарский край</namesource> </city> <name>Сочи город</name>== Получение документов для печати == <fiascode>79da737a-603b-4c19-9b54-9114c96fb912</fiascode>'''Пример запроса получения печатных форм:''' <kladrcode>2300000700000</kladrcodesource lang="xml"> <shortname /> (not yet supported) <typename /> (not yet supported) <coords lat?xml version="431.58550" lonencoding="39.7231UTF-8" /?> </townwaybill> <town> <code>40331<auth extra="8" login="login" pass="pass" /code> <city> <code>32</code> <name>Брянская область </nameorders> <order orderno="1234567" ordercode="33331" /city> <name>Сочилов хутор</name> <fiascode>c9c96c67-2cc9-4f10-afde-fd32417ea216</fiascode> <kladrcode>3201900011100</kladrcode> <shortname /> <typename /> <coords latorder orderno="52.64071234568" lonordercode="33.172433332" /> </townorders> <townform> <code>1140161</codeform> <city> <codestart>605</codestart> <name>Псковская область</namewaybill> </city> <name>Сочихино деревня</namesource> <fiascode>10df7588-19c1-49d1-a387-9de1cf3eb26f</fiascode> <kladrcode>6001900015400</kladrcode> <shortname /> <typename /> <coords lat="56.6003" lon="29.3542" /> </town></townlist></source>'''Описание полей:'''
В ответе города сортируются по популярности, важности (районные центры и т'''waybill''' — Корневой контейнер. Обязательный элемент* '''auth''' — Авторизация. Обязательный элемент* '''orders''' — Список заказов для получения печатных форм. Содержит тэги '''order''' с атрибутами::* '''''orderno''''' — шифр заказа:* '''''ordercode''''' — внутренний код заказа. Указывать необходимо один из атрибутов для всех заказов. Приоритет имеет атрибут '''''ordercode'''''* '''form''' — Формат накладной.дНе обязательный элемент.Принимает значения::* 1 — Подробная накладная (по-умолчанию), и :* 2 — Наклейки Zebra:* 3 — Наклейки на страницу формата А4:* 4 — Акты приема-передачи* '''start''' — Имеет смысл только затем - по алфавитудля form = 3. Начальная позиция первой наклейки. Используется для пропуска наклеек на листе для их экономии.
== Справочник регионов ==
'''Пример запроса справочникаответа:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<regionlistwaybill> <codesearchcontent>EODIcaI8KSBlwQ 4MnEOR7Px8U8EBAyGICBnwpw <code>77< IZhQgz0ZxuPs8EBM/code>GcbjzB AwhBl8hwQYIO00GmEwg1CeEG </codesearch>mqYTChNU0wqf8l8nz4zgc+K fCno+zwU5GjOZmzXGcbEQYIM <conditions>4zkegRE40zWzONyoNNMIOIa cWnp6aDCGEGE9NQmoQd2mg00 <namecontains>край< 79U4f3hPTwnfp6Sdrafeqpa JDpFw/namecontains>1aYT077VNNNdO00G3q <namestarts>Моск< mqqvp9p2E7T0/namestarts> <fullname>Московская область</fullname> <country>1</country> wiFemv8uG6 OM</conditionscontent></regionlistwaybill>
</source>
 В тэге content возвращаются бинарные данные (файл pdf), закодированные в base64.При записи в файл необходимо использовать двоичный формат записи!  '''Обратите внимание''', что печатные формы для заборов не формируются.  '''Пример ответас ошибкой:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<regionlist count="2"waybill> <cityerror> <code>80</code> <country> <code>1</code> <name>Россия</name> <id>643</id> <ShortName1>RU</ShortName1> <ShortName2>RUS</ShortName2> </country> <name>Агинский Бурятский автономный округ</name> </city> <city> <code>1</code> <country> <code>1</code> <name>Россия</name> <id>643</id> <ShortName1>RU</ShortName1> <ShortName2>RUS</ShortName2> </country> <name>Адыгея республика</name> Текст ошибки</cityerror></regionlistwaybill>
</source>
== Справочник улиц городов == '''Пример запроса справочника улицгородов:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<streetlisttownlist> <auth extra="8" /> <codesearch> <zipcode>110000</zipcode> <kladrcode>0100000100800</kladrcode> <fiascode>bd21979d-46f8-49d0-9105-e8d65172a983</fiascode> <code>123</code> </codesearch>
<conditions>
<towncity>Москва городКраснодарский край</towncity> // ОБЯЗАТЕЛЬНОЕ ПОЛЕ! <namecontains>Хохлоновгород</namecontains> <namecontainsparts>молоково моск</namecontainsparts> <namestarts>Академика ХМоск</namestarts> <name>Академика ХохловаМосква</name> <fullname>Академика Хохлова ул.Москва город</fullname> <country>1</country>
</conditions>
<limit>
<countall>YES</countall>
</limit>
</streetlisttownlist>
</source>
Внутри контейнера townlist все элементы могут как отсутствовать, так и комбинироваться. Поиск не чувствителен к регистру. * '''auth''' — Авторизация, необязательный элемент. Используется в случае включенного и настроенного ограничения по населенным пунктам в конкретной курьерской службе. *'''codesearch''' — Поиск по кодам. В случае использования — контейнеры conditionsи limit игнорируются.:* '''zipcode''' — Поиск по индексу. Обратите внимание на то, что один почтовый индекс может распространяться на несколько населенных пунктов. В этом случае система вернет несколько записей.:* '''kladrcode'''  — Поиск по 13- ти значному коду КЛАДР.:* '''fiascode''' — Поиск по коду ФИАС (AOGUID).:* '''code''' — Поиск по коду в системе. * '''conditions''' — Задает условия поиска. Все вложенные элементы одновременно накладывают условие "И"«И».:* '''city''' — Поиск по всем населенным пунктам региона.:* '''townnamecontainsparts''' - Обязательное поле — Поиск населенных пунктов, название которых содержит все указанные слова, с разбиением поисковой фразы через пробел. Название или код населенного пунктаНапример "моск моло" найдет деревню "Молоково" в Московской области.:* '''namecontains''' -  — Поиск населенных пунктов, название которых содержит указанный текст.:* '''namestarts''' -  — Поиск населенных пунктов, название которых начинается с указанного текста.:* '''name''' -  — Поиск населенных пунктов, название которых соответствует указанному тексту.:* '''fullname''' -  — Поиск населенных пунктов, название вместе с типом населенного пункта которых соответствует указанному тексту.:* '''country''' — Поиск только по стране с указанным внутренним кодом или текстовым кодом в соответствии [https://ru.wikipedia.org/wiki/ISO_3166-1 стандартом ISO_3166-1], например, «RU», «RUS» для России.
*'''limit''' -  — Ограничивает вывод результата.:* '''limitfrom''' -  — Задает номер записи результата, начиная с которой выдавать ответ. По-умолчанию - умолчанию — 0.:* '''limitcount'''- Задает количество записей результата, которые нужно вернуть. По-умолчанию - умолчанию — 10000.:* '''countall''' -  — YES указывает на необходимость подсчета общего количества найденных совпадений. Это может замедлять выполнение запроса. Если отключено - отключено — в ответе не указываются totalcount и totalpages.
'''Пример ответа:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<streetlist townlist count="13" page="1" totalcount="3" totalpages="1"> <streettown> <namecode>Академика Хохлова ул.26379</namecode> <shortnamecity> <code>Академика Хохлова23</shortnamecode> <typenamename>ул.Краснодарский край</typenamename> </streetcity> <name>Сочи город</streetlistname> <fiascode>79da737a-603b-4c19-9b54-9114c96fb912</sourcefiascode> <kladrcode>2300000700000</kladrcode>В ответе улицы сортируются по алфавиту. == Справочник номенклатуры == '''Пример запроса справочника номенклатуры:''' <shortname /> (not yet supported) <source lang="xml"typename /> (not yet supported) <?xml versioncoords lat="143.05855" encodinglon="UTF-839.7231" ?/> <itemlist/town> <auth extra="8" login="login" pass="pass"town> <code>40331</authcode> <codesearchcity> <code>12345632</code> <articlename>FD343Брянская область</articlename> <barcode>2345625213125 </barcodecity> <name>Сочилов хутор</codesearchname> <conditionsfiascode> <namecontains>телевизорc9c96c67-2cc9-4f10-afde-fd32417ea216</namecontainsfiascode> <namestartskladrcode>sony3201900011100</namestartskladrcode> <nameshortname />Sony KDL-55W905 ЖК-телевизор <typename /name> <quantitycoords lat="52.6407" lon="33.1724" />EXISTING_ONLY </quantitytown> <storetown>2 </storecode> 114016</conditionscode> <exceptcity> <code>12347860</code> <name>Псковская область</name> </exceptcity> <limitname>Сочихино деревня</name> <limitfromfiascode>3010df7588-19c1-49d1-a387-9de1cf3eb26f</limitfromfiascode> <limitcountkladrcode>106001900015400</limitcountkladrcode> <countallshortname />YES <typename /countall> <coords lat="56.6003" lon="29.3542" /> </limittown></itemlisttownlist>
</source>
Внутри контейнера itemlist все элементы могут как отсутствоватьВ ответе города сортируются по популярности, так и комбинироватьсяважности (районные центры и т. Поиск не чувствителен к регистру д.*'''codesearch''' - Поиск по кодам. В случае использования - контейнеры conditions ), и limit игнорируются.:* '''code''' - Поиск по внутреннему коду системы.:* '''article''' - Поиск по артикулу.:* '''barcode''' - Поиск только затем — по штрих-кодуалфавиту.
*'''conditions''' - Задает условия поиска. Все вложенные элементы одновременно накладывают условие "И".:* '''namecontains''' - Поиск товаров, название которых содержит указанный текст.:* '''namestarts''' - Поиск товаров, название которых начинается с указанного текста.:* '''name''' - Поиск товаров, название которых соответствует указанному тексту.:* '''quantity''' - Наличие на складе. Принимает значения EXISTING_ONLY - Только в наличии, NOT_EXISTING_ONLY - Только не в наличии, ALL - Все. ''Это поле может быть недоступным в некоторых установках.'':* '''store''' - Поиск товаров по определенному складу. *'''except''' - Описание исключений для корректного определения количества зарезервированной номенклатуры.:* '''code''' - Код заказа. *'''limit''' - Ограничивает вывод результата.:* '''limitfrom''' - Задает номер записи результата, начиная с которой выдавать ответ.:* '''limitcount''' - Задает количество записей результата, которые нужно вернуть.== Справочник регионов =='''Пример ответазапроса справочника:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<itemlist count="3" totalcount="3" page="1" totalpages="1"regionlist> <itemcodesearch> <code>12345677</code> <article>FD343 </articlecodesearch> <barcode>2345625213125 </barcodeconditions> <namenamecontains>Sony KDL-55W905 ЖК-телевизоркрай</namenamecontains> <retpricenamestarts>65000Моск</retpricenamestarts> <purchpricefullname>50000Московская область</purchpricefullname> <weightcountry>5.1RU</weightcountry> <length>50 </length> <widthconditions>30</width> <height>40</height> <VATrate>20</VATrate> <CountInPallet>30</CountInPallet> <HasSerials>1</HasSerials> <CountryOfOrigin>Малайзия</CountryOfOrigin> (not yet supported) <Message>Хороший телевизор</Message> <Message2>Снова хороший телевизор</Message2> <quantity>12</quantity> <reserved>3</reserved> <item> ...</itemlistregionlist>
</source>
'''Описание полей:'''*'''code''' - Внутренний идентификатор, присвоенный системой.*'''article''' - Артикул, назначенный клиентом (поставщиком).*'''barcode''' - Штрих-код производителя.*'''name''' - Наименование.*'''retprice''' - Розничная цена по-умолчанию. При оформлении заказа цена используется та, которая указана в заказе.*'''purchprice''' - Закупочная цена.*'''weight''' - Масса в килограммах.*'''length''' - Длина в сантиметрах.*'''width''' - Ширина в сантиметрах.*'''height''' - Высота в сантиметрах.*'''VATrate''' - Ставка НДС, целое число процентов.*'''CountInPallet''' - Количество штук в паллете.*'''HasSerials''' - Требует учета серийных номеров. Принимает значения 1 - да, 0 - нет.*'''CountryOfOrigin''' - Наименование страны происхождения на русском языке.*'''Message''' - Комментарий.*'''Message2''' - Дополнительный комментарий.*'''quantity''' - Количество на складе. Товары, уже собранные в заказы в этом количестве не присутствуют, считаются покинувшими товарный склад. ''Это поле может быть недоступным в некоторых установках.''*'''reserved''' - Количество зарезервированного товара. Может превышать остаток на складе, если покупатели ждут следующей поставки. ''Это поле может быть недоступным в некоторых установках.'' == Движение номенклатуры == '''Пример запроса движения номенклатурыответа:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8" ?><itemmovementsregionlist count="2"> <auth extra="8" login="login" pass="pass"city> <code>80</authcode> <country> <code>42591</code> <datefromname>2020-10-01Россия</datefromname> <datetoid>2020-10-02643</datetoid> <ShortName1>RU</itemmovementsShortName1> <ShortName2>RUS</sourceShortName2> </country> <name>Агинский Бурятский автономный округ</name> </city>*''' <city> <code>1</code''' - внутренний код товара в справочнике номенклатуры.>*'''datefrom''' - дата начала периода. <country>*'''dateto''' - дата окончания периода. <code>1</code> <name>Россия</name> <id>643</id> <ShortName1>RU</ShortName1> <ShortName2>RUS</ShortName2>Может быть указан или код, или период, или код и период одновременно. </country> <name>Адыгея республика</name> </city></regionlist></source>
== Справочник улиц =='''Пример ответа движения номенклатурызапроса справочника улиц:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8" ?><itemmovements count="16"streetlist> <itemmovementconditions> <codetown>151500Москва город</codetown> <date>2017-05-26< //date>ОБЯЗАТЕЛЬНОЕ ПОЛЕ! <retpricenamecontains>0Хохло</retpricenamecontains> <quantitynamestarts>1Академика Х</quantitynamestarts> <deliveredname>0Академика Хохлова</deliveredname> <itemfullname> <code>4259Академика Хохлова ул.</codefullname> <name>Настольная игра Дженга </nameconditions> </itemlimit> <status> <codelimitfrom>530</codelimitfrom> <namelimitcount>Возврат от покупателя10</namelimitcount> </statuscountall> YES<store/countall> <code>1 </codelimit> <name>офис в Москве</namestreetlist> </storesource> <order> <ordercode>3374830</ordercode>* '''conditions''' — Задает условия поиска. Все вложенные элементы одновременно накладывают условие «И».:* '''town''' — Обязательное поле. Название или код населенного пункта. <number>123660-0</number>:* '''namecontains''' — Поиск улиц, название которых содержит указанный текст. <date>2017-05-24</date>:* '''namestarts''' — Поиск улиц, название которых начинается с указанного текста. <orderno>14123</orderno>:* '''name''' — Поиск улиц, название которых соответствует указанному тексту. <barcode>0000000670</barcode>:* '''fullname''' — Поиск улиц, для которых название вместе с типом соответствует указанному тексту. <company>ТОВАР</company> <address>Кравченко ул* '''limit''' — Ограничивает вывод результата.:* '''limitfrom''' — Задает номер записи результата, 1</address>начиная с которой выдавать ответ. По-умолчанию — 0. <delivereddate>2017:* '''limitcount'''-05Задает количество записей результата, которые нужно вернуть. По-29</delivereddate>умолчанию — 10000. <deliveredtime>12:00* '''countall''' — YES указывает на необходимость подсчета общего количества найденных совпадений. Это может замедлять выполнение запроса. Если отключено, в ответе не указываются totalcount и totalpages. '''Пример ответа:00'''</deliveredtimesource lang="xml"> <deliveredto /?xml version="1.0" encoding="UTF-8"?> </orderstreetlist count="1" page="1" totalcount="3" totalpages="1"> <documentstreet> <code>21991124</code> <numbername>318Академика Хохлова ул.</numbername> <dateshortname>2017-05-26Академика Хохлова</dateshortname> <messagetypename>ул.</message> </documenttypename> </itemmovementsstreet></itemliststreetlist>
</source>
''' Описание полей ответа '''*'''code''' - внутренний код операции движения*'''date''' - дата операции*'''retprice''' - цена товара*'''quantity''' - количество товара операции*'''delivered''' - количество доставленного товараВ ответе улицы сортируются по алфавиту.
*== Справочник номенклатуры =='''itemПример запроса справочника номенклатуры:''' <source lang="xml"><?xml version="1.0" encoding="UTF- контейнер товара8" ?><itemlist> <auth extra="8" login="login" pass="pass"></auth> <codesearch>:* ''' <code>123456</code''' - внутренний код товара> <article>FD343</article> <barcode>2345625213125</barcode> </codesearch> <conditions> <namecontains>телевизор</namecontains> <namestarts>sony</namestarts>:* ''' <name''' >Sony KDL-55W905 ЖК- наименование товарателевизор</name> <quantity>EXISTING_ONLY</quantity> <store>2</store> </conditions> <except> <code>123478</code> </except> <limit> <limitfrom>30</limitfrom> <limitcount>10</limitcount> <countall>YES</countall> </limit></itemlist></source>
Внутри контейнера itemlist все элементы могут как отсутствовать, так и комбинироваться. Поиск не чувствителен к регистру.*'''statuscodesearch''' - контейнер статуса операции — Поиск по кодам. В случае использования — контейнеры conditions и limit игнорируются.:* '''code''' - код статуса — Поиск по внутреннему коду системы.:* '''article''' — Поиск по артикулу.:* '''namebarcode''' - наименование — Поиск по штрихкоду.
*'''storeconditions''' — Задает условия поиска. Все вложенные элементы одновременно накладывают условие «И».:* '''namecontains''' - контейнер филиала — Поиск товаров, к которому относится операцияназвание которых содержит указанный текст.:* '''codenamestarts''' - код филиала — Поиск товаров, название которых начинается с указанного текста.:* '''name''' - наименование филиала — Поиск товаров, название которых соответствует указанному тексту.:* '''quantity''' — Наличие на складе. Принимает значения EXISTING_ONLY — Только в наличии, NOT_EXISTING_ONLY — Только не в наличии, ALL — Все. ''Это поле может быть недоступным в некоторых установках.'':* '''store''' — Поиск товаров по определенному складу.
*'''orderexcept''' - контейнер корреспонденции — Описание исключений для корректного определения количества зарезервированной номенклатуры.:* '''ordercodecode''' - внутренний код  — Код заказа:* '''number''' - номер заказа:* '''date''' - дата заказа:* '''orderno''' - шифр:* '''barcode''' - штрих-код:* '''company''' - компания:* '''address''' - адрес:* '''delivereddate''' - дата вручения:* '''deliveredtime''' - время вручения:* '''deliveredto''' - данные о вручении, либо причина недоставки.
*'''documentlimit''' - контейнер документа операции — Ограничивает вывод результата.:* '''codelimitfrom''' - внутренний код документа:* '''number''' - номер документа:* '''extnumber''' - внешний  — Задает номер документа:* '''date''' - дата документазаписи результата, начиная с которой выдавать ответ.:* '''messagelimitcount''' - комментарий — Задает количество записей результата, которые нужно вернуть.
== Получение справочника тарифов по городам == '''Пример запроса справочника тарифов по городамответа:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<tariffs> <auth extraitemlist count="3" totalcount="83" loginpage="login1" passtotalpages="pass1" > <item> <code>123456</code> <townfromarticle>МоскваFD343</townfromarticle> <servicebarcode>12345625213125</servicebarcode> <mainonlyname>1Sony KDL-55W905 ЖК-телевизор</mainonlyname> <retprice>65000</tariffsretprice> <purchprice>50000</sourcepurchprice> *'''auth''' — атрибут '''extra''' обязателен, по нему определяется курьерская служба <weight>5.1</weight>*'''townfrom''' — город-отправитель. Если не передан, то городом будет «Москва». <length>50</length>*'''service''' — режим доставки. Обязательный элемент. <width>30</width>*'''mainonly''' — необязательный элемент. Если передан, то в ответе будут данные только по городам из справочника '''Межгород''' <height>40</height> '''Зоны'''. <VATrate>20</VATrate> '''Пример ответа справочника тарифов по городам''' <CountInPallet>30<source lang="json"/CountInPallet>{ "townfrom": "0c5b2444-70a0-4932-980c-b4dc0d3f02b5",<CountInBox>2</CountInBox> "service": <HasSerials>1,</HasSerials> "tariffs": [<CountryOfOrigin>Малайзия</CountryOfOrigin> (not yet supported) { <Message>Хороший телевизор</Message> "towntofias": "7339e834-2cb4-4734-a4c7-1fca2c66e562", <Message2>Снова хороший телевизор</Message2> "towntocode": "482", <quantity>12</quantity> "towntoname": "Уфа город", "pricesnew": { "before": [ { "price": "100", "every": "0", "mass": "1" }, { "price": "200", "every": "1", "mass": "2" } ], "after": [ { "price": "300", "every": "1", "mass": " <reserved>3"</reserved> } <item> ] }, "prices": { "before": { "mass": "3", "price": "202 ..5" }, "after": { "mass": "3", "every": "1", "price": "18.75" } }, "deliveryPeriodMin": 4, "deliveryPeriodMax": 5 } ]}</itemlist>
</source>
''' Описание полей ответа :'''* '''code''' — Внутренний идентификатор, присвоенный системой.* '''townfromarticle''' — код ФИАС города-отправителя — Артикул, назначенный клиентом (поставщиком).* '''servicebarcode''' — режим доставки — Штрихкод производителя.*'''tariffsname''' — cписок тарифов по городу — Наименование.:* '''towntofiasretprice''' — код ФИАС города — Розничная цена по-получателяумолчанию. При оформлении заказа цена используется та, которая указана в заказе.:* '''towntocodepurchprice''' — внутренний код города-получателя — Закупочная цена.:* '''towntonameweight''' — наименование города-получателя — Масса в килограммах.:* '''pricesnewlength''' — ваши настройки тарифов из справочника  — Длина в сантиметрах.* '''Межгородwidth''' >  — Ширина в сантиметрах.* '''Тарифы по зонамheight''' — Высота в сантиметрах.::* '''priceVATrate''' — цена — Ставка НДС, целое число процентов.::* '''everyCountInPallet''' — за каждые — Количество штук в паллете.::* '''massCountInBox''' — масса — Количество штук в упаковке.:* '''pricesHasSerials''' — устаревший элемент — Требует учета серийных номеров. Принимает значения 1 — да, не используется0 — нет.* '''CountryOfOrigin''' — Наименование страны происхождения на русском языке.* '''Message''' — Комментарий.* '''Message2''' — Дополнительный комментарий.:* '''deliveryPeriodMinquantity''' — минимальный срок доставки — Количество на складе. Товары, уже собранные в заказы в этом количестве не присутствуют, считаются покинувшими товарный склад. ''Это поле может быть недоступным в некоторых установках.'':* '''deliveryPeriodMaxreserved''' — максимальный срок доставки — Количество зарезервированного товара.Может превышать остаток на складе, если покупатели ждут следующей поставки. ''Это поле может быть недоступным в некоторых установках.''
== Номенклатура приходной накладной Движение номенклатуры == '''Пример запроса движения номенклатуры приходной накладной:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8" ?>
<itemdocitemmovements>
<auth extra="8" login="login" pass="pass"></auth>
<code>219914259</code> <datefrom>2020-10-01</datefrom> <dateto>2020-10-02</dateto></itemdocitemmovements>
</source>
*'''code''' -  — внутренний код документа приходной накладной (смтовара в справочнике номенклатуры. предыдущий запрос)* '''datefrom''' — дата начала периода.* '''dateto''' — дата окончания периода.Может быть указан или код, или период, или код и период одновременно.
<source lang="xml">
<?xml version="1.0" encoding="UTF-8" ?>
<itemdocitemmovements count="16"> <codeitemmovement>21991 </code> <number>318151500</numbercode> <date>2017-05-26</date> <messageretprice>0</messageretprice> <quantity>1</quantity> <itemsdelivered>0</delivered> <item > <code=">4259" quantity="1" barcode="200300" article="123555"</code> <name>Настольная игра Дженга</name> </item> <status> <code>5</itemscode> <name>Возврат от покупателя</itemdocname> </sourcestatus> <store>''' Описание полей ответа ''' <code>1</code>* '''code''' - внутренний код приходной накладной <name>офис в Москве</name> </store> <order> <ordercode>3374830</ordercode>* ''' <number''' >123660- номер документа0</number>* ''' <date''' >2017-05- дата документа24</date>* '''message''' - комментарий <orderno>14123</orderno> <barcode>0000000670</barcode>*'''item''' - контейнер товара <company>ТОВАР</company>:* '''code''' - внутренний код товара <address>Кравченко ул., 1</address>:* '''barcode''' <delivereddate>2017- штрих05-код товара29</delivereddate> <deliveredtime>12:* '''article''' - артикул товара00:* '''quantity''' - количество поступившего товара00</deliveredtime> <deliveredto />== Справочник филиалов == </order> <document>'''Пример запроса списка филиалов:''' <code>21991<source lang="xml"/code> <?xml version="1.0" encoding="UTF-8" ?number>318<storelist/number> <auth extra="8"date>2017-05-26</authdate> <jsonmessage>YES</jsonmessage> <client_code/document>7890 </client_codeitemmovements></storelistitemlist>
</source>
''' Описание полей ответа '''* '''code''' — внутренний код операции движения* '''date''' — дата операции* '''retprice''' — цена товара* '''quantity''' — количество товара операции* '''delivered''' — количество доставленного товара * '''item''' — контейнер товара:* '''code''' — внутренний код товара:*'''authname''' — наименование товара * ' - Атрибут ''status'extra'' — контейнер статуса операции:* ' - обязателен''code''' — код статуса:* '''name''' — наименование * '''store''' — контейнер филиала, по нему определяется курьерская службак которому относится операция:*'''jsoncode''' - Признак вывода ответа в виде JSON YES/NO — код филиала:*'''client_codename''' - Код клиента курьерской службы — наименование филиала
* '''order''' — контейнер корреспонденции:* '''ordercode''' — внутренний код заказа:* '''number''' — номер заказа:* '''date''' — дата заказа:* '''orderno''' — шифр:* '''barcode''' — штрихкод:* '''company''' — компания:* '''address''' — адрес:* '''delivereddate''' — дата вручения:* '''deliveredtime''' — время вручения:* '''deliveredto''' — данные о вручении, либо причина недоставки * '''document''' — контейнер документа операции:* '''code''' — внутренний код документа:* '''number''' — номер документа:* '''extnumber''' — внешний номер документа:* '''date''' — дата документа:* '''message''' — комментарий == Получение справочника тарифов по городам == '''Пример ответа:запроса справочника тарифов по городам'''<source lang="xml"><?xml version="1.0" encoding="UTF-8" ?><storelist counttariffs> <auth extra="28" login="login" pass="pass"> <store> <code>123</code> <nametownfrom>ABCМосква</nametownfrom> </storeservice> <store> <code>4561</codeservice> <namemainonly>Филиал 21</name> </storemainonly> </storelisttariffs>
</source>
*'''codeauth'''  — атрибут '''extra''' обязателен, по нему определяется курьерская служба.* '''townfrom''' — город- Код филиалаотправитель. Если не передан, то городом будет «Москва».* '''service''' — режим доставки. Обязательный элемент. *'''namemainonly''' — необязательный элемент. Если передан, то в ответе будут данные только по городам из справочника '''Межгород''' > '''Зоны''' - Наименование филиала.
== Справочник пунктов самовывоза ==
Для отображения списка пунктов выдачи (ПВЗ) есть '''готовый JavaScript модуль''': https://home.courierexe.ru/js/measoft_map.js Инструкция по использованию - внутри. Посмотреть пример работы можно [https://home.courierexe.ru/pvz_test.html Здесь]
'''Пример ответа справочника тарифов по городам'''<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" ?><pvzlistitemdoc> <auth extra="8" login="login" pass="pass"></auth> <code>123421991</code> <client_code>7890</client_code> <town>Нижний Тагил</town> <parentcode>6</parentcode> <acceptcash>YES</acceptcash> <acceptcard>YES</acceptcard> <acceptfitting>YES</acceptfitting> <maxweight>30</maxweight> <acceptindividuals>YES</acceptindividuals> <lt>57.924737</lt> <lg>59.940019</lg> <rt>57.905682</rt> <rg>59.984669</rg> <json>YES</json> <limit> <limitfrom>30</limitfrom> <limitcount>2</limitcount> <countall>YES</countall> </limit></pvzlistitemdoc>
</source>
*'''auth''' - Атрибут '''extra''' - обязателен, по нему определяется курьерская служба, '''login''' и '''pass''' позволяют авторизоваться под клиентом: для отдельного клиента могут быть ограничения по доступности некоторых ПВЗ, и в этом случае они будут учтены.*'''code''' - Внутренний  — внутренний коддокумента приходной накладной (см.*'''client_code''' - Код клиента курьерской службы.*'''town''' - Город получателя.*'''parentcode''' - Фильтр по родительскому [[#Справочник филиалов|филиалу]]*'''acceptcash''' - Фильтр по приему наличных YES/NO*'''acceptcard''' - Фильтр по приему банковских карт YES/NO*'''acceptfitting''' - Фильтр по наличию примерки YES/NO*'''maxweight''' - Фильтр по максимальному весу, с которым работает ПВЗ*'''acceptindividuals''' - Фильтр по доступности физическим лицам YES/NO*'''lt''' - Широта левого верхнего угла*'''lg''' - Долгота левого верхнего угла*'''rt''' - Широта правого нижнего угла*'''rg''' - Долгота правого нижнего угла*'''json''' - Признак вывода ответа в виде JSON 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"itemdoc> <pvz> <code>12621991</code> <clientcodenumber>3318</clientcodenumber> <namedate>Нижний Тагил2017-05-26</namedate> <parentcodemessage>6</parentcodemessage> <parentname>Интеграция </parentnameitems> <town item code="1242674259" regioncodequantity="661" regionnamebarcode="Свердловская область200300" article="123555">Нижний Тагил городНастольная игра Дженга</townitem> <address>622036, г. Нижний Тагил, ул. Циолковского, д. 17 </addressitems> <phone>+73435417709, +73435254989</phoneitemdoc> <comment>Новый пункт доставки</commentsource> <worktime>Вс 10''' Описание полей ответа '''* '''code''' — внутренний код приходной накладной* '''number''' — номер документа* '''date''' — дата документа* '''message''' — комментарий * '''item''' — контейнер товара:00-16* '''code''' — внутренний код товара:00, Сб 10* '''barcode''' — штрихкод товара:00-16* '''article''' — артикул товара:00, Пн-Пт 10* '''quantity''' — количество поступившего товара == Справочник филиалов =='''Пример запроса списка филиалов:00-20:00'''</worktimesource lang="xml"> <traveldescription>Жилое 5?xml version="1.0" encoding="UTF-ти этажное здание, торцом к дороге, второе здание от перекрестка Пархоменко-Циолковского</traveldescription8" ?> <maxweight>10</maxweightstorelist> <acceptcashauth extra="8">YES</acceptcashauth> <acceptcardjson>YES</acceptcardjson> <acceptfittingclient_code>YES7890</acceptfittingclient_code> <acceptindividuals>YES</acceptindividualsstorelist> <latitude>57.93457</latitudesource> <longitude>59.95131</longitude> <uid>40606d00-9c51-11eb-b2c9-cfd6c1111392</uid>* '''auth''' — Атрибут '''extra''' — обязателен, по нему определяется курьерская служба <* '''json''' — Признак вывода ответа в виде JSON YES/pvz>NO <pvz>* '''client_code''' — Код клиента курьерской службы <code>245</code> <clientcode>NTG1</clientcode>'''Пример ответа:''' <name>На Красноармейской</name> <parentcode>6</parentcodesource lang="xml"> <parentname>Интеграция</parentname> <town code?xml version="1242671.0" regioncodeencoding="66UTF-8" regionname?><storelist count="Свердловская область2">Нижний Тагил город</town> <address>КРАСНОАРМЕЙСКАЯ, д.79</addressstore> <phonecode>+7(3435)379-044123</phonecode> <commentname>Возможность примерки отсутствуетABC</commentname> <worktime>Вс 10:00-16:00, Сб 10:00-16:00, Пн-Пт 10:00-20:00 </worktimestore> <traveldescription>Напротив ТЦ Пирамида</traveldescriptionstore> <maxweightcode>20456</maxweightcode> <acceptcashname>YESФилиал 2</acceptcash> <acceptcard>YES</acceptcard> <acceptfitting>NO</acceptfitting> <acceptindividuals>YES</acceptindividuals> <latitude>57.93468</latitude> <longitude>60.55476</longitude> <uid>41116853-9c51-11eb-b2c9-cfd6c1451392</uidname> </pvzstore></pvzliststorelist>
</source>
*'''code''' -  — Код ПВЗ в системе. Используется в запросе [[API#Оформление заказа|оформления заказов]]*'''clientcode''' - Код ПВЗ используемый компанией-подрядчикомфилиала.*'''name''' -  — Наименование ПВЗфилиала.*'''parentcode''' - Код родительского элемента.*'''parentname''' - Наименование родительского элемента.== Справочник пунктов самовывоза ==*Для отображения списка пунктов выдачи (ПВЗ) есть '''townготовый JavaScript модуль''' - Населенный пункт с кодом из [[#Справочник городов|справочника городов]], а также с кодом и наименованием региона: https://home.*'''address''' - Адрес ПВЗcourierexe.*'''phone''' - Телефоны ПВЗru/js/measoft_map.*'''comment''' - Дополнительная информацияjs Инструкция по использованию — внутри.*'''worktime''' - Режим Посмотреть пример работы ПВЗможно [https://home.courierexe.ru/pvz_test.html Здесь]*'''traveldescription''' - Описание местонахождения Уникальные запросы списка ПВЗ или пути к немукешируются на стороне личного кабинета и хранятся до 7 часов утра по московскому времени следующего дня.*'''maxweight''' - Максимальный весНапример, если уникальный запрос с которым работает ПВЗмассой 2 кг был отправлен сегодня в 10 часов, то завтра в 7 утра он сбросится.*'''acceptcash''' - Признак приема наличных*'''acceptcard''' - Признак приема банковских карт*'''acceptfitting''' - Наличие примерки*'''latitude''' - Широта*'''longitude''' - Долгота*'''uid''' - Уникальный идентификатор ПВЗ Если сегодня в 18 часов в системе Measoft*'''count''' - Количество записей этом же запросе вы укажете массу 2 кг, в ответе*'''totalcount''' - Общее количество записейвернется тот же список ПВЗ. Если передадите массу 3 кг, отвечающее параметрам запросасписок может быть другим.
== Получение фискальных данных заказа ==Обратите внимание, что если в выборке количество ПВЗ больше '''10000''' и не указаны параметры '''code''', '''json''' или '''limitcount''', то будет возвращаться ошибка. В этом случае необходимо использовать блок '''limit'''.
'''Пример запроса получения фискальных данныхпунктов самовывоза:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?><receiptdatapvzlist> <auth extra="8" login="testlogin" pass="testmpass" ></auth> <code>1234</code> <client_code>7890</client_code> <orderscity>Свердловская область</city> <order ordernotown regioncode="12345666" 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> <order orderno="890111C" /limit> </orderspvzlist></receiptdatasource>
* '''auth''' — Атрибут '''extra''' — обязателен, по нему определяется курьерская служба, '''login''' и '''pass''' позволяют авторизоваться под клиентом: для отдельного клиента могут быть ограничения по доступности некоторых ПВЗ, и в этом случае они будут учтены.
* '''code''' — Внутренний код.
* '''client_code''' — Код клиента курьерской службы.
* '''city''' — Регион получателя. Можно указать код региона или полное наименование региона из [[#Справочник регионов|справочника регионов]].
* '''town''' — Город получателя.
Для тега города '''town''' можно указать код региона в атрибуте '''''regioncode''''' из [[#Справочник регионов|справочника регионов]]. Поиск будет производиться в указанном регионе.
<Также можно указать страну получателя в атрибуте '''''country''''' в соответствии с [https:/source>/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.<source lang="xml">:* '''countall''' — YES указывает на необходимость подсчета общего количества найденных совпадений. Это может замедлять выполнение запроса. Если отключено — в ответе не указываeтся totalcount.
'''Пример ответа справочника пунктов самовывоза:'''<source lang="xml"><?xml version="1.0" encoding="UTF-8"?><receipts pvzlist count="12" 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<receipt/phone> <ordernocomment>123456Новый пункт доставки</ordernocomment> <fdDatetimeworktime>2020Вс 10:00-0616:00, Сб 10:00-07 1216:1400, Пн-Пт 10:00-20:00</fdDatetimeworktime> <fdValuetraveldescription>123Жилое 5-ти этажное здание, торцом к дороге, второе здание от перекрестка Пархоменко-Циолковского</fdValuetraveldescription> <fdNummaxweight>45610</fdNummaxweight> <fnSnacceptcash>789YES</fnSnacceptcash> <kktNumacceptcard>100YES</kktNumacceptcard> <innacceptfitting>222YES</innacceptfitting> <ofdUrlacceptindividuals>gateYES</acceptindividuals> <latitude>57.ofd93457</latitude> <longitude>59.ru95131</ofdUrllongitude> <fullUrluid>https:40606d00-9c51-11eb-b2c9-cfd6c1111392</uid> </pvz> <pvz> <code>245</code> <clientcode>NTG1</check.ofd.ruclientcode> <name>На Красноармейской</123name> <parentcode>6</fullUrlparentcode> <priceparentname>12345Интеграция</priceparentname> <lines counttown code="124267" regioncode="66" regionname="1Свердловская область">Нижний Тагил город</town> <address>КРАСНОАРМЕЙСКАЯ, д.79<line/address> <itemphone>1111764+7(3435)379-044</itemphone> <namecomment>СапогиВозможность примерки отсутствует</namecomment> <qtyworktime>1Вс 10:00-16:00, Сб 10:00-16:00, Пн-Пт 10:00-20:00</qtyworktime> <pricetraveldescription>1000Напротив ТЦ Пирамида</pricetraveldescription> <vatRatemaxweight>20</vatRatemaxweight> <acceptcash>YES</acceptcash> <governmentCodeacceptcard>Z16513LK2YES</governmentCodeacceptcard> <itemTypeacceptfitting>1NO</acceptfitting> <acceptindividuals>YES</acceptindividuals> <latitude>57.93468</itemTypelatitude> <longitude>60.55476</linelongitude> <uid>41116853-9c51-11eb-b2c9-cfd6c1451392</linesuid> </receiptpvz></receiptspvzlist>
</source>
Параметры ответа:* '''code''' — Код ПВЗ в системе. Используется в запросе [[API#Оформление заказа|оформления заказов]]*'''ordernoclientcode'''  — Код ПВЗ используемый компанией- Номер заказаподрядчиком.* '''name''' — Наименование ПВЗ.*'''fdDatetimeparentcode''' - Дата и время пробития фискального чека — Код родительского элемента.*'''fdValueparentname''' - ФПД (фискальный признак документа) — Наименование родительского элемента.*'''fdNumtown''' - ФИСКАЛЬНЫЙ ДОКУМЕНТ (фискальный номер чека) — Населенный пункт с кодом из [[#Справочник городов|справочника городов]], а также с кодом и наименованием региона.*'''fnSnaddress''' - ФН (номер фискального накопителя) — Адрес ПВЗ.*'''kktNumphone''' - РН (регистрационный номер кассы) — Телефоны ПВЗ.*'''inncomment''' - ИНН — Дополнительная информация.*'''ofdUrlworktime''' - URL адрес (доменное имя) ОФД — Режим работы ПВЗ.*'''pricetraveldescription''' - Сумма чека — Описание местонахождения ПВЗ или пути к нему.*'''fullUrlmaxweight''' - URL чека для просмотра онлайн — Максимальный вес, с которым работает ПВЗ.*'''linesacceptcash''' - Позиции чека — Признак приема наличных:*'''itemacceptcard''' - код товара — Признак приема банковских карт:*'''nameacceptfitting''' - наименование товара — Наличие примерки:*'''qtylatitude''' - количество товара — Широта:*'''pricelongitude''' - цена товара — Долгота:*'''governmentCodeuid''' - считанная последовательность, которая  — Уникальный идентификатор ПВЗ в дальнейшем преобразуется по алгоритму тега 1162системе Measoft:*'''vatRatecount''' - НДС товара — Количество записей в ответе:*'''itemTypetotalcount''' - тип товара (товар — Общее количество записей, доставка и т.д.)отвечающее параметрам запроса
== Справочник Видов срочности Получение фискальных данных заказа == '''Пример запроса Видов срочностиполучения фискальных данных:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8" ?><servicesreceiptdata> <auth extra="8" login="login" pass="pass"/> <orders> <order orderno="123456" /services> <order orderno="890111C" /> </orders></receiptdata>  
</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"?>
<advpricesreceipts count="1"> <auth extrareceipt> <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="8" login="login" pass="pass1" > <line> <item>1111764</item> <name>Сапоги</name> <qty>1</qty> <price>1000</price> <vatRate>20</vatRate> <governmentCode>Z16513LK2</governmentCode> <itemType>1</itemType> </line> <visible/lines>NO </visiblereceipt></advpricesreceipts>
</source>
Параметры ответа:* '''advpricesorderno''' - Корневой контейнер. Обязательный элемент.  — Номер заказа* '''fdDatetime''' — Дата и время пробития фискального чека* '''fdValue''' — ФПД (фискальный признак документа)* '''fdNum''' — ФИСКАЛЬНЫЙ ДОКУМЕНТ (фискальный номер чека)* '''fnSn''' — ФН (номер фискального накопителя)* '''kktNum''' — РН (регистрационный номер кассы)* '''inn''' — ИНН* '''ofdUrl''' — URL адрес (доменное имя) ОФД* '''price''' — Сумма чека* '''fullUrl''' — URL чека для просмотра онлайн* '''lines''' — Позиции чека:* '''item''' — код товара:* '''name''' — наименование товара:* '''qty''' — количество товара:*'''visibleprice''' - Признак возврата  — цена товара:* '''толькоgovernmentCode''' тех услуг — считанная последовательность, что доступны для отображения которая в ЛК YES/NOдальнейшем преобразуется по алгоритму тега 1162:* '''vatRate''' — НДС товара:* '''itemType''' — тип товара (товар, доставка и т. Необязательный элемент д. По-умолчанию NO)
== Справочник Виды срочности =='''Пример ответа справочника дополнительных услугзапроса видов срочности:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8" ?>
<advpricesservices> <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> <auth extra="8"/advprice></advpricesservices>
</source>
Параметры:*'''code''' - внутренний код услуги*'''name''' - наименование услуги. Если поле "название в ЛК" в настройках услуги не пусто, то возвращает значение поля "название в ЛК".*'''hine''' - подсказка по доп услуге для пользователя*'''type''' - тип услуги. Может иметь значения::*'''bool''' - для услуг вида "чекбокс", "Да":*'''float''' - для числа с плавающей точкой:*'''int''' - для целого числа == Расчет стоимости доставки == '''Пример запроса стоимости доставкиответа справочника видов срочности:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8" ?>
<calculator> <auth extraservices count="82" login="login" pass="pass" /> <calc service> pricetype="CUSTOMER" <code>1</code> townfrom="Москва" <name>Эконом</name> addressfrom="Ленинский проспект, 95" </service> zipcode="664000" townto="3800000300000" addressto="Ленина ул., 10" pvz="123" l="10" w="20" h="30" mass="3.7" <service="1"> price="1200" <code>2</code> inshprice="1200" <name>Срочно</name> paytype="CASH" </service></calculatorservices>
</source>
Параметры:== Справочник дополнительных услуг ==*'''pricetypeПример запроса дополнительных услуг:''' - тип требуемой цены<source lang="xml"><?xml version="1. Возможные значения: 0"CUSTOMERencoding=" (поUTF-умолчанию) - [[Личный кабинет клиента#Цена доставки для получателя|цена для конечного получателя]], 8"CLIENT" - цена курьерской службы для клиента.?>*'''townfrom''' - Город отправления<advprices>*'''addressfrom''' - Адрес отправления <auth extra="8" login="login" pass="pass" />*'''zipcode''' - Почтовый индекс города назначения*'''townto''' - Город назначения*'''addressto''' - Адрес назначения</advprices>*'''pvz''' - Код пункта самовывоза по [[#Справочник пунктов самовывоза|справочнику]]*'''l''' - Длина в сантиметрах (не обязательный параметр)*'''w''' - Ширина в сантиметрах (не обязательный параметр)*'''h''' - Высота в сантиметрах (не обязательный параметр)*'''mass''' - Масса в килограммах*'''service''' - Режим доставки - число, указывающее на запись в справочнике [[#Справочник Видов срочности|видов срочности]]. Если этот параметр опустить, система выдаст расчет для всех доступных видов срочности, передав много контейнеров <calc/source> в ответе.*'''price''' - Сумма наложенного платежа*'''inshprice''' - Сумма объявленной ценности*'''paytype''' - Тип оплаты
Суммы НП и ОЦ, а также тип оплаты CARD имеют значение при настроенных в тарифе на вкладке Прочее долях (в процентах) от данных сумм'''advprices''' — Корневой контейнер. Обязательный элемент.
В авторизации можно опустить параметры login и pass, тогда расчет будет производиться по стандартному тарифу курьерской службы, без учета возможных отличий для конкретного клиента.<br>
Объемный вес будет учитываться только при условии указания всех габаритов: длины, ширины и высоты.<br>
В полях город-отправитель и город-получатель можно указывать название города (не рекомендуется!), либо код города из нашего справочника, либо 13-ти значный код КЛАДР, либо 36-ти значный код адресной системы ФИАС (AOID).
 '''Пример ответа стоимости доставкисправочника дополнительных услуг:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?><calculatoradvprices> <calcadvprice> <townfrom code=">1">Москва город</townfromcode> <townto code="56603"name>Иркутск городЭтажей в доме</towntoname> <masstype>3.7int</masstype> <service name="Экспресс">1 </serviceadvprice> <zone>2</zoneadvprice> <pricecode>11632</pricecode> <mindeliverydaysname>1Коэффициент надбавки</mindeliverydaysname> <maxdeliverydaystype>3float</maxdeliverydaystype> <mindeliverydate>2020-05-13 </mindeliverydateadvprice> <deliverypriceadvprice> <advprice code="1" price="1000">База3</advpricecode> <advprice code="4" price="100"name>Процент от суммы рубРасписаться на упаковке</advpricename> <advprice code="5" price="63"type>Процент от объявленной стоимостиbool</advpricetype> </deliveryprice> </calcadvprice></calculatoradvprices>
</source>
Параметры:
*'''townfrom''' - Город-отправитель так, как система его распознала и привязала к справочнику. Атрибут '''code''' -  — внутренний код из справочника городов системы.услуги*'''towntoname''' - Город-получатель так, как система его распознала и привязала к справочнику — наименование услуги. Атрибут '''code''' - код из справочника городов системы.*'''mass''' - Масса Если поле «название в ЛК» в килограммах*'''service''' - Режим доставки - числонастройках услуги не пусто, указывающее на запись то возвращает значение поля «название в справочнике видов срочности (см описание на этой странице)ЛК».*'''zonehine''' - номер тарифной зоны,  — подсказка по которой рассчиталась стоимость. В зависимости от зоны выбирается тарифная сетка. Так же к цене могут применяться повышающие или понижающие коэффициенты при доставке не из/в региональный центр.доп услуге для пользователя*'''pricetype''' - рассчитанная стоимость доставки в валюте прайс-листа курьерской службы. Рекомендуется к использованию в отличие от одноименного атрибута родительского контейнера — тип услуги.Может иметь значения::*'''maxdeliverydaysbool''' - максимальный срок доставки в рабочих днях. — для услуг вида «чекбокс», «Да»:*'''mindeliverydatefloat''' - минимальная дата доставки в учетом выходных дней.  — для числа с плавающей точкой:*'''deliverypriceint''' - Данные по составляющим ценам доставки — для целого числа
   '''''Обратите внимание:''''' В реальном ответе сервера в теге calc присутствует атрибут "price". Он оставлен для обратной совместимости, не используйте его. Пользуйтесь вложенным тегом price. == Получение информации о клиенте Расчет стоимости доставки == '''Пример запроса получения информации о клиентестоимости доставки:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8" ?>
<clientcalculator> <auth extra="8" login="testlogin" pass="testmpass" /> <order> <pricetype>CUSTOMER</pricetype> <sender> <town>Санкт-Петербург</town> <address>Петровка 38 офис 35</clientaddress> <coords lat="55.680327" lon="37.604456"></sourcecoords> </sender>'''client''' <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>*'''auth''' - Авторизация <weight>5. Обязательный элемент1</weight> <service>2</service> <paytype>CASH</paytype> <price>387.5</price> <deliveryprice>150</deliveryprice>'''Пример ответа на запрос получения информации о клиенте:''' <inshprice>387.5</inshprice> <source langpackages> <package mass="1" quantity="xml5"></package> <?xml versionpackage mass="12.05" encodinglength="UTF-810" width="20" height="30" ?></package> <client/packages> <userid>user123</userid> <groupid>customer<code/groupid>1082 </codeorder></clientcalculator>
</source>
*'''code''' - Код клиента
== Список актов передачи денег ==Параметры:Структура данных и заполнение полей аналогичны и совместимы с [[#Оформление заказа]].
Дополнительные поля:* '''Пример запроса списка актов передачи денег:pricetype'''<source lang="xml"><?xml version="1 — тип требуемой цены.0" encoding="UTFВозможные значения: «CUSTOMER» (по-8" ?>умолчанию) — [[Личный кабинет клиента#Цена доставки для получателя|цена для конечного получателя]], «CLIENT» — цена курьерской службы для клиента.<smalist> <auth extra="8" login="login" pass="pass" * '''userid''' — Идентификатор пользователя, строковый или числовой тип. Виртуальное поле. Необязательное. Данное поле используется совместно с настройками «Цена доставки для получателя», определяя приоритет правила. Можно использовать в различных CMS/>CRM системах, настраивая цены для определенного покупателя. <datefrom>2016-02-10<* '''groupid''' — Идентификатор группы пользователя, строковый или числовой тип. Виртуальное поле. Необязательное. Данное поле используется совместно с настройками «Цена доставки для получателя», определяя приоритет правила. Можно использовать в различных CMS/datefrom> <dateto>2016-03-10</dateto></smalist></source>CRM системах, настраивая цены для определенной группы покупателей.
'''smalist''' - Корневой контейнер. Обязательный элемент.*'''auth''' - Авторизация. Обязательный элемент.*'''datefrom''' - Дата "с". Необязательный элемент.*'''dateto''' - Дата "по". Необязательный элемент.Если интервал дат не указанСуммы НП и ОЦ, то возвращаются акты передачи денег за последний месяца также тип оплаты CARD имеют значение при настроенных в тарифе на вкладке Прочее долях (в процентах) от данных сумм.
'''Пример ответа на запрос списка актов передачи денег:'''В авторизации можно опустить параметры login и pass, тогда расчет будет производиться по стандартному тарифу курьерской службы, без учета возможных отличий для конкретного клиента.<source lang="xml"br><?xml version="1Объемный вес будет учитываться только при условии указания всех габаритов: длины, ширины и высоты.0" encoding="UTF-8"?><smalist count="1"> <smabr> <code>6278</code> <number>3992</number> <actdate>2016В полях город-02отправитель и город-12</actdate> <datepay></datepay> <dateto>2016получатель можно указывать название города (не рекомендуется!), либо код города из нашего справочника, либо 13-02ти значный код КЛАДР, либо 36-12</dateto> <promiseddatepay></promiseddatepay> <price>637.00</price> <pricecorr>113ти значный код адресной системы ФИАС (AOID).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" ?><smadetailcalculator> <auth extracalc> <townfrom code="81" login>Москва город</townfrom> <townto code="login56603" pass>Иркутск город</townto> <mass>3.7</mass> <service name="passЭкспресс" >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">6278Процент от объявленной стоимости</advprice> <advprice code="6" price="-50">Скидка при доставке</advprice> </deliveryprice> </calc></smadetailcalculator>
</source>
Параметры:* '''smadetailtownfrom'''  — Город- Корневой контейнеротправитель так, как система его распознала и привязала к справочнику. Обязательный элементАтрибут '''code''' — код из справочника городов системы.*'''authtownto'''  — Город- Авторизацияполучатель так, как система его распознала и привязала к справочнику. Обязательный элементАтрибут '''code''' — код из справочника городов системы.*'''codemass''' — Масса в килограммах* '''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>
*'''code''' - Код записи.
*'''ordercode''' - Код заказа.
*'''orderno''' - Шифр заказа.
*'''orderdate''' - Дата заказа.
*'''delivereddate''' - Дата доставки.
*'''company''' - Получатель.
*'''price''' - Стоимость услуг.
*'''rur''' - Сумма заказа.
*'''inshprice''' - Стоимость заказа.
*'''pricekur''' - Стоимость курьерской доставки.
*'''priceag''' - Агентское вознаграждение.
*'''pricecalc''' - Сумма для передачи агенту.
*'''paytype''' - Тип оплаты: 1 - безнал, 2 - наличными курьером, 3 - наличными в офисе, 4 - перевод на карту.
*'''paytypename''' - Строковое представление типа оплаты
*'''weight''' - Вес заказа.
*'''distance''' - Дистанция по заказу
*'''status''' - Статус заказа.
== Генерация коротких ссылок Размещение страниц на своем сайте (iframe) ==
В некоторых случаях, например, при использовании в СМС, может потребоваться использование коротких ссылок имеет смысл разметить те или иные страницы на ЛК.Для этого, необходимо отправить запрос с полной ссылкой, в ответ на который придёт хэш-код для ссылкисвоем сайте.
Например, чтобы клиенты могли рассчитать стоимость доставки не переходя по внешней ссылке, а там же, на сайте, калькулятор можно разместить прямо на странице такого сайта посредством так называемого фрейма — '''Пример запроса генерации коротких ссылок:iframe'''<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''' - Корневой [https://ya.ru/search/?text=iframe Фрейм] — контейнер. Обязательный элемент.*'''link''' - Полная ссылка, для которой необходимо получить код. Обязательный элемент. Если атрибут '''short''' равен 1, то ответ не будет содержать XMLвнутри обычной страницы, а только хэш-кодкоторый позволяет загружать сторонние страницы.Пример загрузки калькулятора:
'''Пример ответа на запрос генерации коротких ссылок:'''<source lang="xmlhtml"><?xml versioniframe id="1.0frame" encodingsrc="UTF-https://home.courierexe.ru/8/calculator"?><shortlink> <hash>35AF350C</hash> Здесь должен отобразиться калькулятор</shortlinkiframe>
</source>
*Для удобства пользователей вашего сайта можно указать язык интерфейса (который переключается непосредственно на сайте) параметром '''hashlang''' - Хэш-код ссылки. Далее, можно использовать ссылку на ЛК: <nowiki>https://home.courierexe.ru/35AF350C или curie.ru/35AF350C</nowiki> 
'''Примечание!''' Сервис коротких ссылок работает только для ресурсов компании MeaSoft. == Проверка надежности покупателя == Проверка надежности работает только для тарифа "Максимум" личного кабинета. <source lang="xmlhtml"><?xml versioniframe id="1.0frame" encodingsrc="UTF-https://home.courierexe.ru/8" /calculator?><mcheck> <auth extralang=2"8" login="login" pass="pass" /> <phones> <phone>89161147992</phone> </phones>Здесь должен отобразиться калькулятор</mcheckiframe>
</source>
Ответ:Обратите внимание! Если язык не указать, то на страницах калькулятора и трекинга отображается свой переключатель языка. Если язык указан, то переключатель не отоборажается.
<source lang="xml">Поддерживаемые языки и их коды:<?xml version=":'''1.0" encoding="UTF-8" ?>''' — русский<mcheck>:'''2''' — английский <phones> <phone rate="90">89161147992</phone> </phones></mcheck></source>:'''4''' — узбекский
Источник — «https://wiki.courierexe.ru/index.php/Служебная:Сравнение_версий/12375...14988»

Навигация