Изменения

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

API

45 611 байт добавлено, 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 курьерскими службами. '''Ответственность за корректность передачи данных лежит на интернет-магазине.'''Модули сторонних разработчиков обслуживаются и СКЬ-системами можно скачать модули интеграции:разрабатываются сторонними компаниями. Все вопросы по их приобретению и поддержке необходимо задавать им. Сообщайте нам свои пожелания по работе наших модулей. Мы учтем их в новых версиях.
{| class="wikitable" align="center" style="width: 80%; margin: auto; background-color:#ffffff; border: 1px solid #999999;" cellpadding="10" cellspacing="0"
|-
|[[Файл:bitrix.png|center|x44px]]
|style="text-align: center;"|[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 для выполнения отладки, а также видеть историю отправленных запросов. На закладке "Созданные заказы появятся в пункте основного меню '''Отслеживание" Вы увидите созданные заказы'''.
Для упрощения интеграции можно скачать [httphttps://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== Авторизация курьерской службы ==Если курьерской службе требуется подключение под своими учетным данными, указывается в карточке клиента на вкладке '''используйте строку вида: <source lang=xml><auth extra="Прочее8"''' в поле '''login="Имя пользователяlogin"'''. Возможно, что в программе КС2008 понадобится создать новую карточку клиента (на скриншоте ниже).pass="pass" clientcode="123"></auth></source>
3. Описание:* '''Парольextra''' - параметр учетной записи для ЛК клиента и API, указывается в карточке клиента на вкладке  — уникальный идентификатор компании;* '''login''' — логин курьерской службы;* '''"Прочее"pass''' в поле  — пароль курьерской службы;* '''"Пароль"clientcode'''  — внутренний код клиента (на скриншоте нижевкладка '''Клиенты''', столбец «Внутренний код»).
Вы можете узнать код экстра, логин и пароль курьерской службы в офисном приложении MeaSoft в справочнике '''Дополнительные возможности'''. Подробнее см. раздел «[[Файл:33_client.pngЛичный кабинет курьерской службы#Подключение|500pxПодключение]]».
== Общие понятия ==
На стороне курьерской службы имеется веб-сервис по адресу: https://home.courierexe.ru/api/. <rspoiler text="Еще есть порт 8443.">Некоторые маршрутизаторы, используемые провайдерами, РНК и прочее, в попытке глубокого анализа могут повреждать трафик на стандартный порт 443. Сделано по тикету 10964.</rspoiler> Обратите внимание на символ '''«/»''' (slash) в конце адреса. Тестовые авторизационные данные: логин: 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>
<return_service>1</return_service>
<type>3</type>
<return>NO</return>
<return_service>1</return_service>
<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>
=== Описание элементов для оформления заказа ===
'''Обязательные поля'''
 
Обязательными на уровне системы являются только 3 поля: receiver->company или receiver->person, receiver->address и receiver->phone. Так же в настройках системы сама курьерская служба может назначить какие-то дополнительные поля обязательными, тогда, если вы их не укажете, получите сообщение об ошибке.
<spoiler text="Пример минимально возможного заказа">
<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<neworder>
<auth extra="8" login="login" pass="pass" />
<order>
<receiver>
<company>МВД</company>
<phone>(495)123-45-67</phone>
<address>Петровка, 38</address>
</receiver>
</order>
</neworder>
</source>
</spoiler>
 
'''Описание полей'''
 
* '''neworder''' — Корневой контейнер, обязательный элемент.
 
:* '''''newfolder''''' — Признак нового заказа YES/NO. Если стоит YES, то в системе курьерской службы для данной корреспонденции создастся новый заказ. Необязательный элемент.
 
* '''order''' — Контейнер для описания одного заказа, обязательный элемент. В одном контейнере '''neworder''' может быть много контейнеров '''order''' для создания нескольких заказов одним запросом.
 
:* '''''orderno''''' — Номер заказа. Если присваивается клиентом — указывается здесь. Если не присваивается — можно оставить пустым, система сгенерирует свой номер, и вернет его в ответе. Система проверяет наличие заказов с указанным номером в пределах текущего календарного года, и в случае их существования — заказ создан не будет, а в ответе вернется ошибка 17 «Such number exists». Если не указан штрихкод (поле barcode), и значение поля подходит для использования его в качестве штрихкода, данное значение будет скопировано в поле «Штрихкод». Это накладывает ограничения в частности, на длину указанного поля (25 знаков, чтобы работали стандартные печатные формы).
 
* '''barcode''' — Штрихкод заказа. Если клиент штрихкодирует свои отправления и штрихкод отличается от номера заказа, в этом поле указывается штрихкод. Если ШК содержит кириллицу или малое количество символов, то формируется ШК в формате EAN13.
*'''neworder''' <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''' - Универсальный идентификатор заказа на стороне отправителя. Не обязательный параметр, ограниченного по времени действия. Время хранения в системе, - сутки.
*'''zipcodeitems''' - Почтовый индекс — Контейнер для описания вложений. <rspoiler text="Необязательный контейнер">Если для поставщика товара в системе MeaSoft не указаны полное наименование компании и ИНН в карточке клиента, заполните параметры <code>suppcompany</code> и <code>suppINN</code> в этом контейнере. Отсутствие информации о поставщике приведет к [[Настройка модуля печати кассовых чеков#Ошибка фискализации (ошибка программирования реквизита 1226)|ошибке фискализации]].</rspoiler>.Атрибуты::*'''weight''item' - Общий вес заказа в килограммах'''' — Название вложения.:*'''return_weight''quantity''' - Общий вес возврата заказа в килограммах'' — Количество единиц товара.:*'''quantity''mass''''' - Количество мест — Масса единицы товара в килограммах.:*'''service''volume''''' - Режим доставки (тип услуги) передается код из справочника [[#Справочник Видов срочности|"Виды срочности"]] — Объемный вес единицы товара в килограммах.При указании объемного веса значение подставляется вместо массы:*'''return_service''length' - Режим возврата '''' — Длина единицы товара (тип услугив сантиметрах) передается код из справочника "Виды срочности".:*'''type''width''''' - Тип корреспонденции  — Ширина единицы товара (отправленияв сантиметрах) передается код из справочника "Типы корреспонденции".:*'''return_type''height' - Тип возвратной корреспонденции '''' — Высота единицы товара (отправленияв сантиметрах) передается код из справочника "Типы корреспонденции".:*'''price''retprice' - Сумма заказа'''' — Цена единицы товара. Округляется до копеек. Должна быть с учетом всех скидок и наценок. В случае наличия контейнера items значение данного параметра будет проигнорированоДля вложений типов 1, 2, и рассчитано автоматически3 не может быть отрицательной.<!-- , либо мы сами посчитаем скидку при указании тега order->discount -->:*'''deliveryprice''inshprice''''' - Сумма доставки — Объявленная ценность единицы товара. Округляется до копеек. В случае наличия контейнера items, в него будет добавлено вложение "Доставка"Если не указана принимается равной '''''retprice'''''.:* '''''VATrate''''' -  — Ставка НДС - НДС — целое число процентов.*Если товар хранится в КС (смотрите '''returnarticle''' ниже), значение берется из номенклатуры. Иначе, если значение указано, берется указанное значение, если нет - Признак необходимости возвратазначение из настроек фирмы КС. Значение «0» означает ставку «Без НДС», ставка «0%» на данный момент не поддерживается.:*'''return_service''barcode' - Режим возврата (тип услуги) передается код из справочника "Виды срочности"'''' — Штрихкод вложения.:*'''discount''article''''' - Сумма скидки — Артикул вложения. Скидка "размазывается" по товарным вложениям''Внимание!'' Указание артикула используется только тогда, сумма НП уменьшается когда товар хранится на сумму скидкиответственном хранении в службе доставки, и необходима комплектация. При В этом вложение Скидка случае система пытается привязать товар к [[API#Справочник номенклатуры|справочнику номенклатуры]]. Если товар в справочнике не создаетсянайден — система выдаст соответствующую ошибку. ВНИМАНИЕЕсли по артикулу найдено несколько товаров — система выберет один из них случайным образом, при использовании этого тега общая сумма что может расходиться привести к ошибочной комплектации! Если товар НЕ на копейки из-за округления! Старайтесь не использовать этот тег, а ответственном хранении — артикул указывать цену товаров уже с учетом скидокНЕ нужно. Позиция попадет в систему просто текстом.:*'''enclosure''itemcode''''' — Внутренний код товара, может использоваться вместо артикула. ''Внимание!'' - ВложениеУказание кода товара используется только тогда, когда товар хранится на ответственном хранении в службе доставки, и необходима комплектация. В этом случае система пытается привязать товар к [[API#Справочник номенклатуры|справочнику номенклатуры]]. Если товар в справочнике не найден — система выдаст соответствующую ошибку. Если товар НЕ на ответственном хранении — код товара указывать НЕ нужно.:*'''inshprice''type'''''  — Тип вложения. Принимает значения::: 1 — Товар. По- Объявленная ценностьумолчанию.:: 2 — Доставка. Такое вложение добавится автоматически, если заполнить order->deliveryprice:: 3 — Услуга:: 4 — Предоплата. Указывается сумма. Поле quantity игнорируется, всегда «1». Если явно не указана В заказе сумма будет отрицательной независимо от знака в запросе. Такое вложение добавится автоматически при указании order- автоматически считается как >paytype=NO.:: 6 — Оплата кредитом. Указывается сумма. Поле quantity игнорируется, всегда «1». В заказе сумма по товарамбудет отрицательной независимо от знака в запросе.:: 7 — Забор товара. Если товар нужно у получателя забрать, возможно — вернуть деньги, или его стоимость вычтется из суммы других товаров. У такого товара в заказе будет отрицательное количество независимо от знака в запросе.:* '''''extcode''''' — Внешний код строки. Используется для идентификации строк заказов при получении статусов. Необязательное поле.:*'''instruction''origincountry' '''' — Код страны-производителя в соответствии со [https://ru.wikipedia.org/wiki/ISO_3166- Поручение 1 стандартом ISO_3166- Примечание1], например, «RU», «RUS» или «643» для России.:*'''courier''GTD''' - Запланированный курьер'' — Номер ГТД.:* '''''excise''''' — Сумма акциза. Согласно коду курьера в КС2008:* '''''suppcompany''''' — Наименование компании поставщика, если отличается от заказчика.:*'''receiverpays''suppphone' - Признак оплаты стоимости доставки - услуг службы доставки получателем'''' — Номер телефона компании поставщика, а не заказчиком YES/NOесли отличается от заказчика.:*'''department''suppINN'''' - Подразделение' — ИНН компании поставщика, в котором оформляется заказесли отличается от заказчика.:*'''pickup''governmentCode''''' — Код товарной номенклатуры. Используется для [[Маркировка|маркированных товаров, например («Честный знак»)]]. Для кода '''Честный знак''' Нужно указывать все данные из нанесенного QR- Признак оформления забора YES/NOкода кроме не читаемых символов (#29). Если стоит YESкод не известен — укажите знак вопроса «?», то весь заказ тогда курьер отсканирует код фактически передаваемого покупателю товара. Для некоторых процессов может использоваться значение «!» — в этом случае курьер сканирует серийный номер товара, но это не считается заданием на забор грузакодом маркировки. При этом, а не на доставкуесли указано значение «?» или «! Применяется для вызова курьера к отправителю для забора других отправлений» и quantity больше 1, то такое вложение растиражируется quantity раз.:*'''acceptpartially''govType' '''' — Тип маркировки товара. В данный момент существуют следующие типы маркировки::: 1 — Честный знак. По- Признак возможности частичного выкупа товаров отправления YES/NOумолчанию.:: 2 — ГИИС ДМДК.:: 3 — Серийный номер.
*'''items''' - Контейнер для описания вложений. <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'''extraTags'' - Внутренний код товара, может использоваться вместо артикула. ''Внимание!'' Указание кода товара используется только тогда, когда товар хранится на ответственном хранении  — Строка в службе доставки, и необходима комплектация. В этом случае система пытается привязать товар к [[API#Справочник номенклатуры|справочнику номенклатуры]]. Если товар в справочнике не найден - система выдаст соответствующую ошибку. Если товар НЕ на ответственном хранении - код товара указывать НЕ нужно.:* '''''type''''' - Тип вложения. Принимает значения::: 1 - Товар. По-умолчанию.:: 2 - Доставка. Такое вложение добавится автоматически, если заполнить order->deliveryprice:: 3 - Услуга:: 4 - Предоплата. Указывается сумма. Поле quantity игнорируется, всегда "1". В заказе сумма будет отрицательной независимо от знака в запросе. Такое вложение добавится автоматически при указании order->paytype=NO.:: 6 - Оплата кредитом. Указывается сумма. Поле quantity игнорируется, всегда "1". В заказе сумма будет отрицательной независимо от знака в запросе.:: 7 - Забор товара. Если товар нужно у получателя забрать, возможно - вернуть деньги, или его стоимость вычтется из суммы других товаров. У такого товара в заказе будет отрицательное количество независимо от знака в запросе.:* '''''extcode''''' - Внешний код строки. Используется для идентификации строк заказов при получении статусов. Необязательное поле.:* '''''origincountry''''' - Код страны-производителя в соответствии со [https://ru.wikipedia.org/wiki/ISO_3166-1 стандартом ISO_3166-1], например, "RU", "RUS" или "643" для России.:* '''''GTD''''' - Номер ГТД.:* '''''excise''''' - Сумма акциза.:* '''''suppcompany''''' - Наименование компании поставщика, если отличается от заказчика.:* '''''suppphone''''' - Номер телефона компании поставщика, если отличается от заказчика.:* '''''suppINN''''' - ИНН компании поставщика, если отличается от заказчика.:* '''''governmentCode''''' - Код товарной номенклатуры. Используется формате JSON для [[Маркировка | маркированных товаров ("Честный знак")]]. Нужно указывать все данные из нанесенного QR-кода кроме не читаемых символов (#29). Если код не известен - укажите знак вопроса "?", тогда курьер отсканирует код фактически передаваемого покупателю товара. Для некоторых процессов может использоваться значение "!" - отправки в этом случае курьер сканирует серийный номер товара, но это не считается кодом маркировки. Если поле заполнено - поле quantity должно содержать только "1", иначе вернется ошибкаОФД.
*'''packages''' - Контейнер для описания мест. Необязательный контейнер. Атрибуты::* '''''package''''' - Название места.:* '''''code''''' - Внутренний код строки.:* '''''strbarcode''''' - ШтрихТэг 1265 -значение отраслевого реквизита = код места.:* '''''mass''''' - Масса места в килограммах.:* '''''message''''' - Строка сообщения.:* '''''length''''' - Длина единицы товара (в сантиметрах).:* '''''width''''' - Ширина единицы товара (в сантиметрах).:* '''''height''''' - Высота единицы товара (в сантиметрах).деятельности аптеки
* '''deliveryset''' - настройка [[Дифференциальная стоимость доставки | дифференциальной стоимости доставки]]. Атрибуты::* '''''above_price''''' - стоимость в случае полного выкупа заказа (действует как Тэг 1262 – идентификатор ФОИВ = "сумма от020" последней границы, указанной в теге below_sum(константа ФОИВ МИНЗДРАВа):* '''''return_price''''' - стоимость в случае возврата заказа:* '''''VATrate''''' - Ставка НДС - целое число процентов.
* '''below''' - граница стоимости настроек:* '''''below_sum''''' - граница стоимости выкупаемого заказа:* '''''price''''' Тэг 1263 - стоимость выкупаемого заказа до соответствующей границыдата нормативного акта федерального органа исполнительной власти = "14.12.2018" (константа)
* '''advprices''' :: Тэг 1264 - Контейнер для описания дополнительных услуг. Необязательный элемент. <span styleномер нормативного акта федерального органа исполнительной власти ="color: red;>Для обработки в API требует включения в настройках полей оформления [[Личный_кабинет_курьерской_службы#Настройка вкладки "Оформить заказ"|заказов]] / [[Личный_кабинет_курьерской_службы#Настройка вкладки "Заявка на забор1556"|заборов]]</span>:* '''''code''''' - код услуги:* '''''value''''' - значение услуги. Если тип услуги bool, то в значении передаем true(константа)
*'''costcode''' :: Тэг 1212 - Кост-код сотрудника.Признак предмета расчета
*'''overall_volume''' - Общий объем, м3. Виртуальное поле. Необязательное. Из этого поля рассчитывается длина/высота/ширина места. Расчет срабатывает только если в каждом месте есть нулевые значения длины или высоты или ширины.:: Пример:
<source lang="json">
"item_industry_props":{"tag1262":"020","tag1263":"14.12.2018","tag1264":"1556","tag1265":"tm=mdlp&sid=00000000XXXXXX"},
"tag1212": "1"
</source>
<div style="color: #a94442; background-color: #f2dede; border: 1px solid #ebccd1; padding: 3px 10px 10px;">
'''Обратите внимание!'''
При передаче заказов, у которых плановая дата доставки/забора меньше ближайшей возможной, дата автоматически меняется на самую раннюю возможную. [[Личный_кабинет_курьерской_службы#Как считается минимальная дата возможной доставки|Подробнее]]</div>
* '''packages''' — Контейнер для описания мест. Необязательный контейнер. Атрибуты:
:* '''''package''''' — Название места.
:* '''''code''''' — Внутренний код строки.
:* '''''strbarcode''''' — Штрихкод места.
:* '''''mass''''' — Масса места в килограммах.
:* '''''message''''' — Строка сообщения.
:* '''''length''''' — Длина товарного места (в сантиметрах).
:* '''''width''''' — Ширина товарного места (в сантиметрах).
:* '''''height''''' — Высота товарного места (в сантиметрах).
:* '''''quantity''''' — Количество мест с данным набором параметров. Действует ограничение на общее количество мест в заказе. Общее количество мест в заказе не может быть больше 1000.
* '''deliveryset''' — настройка [[Дифференцированная стоимость доставки|дифференцированной стоимости доставки]]. Атрибуты::* '''''above_price''''' — стоимость в случае полного выкупа заказа (действует как «сумма от» последней границы, указанной в теге below_sum):* '''''return_price''''' — стоимость в случае возврата заказа:* '''''VATrate''''' — Ставка НДС — целое число процентов. * '''below''' — граница стоимости настроек:* '''''below_sum''''' — граница стоимости выкупаемого заказа:* '''''price''''' — стоимость выкупаемого заказа до соответствующей границы * '''advprices''' — Контейнер для описания дополнительных услуг. Необязательный элемент. <span style="color: red;>Для обработки в API включите дополнительные услуги в настройках полей [[Личный кабинет курьерской службы#Настройка личного кабинета клиента|заказов и заборов]]</span>:* '''''code''''' — код услуги.:* '''''value''''' — значение услуги. Если тип услуги bool, то в значении передаем true. * '''overall_volume''' — Общий объем, м3. Виртуальное поле. Необязательное. Из этого поля рассчитывается длина/высота/ширина места. Расчет срабатывает только если в каждом месте есть нулевые значения длины или высоты или ширины. * '''userid''' — Идентификатор пользователя, строковый или числовой тип. Виртуальное поле. Необязательное. Данное поле используется совместно с настройками «Цена доставки для получателя», определяя приоритет правила. Можно использовать в различных CMS/CRM системах, настраивая цены для определенного покупателя. * '''groupid''' — Идентификатор группы пользователя, строковый или числовой тип. Виртуальное поле. Необязательное. Данное поле используется совместно с настройками «Цена доставки для получателя», определяя приоритет правила. Можно использовать в различных CMS/CRM системах, настраивая цены для определенной группы покупателей. <div style="color: #a94442; background-color: #f2dede; border: 1px solid #ebccd1; padding: 3px 10px 10px;">'''Обратите внимание!'''При передаче заказов, у которых плановая дата доставки/забора меньше ближайшей возможной, дата автоматически меняется на самую раннюю возможную. [[Личный кабинет курьерской службы#Как считается минимальная дата возможной доставки|Подробнее]]</div>  В случае необходимости указания, помимо товаров, дополнительных услуг (например, ДОСТАВКА, комплектация, подъем на этаж и ти т.д д.) -  — их нужно указать в том же контейнере items как товары, без артикула.
=== Примеры ответов ===
При успешном выполнении запроса, создании заказа, возвращается сумма заказа в атрибуте orderprice, а также ошибка 0. При не успешном - успешном — номер ошибки и текст ее на английском языке в атрибуте errormsg, для некоторых ошибок выводится перевод на русский в атрибуте errormsgru.В атрибут orderno помещается номер заказа, в атрибут barcode — штрихкод заказа.
'''Пример успешного ответа'''
<?xml version="1.0" encoding="UTF-8"?>
<neworder>
<createorder orderno="AB23541" barcode="67567#114" error="0" errormsg="successSuccess" errormsgru="Успешно" orderprice="5000"></createorder> <createorder orderno="55_6542AB23542" barcode="67567#115" error="0" errormsg="successSuccess" errormsgru="Успешно" orderprice="6000"></createorder> <createorder orderno="AB23542AB23543" barcode="67567#116" error="0" errormsg="successSuccess" errormsgru="Успешно" orderprice="0"></createorder>
</neworder>
</source>
<?xml version="1.0" encoding="UTF-8"?>
<neworder>
<createorder orderno="AB23541" barcode="67567#114" error="1767" errormsg="Such number Order barcode already existsin the database." errormsgru="Такой штрихкод заказа уже есть в базе."></createorder> <createorder orderno="AB23542" barcode="67567#115" error="1317" errormsg="empty companyOrder number already exists in the database." errormsgru="Такой номер заказа уже есть в базе."></createorder> <createorder orderno="AB23543" barcode="67567#116" error="1467" errormsg="empty personOrder barcode already exists in the database." errormsgru="Такой штрихкод заказа уже есть в базе."></createorder>
</neworder>
</source>
</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> </receiver>|- <pickup>NO</pickup> <weight>5|56||Specify the «Delivery mode» field value.1</weight> <return_weight>5||Укажите значение поля «Режим доставки».1</return_weight> <quantity>2</quantity>|- <paytype>CASH</paytype>|57||Specify the «Shipment type» field value.||Укажите значение поля «Тип отправления». <service>2</service>|- <return_service>2</service>|58||Specify whether return trip is required.||Укажите значение поля «Необходимость возврата». <type>3</type>|- <return_type>3</return_type>|59||Specify the «Return trip mode» field value.||Укажите значение поля «Режим возврата» <waittime>12</waittime> <price>387|-|60||Specify the «Return shipment type» field value.||Укажите значение поля «Тип возврата».5</price> <print_check>YES</print_check>|- <inshprice>387|61||Specify barcode.||Укажите штрихкод.5</inshprice> <enclosure>Детские игрушки</enclosure>|- <instruction>Проверить при покупателе, подписать акт</instruction> <currcoords lat="55|62||Specify item weight.680327" lon="37||Укажите массу единицы товара.604456" accuracy="50" RequestDateTime="2014|-|63||Specify item quantity.||Укажите количество товара.|-04-21 18:07:45"></currcoords> <courier> <code>26</code>|64||Specify item price.||Укажите цену единицы товара.|- <|65||Specify item name>Иванов Владимир Петрович</name>.||Укажите название товара. <phone>+79161234567</phone>|- </courier>|66||Wrong XLS file||Некорректный файл XLS.|- <deliveryprice total="158|67||Order barcode already exists in the database.6" delivery="100||Такой штрихкод заказа уже есть в базе.00" return="58|-|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>
 
'''Пример ответа при ошибке синтаксиса'''
 
<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<request>
<error>column:1 line:11 message:expected '>'</error>
</request>
</source>
 
=== Описание полей ответа статусов ===
Все поля ответа соответствуют структуре order при создании заказа, с некоторыми добавлениями:
 
* Атрибуты контейнера '''order''':
:* '''''awb''''' - Номер накладной в системе курьерской службы.
:* '''''orderno2''''' - Номер накладной в подсистеме срочной доставки курьерской службы.
:* '''''ordercode''''' - внутренний код заказа в системе, применяется для некоторых внутренних операций.
:* '''''givencode''''' - внутренний код заказа в системе, применяется для некоторых внутренних операций.
 
* атрибут '''''code''''' контейнера '''item''' - внутренний код строки заказа в системе, применяется для некоторых внутренних операций.
:* '''''returns''''' - количество данного товара, от которого отказался получатель. Не нулевое только в случае частичного отказа.
 
* атрибут '''''got''''' контейнера '''package''' - признак принятого места YES / NO.
:* '''''returns''''' - количество данного товара, от которого отказался получатель. Не нулевое только в случае частичного отказа.
 
* '''''coords''''' в контейнере '''receiver''' - координаты получателя.
* '''pickup''' - признак оформления забора, возможные значения: '''YES''', '''NO'''. Если указано '''YES''', то весь заказ считается заданием на забор груза, а не на доставку.
* '''currcoords''' - текущие координаты заказа. Атрибуты:
:* '''''lat''''' - широта
:* '''''lon''''' - долгота
:* '''''accuracy''''' - точность в метрах
:* '''''RequestDateTime''''' - дата/время последнего обновления координат.
 
* '''courier''' - Данные курьера, которому выдан заказ. Если заказ не выдан, то выводятся данные запланированного курьера.
* '''waittime ''' - Время ожидания курьера.
* '''deliveryprice''' - Стоимость услуг в валюте расчетов с клиентом. Атрибуты:
:* '''''total''''' - общая стоимость услуг
:* '''''delivery''''' - стоимость доставки "Туда"
:* '''''return''''' - стоимость доставки "Обратно" (если order->return=YES)
Тэг '''deliveryprice''' включает список дополнительных услуг (только для тарифа "Премиум"):
:* '''''advprice''''' - наименование дополнительной услуги
:* '''''code''''' - код дополнительной услуги
:* '''''price''''' - стоимость дополнительной услуги
 
* '''status''' - статус доставки (список статусов см. ниже). Атрибуты (заполняются начиная с версии системы 2008.0.0.670):
:* '''''eventstore''''' - филиал, к которому относится текущий статус
:* '''''eventtime''''' - время события по часовому поясу места его наступления.
:* '''''createtimegmt''''' - время по GMT создания записи о смене статуса в БД. Используется для сортировки записей, чтобы соблюсти хронологическую последовательность. <spoiler text="Подробнее">Большинство событий фиксируются в полях eventtime и createtimegmt на основании одного действия, тогда они отличаются только сдвигом от GMT. Однако, если курьер доставил отправление 10.10.2010 в 20:00, по какой-то причине не внес это в мобильное приложение, на следующий день сдал накладную, и в 9 утра оператор внесла, что он доставил вчера в 20:00. Тогда в createtimegmt будет сегодня 6 утра (для Москвы), а в eventtime - вчера в 20:00. При этом оператор по каким-то причинам может внести время вручения раньше, чем какое-то предыдущее событие, т.о. нарушится последовательность времени в eventtime, но при сортировке по createtimegmt все-равно все будет правильно.</spoiler>
:* '''''message''''' - наименование филиала-получателя, при передаче между филиалами
:* '''''title''''' - русское наименование статуса
 
* '''statushistory''' - история статусов доставки. Содержит список контейнеров '''status'''. Заполняется только для тарифа "Премиум" начиная с версии системы 2008.0.0.670.
* '''customstatecode''' - код внутреннего статуса курьерской службы. Значения уточняйте в курьерской службе. Назначаются курьерской службой в разделе "Справочники" - "Статусы" - "15 Статусы корреспонденции". Справочник не передается через API клиенту по причине возможного наличия в нем внутренних технологических статусов курьерской службы.
* '''clientstatecode''' - код статуса клиента. Используется, если клиент предлагает свои коды статусов доставки/причин недоставки.
* '''deliveredto''' - данные о вручении, либо причина недоставки.
* '''delivereddate''' - дата вручения.
* '''deliveredtime''' - время вручения. В случае недоставки может быть пустым.
* '''arrival''' - плановая дата прибытия в формате гггг-мм-дд чч:мм:сс
* '''outstrbarcode''' - код у подрядчика (код заказа во внешней системе). Используется в интеграциях с внешними системами.
* '''return_message''' - информация о возврате
* '''department''' - Подразделение, в котором оформляется заказ.
Контейнер '''status''' может принимать следующие значения:
: ACCEPTED — Получен складом.
: AWAITING_SYNC — Ожидает синхронизации. Данные заказа пока не появились в бэкофисе.
: CANCELED — Не доставлен (Возврат/Отмена).
: COMPLETE — Доставлен.
: CONFIRM — Согласована доставка.
: COURIERCANCELED — Отказ со слов курьера.
: COURIERDELIVERED — Доставлен (предварительно).
: COURIERPARTIALLY — Частично со слов курьера.
: COURIERRETURN — Возвращено курьером. Курьер не смог доставить до получателя и вернул заказ обратно на склад. Это промежуточный статус, после которого менеджер выясняет, нужно ли пытаться заново доставить заказ или это окончательная недоставка.
: CUSTOMSFINISHED — Таможенный контроль произведен.
: CUSTOMSPROCESS — Производится таможенный контроль.
: DATECHANGE — Перенос.
: DELIVERY — Выдан курьеру на доставку.
: DEPARTURE — Отправлено со склада.
: DEPARTURING — Планируется отправка.
: INVENTORY — Инвентаризация.
: LOST — Утрачен/утерян.
: NEW — Новый.
: NEWPICKUP — Создан забор.
: PARTIALLY — Доставлен частично.
: PICKUP — Забран у отправителя.
: PICKUPREADY — Готов к выдаче.
: RETURNED — Возвращен.
: RETURNING — Планируется возврат.
: UNCONFIRM — Не удалось согласовать доставку.
: WMSASSEMBLED — Скомплектован на складе.
: WMSDISASSEMBLED — Разукомплектован.
 
'''Примечание.''' В будущем возможно изменение используемого набора статусов.
<div style="color: #a94442; background-color: #f2dede; border: 1px solid #ebccd1; padding: 3px 10px 10px;">
'''Обратите внимание!'''
 # Атрибуты контейнера Периода запроса статусов (контейнеры '''statusdatefrom''' заполняются для версий системы 2008.0.0.670 и выше'''dateto''') ограничивается двумя месяцами — два месяца до даты '''«по»'''.# Контейнер Если не указаны обе даты — '''statushistorydateto''' заполняется для тарифа [[Личный_кабинетпринимается равной текущей дате.#Если не указана дата '''dateto''' — она принимается равной '''datefrom''' плюс 2 месяца.D0.9F.D0.BE.D0.B4.D0.BA.D0.BB.D1.8E.D1.87.D0.B5.D0.BD.D0.B8.D0.B5|Премиум]] и версий системы 2008.0.0.670 и выше# Если не указана дата '''datefrom''' — она принимается равной '''dateto''' минус 2 месяца.# Контейнер Поиск по '''deliverypriceconditions''' заполняется работает только для тарифа [[Личный_кабинет#.D0.9F.D0.BE.D0.B4.D0.BA.D0.BB.D1.8E.D1.87.D0.B5.D0.BD.D0.B8.D0.B5|Премиум]].«Номер заказа(шифр)» и только от 4 символов
</div>
<br />
=== Передача только изменившихся статусов Примеры ответов ===В нашем API предусмотрено очень удобное средство получения статусов всех заказов, без необходимости "бомбить" сервер запросами статусов по каждому заказу. Работает это так: раз в какое-то время, например, в 10 минут, вы посылаете запрос "А покажите все изменившиеся статусы". '''Пример запроса ниже. Система вам отдает ВСЕ заказы, статусы (или некоторые другие поля, см ниже) которых изменились с момента последнего запроса. Вы разбираете полученный документ, по каждому заказу сохраняете его актуальный статус в своей системе, и если все хорошо, у вас все получилось, ваша система неожиданно не упала от наплыва информации, посылаете нам запрос подтверждения получения статусов (commitlaststatus). Мы у себя отмечаем, что эти статусы вами получены, и их не надо передавать повторно. Т.о. сколько бы заказов у вас не было, статусы по ним всем почти в реальном времени вы можете получать всего 2-мя запросами.успешного ответа'''
Для получения только изменившихся статусов отправьте запрос
<source lang="xml">
<?xml version="1.0" encoding="UTF-8" ?><statusreqcount="23"> <auth extraorder orderno="8111111" awb="qwerty" orderno2="123123" loginordercode="login34534234" passgivencode="pass2345334"> <barcode>111111</authbarcode> <sender> <changescompany>ONLY_LASTМВД</changescompany> <person>Иванов И.И.</statusreqperson> </sourcephoneСистема выдает все заказы, в которых, с момента последнего запроса в этом режиме, изменилось хотя бы одно из полей: orderno status delivereddate deliveredtime deliveredto receiver123-45-67</phone>date receiver- <contacts>address price После успешной обработки ответа необходимо отметить полученные статусы успешно полученными, отправив запрос <source lang="xml"phone>+74951234567<?xml version="1.0" encoding="UTF-8" ?/phone> <commitlaststatus/contacts> <auth extra="8" logintown code="login" pass="pass23432">Санкт-Петербург</authtown> <clientaddress>CLIENTПетровка 38 офис 35</clientaddress> </commitlaststatusdate>2014-03-22</sourcedate'''Описание полей запроса''' *'''auth''' - Авторизация. Обязательный элемент.*'''client''' - Признак клиента или агента. Необязательный элемент.:* CLIENT - Признак клиента, значение по умолчанию:* AGENT - Признак агента. В ответ отдается информация по заказам, переданным агенту на доставку В случае успеха Вы получите ответ <source lang="xml"time_min>09:00<?xml version="1.0" encoding="UTF-8" ?/time_min> <commitlaststatus error="0"time_max>OK14:00</commitlaststatustime_max> </sourcesenderДанный способ передачи статусов гарантирует полную корректную передачу статусов, даже в случае, если в нашей системе статус изменился в промежутке времени между запросом статусов и подтверждением их получения. Если система не получила подтверждение успешной передачи статуса, она будет считать информацию не переданной, и выдаст ее при повторном запросе.   <div style="color: #a94442; background-color: #f2dede; border: 1px solid #ebccd1; padding: 3px 10px 10px;"receiver>'''Обратите внимание!''' # При данном способе передачи ( <changescompany>ONLY_LASTМВД</changescompany>) система просматривает заказы, оформленные за последние 3 месяца. Если заказ сделан ранее - изменение статуса по нему не попадет в результат выполнения данного запроса.# Система всегда выдает текущий статус <person>Иванов И. ТИ.е. Вы можете одним запросом получить статус "NEW", а следующим - "COMPLETE". В промежутке между запросами отправление могло пройти через несколько промежуточных статусов. Если нужна гарантия получения всех промежуточных статусов, нужно анализировать блок statushistory (может не заполняться в следствии ограничений версии или тарифа конкретной службы доставки).# Система никогда не гарантирует последовательность прохождения заказом набора статусов. Т.е. Вы можете получить статус "COMPLETE", а следующим запросом - "NEW" - такое может произойти, например, если оператор ошибочно отметил заказ выполненным, а затем исправил ошибку.</divperson> <br /phone>  == Трекинг заказа по номеру == Запрос трекинга по номеру предназначен для выдачи минимальной обезличенной информации о конкретном заказе не авторизованному пользователю123-45-67 - Иван (916)234. Наша система имеет для этого интерфейс по адресу "home45.courierexe21 Петр,mvd@mail.ru</{код экстра}/tracking". Вы можете либо сделать ссылку на такую страницу на своем сайте, либо разместить ее iframe'ом у себя, либо сделать свою и пользоваться нашим API. Этот интерфейс создан специально для выдачи информации живому пользователю сайта. Для получения статусов заказов в свою информационную систему нужно использовать запрос "statusreq", желательно с параметром changes=ONLY_LAST! '''Пример запроса:'''<source lang="xml"><?xml version="1.0" encoding="UTF-8"?phone> <trackingcontacts> <extraphone>8+74951234567</extraphone> <ordernophone>1234+79162344521</ordernophone> </trackingemail>mvd@mail.ru</sourceemail'''Пример ответа:''' <source lang="xml"/contacts> <?xml version="1.0" encoding="UTF-8"?><tracking> <order orderno="111111"> <barcodeinn>1111111112223335</barcodeinn> <AWBzipcode>111111125480</AWB> <senderzipcode> <town code="1153361" regioncode="78" countryregionname="RUСанкт-Петербург город">Москва Санкт-Петербург город</town> <dateaddress>2014-03-22Петровка 38 офис 35</dateaddress> <time_minarea>09:00Район 1</time_minarea> <time_maxpvz>14:00 </time_maxcode> 126</sendercode> <receiverclientcode> <town code="1" country="RU">Москва городQWERTY</townclientcode> <zipcode>125480</zipcodepvz> <date>2014-03-22</date> <time_min>09:00</time_min> <time_max>14:00</time_max> <coords lat="55.680327" lon="37.604456"></coords> <deliveryPIN>1234</deliveryPIN> </receiver> <price>387.5</price> <inshprice>387.5</inshprice> <paytypecode="1">CASH</paytype> <weight>5.1</weight> <quantity>2</quantity> <service>2</service> <type>3</type> <return>NO</return> <return_service>2</service> <return_datereturn_type>3</return_datereturn_type> <return_timereturn_weight>5.1</return_timereturn_weight> <return_message>Доставлено в целости</return_message> <pickup>NO</pickup> <print_check>YES</print_check> <waittime>12</waittime> <enclosure>Детские игрушки</enclosure> <instruction>Проверить при покупателе, подписать акт</instruction> <deliveryprice totalcurrcoords lat="15855.6680327" deliverylon="10037.00604456" accuracy="50" returnRequestDateTime="58.62014-04-21 18:07:45" ></currcoords> <courier> <code>26</code> <name>Иванов Владимир Петрович</name> <phone>+79161234567</phone> </courier> <currcoords latdeliveryprice total="158.6" delivery="100.00" return="5558.6803276"> <advprice code="1" price="150">База</advprice> <advprice code="2" price="0">% от объявленной стоимости</advprice> <advprice code="3" lonprice="378.6044566" accuracy>Топливный сбор</advprice> <advprice code="504" RequestDateTimeprice="2014-04-21 18:07:450" >Округление</advprice> </deliveryprice> <receiverpays>NO</receiverpays> <acceptpartially>NO</acceptpartially> <status eventstore="филиал в Санкт-Петербурге" eventtime="2016-06-02 17:22:00" createtimegmt="2016-06-03 16:14:44" message="" title="Доставлен" eventtown="Санкт-Петербург город" color="16777215">COMPLETE</status>
<statushistory>
<status eventstore="Офис в Москве" eventtime="2016-05-30 10:20:00" createtimegmt="2016-06-03 16:14:44" message="" title="Новый" eventtown="Москва город" country="RU">NEW</status> <status eventstore="Офис в Москве" eventtime="2016-06-01 17:38:00" createtimegmt="2016-06-03 16:14:44" message="филиал в Санкт-Петербурге" title="Планируется отправка" eventtown="Москва город" country="RU">DEPARTURING</status> <status eventstore="Офис в Москве" eventtime="2016-06-01 19:53:00" createtimegmt="2016-06-03 16:14:44" message="филиал в Санкт-Петербурге" title="Отправлено со склада" eventtown="Москва город" country="RU">DEPARTURE</status> <status eventstore="филиал в Санкт-Петербурге" eventtime="2016-06-02 07:41:00" createtimegmt="2016-06-03 16:14:44" message="" title="Получен складом" eventtown="Санкт-Петербург город" country="RU">ACCEPTED</status> <status eventstore="филиал в Санкт-Петербурге" eventtime="2016-06-02 09:17:00" createtimegmt="2016-06-03 16:14:44" message="" title="Выдан курьеру на доставку" eventtown="Санкт-Петербург город" country="RU">DELIVERY</status> <status eventstore="филиал в Санкт-Петербурге" eventtime="2016-06-02 17:22:00" createtimegmt="2016-06-03 16:14:44" message="" title="Доставлен (предварительно)" eventtown="Санкт-Петербург город" country="RU">COURIERDELIVERED</status> <status eventstore="филиал в Санкт-Петербурге" eventtime="2016-06-02 17:22:00" createtimegmt="2016-06-03 16:14:44" message="" title="Доставлен" eventtown="Санкт-Петербург город" country="RU">COMPLETE</status> </statushistory> <customstatecode>2<customstatecode> <clientstatecode></clientstatecode>
<deliveredto>Иванова, секр.</deliveredto>
<delivereddate>2016-06-02</delivereddate>
<deliveredtime>17:22</deliveredtime>
<department>Отдел</department>
<costcode>cc12345</costcode>
<outstrbarcode>EXT123456</outstrbarcode>
<respstore>14</respstore>
<partner>Офис на Ленина</partner>
<arrival>2016-05-02 23:21</arrival>
<receipt fdNum="124555" fnSn="9289000100295555" kktNum="0001611984048555" inn="7722756555" fdValue="2899551555" summ="387.5" ofdUrl="gate.ofd.ru">https://ofd.ru/rec/7722756555/0001611984048555/9289000100295555/124555/2899551555</receipt>
<items>
<item code="34533" extcode="abc123" quantity="1" mass="0.2" retprice="37.5" VATrate="0" barcode="2345625213125" article="1" returns="0" origincountry="040" GTD="" excise="0.00" governmentCode="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" itemcode="44123" article="3" returns="0" governmentCode="">Погремушка желтая</item>
</items>
<packages>
<package code="33331" strbarcode="ORD0000001" mass="1" message="" got="YES"></package>
<package code="33332" strbarcode="ORD0000002" mass="2.5" message="" got="NO"></package>
</packages>
</order>
</trackingstatusreq>
</source>
'''Пример ответа если нет заказов'''
'''Получение информации в формате 17 TRACK'''
 
'''Пример запроса:'''
<source lang="xml">
<?xml version="1.0" encoding="UTFutf-8"?><tracking17statusreq count="0"></statusreq> </source> '''Пример ответа при ошибке авторизации''' <extrasource lang="xml"><?xml version="1.0" encoding="utf-8"?></extrarequest> <ordernoerror error="1" errormsg="authorization error">1234</ordernoerror></tracking17request>
</source>
'''Пример ответа:при ошибке синтаксиса''' <pre>{ source lang="numberxml":"ExtNumber",> <?xml version="oriNumber1.0":encoding="1234UTF-8",?> "oriCountry":"RU",<request> "destCountry" <error>column:"RU", "status"1 line:"Complete", "events"11 message:[expected '>'</error> {</request> "time":"2016-06-02 17:22:00",</source> "location":"RU", "content":"Complete"=== Описание полей ответа статусов === }Все поля ответа соответствуют структуре order при создании заказа,с некоторыми добавлениями: { "time"* Атрибуты контейнера '''order''':"2016-06-02 17:22* '''''awb''''' — Номер накладной в системе курьерской службы.:00",* '''''orderno2''''' — Номер накладной в подсистеме срочной доставки курьерской службы. "location":"RU"* '''''ordercode''''' — внутренний код заказа в системе,применяется для некоторых внутренних операций. "content":"Courierdelivered" }* '''''givencode''''' — внутренний код заказа в системе,применяется для некоторых внутренних операций. { "time":"2016-06*'''paytype''' -02 09Тип оплаты заказа получателем. Принимает значения:17:00", "location":"RU", "content":"Delivery" }, { "time":"2016CASH -06Наличными при получении (по-02 07умолчанию):41:00",CARD - Картой при получении "location":"RU",: NO - Без оплаты. "content":"Accepted" }, { "time":"2016OTHER -06Прочее (Предусмотрен для того, чтобы оплата поступала непосредственно в курьерскую службу посредством прочих типов оплаты -01 19таких как:53:00"вебмани, яденьги, картой на сайте,прочие платежные системы и т.д.) "location"* Атрибуты контейнера '''paytype''':"RU", ** '''''code''''' - (integer) внутренний код типа оплаты заказа в системном справочнике "content":"DepartureТипы оплаты корреспонденции". Не обязательный элемент. }, { "time":"2016-06-01 17:38:00"* атрибут '''''code''''' контейнера '''item''' — внутренний код строки заказа в системе,применяется для некоторых внутренних операций. "location":"RU"* '''''returns''''' — количество данного товара,от которого отказался получатель. Не нулевое только в случае частичного отказа. "content":"Departuring" },* атрибут '''''got''''' контейнера '''package''' — признак принятого места YES / NO. { "time":"2016-05-30 10:20:00", "location":"RU"* '''''returns''''' — количество данного товара, "content":"New" } ]}</pre>от которого отказался получатель. Не нулевое только в случае частичного отказа.
Функция ищет последний заказ по номеру среди заказов всех клиентов* '''''area''''' в контейнере '''receiver''' — район/метро получателя. Выдает неперсонализированную информацию о текущем состоянии заказа* '''''coords''''' в контейнере '''receiver''' — координаты получателя.<br />Описание контейнеров ответа аналогично описанию [[API#* '''''deliveryPIN''''' в контейнере '''receiver''' — Пин-код.D0* '''pickup''' — признак оформления забора, возможные значения: '''YES''', '''NO'''.97Если указано '''YES''', то весь заказ считается заданием на забор груза, а не на доставку.D0* '''currcoords''' — текущие координаты заказа.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|Запроса статусов заказов]]Атрибуты::* '''''lat''''' — широта:* '''''lon''''' — долгота:* '''''accuracy''''' — точность в метрах:* '''''RequestDateTime''''' — дата/время последнего обновления координат.
== Изменение заказа ==Запрос предназначен для изменения заказов* '''courier''' — Данные курьера, по которым которому выдан заказ. Если заказ не было произведено изменений статуса корреспонденциивыдан, времени доставки — то есть заказов, которые ещё не выводятся данные запланированного курьера.* '''waittime ''' — Время ожидания курьера.* '''deliveryprice''' — Стоимость услуг в работевалюте расчетов с клиентом.Атрибуты::* '''''total''''' — общая стоимость услуг:* '''''delivery''''' — стоимость доставки «Туда»:* '''''return''''' — стоимость доставки «Обратно» (если order->return=YES)Тэг '''deliveryprice''' включает список дополнительных услуг (только для тарифа «Премиум»)::* '''''advprice''''' — наименование дополнительной услуги:* '''''code''''' — код дополнительной услуги:* '''''price''''' — стоимость дополнительной услуги
Изменять заказы могут курьерские службы * '''status''' — статус доставки (список статусов см. ниже). Атрибуты (заполняются начиная с тарифами «Премиум» версии системы 2008.0.0.670)::* '''''eventstore''''' — филиал, к которому относится текущий статус:* '''''eventtime''''' — время события по часовому поясу места его наступления.:* '''''createtimegmt''''' — время по GMT создания записи о смене статуса в БД. Используется для сортировки записей, чтобы соблюсти хронологическую последовательность. <spoiler text="Подробнее">Большинство событий фиксируются в полях eventtime и createtimegmt на основании одного действия, тогда они отличаются только сдвигом от GMT. Однако, если курьер доставил отправление 10.10.2010 в 20:00, по какой-то причине не внес это в мобильное приложение, на следующий день сдал накладную, и «Максимум»в 9 утра оператор внесла, что он доставил вчера в 20:00. Чтобы разрешить изменение заказовТогда в createtimegmt будет сегодня 6 утра (для Москвы), а в eventtime — вчера в личном кабинете курьерской службы перейдите 20:00. При этом оператор по каким-то причинам может внести время вручения раньше, чем какое-то предыдущее событие, т.о. нарушится последовательность времени в eventtime, но при сортировке по createtimegmt все-равно все будет правильно.</spoiler>:* '''''Параметрыmessage''' > '' — наименование филиала-получателя, при передаче между филиалами:* 'Расширенные''' и установите флажок 'title''Разрешить отмену и изменение заказов'''. — русское наименование статуса
<div style="color: #a94442; background-color: #f2dede; border: 1px solid #ebccd1; padding: 3px 10px 10px;">* '''statushistory''' — история статусов доставки. Содержит список контейнеров '''status'''. Заполняется только для тарифа «Премиум» начиная с версии системы 2008.0.0.670.* '''Обратите внимание!customstatecode''' — код внутреннего статуса курьерской службы. Значения уточняйте в курьерской службе. Назначаются курьерской службой в разделе «Справочники» — «Статусы» — «15 Статусы корреспонденции». Справочник не передается через API клиенту по причине возможного наличия в нем внутренних технологических статусов курьерской службы.# Данные запроса изменения указываются * '''полностьюclientstatecode''' — код статуса клиента. Используется, как если бы заказ создавался впервыеклиент предлагает свои коды статусов доставки/причин недоставки.# При отсутствии вложения в запросе изменения данное вложение * '''не удаляетсяdeliveredto'''  — данные из заказаполя «Инфо. о доставке» (может быть информация о доставке, причина недоставки и т. п.).* '''delivereddate''' — дата вручения.* '''deliveredtime''' — время вручения. В случае недоставки может быть пустым.* '''arrival''' — плановая дата прибытия в формате гггг-мм-дд чч: мм: сс. Заполняется только при использовании автоматических систем планирования (Максоптра, Яндекс доставка), но его количество становится равным 0во всех остальных случаях - пустое.# При одновременном изменении * '''outstrbarcode''' — код у подрядчика (код заказа в API и во внешней системе курьерской службы приоритет отдается данным системы курьерской службы). То есть изменения Используется в API приняты не будут!интеграциях с внешними системами.<* '''partner''' — текущий филиал/div>подрядчик.<br>* '''return_message''' — информация о возврате* '''department''' — Подразделение, в котором оформляется заказ.
=== Описание полей запроса изменения ===Контейнер '''status''' может принимать следующие значения:Все поля запроса соответствуют структуре order при создании : AWAITING_SYNC — Ожидает синхронизации. Данные заказа за исключениемпока не появились в службе доставки.:* вместо корневого тэга '''neworderNEW''' указывается  — Успешно создан, передан в службу доставки.: NEWPICKUP — Создан забор.: PICKUP — Забран у отправителя.: WMSASSEMBLED — Скомплектован на складе фулфилмента.: WMSDISASSEMBLED — Разукомплектован на склад фулфилмента.: '''editorderACCEPTED''' — Получен складом.: CUSTOMSPROCESS — Производится таможенный контроль.: CUSTOMSFINISHED — Таможенный контроль произведен.: CONFIRM — Согласована доставка.: UNCONFIRM — Не удалось согласовать доставку.: DEPARTURING — Планируется отправка со склада на другой склад.: DEPARTURE — Отправлено со склада на другой склад.: INVENTORY — Инвентаризация. Убедились в наличии отправления на складе.: PICKUPREADY — Готов к выдаче в ПВЗ.* тэг штрих-кода : '''barcodeDELIVERY'''  — Выдан курьеру на доставку.: COURIERDELIVERED — Доставлен (предварительно, ожидает подтверждения менеджером, чтобы перейти в статус COMPLETE).: COURIERPARTIALLY — Частично доставлен (предварительно, ожидает подтверждения менеджером, чтобы перейти в статус PARTIALLY).: COURIERCANCELED — Отказ (предварительно, после этого ожидается COURIERRETURN).: COURIERRETURN — Возвращено курьером. Курьер не указываетсясмог доставить до получателя и вернул заказ обратно на склад. Это промежуточный статус, после которого менеджер выясняет, поскольку присваивается при создании заказанужно ли повторно доставлять (статусы DATECHANGE/DELIVERY) или это окончательная недоставка (CANCELED).: DATECHANGE — Перенос даты доставки.* для вложений : '''COMPLETE''' — Доставлен.: ''item'PARTIALLY'' указывается внутренний код вложения в атрибуте ' — Доставлен частично.: '''codeCANCELED''' — Не доставлен (Возврат/Отмена). После этого статуса отправление должны вернуть заказчику, который можно получить при получении статуса заказабудут статусы RETURNING и RETURNED : RETURNING — Планируется возврат заказчику (после CANCELED).: RETURNED — Возвращен заказчику.: LOST — Утрачен/утерян. : PARTLYRETURNING — Планируется возврат остатков.: PARTLYRETURNED — Остаток возвращен.: TRANSACCEPTED — Прибыл на склад перевозчика.: PICKUPTRANS — Забран у перевозчика.
=== Описание полей ответа изменения ===
Все поля ответа соответствуют ответу при создании заказа за исключением корневого тэга — вместо '''neworder''' возвращается '''editorder'''.
== Отмена заказа ==Запрос отмены предназначен для отмены тех заказов, по которым не было произведено изменений — статуса доставки, статуса корреспонденции, времени доставки — то есть заказов, которые ещё не находятся в работе'''Примечание.''' В будущем возможно дополнение используемого набора статусов.
Отменять заказы могут курьерские службы с тарифами «Премиум» и «Максимум». Чтобы разрешить отмену заказов, в личном кабинете курьерской службы перейдите в '''Параметры''' <div style="color: #a94442; background-color: #f2dede; border: 1px solid #ebccd1; padding: 3px 10px 10px;"> '''Расширенные''' и установите флажок '''Разрешить отмену и изменение заказовОбратите внимание!'''.
При отмене заказа поле «Инфо о доставке» получает значение «Отменено заказчиком»# Контейнер '''statushistory''' и '''deliveryprice''' заполняется для тарифов [[Личный кабинет курьерской службы#Функции личного кабинета|Премиум и Максимум]].# Система никогда не гарантирует последовательность прохождения заказом набора статусов. То есть Вы можете получить статус «COMPLETE», а следующим запросом — «NEW» — такое может произойти, например, поле «Дата доставки» — текущую датуесли оператор ошибочно отметил заказ выполненным, а «Вручил курьер» — системную запись «ОТМЕНА»затем исправил ошибку.</div><br>
=== Передача только изменившихся статусов ===
В нашем API предусмотрено удобное средство получения статусов всех заказов, без необходимости «бомбить» сервер запросами статусов по каждому заказу. Работает это так: раз, например, в 10 минут, вы посылаете запрос «покажите все изменившиеся статусы». Пример запроса ниже. Система вам отдает ВСЕ заказы, статусы (или некоторые другие поля, см. ниже) которых изменились с момента последнего запроса. Вы разбираете полученный документ, по каждому заказу сохраняете его актуальный статус в своей системе, и если все хорошо, у вас все получилось, ваша система неожиданно не упала от наплыва информации, посылаете нам запрос подтверждения получения статусов (commitlaststatus). Мы у себя отмечаем, что эти статусы вами получены и их не надо передавать повторно. Таким образом, сколько бы заказов у вас ни было, статусы по ним всем почти в реальном времени вы можете получать всего двумя запросами.
'''Пример запроса отмены заказаДля получения только изменившихся статусов отправьте запрос:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8" ?>
<cancelorderstatusreq> <auth extra="8" login="login" pass="pass" ></auth> <order orderno="" ordercode="123456" changes>ONLY_LAST</changes> <order orderno="123aaa" ordercode="" streamid>1234</streamid></cancelorderstatusreq>
</source>
Система выдает все заказы, в которых с момента последнего запроса в этом режиме изменилось хотя бы одно из полей:
orderno
status
delivereddate
deliveredtime
deliveredto
receiver->date
receiver->address
price
'''Описание полей запроса статуса:''' '''cancelorder''' — Корневой контейнер. Обязательный элемент.* '''auth''' — Авторизация. Обязательный элемент.* '''order''' — Контейнер отменяемого заказа. Обязательный элемент. Запрос может содержать более одного контейнера '''order'''. Атрибуты::* '''''orderno''''' — Шифр заказа.:* '''''ordercode''''' — Внутренний код заказа.Обратите вниманиеПосле успешной обработки ответа необходимо отметить полученные статусы успешно полученными, что должен быть указан хотя бы один из атрибутов ''orderno'' или ''ordercode''!  '''Пример ответаотправив запрос:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8" ?>
<cancelordercommitlaststatus> <order ordernoauth extra="123test8" ordercodelogin="123456login" errorpass="0" errormsg="OK" errormsgru="Успешноpass" ></auth> <client>CLIENT</client> <order orderno="123aaa" ordercode="" error="52" errormsg="order not found" errormsgru="Заказ не найден" streamid>1234</streamid></cancelordercommitlaststatus>
</source>
== Добавление вложений к накладной =='''Описание полей запроса''' * '''auth''' — авторизация. Обязательный элемент.* '''streamid''' — идентификатор потока. Если у вас несколько интеграций и каждая нуждается в получении статусов, вы можете передавать данный параметр и тем самым разделять получение и отметку об успешном получении статусов по заказам. Значение должно входить в промежуток от 100 до 10000, включительно. Необязательный элемент.* '''client''' — признак клиента или агента. Необязательный элемент.:* CLIENT — признак клиента, значение по умолчанию:* AGENT — признак агента. В ответ отдается информация по заказам, переданным агенту на доставку
'''Пример запросаВ случае успеха вы получите ответ:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8" ?>
<addattachments> <auth extracommitlaststatus error="80" login="login" pass="pass" /> <orderno>1234567</orderno> <attachments> <item name="photo1.jpg">JVBERi0xLjMN1wb25lbnQgMQ JUBQREYwMTIzNDU2Nzg5IDI NMyAwIG9iag08PA0vVHlwZSA U3VidHlwZSAvSW1hZ2UNL1d pZHRoIDE4MDgNL0hlaWdodCA ggNCAwIFINL0JpdHNQZXJDb 21wb25lbnQgMQ0vRGVjb2RlU ENL0NvbHVtbnMgMTgwOA0+P g0vSW1hZ2VNYXNrIHRydWUNL XhEZWNvZGUNPj4Nc3RyZWFt DQ</item> <item name="photo2.jpg">VBERi0xLjMNAwIG9iag0HRoJ JUBQREYwMTIzNDU2Nzg5IDI NMyAwIG9iag08PA0vVHlwZSA vWE9iamVjdA0vU3VidHlwZS AvSW1hZ2UNL1dpZHRoIDEzNj gNL0hlaWdodCAxMzMzDS9MZ W5ndGggNCAwIFINL0JpdHNQZ XJDb21wb25lbnQgMQ0vRGVj b2RlUGFybXMgPDwNL0sgLTEN L0NvbHVtbnMgMTM2OA0+Pg0 vSW</item> </attachments>OK</addattachmentscommitlaststatus>
</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>
'''addattachments''' - Корневой контейнер. Обязательный элемент.== Трекинг заказа по номеру ==*'''auth''' - АвторизацияЗапрос трекинга по номеру предназначен для выдачи минимальной обезличенной информации о конкретном заказе не авторизованному пользователю. Обязательный элемент.*'''orderno''' - Номер заказаНаша система имеет для этого интерфейс по адресу «home. Обязательный элементcourierexe. Может использоваться тэг <ordercode> с указанием внутреннего кода заказаru/{код экстра}/tracking».*'''attachments''' - Обязательный элементВы можете либо сделать ссылку на такую страницу на своем сайте, в котором перечисляются передаваемые данные файлов.**'''item''' - Бинарные данные либо разместить ее [[#Размещение страниц на своем сайте (файлiframe)|iframe’ом]] у себя, закодированные в base64либо сделать свою и пользоваться нашим API. Обязательный элементЭтот интерфейс создан специально для выдачи информации живому пользователю сайта.***'''name''' - Атрибут элемента '''item'''Для получения статусов заказов в свою информационную систему нужно использовать запрос «statusreq», в котором передается имя файла. Обязательный элемент.желательно с параметром changes=ONLY_LAST!
 '''Пример ответазапроса:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<addattachmentstracking> <attachmentsextra> <item name="photo1.jpg" error="0" errormsg="OK" errormsgru="Успешно" /> <item name="photo2.jpg" error="0" errormsg="OK" errormsgru="Успешно" /> </attachments></addattachments>8</source> == Получение вложений к накладной == '''Пример запроса:'''<source lang="xml"><?xml version="1.0" encoding="UTF-8" ?><attachments> <auth extra="8" login="login" pass="pass" /> <orderno>12345671234</orderno></attachmentstracking>
</source>
 
'''Описание полей:'''
 
'''attachments''' - Корневой контейнер. Обязательный элемент.
*'''auth''' - Авторизация. Обязательный элемент.
*'''orderno''' - Номер/код заказа. Обязательный элемент.
 
'''Пример ответа:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<attachmentstracking> <item nameorder orderno="111111"> <barcode>111111</barcode> <AWB>111111</AWB> <sender> <town code="doc1.docx1" sizecountry="35654RU">JVBERi0xLjMNМосква город</town> JUBQREYwMTIzNDU2Nzg5IDI NMyAwIG9iag08PA0vVHlwZSA <date>2014-03-22</date> U3VidHlwZSAvSW1hZ2UNL1d pZHRoIDE4MDgNL0hlaWdodCA <time_min>09:00</time_min> ggNCAwIFINL0JpdHNQZXJDb 21wb25lbnQgMQ0vRGVjb2RlU <time_max>14:00</time_max> ENL0NvbHVtbnMgMTgwOA0+P g0vSW1hZ2VNYXNrIHRydWUNL </sender> XhEZWNvZGUNPj4Nc3RyZWFt DQ </itemreceiver> <item nametown code="photo2.jpg1" sizecountry="74861RU">VBERi0xLjMN Москва город</town> JUBQREYwMTIzNDU2Nzg5IDI NMyAwIG9iag08PA0vVHlwZSA <zipcode>125480</zipcode> vWE9iamVjdA0vU3VidHlwZS AvSW1hZ2UNL1dpZHRoIDEzNj <date>2014-03-22</date> gNL0hlaWdodCAxMzMzDS9MZ W5ndGggNCAwIFINL0JpdHNQZ <time_min>09:00</time_min> XJDb21wb25lbnQgMQ0vRGVj b2RlUGFybXMgPDwNL0sgLTEN <time_max>14:00</time_max> L0NvbHVtbnMgMTM2OA0+Pg0 vSW </itemreceiver> <price>387.5</attachmentsprice> <inshprice>387.5</sourceinshprice> <paytype>CASH</paytype>В тегах item возвращаются бинарные данные (файлы), закодированные в base64 <weight>5.1</weight> <quantity>2</quantity> <service>2</service> <type>3</type> <return>NO</return> <return_service>2</return_service>== Изменение статуса агентом == <return_date></return_date> <return_time></return_time>Запрос изменения статуса заказа позволяет установить окончательный статус заказа - "Доставлен" или "Не доставлен (Возврат <return_message></return_message> <waittime>12</Отмена)".waittime> <enclosure>Детские игрушки</enclosure>Кроме этого, устанавливается дата и время ( <instruction>Проверить при необходимости) изменения статусапокупателе, а также сообщение в поле ''Инфо о доставке''подписать акт</instruction> <deliveryprice total="158.6" delivery="100.00" return="58.6" /> <courier>При необходимости к заказу можно прикрепить изображения. <code>26</code> <name>Иванов Владимир Петрович</name> <phone>+79161234567</phone>'''Пример запроса изменения статуса:''' </courier> <source langcurrcoords lat="55.680327" lon="37.604456" accuracy="50" RequestDateTime="xml2014-04-21 18:07:45"/> <?xml versionstatus eventstore="1.0филиал в Санкт-Петербурге" eventtime="2016-06-02 17:22:00" encodingcreatetimegmt="UTF2016-06-803 16:14:44" ?message="" title="Доставлен">COMPLETE</status> <setorderinfostatushistory> <auth extrastatus eventstore="Офис в Москве" eventtime="82016-05-30 10:20:00" createtimegmt="2016-06-03 16:14:44" loginmessage="login" passtitle="passНовый" >NEW</status> <order ordercodestatus eventstore="Офис в Москве" eventtime="2016-06-01 17:38:00" createtimegmt="2016-06-03 16:14:44" message="филиал в Санкт-Петербурге" title="123456Планируется отправка">DEPARTURING</status> <status eventstore="Офис в Москве" eventtime="2016-06-01 19:53:00" createtimegmt="2016-06-03 16:14:44" message="филиал в Санкт-Петербурге" title="Отправлено со склада">Получил ИвановDEPARTURE</status> <status eventstore="филиал в Санкт-Петербурге" eventtime="2016-06-02 07:41:00" createtimegmt="2016-06-03 16:14:44" message="" title="Получен складом"> ACCEPTED</orderstatus> <order ordercodestatus eventstore="филиал в Санкт-Петербурге" eventtime="2016-06-02 09:17:00" createtimegmt="2016-06-03 16:14:44" message="" title="234567Выдан курьеру на доставку">DELIVERY</status> <statuseventstore="филиал в Санкт-Петербурге" eventtime="2016-06-02 17:22:00" createtimegmt="2016-06-03 16:14:44" message="" title="Доставлен (предварительно)">PICKUPREADYCOURIERDELIVERED</status> <status eventstore="филиал в Санкт-Петербурге" eventtime>="2016-0506-30 1002 17:2022:00" createtimegmt="2016-06-03 16:14:44" message="" title="Доставлен">COMPLETE</status> </statushistory> <deliveredto>Иванова, секр.</eventtimedeliveredto> <delivereddate>2016-06-02</delivereddate> <messagedeliveredtime>Клиент отказался от покупки17:22</messagedeliveredtime> <paytypeoutstrbarcode>CASHEXT123456</paytypeoutstrbarcode> <items> <item code="34533" extcode="abc123" quantity="1" reasonmass="0.2" retprice="37.5" VATrate="0" barcode="2345625213125" article="1" returns="0" origincountry="040" GTD="" excise="0.00" governmentCode="11223311" suppcompany="Поставщик" suppINN="1112223334" suppphone="79161234567">Мяч</item> <item code="34456" extcode="abc124" quantity="2" mass="2" retprice="100" VATrate="10" barcode="4645625213138" article="2" returns="0" reasongovernmentCode="0" >Обруч</item> <item code="34421" extcode="abc125" quantity="23" mass="0.3" retprice="50" VATrate="18" barcode="2345625213126" article="3" reasonreturns="0" /> </items> <image filenamegovernmentCode="filename1.jpg"> Погремушка желтая</9j/4AAQSkZJRgAitem> BAQAAAQABAAD/2wBDAA0JCg sKCA0LCgsODg0PEyAVExISEy ccHhcgLikxMC4pLSwzOko+M zZGNywtQFdBRkxOUlNSMj5aY VpQYEpRUk//2wBDAQ4ODhMR EyYVFSZPNS01T09PT09PT09P T09PT09PT09PT09PT09PT09 PT09PT09PT09PT09PT09PT09 PT09PT0//wAARCAYACAADAS IA </imageitems> </order></setorderinfotracking>
</source>
'''Описание полей запроса статуса:Получение информации в формате 17 TRACK'''
'''setorderinfo''' - Корневой контейнер. Обязательный элемент.*'''auth''' - Авторизация. Обязательный элемент.*'''order''' - Контейнер заказа. Обязательный элемент. Запрос может содержать более одного контейнера '''order'''. Атрибут '''''ordercode''''' - внутренний код заказа.*'''status''' - Новый статус заказа. Доступны статусы из раздела [[#Описание полей ответа статусов]], кроме AWAITING_SYNC и NEW.*'''eventtime''' - Дата и время изменения статуса. Обязательно при указании статуса.*'''message''' - Текст сообщения ''Инфо о доставке''.*'''paytype''' - Тип оплаты заказа. Допустимые значения CASH/CARD.*'''items''' - Контейнер для описания вложений '''item''' . Атрибуты::* '''''code''''' - Код вложения.:* '''''quantity''''' - Количество доставленных единиц вложения.:* '''''reason''''' - Причина недоставки, выбирается из соответствующего списка статусов.*'''image''' - Контейнер прикрепляемого изображения. Содержит текст файла изображения, закодированный по стандарту ''base64''. Контейнер '''order''' может содержать более одного контейнера '''image'''. Атрибут::* '''''filename''''' - Имя файла.   '''Пример ответазапроса:'''<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<setorderinfotracking17> <order ordercode="123456" error="0" errormsg="OK" errormsgru="Успешно" extra>8</extra> <order ordercode="234567" error="59" errormsg="value [date_put] is already set" errormsgru="Значение [Дата доставки] уже указано" orderno>1234</orderno></setorderinfotracking17>
</source>
== Получение документов для печати == '''Пример запроса получения печатных формответа:'''<source lang=pre>{ "number":"ExtNumber", "oriNumber":"xml1234">,<?xml version= "1.0oriCountry" encoding=:"UTF-8RU" ?>,<waybill> "destCountry":"RU", <auth extra= "8status" login=:"loginComplete" pass=, "passevents" />:[ <orders> { <order orderno= "1234567time" ordercode=:"333312016-06-02 17:22:00" />, <order orderno= "1234568location" ordercode=:"33332RU" />, </orders> "content":"Complete" <form>1</form> },</waybill> {</source> "time":"2016-06-02 17:22:00", "location":"RU",'''Описание полей "content":'''"Courierdelivered" },'''waybill''' - Корневой контейнер. Обязательный элемент {*'''auth''' "time":"2016- Авторизация. Обязательный элемент*'''orders''' 06- Список заказов для получения печатных форм. Содержит тэги '''order''' с атрибутами02 09:17:00", "location":* '''''orderno''''' - шифр заказа"RU", "content":* '''''ordercode''''' - внутренний код заказа. Указывать необходимо один из атрибутов для всех заказов. Приоритет имеет атрибут '''''ordercode'''''"Delivery" },*'''form''' - Формат накладной. Не обязательный элемент. Принимает значения: { "time":* 1 "2016- Подробная накладная (по06-умолчанию)02 07:41:00", "location":* 2 - Наклейки Zebra"RU", "content":* 3 - Наклейки на страницу формата А4"Accepted" }, { "time":* 4 "2016- Акты приема06-передачи01 19:53:00", "location":"RU", '''Пример ответа "content":'''<source lang="xmlDeparture"><?xml version= }, { "1.0time" encoding=:"UTF2016-06-801 17:38:00"?>,<waybill> "location":"RU", < "content>EODIcaI8KSBlwQ 4MnEOR7Px8U8EBAyGICBnwpw ":"Departuring" IZhQgz0ZxuPs8EBM/GcbjzB AwhBl8hwQYIO00GmEwg1CeEG }, mqYTChNU0wqf8l8nz4zgc+K fCno+zwU5GjOZmzXGcbEQYIM { 4zkegRE40zWzONyoNNMIOIa cWnp6aDCGEGE9NQmoQd2mg00 "time":"2016-05-30 10:20:00", 79U4f3hPTwnfp6Sdrafeqpa JDpFw/1aYT077VNNNdO00G3q "location":"RU", mqqvp9p2E7T0/wiFemv8uG6 OM</ "content>":"New" } ]}</waybillpreФункция ищет последний заказ по номеру среди заказов всех клиентов. Выдает неперсонализированную информацию о текущем состоянии заказа.</sourcebr>Описание контейнеров ответа аналогично описанию [[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|Запроса статусов заказов]]. В тэге content возвращаются бинарные данные (файл pdf)== Изменение заказа ==Запрос предназначен для изменения заказов. Изменять заказы могут курьерские службы с тарифами «Премиум» и «Максимум». Чтобы разрешить изменение заказов, закодированные в base64личном кабинете курьерской службы перейдите в '''Настройки''' > '''Заказы''' и в разделе '''Отмена и редактирование''' установите флажок '''Разрешить отмену и изменение заказов'''.   Вы также можете пометить в списке '''Обратите вниманиеСтатусы для отмены и редактирования заказов''' галками статусы корреспонденции, что печатные формы для заборов которых возможны отмена и изменение заказов. По умолчанию (когда в этом списке ничего не формируются.выбрано) редактирование и отмена разрешены для статуса «Новый»
<div style="color: #a94442; background-color: #f2dede; border: 1px solid #ebccd1; padding: 3px 10px 10px;">
'''Обратите внимание!'''
# Данные запроса изменения указываются '''полностью''', как если бы заказ создавался впервые.
# При отсутствии вложения в запросе изменения данное вложение '''не удаляется''' из заказа, но его количество становится равным 0.
# При одновременном изменении заказа в API и системе курьерской службы приоритет отдается данным системы курьерской службы. То есть изменения в API приняты не будут.
</div>
== Справочник городов ==При редактировании заказа может быть отменен запланированный курьер. Это зависит от значения переменной '''Справочники''' > '''Переменные''' > '''Корреспонденция''' > '''Автоматически устанавливать заплан. курьера по району''':* '''Нет''' — при редактировании заказа по АПИ курьер не изменяется;* '''Район''' — если изменен адрес доставки, курьер сбрасывается;* '''Район или дата план. доставки''' — если изменен адрес доставки или плановая дата вручения, курьер сбрасывается.
=== Описание полей запроса изменения ===Все поля запроса соответствуют структуре order при создании заказа за исключением: * значение '''Пример запроса справочника городов:orderno'''данным методом изменить нельзя.<source lang="xml"><?xml version="1* значение '''barcode''' изменяется в случае явного его указания.0" encoding="UTFВ случае отсутствия или пустого значения -8"?>остается прежним.<townlist>* вместо корневого тэга '''neworder''' указывается '''editorder'''; <auth extra="8" />* тэг курьера '''courier''' можно изменить только при включенной настройке '''Разрешить изменение курьера по АПИ'''; <codesearch>* для вложений '''item''' указывается внутренний код вложения в атрибуте '''code''', который можно получить при получении статуса заказа. <zipcode>110000</zipcode> <kladrcode>0100000100800</kladrcode> <fiascode>bd21979d-46f8-49d0-9105-e8d65172a983</fiascode> <* для мест '''package''' указывается внутренний код вложения в атрибуте '''code>123</code> </codesearch> <conditions> <city>Краснодарский край</city> <namecontains>новгород</namecontains> <namestarts>Моск</namestarts> <name>Москва</name> <fullname>Москва город</fullname> <country>1</country> </conditions> <limit> <limitfrom>30</limitfrom> <limitcount>10</limitcount> <countall>YES</countall> </limit></townlist></source>''', который можно получить при получении статуса заказа.
Внутри контейнера townlist все элементы могут как отсутствовать, так и комбинироваться. Поиск не чувствителен к регистру.
*'''auth''' - АвторизацияНеобходимо иметь в виду, необязательный элемент. Используется в случае включенного и настроенного ограничения по населенным пунктам в конкретной курьерской службе.что:
*'''codesearch''' # Заказ нельзя изменить, пока он не синхронизирован с системой (пока предыдущие изменения не переданы в бэк- Поиск по кодам. В случае использования - контейнеры conditions офис)# Удаление вложений и limit игнорируются.:* '''zipcode''' - Поиск по индексу. Обратите внимание на томест выполняется не моментально, что один почтовый индекс может распространяться на несколько населенных пунктов. В этом случае система вернет несколько записей.:* '''kladrcode''' а в процессе синхронизации с бэк- Поиск по 13-ти значному коду КЛАДР.:* '''fiascode''' - Поиск по коду ФИАС офисом (AOGUIDдля записей указываются метки Удалено).:* '''code''' - Поиск по коду в системе.
*'''conditions''' - Задает условия поиска. === Описание полей ответа изменения ===Все вложенные элементы одновременно накладывают условие "И".:* поля ответа соответствуют ответу при создании заказа за исключением корневого тэга — вместо '''cityneworder''' - Поиск по всем населенным пунктам региона.:* '''namecontains''' - Поиск населенных пунктов, название которых содержит указанный текст.:* '''namestarts''' - Поиск населенных пунктов, название которых начинается с указанного текста.:* '''name''' - Поиск населенных пунктов, название которых соответствует указанному тексту.:* '''fullname''' - Поиск населенных пунктов, название вместе с типом населенного пункта которых соответствует указанному тексту.:* возвращается '''countryeditorder''' - Поиск только по стране с указанным кодом.
*'''limit''' - Ограничивает вывод результата.== Отмена заказа ==:* '''limitfrom''' - Задает номер записи результата, начиная с которой выдавать ответ. По-умолчанию - 0.:* '''limitcount'''- Задает количество записей результата, которые нужно вернуть. По-умолчанию - 10000.:* '''countall''' - YES указывает на необходимость подсчета общего количества найденных совпадений. Это может замедлять выполнение запроса. Если отключено - в ответе не указываются totalcount и totalpagesЗапрос предназначен для отмены заказов.
Отменять заказы могут курьерские службы с тарифами «Премиум» и «Максимум». Разрешения для отмены заказов и статусы в которых заказы можно отменять описаны в разделе '''Изменение заказов''' При отмене заказа поле «Инфо о доставке» получает значение «Отменено заказчиком», поле «Дата доставки» — текущую дату, а «Вручил курьер» — системную запись «ОТМЕНА».  '''Пример ответазапроса отмены заказа:'''<source lang="xml"><?xml version="1.0" encoding="UTF-8"?><townlist countcancelorder> <auth extra="38" pagelogin="1login" totalcountpass="3" totalpages="1pass"/> <town> <code>26379<order orderno="" ordercode="123456" /code> <city> <code>23 <order orderno="123aaa" ordercode="" /code> <name>Краснодарский край</namecancelorder> </citysource> <name>Сочи город</name> <fiascode>79da737a-603b-4c19-9b54-9114c96fb912</fiascode> <kladrcode>2300000700000</kladrcode>'''Описание полей:''' <shortname /> (not yet supported) <typename /> (not yet supported)'''cancelorder''' — Корневой контейнер. Обязательный элемент. <coords lat="43* '''auth''' — Авторизация.5855" lon="39Обязательный элемент.7231" /> </town>* '''order''' — Контейнер отменяемого заказа. Обязательный элемент. Запрос может содержать более одного контейнера '''order'''. Атрибуты: <town>:* '''''orderno''''' — Шифр заказа. <code>40331</code>:* '''''ordercode''''' — Внутренний код заказа. <city>Обратите внимание, что должен быть указан хотя бы один из атрибутов ''orderno'' или ''ordercode''! <code>32</code> <name>Брянская область</name> </city>'''Пример ответа:''' <name>Сочилов хутор</namesource lang="xml"> <fiascode>c9c96c67-2cc9-4f10-afde-fd32417ea216</fiascode> <kladrcode>3201900011100</kladrcode> <shortname /> <typename /> <coords lat?xml version="521.64070" lonencoding="33.1724UTF-8" /?> </towncancelorder> <town> <code>114016</code> <city> <code>60</code> <name>Псковская область</name> </city> <name>Сочихино деревня</name> <fiascode>10df7588-19c1-49d1-a387-9de1cf3eb26f</fiascode> <kladrcode>6001900015400</kladrcode> <shortname /> <typename /> <coords latorder orderno="123test" ordercode="123456" error="0" errormsg="56.6003OK" lonerrormsgru="29.3542Успешно" /> <order orderno="123aaa" ordercode="" error="52" errormsg="order not found" errormsgru="Заказ не найден" /town></townlistcancelorder>
</source>
В ответе города сортируются по популярности, важности (районные центры и т.д.), и только затем - по алфавиту.== Добавление вложений к накладной ==
== Справочник регионов ==Метод позволяет прикрепить файлы к корреспонденции.Размер загружаемого файла не должен превышать 1 Мб.
'''Пример запроса справочника:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?><regionlistaddattachments> <codesearchauth extra="8" login="login" pass="pass" /> <codeorderno>771234567</codeorderno> </codesearchattachments> <conditionsitem name="photo1.jpg">JVBERi0xLjMN1wb25lbnQgMQ JUBQREYwMTIzNDU2Nzg5IDI NMyAwIG9iag08PA0vVHlwZSA U3VidHlwZSAvSW1hZ2UNL1d pZHRoIDE4MDgNL0hlaWdodCA ggNCAwIFINL0JpdHNQZXJDb 21wb25lbnQgMQ0vRGVjb2RlU ENL0NvbHVtbnMgMTgwOA0+P g0vSW1hZ2VNYXNrIHRydWUNL <namecontains>крайXhEZWNvZGUNPj4Nc3RyZWFt DQ</namecontainsitem> <namestarts>Моск</namestartsitem name="photo2.jpg">VBERi0xLjMNAwIG9iag0HRoJ JUBQREYwMTIzNDU2Nzg5IDI NMyAwIG9iag08PA0vVHlwZSA vWE9iamVjdA0vU3VidHlwZS AvSW1hZ2UNL1dpZHRoIDEzNj gNL0hlaWdodCAxMzMzDS9MZ W5ndGggNCAwIFINL0JpdHNQZ <fullname>Московская область</fullname>XJDb21wb25lbnQgMQ0vRGVj b2RlUGFybXMgPDwNL0sgLTEN <country>1L0NvbHVtbnMgMTM2OA0+Pg0 vSW</countryitem> </conditionsattachments></regionlistaddattachments>
</source>
 '''Описание полей:''' '''addattachments''' — Корневой контейнер. Обязательный элемент.* '''auth''' — Авторизация. Обязательный элемент.* '''orderno''' — Номер заказа. Обязательный элемент. Может использоваться тэг <ordercode> с указанием внутреннего кода заказа.* '''attachments''' — Обязательный элемент, в котором перечисляются передаваемые данные файлов.** '''item''' — Бинарные данные (файл), закодированные в base64. Обязательный элемент.*** '''name''' — Атрибут элемента '''item''', в котором передается имя файла. Обязательный элемент.  '''Пример ответа:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<regionlist count="2"addattachments> <cityattachments> <code>80<item name="photo1.jpg" error="0" errormsg="OK" errormsgru="Успешно" /code> <country> <code>1</code> <item name>Россия<="photo2.jpg" error="0" errormsg="OK" errormsgru="Успешно" /name> <id>643</id> <ShortName1>RU </ShortName1attachments> <ShortName2>RUS</ShortName2addattachments> </countrysource> <name>Агинский Бурятский автономный округ</name> </city>== Получение вложений к накладной == <city>'''Пример запроса:''' <code>1</codesource lang="xml"> <country> <code>?xml version="1</code.0" encoding="UTF-8" ?> <name>Россия</nameattachments> <id>643 <auth extra="8" login="login" pass="pass" /id> <ShortName1>RU</ShortName1> <ShortName2>RUS </ShortName2orderno> </country> <name>Адыгея республика</name> 1234567</cityorderno></regionlistattachments>
</source>
== Справочник улиц =='''Описание полей:''' '''attachments''' — Корневой контейнер. Обязательный элемент.* '''auth''' — Авторизация. Обязательный элемент.* '''orderno''' — Номер/код заказа. Обязательный элемент. 
'''Пример запроса справочника улицответа:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<streetlistattachments> <conditionsitem name="doc1.docx" size="35654">JVBERi0xLjMN JUBQREYwMTIzNDU2Nzg5IDI NMyAwIG9iag08PA0vVHlwZSA U3VidHlwZSAvSW1hZ2UNL1d pZHRoIDE4MDgNL0hlaWdodCA <town>Москва город</town> // ОБЯЗАТЕЛЬНОЕ ПОЛЕ!ggNCAwIFINL0JpdHNQZXJDb 21wb25lbnQgMQ0vRGVjb2RlU <namecontains>Хохло</namecontains> ENL0NvbHVtbnMgMTgwOA0+P g0vSW1hZ2VNYXNrIHRydWUNL <namestarts>Академика Х XhEZWNvZGUNPj4Nc3RyZWFt DQ</namestartsitem> <item name>Академика Хохлова</name> <fullname>Академика Хохлова ул="photo2.</fullnamejpg" size="74861">VBERi0xLjMN </conditions>JUBQREYwMTIzNDU2Nzg5IDI NMyAwIG9iag08PA0vVHlwZSA <limit>vWE9iamVjdA0vU3VidHlwZS AvSW1hZ2UNL1dpZHRoIDEzNj <limitfrom>30</limitfrom> gNL0hlaWdodCAxMzMzDS9MZ W5ndGggNCAwIFINL0JpdHNQZ <limitcount>10</limitcount> <countall>YES</countall> XJDb21wb25lbnQgMQ0vRGVj b2RlUGFybXMgPDwNL0sgLTEN L0NvbHVtbnMgMTM2OA0+Pg0 vSW</limititem></streetlistattachments>
</source>
*'''conditions''' - Задает условия поиска. Все вложенные элементы одновременно накладывают условие "И".:* '''town''' - Обязательное поле. Название или код населенного пункта.:* '''namecontains''' - Поиск населенных пунктовВ тегах item возвращаются бинарные данные (файлы), название которых содержит указанный текст.:* '''namestarts''' - Поиск населенных пунктов, название которых начинается с указанного текста.:* '''name''' - Поиск населенных пунктов, название которых соответствует указанному тексту.:* '''fullname''' - Поиск населенных пунктов, название вместе с типом населенного пункта которых соответствует указанному текстузакодированные в base64.
*'''limit''' - Ограничивает вывод результата.== Изменение статуса агентом ==:* '''limitfrom''' - Задает номер записи результата, начиная с которой выдавать ответ. По-умолчанию - 0.:* '''limitcount'''- Задает количество записей результата, которые нужно вернуть. По-умолчанию - 10000.:* '''countall''' - YES указывает на необходимость подсчета общего количества найденных совпадений. Это может замедлять выполнение запроса. Если отключено - в ответе не указываются totalcount и totalpagesЗапрос изменения статуса заказа позволяет установить окончательный статус заказа — «Доставлен» или «Не доставлен (Возврат/Отмена)».
Кроме этого, устанавливается дата и время (при необходимости) изменения статуса, а также сообщение в поле ''Инфо о доставке'Пример ответа:'''<source lang="xml"><?xml version="1.0" encoding="UTF-8"?><streetlist count="1" page="1" totalcount="3" totalpages="1"> <street> <name>Академика Хохлова ул.</name> <shortname>Академика Хохлова</shortname> <typename>ул.</typename> </street></streetlist></source>
В ответе улицы сортируются по алфавитуПри необходимости к заказу можно прикрепить изображения.
== Справочник номенклатуры ==
'''Пример запроса справочника номенклатурыизменения статуса:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8" ?>
<itemlistsetorderinfo> <auth extra="8" login="login" pass="pass"></auth> <codesearchorder ordercode="123456"> <codemessage>123456Получил Иванов</codemessage> <articleoutstrbarcode>FD3437654312</articleoutstrbarcode> <barcode>2345625213125 </barcodeorder> </codesearchorder ordercode="234567"> <conditionsstatus> <namecontains>телевизорPICKUPREADY</namecontainsstatus> <namestartseventtime>sony2016-05-30 10:20:00</namestartseventtime> <namemessage>Sony KDL-55W905 ЖК-телевизорКлиент отказался от покупки</namemessage> <quantitypaytype>EXISTING_ONLYCASH</quantitypaytype> <storestoreprice>2123</storestoreprice> </conditionsitems> <exceptitem code="34533" quantity="1" reason="0" governmentCode="11223311" /> <item code="34456" quantity="0" reason="0" />123478 <item code="34421" quantity="2" reason="0" /code> </exceptitems> <limitimage filename="filename1.jpg">/9j/4AAQSkZJRgA <limitfrom>30< BAQAAAQABAAD/limitfrom>2wBDAA0JCg sKCA0LCgsODg0PEyAVExISEy ccHhcgLikxMC4pLSwzOko+M zZGNywtQFdBRkxOUlNSMj5aY <limitcount>10< VpQYEpRUk//limitcount>2wBDAQ4ODhMR EyYVFSZPNS01T09PT09PT09P T09PT09PT09PT09PT09PT09 PT09PT09PT09PT09PT09PT09 <countall>YES PT09PT0//wAARCAYACAADAS IA</countallimage> </limitorder></itemlistsetorderinfo>
</source>
Внутри контейнера itemlist все элементы могут как отсутствовать, так и комбинироваться. Поиск не чувствителен к регистру.
*'''codesearch''' - Поиск по кодам. В случае использования - контейнеры conditions и limit игнорируются.
:* '''code''' - Поиск по внутреннему коду системы.
:* '''article''' - Поиск по артикулу.
:* '''barcode''' - Поиск по штрих-коду.
'''Описание полей запроса статуса:''' '''setorderinfo''' — Корневой контейнер. Обязательный элемент.*'''conditionsauth''' - Задает условия поиска — Авторизация. Все вложенные элементы одновременно накладывают условие "И"Обязательный элемент.* '''order''' — Контейнер заказа. Обязательный элемент. Запрос может содержать более одного контейнера '''order'''. Атрибут '''''ordercode''''' — внутренний код заказа.:* '''namecontainsstatus''' - Поиск товаров — Новый статус заказа. Доступны статусы из раздела [[#Описание полей ответа статусов]], название которых содержит указанный тексткроме AWAITING_SYNC и NEW.* '''eventtime''' — Дата и время изменения статуса. Обязательно при указании статуса.* '''message''' — Текст сообщения ''Инфо о доставке''.:* '''namestartsoutstrbarcode''' - Поиск товаров, название которых начинается  — код у подрядчика (код заказа во внешней системе). Используется в интеграциях с указанного текставнешними системами.* '''paytype''' — Тип оплаты заказа. Допустимые значения CASH/CARD.* '''storeprice''' — Агентское вознаграждение.* '''items''' — Контейнер для описания вложений '''item''' . Атрибуты::* '''name''code''''' - Поиск товаров, название которых соответствует указанному тексту — Код вложения.:* '''''quantity''' - Наличие на складе'' — Количество доставленных единиц вложения. Принимает значения EXISTING_ONLY - Только в наличии:* '''''reason''''' — Причина недоставки, NOT_EXISTING_ONLY - Только не в наличиивыбирается из соответствующего списка статусов.:* '''''governmentCode''''' — Указание кода ТН для вложения при необходимости.* '''image''' — Контейнер прикрепляемого изображения. Содержит текст файла изображения, ALL - Всезакодированный по стандарту ''base64''. Контейнер '''order'''Это поле может быть недоступным в некоторых установках.содержать более одного контейнера '''image'''. Атрибут::* '''store''filename' - Поиск товаров по определенному складу'''' — Имя файла.
*'''except''' - Описание исключений для корректного определения количества зарезервированной номенклатуры.
:* '''code''' - Код заказа.
*'''limit''' - Ограничивает вывод результата.
:* '''limitfrom''' - Задает номер записи результата, начиная с которой выдавать ответ.
:* '''limitcount''' - Задает количество записей результата, которые нужно вернуть.
'''Пример ответа:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<itemlist countsetorderinfo> <order ordercode="3123456" totalcounterror="30" pageerrormsg="1OK" totalpageserrormsgru="1Успешно"/> <itemorder ordercode="234567" error="59" errormsg="value [date_put] is already set" errormsgru="Значение [Дата доставки] уже указано" /> <code>123456</codesetorderinfo> <article>FD343</articlesource> <barcode>2345625213125</barcode> <name>Sony KDL-55W905 ЖК-телевизор</name>== Получение документов для печати == <retprice>65000</retprice>'''Пример запроса получения печатных форм:''' <purchprice>50000</purchpricesource lang="xml"> <weight>5?xml version="1.1</weight0" encoding="UTF-8" ?> <lengthwaybill>50 <auth extra="8" login="login" pass="pass" /length> <width>30</widthorders> <height>40<order orderno="1234567" ordercode="33331" /height> <VATrate>20<order orderno="1234568" ordercode="33332" /VATrate> <CountInPallet>30 </CountInPalletorders> <HasSerialsform>1</HasSerialsform> <CountryOfOriginstart>Малайзия</CountryOfOrigin> (not yet supported) <Message>Хороший телевизор</Message> <Message2>Снова хороший телевизор</Message2> <quantity>12</quantity> <reserved>35</reservedstart> <item> ...</itemlistwaybill>
</source>
'''Описание полей:'''
*'''code''' - Внутренний идентификатор, присвоенный системой.
*'''article''' - Артикул, назначенный клиентом (поставщиком).
*'''barcode''' - Штрих-код производителя.
*'''name''' - Наименование.
*'''retprice''' - Розничная цена по-умолчанию. При оформлении заказа цена используется та, которая указана в заказе.
*'''purchprice''' - Закупочная цена.
*'''weight''' - Масса в килограммах.
*'''length''' - Длина в сантиметрах.
*'''width''' - Ширина в сантиметрах.
*'''height''' - Высота в сантиметрах.
*'''VATrate''' - Ставка НДС, целое число процентов.
*'''CountInPallet''' - Количество штук в паллете.
*'''HasSerials''' - Требует учета серийных номеров. Принимает значения 1 - да, 0 - нет.
*'''CountryOfOrigin''' - Наименование страны происхождения на русском языке.
*'''Message''' - Комментарий.
*'''Message2''' - Дополнительный комментарий.
*'''quantity''' - Количество на складе. Товары, уже собранные в заказы в этом количестве не присутствуют, считаются покинувшими товарный склад. ''Это поле может быть недоступным в некоторых установках.''
*'''reserved''' - Количество зарезервированного товара. Может превышать остаток на складе, если покупатели ждут следующей поставки. ''Это поле может быть недоступным в некоторых установках.''
'''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" ?><itemmovementswaybill> <auth extra="8" login="login" pass="pass"content><EODIcaI8KSBlwQ 4MnEOR7Px8U8EBAyGICBnwpw IZhQgz0ZxuPs8EBM/auth>GcbjzB AwhBl8hwQYIO00GmEwg1CeEG mqYTChNU0wqf8l8nz4zgc+K fCno+zwU5GjOZmzXGcbEQYIM 4zkegRE40zWzONyoNNMIOIa cWnp6aDCGEGE9NQmoQd2mg00 <code>4259< 79U4f3hPTwnfp6Sdrafeqpa JDpFw/code>1aYT077VNNNdO00G3q <datefrom>2020-10-01< mqqvp9p2E7T0/datefrom> <dateto>2020-10-02wiFemv8uG6 OM</datetocontent></itemmovementswaybill>
</source>
*'''code''' - внутренний код товара В тэге content возвращаются бинарные данные (файл pdf), закодированные в справочнике номенклатурыbase64.*'''datefrom''' - дата начала периода.При записи в файл необходимо использовать двоичный формат записи!  *'''datetoОбратите внимание''' - дата окончания периода.Может быть указан или код, или период, или код и период одновременночто печатные формы для заборов не формируются.
'''Пример ответа движения номенклатурыс ошибкой:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8" ?><itemmovements count="16"waybill> <itemmovement> <codeerror>151500Текст ошибки</codeerror> <date>2017-05-26</datewaybill> <retprice>0</retpricesource> == Справочник городов =='''Пример запроса справочника городов:'''<quantity>1</quantitysource lang="xml"> <delivered>?xml version="1.0</delivered" encoding="UTF-8"?> <itemtownlist> <code>4259 <auth extra="8" /code> <namecodesearch>Настольная игра Дженга </namezipcode> 110000</itemzipcode> <status> <codekladrcode>50100000100800</codekladrcode> <namefiascode>Возврат от покупателяbd21979d-46f8-49d0-9105-e8d65172a983</name> </statusfiascode> <store> <code>1123</code> <name>офис в Москве </namecodesearch> </storeconditions> <ordercity> <ordercode>3374830Краснодарский край</ordercodecity> <numbernamecontains>123660-0новгород</numbernamecontains> <datenamecontainsparts>2017-05-24молоково моск</datenamecontainsparts> <ordernonamestarts>14123Моск</ordernonamestarts> <barcodename>0000000670Москва</barcodename> <companyfullname>ТОВАРМосква город</companyfullname> <addresscountry>Кравченко ул., 1</addresscountry> <delivereddate>2017-05-29 </delivereddateconditions> <deliveredtime>12:00:00 </deliveredtimelimit> <deliveredto /limitfrom> 30</orderlimitfrom> <documentlimitcount> <code>2199110</codelimitcount> <numbercountall>318</number> <date>2017-05-26</date> <message></message> YES</documentcountall> </itemmovementslimit></itemlisttownlist></source>
''' Описание полей ответа '''*'''code''' - внутренний код операции движения*'''date''' - дата операции*'''retprice''' - цена товара*'''quantity''' - количество товара операции*'''delivered''' - количество доставленного товараВнутри контейнера townlist все элементы могут как отсутствовать, так и комбинироваться. Поиск не чувствителен к регистру.
*'''itemauth''' - контейнер товара:* '''code''' - внутренний код товара:* '''name''' - наименование товара — Авторизация, необязательный элемент. Используется в случае включенного и настроенного ограничения по населенным пунктам в конкретной курьерской службе.
*'''statuscodesearch'''  — Поиск по кодам. В случае использования — контейнеры conditions и limit игнорируются.:* '''zipcode''' — Поиск по индексу. Обратите внимание на то, что один почтовый индекс может распространяться на несколько населенных пунктов. В этом случае система вернет несколько записей.:* '''kladrcode''' — Поиск по 13- контейнер статуса операциити значному коду КЛАДР.:* '''codefiascode''' - код статуса — Поиск по коду ФИАС (AOGUID).:* '''namecode''' - наименование — Поиск по коду в системе.
*'''storeconditions''' - контейнер филиала — Задает условия поиска. Все вложенные элементы одновременно накладывают условие «И».:* '''city''' — Поиск по всем населенным пунктам региона.:* '''namecontainsparts''' — Поиск населенных пунктов, название которых содержит все указанные слова, с разбиением поисковой фразы через пробел. Например "моск моло" найдет деревню "Молоково" в Московской области.:* '''namecontains''' — Поиск населенных пунктов, к которому относится операцияназвание которых содержит указанный текст.:* '''codenamestarts''' - код филиала — Поиск населенных пунктов, название которых начинается с указанного текста.:* '''name'''  — Поиск населенных пунктов, название которых соответствует указанному тексту.:* '''fullname''' — Поиск населенных пунктов, название вместе с типом населенного пункта которых соответствует указанному тексту.:* '''country''' — Поиск только по стране с указанным внутренним кодом или текстовым кодом в соответствии [https://ru.wikipedia.org/wiki/ISO_3166- наименование филиала1 стандартом ISO_3166-1], например, «RU», «RUS» для России.
*'''orderlimit''' - контейнер корреспонденции — Ограничивает вывод результата.:* '''ordercode''' - внутренний код заказа:* 'limitfrom''number''' -  — Задает номер заказа:* '''date''' записи результата, начиная с которой выдавать ответ. По- дата заказаумолчанию — 0.:* '''ordernolimitcount''' - шифр:* '''barcode''' Задает количество записей результата, которые нужно вернуть. По- штрих-кодумолчанию — 10000.:* '''companycountall''' - компания:* '''address''' - адрес:* '''delivereddate''' - дата вручения:* '''deliveredtime''' - время вручения:* '''deliveredto''' - данные о вручении, либо причина недоставки — YES указывает на необходимость подсчета общего количества найденных совпадений. Это может замедлять выполнение запроса. Если отключено — в ответе не указываются totalcount и totalpages.
*'''document''' - контейнер документа операции:* '''code''' - внутренний код документа:* '''number''' - номер документа:* '''extnumber''' - внешний номер документаПример ответа:* '''date''' - дата документа:* '''message''' - комментарий == Получение справочника тарифов по городам == '''Пример запроса справочника тарифов по городам'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<tariffs> <auth extratownlist count="3" page="81" logintotalcount="login3" passtotalpages="pass1" /> <town> <townfromcode>Москва26379</townfromcode> <city> <servicecode>123</servicecode> <mainonlyname>1Краснодарский край</mainonlyname> </tariffscity> </sourcename*'''auth''' — атрибут '''extra''' обязателен, по нему определяется курьерская служба.*'''townfrom''' — Сочи город-отправитель. Если не передан, то городом будет «Москва».*'''service''' — режим доставки. Обязательный элемент.*'''mainonly''' — необязательный элемент. Если передан, то в ответе будут данные только по городам из справочника '''Межгород''' </name> '''Зоны'''.  '''Пример ответа справочника тарифов по городам''' <source lang="json"fiascode>{ "townfrom": "0c5b244479da737a-70a0603b-49324c19-980c9b54-b4dc0d3f02b5",9114c96fb912</fiascode> "service": 1,<kladrcode>2300000700000</kladrcode> "tariffs": [<shortname /> (not yet supported) { <typename /> (not yet supported) <coords lat="towntofias43.5855": lon="7339e834-2cb4-4734-a4c7-1fca2c66e56239.7231",/> "towntocode": "482", </town> "towntoname": "Уфа город", <town> "pricesnew": { <code>40331</code> "before": [ <city> { <code>32</code> "price": "100", <name>Брянская область</name> "every": "0", </city> "mass": "1" <name>Сочилов хутор</name> }, <fiascode>c9c96c67-2cc9-4f10-afde-fd32417ea216</fiascode> { <kladrcode>3201900011100</kladrcode> "price": "200", <shortname /> "every": "1", <typename /> <coords lat="mass52.6407": lon="2" } ], "after": [ { "price": "300", "every": "1", "mass": "3" } ] }, "prices": { "before": { "mass": "3", "price": "20233.51724"/> }, </town> "after": { <town> "mass": "3", <code>114016</code> "every": "1", <city> "price": "18.75" } <code>60</code> }, "deliveryPeriodMin": 4, "deliveryPeriodMax": 5 } <name>Псковская область</name> ]}</city> <name>Сочихино деревня</sourcename''' Описание полей ответа '''* '''townfrom''' — код ФИАС города <fiascode>10df7588-19c1-отправителя.* '''service''' — режим доставки.*'''tariffs''' — cписок тарифов по городу.:* '''towntofias''' — код ФИАС города49d1-получателя.:* '''towntocode''' — внутренний код городаa387-получателя.9de1cf3eb26f</fiascode>:* '''towntoname''' — наименование города-получателя. <kladrcode>6001900015400</kladrcode>:* '''pricesnew''' — ваши настройки тарифов из справочника '''Межгород''' <shortname /> '''Тарифы по зонам'''.::* '''price''' — цена. <typename />::* '''every''' — за каждые <coords lat="56.::* '''mass''' — масса6003" lon="29.3542" />:* '''prices''' — устаревший элемент, не используется. </town>:* '''deliveryPeriodMin''' — минимальный срок доставки.</townlist>:* '''deliveryPeriodMax''' — максимальный срок доставки.</source>
== Номенклатура приходной накладной ==В ответе города сортируются по популярности, важности (районные центры и т. д.), и только затем — по алфавиту.
== Справочник регионов =='''Пример запроса номенклатуры приходной накладнойсправочника:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8" ?><itemdocregionlist> <auth extra="8" login="login" pass="pass"codesearch> <code>77</code> </codesearch> <conditions> <namecontains>край</namecontains> <namestarts>Моск</namestarts> <fullname>Московская область</authfullname> <codecountry>RU</country>21991 </codeconditions></itemdocregionlist>
</source>
*'''code''' - внутренний код документа приходной накладной (см. предыдущий запрос).  '''Пример ответа движения номенклатуры:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8" ?><itemdocregionlist count="2"> <city> <code>2199180</code> <country> <code>1</code> <name>Россия</name> <id>643</id> <numberShortName1>318RU</numberShortName1> <ShortName2>RUS<date/ShortName2>2017-05-26 </datecountry> <name>Агинский Бурятский автономный округ<message/name> </messagecity> <itemscity> <code>1</code> <item country> <code="4259" quantity=">1" barcode="200300" article="123555"</code> <name>Россия</name> <id>643</id> <ShortName1>RU</ShortName1> <ShortName2>RUS</ShortName2> </country> <name>Настольная игра ДженгаАдыгея республика</itemname> </itemscity></itemdocregionlist></source>
''' Описание полей ответа '''* '''code''' - внутренний код приходной накладной* '''number''' - номер документа* '''date''' - дата документа* '''message''' - комментарий *'''item''' - контейнер товара:* '''code''' - внутренний код товара:* '''barcode''' - штрих-код товара:* '''article''' - артикул товара:* '''quantity''' - количество поступившего товара == Справочник филиалов улиц == '''Пример запроса списка филиаловсправочника улиц:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8" ?><storeliststreetlist> <auth extra="8"conditions> <town>Москва город</town> // ОБЯЗАТЕЛЬНОЕ ПОЛЕ! <namecontains>Хохло</namecontains> <namestarts>Академика Х</namestarts> <name>Академика Хохлова</name> <fullname>Академика Хохлова ул.</fullname> </conditions> <limit> <limitfrom>30</authlimitfrom> <jsonlimitcount>YES10</jsonlimitcount> <countall>YES<client_code/countall>7890 </client_codelimit></storeliststreetlist>
</source>
*'''authconditions''' - Атрибут  — Задает условия поиска. Все вложенные элементы одновременно накладывают условие «И».:* '''town''' — Обязательное поле. Название или код населенного пункта.:* '''namecontains''' — Поиск улиц, название которых содержит указанный текст.:* '''namestarts''' — Поиск улиц, название которых начинается с указанного текста.:* '''name''' — Поиск улиц, название которых соответствует указанному тексту.:* '''extrafullname''' - обязателен — Поиск улиц, по нему определяется курьерская службадля которых название вместе с типом соответствует указанному тексту. * '''limit''' — Ограничивает вывод результата.:*'''jsonlimitfrom'''  — Задает номер записи результата, начиная с которой выдавать ответ. По- Признак вывода ответа в виде JSON YES/NOумолчанию — 0.:*'''client_codelimitcount''' - Код клиента курьерской службыЗадает количество записей результата, которые нужно вернуть. По-умолчанию — 10000.:* '''countall''' — YES указывает на необходимость подсчета общего количества найденных совпадений. Это может замедлять выполнение запроса. Если отключено, в ответе не указываются totalcount и totalpages.
'''Пример ответа:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8" ?><storelist streetlist count="21" page="1" totalcount="3" totalpages="1"> <storestreet> <code>123124</code> <name>ABCАкадемика Хохлова ул.</name> </storeshortname> <store> <code>456Академика Хохлова</codeshortname> <nametypename>Филиал 2ул.</nametypename> </storestreet></storeliststreetlist>
</source>
*'''code''' - Код филиала. *'''name''' - Наименование филиалаВ ответе улицы сортируются по алфавиту.
== Справочник пунктов самовывоза номенклатуры == Для отображения списка пунктов выдачи (ПВЗ) есть '''готовый JavaScript модуль''': https://home.courierexe.ru/js/measoft_map.js Инструкция по использованию - внутри. Посмотреть пример работы можно [https://home.courierexe.ru/pvz_test.html Здесь] '''Пример запроса пунктов самовывозасправочника номенклатуры:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8" ?>
<pvzlistitemlist> <auth extra="8" login="login" pass="pass"></auth> <codesearch> <code>1234123456</code> <client_codearticle>7890FD343</client_codearticle> <townbarcode>Нижний Тагил2345625213125</townbarcode> <parentcode>6 </parentcodecodesearch> <acceptcash>YES </acceptcashconditions> <acceptcardnamecontains>YESтелевизор</acceptcardnamecontains> <acceptfittingnamestarts>YESsony</acceptfittingnamestarts> <maxweightname>30Sony KDL-55W905 ЖК-телевизор</maxweightname> <acceptindividualsquantity>YESEXISTING_ONLY</acceptindividualsquantity> <ltstore>57.9247372</ltstore> <lg>59.940019 </lgconditions> <rt>57.905682</rtexcept> <rgcode>59.984669123478</rgcode> <json>YES </jsonexcept> <limit> <limitfrom>30</limitfrom> <limitcount>210</limitcount> <countall>YES</countall> </limit></pvzlistitemlist>
</source>
*'''auth''' - Атрибут '''extra''' - обязателен, по нему определяется курьерская служба, '''login''' и '''pass''' позволяют авторизоваться под клиентом: для отдельного клиента Внутри контейнера itemlist все элементы могут быть ограничения по доступности некоторых ПВЗкак отсутствовать, так и в этом случае они будут учтеныкомбинироваться. Поиск не чувствителен к регистру.*'''codecodesearch''' - Внутренний код — Поиск по кодам. В случае использования — контейнеры conditions и limit игнорируются.:*'''client_codecode''' - Код клиента курьерской службы — Поиск по внутреннему коду системы.:*'''townarticle''' - Город получателя — Поиск по артикулу.:*'''parentcodebarcode''' - Фильтр  — Поиск по родительскому [[#Справочник филиалов|филиалу]]штрихкоду.*'''acceptcash''' - Фильтр по приему наличных YES/NO*'''acceptcardconditions''' - Фильтр по приему банковских карт YES/NO — Задает условия поиска. Все вложенные элементы одновременно накладывают условие «И».:*'''acceptfittingnamecontains''' - Фильтр по наличию примерки YES/NO — Поиск товаров, название которых содержит указанный текст.:*'''maxweightnamestarts''' - Фильтр по максимальному весу — Поиск товаров, название которых начинается с которым работает ПВЗуказанного текста.:*'''acceptindividualsname''' - Фильтр по доступности физическим лицам YES/NO*'''lt''' - Широта левого верхнего угла*'''lg''' - Долгота левого верхнего угла*'''rt''' - Широта правого нижнего угла*'''rg''' - Долгота правого нижнего угла*'''json''' - Признак вывода ответа в виде JSON YES/NO*'''limit''' - Ограничивает вывод результата — Поиск товаров, название которых соответствует указанному тексту.:* '''limitfromquantity''' - Задает номер записи результата — Наличие на складе. Принимает значения EXISTING_ONLY — Только в наличии, NOT_EXISTING_ONLY — Только не в наличии, начиная с которой выдавать ответALL — Все. По-умолчанию - 0.:* '''limitcountЭто поле может быть недоступным в некоторых установках.'''- Задает количество записей результата, которые нужно вернуть. По-умолчанию - 100.:* '''countallstore''' - YES указывает на необходимость подсчета общего количества найденных совпадений. Это может замедлять выполнение запроса. Если отключено - в ответе не указываeтся totalcount — Поиск товаров по определенному складу.
* '''except''' — Описание исключений для корректного определения количества зарезервированной номенклатуры.
:* '''code''' — Код заказа.
* '''limit''' — Ограничивает вывод результата.:* '''limitfrom''' — Задает номер записи результата, начиная с которой выдавать ответ.:* '''limitcount''' — Задает количество записей результата, которые нужно вернуть. '''Пример ответа справочника пунктов самовывоза:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8" ?><pvzlist itemlist count="23" totalcount="40465"> <pvz> <code>126</code> <clientcode>3</clientcode> <name>Нижний Тагил</name> <parentcode>6</parentcode> <parentname>Интеграция</parentname> <town code="124267" regioncodepage="661" regionnametotalpages="Свердловская область1">Нижний Тагил город</town> <address>622036, г. Нижний Тагил, ул. Циолковского, д. 17</addressitem> <phonecode>+73435417709, +73435254989123456</phonecode> <commentarticle>Новый пункт доставкиFD343</commentarticle> <worktimebarcode>Вс 10:00-16:00, Сб 10:00-16:00, Пн-Пт 10:00-20:002345625213125</worktimebarcode> <traveldescriptionname>Жилое 5Sony KDL-ти этажное здание, торцом к дороге, второе здание от перекрестка Пархоменко55W905 ЖК-Циолковскоготелевизор</traveldescriptionname> <maxweightretprice>1065000</maxweightretprice> <acceptcashpurchprice>YES50000</acceptcashpurchprice> <acceptcardweight>YES</acceptcard> <acceptfitting>YES</acceptfitting> <acceptindividuals>YES</acceptindividuals> <latitude>57.93457</latitude> <longitude>595.951311</longitudeweight> <uidlength>40606d00-9c51-11eb-b2c9-cfd6c111139250</uid> </pvz> <pvzlength> <codewidth>24530</codewidth> <clientcodeheight>NTG140</clientcodeheight> <nameVATrate>На Красноармейской20</nameVATrate> <parentcodeCountInPallet>630</parentcodeCountInPallet> <parentnameCountInBox>Интеграция2</parentnameCountInBox> <town code="124267" regioncode="66" regionname="Свердловская область"HasSerials>Нижний Тагил город1</townHasSerials> <addressCountryOfOrigin>КРАСНОАРМЕЙСКАЯ, д.79Малайзия</addressCountryOfOrigin> <phone>+7 (3435not yet supported)379-044</phone> <commentMessage>Возможность примерки отсутствуетХороший телевизор</commentMessage> <worktimeMessage2>Вс 10:00-16:00, Сб 10:00-16:00, Пн-Пт 10:00-20:00Снова хороший телевизор</worktimeMessage2> <traveldescriptionquantity>Напротив ТЦ Пирамида12</traveldescriptionquantity> <maxweightreserved>203</maxweightreserved> <acceptcash>YES </acceptcashitem> <acceptcard>YES</acceptcard> <acceptfitting>NO</acceptfitting> <acceptindividuals>YES</acceptindividuals> <latitude>57 ..93468</latitude> <longitude>60.55476</longitude> <uid>41116853-9c51-11eb-b2c9-cfd6c1451392</uid> </pvz></pvzlistitemlist></source>
*'''codeОписание полей:''' - Код ПВЗ в системе. Используется в запросе [[API#Оформление заказа|оформления заказов]]*'''clientcodecode''' - Код ПВЗ используемый компанией-подрядчиком — Внутренний идентификатор, присвоенный системой.*'''namearticle''' - Наименование ПВЗ — Артикул, назначенный клиентом (поставщиком).*'''parentcodebarcode''' - Код родительского элемента — Штрихкод производителя.*'''parentnamename''' -  — Наименование родительского элемента.*'''townretprice'''  — Розничная цена по- Населенный пункт с кодом из [[#Справочник городов|справочника городов]]умолчанию. При оформлении заказа цена используется та, а также с кодом и наименованием регионакоторая указана в заказе.*'''addresspurchprice''' - Адрес ПВЗ — Закупочная цена.*'''phoneweight''' - Телефоны ПВЗ — Масса в килограммах.*'''commentlength''' - Дополнительная информация — Длина в сантиметрах.*'''worktimewidth''' - Режим работы ПВЗ — Ширина в сантиметрах.*'''traveldescriptionheight''' - Описание местонахождения ПВЗ или пути к нему — Высота в сантиметрах.*'''maxweightVATrate''' - Максимальный вес — Ставка НДС, с которым работает ПВЗцелое число процентов.*'''acceptcashCountInPallet''' - Признак приема наличных — Количество штук в паллете.*'''acceptcardCountInBox''' - Признак приема банковских карт — Количество штук в упаковке.*'''acceptfittingHasSerials''' - Наличие примерки — Требует учета серийных номеров. Принимает значения 1 — да, 0 — нет.*'''latitudeCountryOfOrigin''' - Широта — Наименование страны происхождения на русском языке.*'''longitudeMessage''' - Долгота — Комментарий.*'''uidMessage2''' - Уникальный идентификатор ПВЗ в системе Measoft — Дополнительный комментарий.*'''countquantity''' -  — Количество записей на складе. Товары, уже собранные в заказы в этом количестве не присутствуют, считаются покинувшими товарный склад. ''Это поле может быть недоступным в ответенекоторых установках.''*'''totalcountreserved''' - Общее количество записей — Количество зарезервированного товара. Может превышать остаток на складе, отвечающее параметрам запросаесли покупатели ждут следующей поставки. ''Это поле может быть недоступным в некоторых установках.''
== Получение фискальных данных заказа Движение номенклатуры == '''Пример запроса получения фискальных данныхдвижения номенклатуры:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?><receiptdataitemmovements> <auth extra="8" login="testlogin" pass="testmpass" ></auth> <orderscode>4259</code> <datefrom>2020-10-01<order orderno="123456" /datefrom> <dateto>2020-10-02<order orderno="890111C" /dateto> </ordersitemmovements></receiptdatasource>
* '''code''' — внутренний код товара в справочнике номенклатуры.
* '''datefrom''' — дата начала периода.
* '''dateto''' — дата окончания периода.
Может быть указан или код, или период, или код и период одновременно.
</source>
'''Пример ответа получения фискальных данныхдвижения номенклатуры:'''
<source lang="xml">
  <?xml version="1.0" encoding="UTF-8"?><receipts itemmovements count="116"> <receiptitemmovement> <ordernocode>123456151500</ordernocode> <fdDatetimedate>20202017-0605-07 12:14:0026</fdDatetimedate> <fdValueretprice>1230</fdValueretprice> <fdNumquantity>4561</fdNumquantity> <fnSndelivered>7890</fnSndelivered> <item> <kktNumcode>1004259</kktNumcode> <innname>222Настольная игра Дженга</innname> </item> <status> <ofdUrlcode>gate.ofd.ru5</ofdUrlcode> <fullUrlname>https:Возврат от покупателя</name> </check.ofd.ru/123status> <store> <code>1</fullUrlcode> <pricename>12345офис в Москве</pricename> <lines count="1"/store> <lineorder> <itemordercode>11117643374830</itemordercode> <namenumber>Сапоги123660-0</namenumber> <qtydate>12017-05-24</qtydate> <priceorderno>100014123</priceorderno> <vatRatebarcode>200000000670</vatRatebarcode> <governmentCodecompany>Z16513LK2ТОВАР</governmentCodecompany> <itemTypeaddress>Кравченко ул., 1</itemTypeaddress> <delivereddate>2017-05-29</linedelivereddate> <deliveredtime>12:00:00</linesdeliveredtime> <deliveredto /receipt> </receiptsorder> <document> <code>21991</sourcecode> <number>318</number>Параметры ответа:*'''orderno''' <date>2017- Номер заказа*'''fdDatetime''' 05- Дата и время пробития фискального чека*'''fdValue''' - ФПД (фискальный признак документа)*'''fdNum''' - ФИСКАЛЬНЫЙ ДОКУМЕНТ (фискальный номер чека)*'''fnSn''' - ФН (номер фискального накопителя)*'''kktNum''' - РН (регистрационный номер кассы)*'''inn''' - ИНН*'''ofdUrl''' - URL адрес (доменное имя) ОФД*'''price''' - Сумма чека*'''fullUrl''' - URL чека для просмотра онлайн*'''lines''' - Позиции чека:*'''item''' - код товара:*'''name''' - наименование товара:*'''qty''' - количество товара:*'''price''' - цена товара:*'''governmentCode''' - считанная последовательность, которая в дальнейшем преобразуется по алгоритму тега 1162:*'''vatRate''' - НДС товара:*'''itemType''' - тип товара (товар, доставка и т.д.) == Справочник Видов срочности == '''Пример запроса Видов срочности:'''26</date> <source lang="xml"message><?xml version="1.0" encoding="UTF-8" ?/message> <services/document> <auth extra="8"/itemmovements></servicesitemlist>
</source>
'''Пример Описание полей ответа справочника Видов срочности:'''<source lang="xml">* '''code''' — внутренний код операции движения<?xml version="1.0" encoding="UTF-8" ?>* '''date''' — дата операции<services count="2">* '''retprice''' — цена товара <service>* '''quantity''' — количество товара операции <code>1</code>* '''delivered''' — количество доставленного товара <name>Эконом</name> </service>* '''item''' — контейнер товара <service> <:* '''code>2</code>''' — внутренний код товара <:* '''name>Срочно</name> </service></services></source>''' — наименование товара
* '''status''' — контейнер статуса операции
:* '''code''' — код статуса
:* '''name''' — наименование
== Справочник дополнительных услуг ==* '''store''' — контейнер филиала, к которому относится операция:* '''code''' — код филиала:* '''name''' — наименование филиала
* '''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"?>
<advpricestariffs> <auth extra="8" login="login" pass="pass" /> <townfrom>Москва</townfrom> <service>1</service> <visiblemainonly>NO1</visiblemainonly> </advpricestariffs>
</source>
* '''auth''' — атрибут '''extra''' обязателен, по нему определяется курьерская служба.* '''advpricestownfrom'''  — город- Корневой контейнеротправитель. Если не передан, то городом будет «Москва».* '''service''' — режим доставки. Обязательный элемент. *'''visiblemainonly''' — необязательный элемент. Если передан, то в ответе будут данные только по городам из справочника ''' - Признак возврата Межгород''' > '''толькоЗоны''' тех услуг, что доступны для отображения в ЛК YES/NO. Необязательный элемент. По-умолчанию NO 
'''Пример ответа справочника дополнительных услуг:тарифов по городам'''<source lang="xmljson"><?xml version={ "townfrom": "0c5b2444-70a0-4932-980c-b4dc0d3f02b5", "service": 1, "tariffs": [ { "towntofias": "0c5b2444-70a0-4932-980c-b4dc0d3f02b5", "towntocode": 1, "towntoname": "Москва город", "townregion": "Город Москва", "distance": 0, "pricedistance": 0, "pricesnew": { "before": [ { "price": 100, "every": 0, "mass": 1. }, { "price": 150, "every": 0, " encoding=mass": 5 } ], "UTF-8after" ?>: [<advprices> { <advprice> "price": 0, <code> "every": 1</code>, <name>Этажей в доме</name> "mass": 38.01 <type>int</type> }, </advprice> { <advprice> "price": 15, <code>2</code> "every": 1, <name>Коэффициент надбавки</name> "mass": 51.01 <type>float</type> } </advprice> ] <advprice> }, <code>3</code> "deliveryPeriodMin": 1, <name>Расписаться на упаковке</name> "deliveryPeriodMax": 2 <type>bool</type> } </advprice> ]</advprices>}
</source>
Параметры''' Описание полей ответа '''* '''townfrom''' — код ФИАС города-отправителя.* '''service''' — режим доставки.* '''tariffs''' — cписок тарифов по городу.:* '''townregion''' — регион города-получателя.:*'''codetowntofias'''  — код ФИАС города- получателя.:* '''towntocode''' — внутренний код услугигорода-получателя.:*'''nametowntoname'''  — наименование города- наименование услугиполучателя. Если поле "название :* '''distance''' — дистанция в ЛК" км до города от МКАД, если в настройках услуги не пустозапросе townfrom — Москва.:* '''pricedistance''' — сумма за километраж до города от МКАД, то возвращает значение поля "название если в ЛК"запросе townfrom — Москва.:* '''pricesnew''' — ваши настройки тарифов из справочника '''Межгород''' > '''Тарифы по зонам'''.::*'''hinebefore/after''' - подсказка  — контейнеры ДО/ОТ.:::* '''price''' — цена. Если ответ идет по доп услуге для пользователя«before», то в цену также плюсуется сумма pricedistance:::*'''typeevery''' - тип услуги — за каждые. Может иметь значения:::* '''mass''' — масса.:*'''boolprices''' - для услуг вида "чекбокс" — устаревший элемент, "Да"не используется.:*'''floatdeliveryPeriodMin''' - для числа с плавающей точкой — минимальный срок доставки.:*'''intdeliveryPeriodMax''' - для целого числа — максимальный срок доставки.
== Расчет стоимости доставки Номенклатура приходной накладной == '''Пример запроса стоимости доставкиноменклатуры приходной накладной:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8" ?>
<calculatoritemdoc> <auth extra="8" login="login" pass="pass" ></auth> <code>21991<calc pricetype="CLIENT" townfrom="Москва" addressfrom="Ленинский проспект, 95" zipcode="664000" townto="3800000300000" addressto="Ленина ул., 10" pvz="123" l="10" w="20" h="30" mass="3.7" service="1" price="1200" inshprice="1200" paytype="CASH" /code></calculatoritemdoc>
</source>
Параметры:*'''pricetypecode''' - тип требуемой цены. Возможные значения: "CLIENT"  — внутренний код документа приходной накладной (по-умолчанию) - цена для клиента. "CUSTOMER" - цена для конечного получателясм. (пока не поддерживаетсяпредыдущий запрос)*'''townfrom''' - Город отправления*'''addressfrom''' - Адрес отправления*'''zipcode''' - Почтовый индекс города назначения*'''townto''' - Город назначения*'''addressto''' - Адрес назначения*'''pvz''' - Код пункта самовывоза по справочнику*'''l''' - Длина в сантиметрах (не обязательный параметр)*'''w''' - Ширина в сантиметрах (не обязательный параметр)*'''h''' - Высота в сантиметрах (не обязательный параметр)*'''mass''' - Масса в килограммах*'''service''' - Режим доставки - число, указывающее на запись в справочнике [[#Справочник Видов срочности|видов срочности]]. Если этот параметр опустить, система выдаст расчет для всех доступных видов срочности, передав много контейнеров <calc> в ответе.*'''price''' - Сумма наложенного платежа*'''inshprice''' - Сумма объявленной ценности*'''paytype''' - Тип оплаты
Суммы НП и ОЦ, а также тип оплаты CARD имеют значение при настроенных в тарифе на вкладке Прочее долях (в процентах) от данных сумм.
В авторизации можно опустить параметры login и pass, тогда расчет будет производиться по стандартному тарифу курьерской службы, без учета возможных отличий для конкретного клиента.<br>Объемный вес будет учитываться только при условии указания всех габаритов: длины, ширины и высоты.<br>В полях город-отправитель и город-получатель можно указывать название города (не рекомендуется!), либо код города из нашего справочника, либо 13-ти значный код КЛАДР, либо 36-ти значный код адресной системы ФИАС (AOID).  '''Пример ответа стоимости доставкидвижения номенклатуры:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?><calculatoritemdoc> <calc> <townfrom code="1">Москва город21991</townfrom> <townto code="56603">Иркутск город</townto> <massnumber>3.7318</massnumber> <service name="Экспресс"date>12017-05-26</servicedate> <zonemessage>2</zonemessage> <price>1163</priceitems> <mindeliverydays>item code="4259" quantity="1</mindeliverydays> <maxdeliverydays>3</maxdeliverydays> <mindeliverydate" barcode="200300" article="123555">2020-05-13Настольная игра Дженга</mindeliverydateitem> </calcitems></calculatoritemdoc>
</source>
Параметры:*'''townfrom''Описание полей ответа ' - Город-отправитель так, как система его распознала и привязала к справочнику. Атрибут '''code''' - код из справочника городов системы.*'''townto''' - Город-получатель так, как система его распознала и привязала к справочнику. Атрибут '''code''' -  — внутренний код из справочника городов системы.*'''mass''' - Масса в килограммахприходной накладной*'''servicenumber''' - Режим доставки - число, указывающее на запись в справочнике видов срочности (см описание на этой странице).*'''zone''' -  — номер тарифной зоны, по которой рассчиталась стоимость. В зависимости от зоны выбирается тарифная сетка. Так же к цене могут применяться повышающие или понижающие коэффициенты при доставке не из/в региональный центр.документа*'''pricedate''' - рассчитанная стоимость доставки в валюте прайс-листа курьерской службы. Рекомендуется к использованию в отличие от одноименного атрибута родительского контейнера.*'''maxdeliverydays''' - максимальный срок доставки в рабочих днях. — дата документа*'''mindeliverydatemessage''' - минимальная дата доставки в учетом выходных дней.  — комментарий
* '''item''Обратите внимание' — контейнер товара:* '''code''' — внутренний код товара:* '''barcode''' — штрихкод товара:* '''article''' — артикул товара:* '''quantity''' В реальном ответе сервера в теге calc присутствует атрибут "price". Он оставлен для обратной совместимости, не используйте его. Пользуйтесь вложенным тегом price. — количество поступившего товара
== Получение информации о клиенте Справочник филиалов == '''Пример запроса получения информации о клиентесписка филиалов:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8" ?>
<clientstorelist> <auth extra="8" login="test" pass="testm" ></auth> <json>YES</json> <client_code>7890</client_code> </clientstorelist>
</source>
* '''clientauth''' - Корневой контейнер. Обязательный элемент. — Атрибут '''extra''' — обязателен, по нему определяется курьерская служба*'''authjson''' — Признак вывода ответа в виде JSON YES/NO* '''client_code''' - Авторизация. Обязательный элемент. — Код клиента курьерской службы
'''Пример ответа на запрос получения информации о клиенте:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8" ?>
<clientstorelist count="2"> <store> <code>123</code> <name>ABC</name> </store> <store> <code>1082456</code> <name>Филиал 2</name> </store></clientstorelist>
</source>
*'''code''' -  — Код клиентафилиала.* '''name''' — Наименование филиала. == Справочник пунктов самовывоза ==Для отображения списка пунктов выдачи (ПВЗ) есть '''готовый JavaScript модуль''': https://home.courierexe.ru/js/measoft_map.js Инструкция по использованию — внутри. Посмотреть пример работы можно [https://home.courierexe.ru/pvz_test.html Здесь] Уникальные запросы списка ПВЗ кешируются на стороне личного кабинета и хранятся до 7 часов утра по московскому времени следующего дня. Например, если уникальный запрос с массой 2 кг был отправлен сегодня в 10 часов, то завтра в 7 утра он сбросится. Если сегодня в 18 часов в этом же запросе вы укажете массу 2 кг, в ответе вернется тот же список ПВЗ. Если передадите массу 3 кг, список может быть другим.
== Список актов передачи денег ==Обратите внимание, что если в выборке количество ПВЗ больше '''10000''' и не указаны параметры '''code''', '''json''' или '''limitcount''', то будет возвращаться ошибка. В этом случае необходимо использовать блок '''limit'''.
'''Пример запроса списка актов передачи денегпунктов самовывоза:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8" ?>
<smalistpvzlist> <auth extra="8" login="login" pass="pass" ></auth> <code>1234</code> <client_code>7890</client_code> <city>Свердловская область</city> <town regioncode="66" country="RU">Нижний Тагил</town> <address>Щёлковское шоссе</address> <house>77</house> <parentcode>6</parentcode> <acceptcash>YES</acceptcash> <acceptcard>YES</acceptcard> <acceptfitting>YES</acceptfitting> <datefrommaxweight>2016-02-1030</datefrommaxweight> <datetoacceptindividuals>2016-03-10YES</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> </datetolimit></smalistpvzlist>
</source>
* '''auth''' — Атрибут '''extra''' — обязателен, по нему определяется курьерская служба, '''login''' и '''smalistpass''' - Корневой контейнерпозволяют авторизоваться под клиентом: для отдельного клиента могут быть ограничения по доступности некоторых ПВЗ, и в этом случае они будут учтены. Обязательный элемент* '''code''' — Внутренний код.*'''authclient_code''' - Авторизация. Обязательный элемент — Код клиента курьерской службы.*'''datefromcity''' - Дата "с" — Регион получателя. Необязательный элементМожно указать код региона или полное наименование региона из [[#Справочник регионов|справочника регионов]].*'''datetotown''' - Дата "по" — Город получателя. Необязательный элементДля тега города '''town''' можно указать код региона в атрибуте '''''regioncode''''' из [[#Справочник регионов|справочника регионов]].Если интервал дат не указан, то возвращаются акты передачи денег за последний месяцПоиск будет производиться в указанном регионе.
Также можно указать страну получателя в атрибуте '''Пример ответа на запрос списка актов передачи денег:''country'''''<source lang="xml"><?xml version="1.0" encoding="UTF-8"?><smalist count="1"> <sma> <code>6278<в соответствии с [https:/code> <number>3992</number> <actdate>2016-02-12<ru.wikipedia.org/actdate> <datepay><wiki/datepay> <dateto>2016ISO_3166-021 стандартом ISO_3166-12</dateto> <promiseddatepay></promiseddatepay> <price>637.00</price> <pricecorr>113.00</pricecorr> <rur>13430.00</rur> <pricekur>5701], например, «RU», «RUS» или «643» для России.00</pricekur> <priceag>67Для формата запроса JSON фильтрация по городу работает только в связке с фильтром по адресу.00</priceag> <payno>42423</payno> <paytype>1</paytype> <paytypename>Безнал</paytypename> <signedcopyreceived>NO</signedcopyreceived> </sma></smalist></source>
*'''codeaddress''' - Код акта — Фильтр по адресу, работает только в связке с фильтром по городу*'''numberhouse''' - Номер акта  — Фильтр по номеру дома, работает только в системесвязке с фильтрами по адресу и городу* '''parentcode''' — Фильтр по родительскому [[#Справочник филиалов|филиалу]]* '''acceptcash''' — Фильтр по приему наличных YES/NO*'''actdateacceptcard''' - Дата акта — Фильтр по приему банковских карт YES/NO*'''datepayacceptfitting''' - Дата оплаты  — Фильтр по актуналичию примерки YES/NO*'''datetomaxweight''' - Дата конечного периода для формирования АПД — Фильтр по максимальному весу, с которым работает ПВЗ*'''promiseddatepayacceptindividuals''' - Плановая дата оплаты — Фильтр по доступности физическим лицам YES/NO*'''pricelt''' - Стоимость услуг — Широта левого верхнего угла*'''pricecorrlg''' - Сумма корректировки — Долгота левого верхнего угла*'''rurrt''' - Сумма заказа — Широта правого нижнего угла*'''pricekurrg''' - Стоимость курьерской доставки — Долгота правого нижнего угла*'''priceagjson''' - Агентское вознаграждение — Признак вывода ответа в виде JSON YES/NO*'''paynowith_coords''' - Номер платежного поручения — Признак вывода ПВЗ только с наличием координат YES/NO*'''paytypelimit''' - Тип оплаты — Ограничивает вывод результата.: 1 - безнал, 2 - наличными курьером, 3 - наличными в офисе* '''limitfrom''' — Задает номер записи результата, 4 начиная с которой выдавать ответ. По- перевод на картуумолчанию — 0.:*'''paytypenamelimitcount''' - Строковое представление типа оплатыЗадает количество записей результата, которые нужно вернуть. По-умолчанию — 100.:*'''signedcopyreceivedcountall''' - Признак факта возврата акта  — YES/NOуказывает на необходимость подсчета общего количества найденных совпадений. Это может замедлять выполнение запроса. Если отключено — в ответе не указываeтся totalcount.
== Детализация актов передачи денег ==
'''Пример запроса детализации актов передачи денегответа справочника пунктов самовывоза:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8" ?>
<smadetailpvzlist count="2" totalcount="40465"> <auth extrapvz> <code>126</code> <clientcode>3</clientcode> <name>Нижний Тагил</name> <parentcode>6</parentcode> <parentname>Интеграция</parentname> <town code="8124267" loginregioncode="login66" passregionname="passСвердловская область" >Нижний Тагил город</town> <address>622036, г. Нижний Тагил, ул. Циолковского, д. 17</address> <phone>+73435417709, +73435254989</phone> <comment>Новый пункт доставки</comment> <worktime>Вс 10:00-16:00, Сб 10:00-16:00, Пн-Пт 10:00-20:00</worktime> <traveldescription>Жилое 5-ти этажное здание, торцом к дороге, второе здание от перекрестка Пархоменко-Циолковского</traveldescription> <maxweight>10</maxweight> <acceptcash>YES</acceptcash> <acceptcard>YES</acceptcard> <acceptfitting>YES</acceptfitting> <acceptindividuals>YES</acceptindividuals> <latitude>57.93457</latitude> <longitude>59.95131</longitude> <uid>40606d00-9c51-11eb-b2c9-cfd6c1111392</uid> </pvz> <pvz> <code>245</code>6278 <clientcode>NTG1</clientcode> <name>На Красноармейской</name> <parentcode>6</parentcode> <parentname>Интеграция</parentname> <town code="124267" regioncode="66" regionname="Свердловская область">Нижний Тагил город</town> <address>КРАСНОАРМЕЙСКАЯ, д.79</smadetailaddress> <phone>+7(3435)379-044</phone> <comment>Возможность примерки отсутствует</comment> <worktime>Вс 10:00-16:00, Сб 10:00-16:00, Пн-Пт 10:00-20:00</worktime> <traveldescription>Напротив ТЦ Пирамида</traveldescription> <maxweight>20</maxweight> <acceptcash>YES</acceptcash> <acceptcard>YES</acceptcard> <acceptfitting>NO</acceptfitting> <acceptindividuals>YES</acceptindividuals> <latitude>57.93468</latitude> <longitude>60.55476</longitude> <uid>41116853-9c51-11eb-b2c9-cfd6c1451392</uid> </pvz></pvzlist></source> * '''code''' — Код ПВЗ в системе. Используется в запросе [[API#Оформление заказа|оформления заказов]]* '''smadetailclientcode'''  — Код ПВЗ используемый компанией- Корневой контейнерподрядчиком. Обязательный элемент* '''name''' — Наименование ПВЗ.*'''authparentcode''' - Авторизация — Код родительского элемента.* '''parentname''' — Наименование родительского элемента.* '''town''' — Населенный пункт с кодом из [[#Справочник городов|справочника городов]], а также с кодом и наименованием региона.* '''address''' — Адрес ПВЗ.* '''phone''' — Телефоны ПВЗ. Обязательный элемент* '''comment''' — Дополнительная информация.*'''codeworktime''' - Код акта передачи денег (см — Режим работы ПВЗ. запрос списка АПД)* '''traveldescription''' — Описание местонахождения ПВЗ или пути к нему. Обязательный элемент* '''maxweight''' — Максимальный вес, с которым работает ПВЗ.* '''acceptcash''' — Признак приема наличных* '''acceptcard''' — Признак приема банковских карт* '''acceptfitting''' — Наличие примерки* '''latitude''' — Широта* '''longitude''' — Долгота* '''uid''' — Уникальный идентификатор ПВЗ в системе Measoft* '''count''' — Количество записей в ответе* '''totalcount''' — Общее количество записей, отвечающее параметрам запроса == Получение фискальных данных заказа =='''Пример ответа на запрос детализации актов передачи денегзапроса получения фискальных данных:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<receiptdata> <auth extra="8" login="login" pass="pass" /> <orders> <order orderno="123456" /> <order orderno="890111C" /> </orders></receiptdata>  </source> '''Пример ответа получения фискальных данных:'''<source lang="xml">  <?xml version="1.0" encoding="UTF-8"?><receipts count="1"> <receipt> <orderno>123456</orderno> <fdDatetime>2020-06-07 12:14:00</fdDatetime> <fdValue>123</fdValue> <fdNum>456</fdNum> <fnSn>789</fnSn> <kktNum>100</kktNum> <inn>222</inn> <ofdUrl>gate.ofd.ru</ofdUrl> <fullUrl>https://check.ofd.ru/123</fullUrl> <price>12345</price> <lines count="1"> <line> <item>1111764</item> <name>Сапоги</name> <qty>1</qty> <price>1000</price> <vatRate>20</vatRate> <governmentCode>Z16513LK2</governmentCode> <itemType>1</itemType> </line> </lines> </receipt></receipts></source> Параметры ответа:* '''orderno''' — Номер заказа* '''fdDatetime''' — Дата и время пробития фискального чека* '''fdValue''' — ФПД (фискальный признак документа)* '''fdNum''' — ФИСКАЛЬНЫЙ ДОКУМЕНТ (фискальный номер чека)* '''fnSn''' — ФН (номер фискального накопителя)* '''kktNum''' — РН (регистрационный номер кассы)* '''inn''' — ИНН* '''ofdUrl''' — URL адрес (доменное имя) ОФД* '''price''' — Сумма чека* '''fullUrl''' — URL чека для просмотра онлайн* '''lines''' — Позиции чека:* '''item''' — код товара:* '''name''' — наименование товара:* '''qty''' — количество товара:* '''price''' — цена товара:* '''governmentCode''' — считанная последовательность, которая в дальнейшем преобразуется по алгоритму тега 1162:* '''vatRate''' — НДС товара:* '''itemType''' — тип товара (товар, доставка и т. д.) == Справочник Виды срочности =='''Пример запроса видов срочности:'''<source lang="xml"><?xml version="1.0" encoding="UTF-8" ?><services><auth extra="8"/></services></source> '''Пример ответа справочника видов срочности:'''<source lang="xml"><?xml version="1.0" encoding="UTF-8" ?><services count="2"> <service> <code>1</code> <name>Эконом</name> </service> <service> <code>2</code> <name>Срочно</name> </service></services></source> == Справочник дополнительных услуг =='''Пример запроса дополнительных услуг:'''<source lang="xml"><?xml version="1.0" encoding="UTF-8"?><advprices> <auth extra="8" login="login" pass="pass" /></advprices></source> '''advprices''' — Корневой контейнер. Обязательный элемент.  '''Пример ответа справочника дополнительных услуг:'''<source lang="xml"><?xml version="1.0" encoding="UTF-8" ?><advprices> <advprice> <code>1</code> <name>Этажей в доме</name> <type>int</type> </advprice> <advprice> <code>2</code> <name>Коэффициент надбавки</name> <type>float</type> </advprice> <advprice> <code>3</code> <name>Расписаться на упаковке</name> <type>bool</type> </advprice></advprices></source> Параметры:* '''code''' — внутренний код услуги* '''name''' — наименование услуги. Если поле «название в ЛК» в настройках услуги не пусто, то возвращает значение поля «название в ЛК».* '''hine''' — подсказка по доп услуге для пользователя* '''type''' — тип услуги. Может иметь значения::* '''bool''' — для услуг вида «чекбокс», «Да»:* '''float''' — для числа с плавающей точкой:* '''int''' — для целого числа == Расчет стоимости доставки =='''Пример запроса стоимости доставки:'''<source lang="xml"><?xml version="1.0" encoding="UTF-8" ?><calculator> <auth extra="8" login="login" pass="pass" /> <order> <pricetype>CUSTOMER</pricetype> <sender> <town>Санкт-Петербург</town> <address>Петровка 38 офис 35</address> <coords lat="55.680327" lon="37.604456"></coords> </sender> <receiver> <zipcode>125480</zipcode> <town regioncode="78" country="RU">Санкт-Петербург</town> <address>Петровка 38 офис 35</address> <pvz>124</pvz> <coords lat="55.680327" lon="37.604456"></coords> </receiver> <weight>5.1</weight> <service>2</service> <paytype>CASH</paytype> <price>387.5</price> <deliveryprice>150</deliveryprice> <inshprice>387.5</inshprice> <packages> <package mass="1" quantity="5"></package> <package mass="2.5" length="10" width="20" height="30"></package> </packages> <userid>user123</userid> <groupid>customer</groupid> </order></calculator></source>  Параметры:Структура данных и заполнение полей аналогичны и совместимы с [[#Оформление заказа]]. Дополнительные поля:* '''pricetype''' — тип требуемой цены. Возможные значения: «CUSTOMER» (по-умолчанию) — [[Личный кабинет клиента#Цена доставки для получателя|цена для конечного получателя]], «CLIENT» — цена курьерской службы для клиента.* '''userid''' — Идентификатор пользователя, строковый или числовой тип. Виртуальное поле. Необязательное. Данное поле используется совместно с настройками «Цена доставки для получателя», определяя приоритет правила. Можно использовать в различных CMS/CRM системах, настраивая цены для определенного покупателя.* '''groupid''' — Идентификатор группы пользователя, строковый или числовой тип. Виртуальное поле. Необязательное. Данное поле используется совместно с настройками «Цена доставки для получателя», определяя приоритет правила. Можно использовать в различных CMS/CRM системах, настраивая цены для определенной группы покупателей. Суммы НП и ОЦ, а также тип оплаты CARD имеют значение при настроенных в тарифе на вкладке Прочее долях (в процентах) от данных сумм. В авторизации можно опустить параметры login и pass, тогда расчет будет производиться по стандартному тарифу курьерской службы, без учета возможных отличий для конкретного клиента.<br>Объемный вес будет учитываться только при условии указания всех габаритов: длины, ширины и высоты.<br>В полях город-отправитель и город-получатель можно указывать название города (не рекомендуется!), либо код города из нашего справочника, либо 13-ти значный код КЛАДР, либо 36-ти значный код адресной системы ФИАС (AOID).  '''Пример ответа стоимости доставки:'''<source lang="xml"><?xml version="1.0" encoding="UTF-8"?><calculator> <calc> <townfrom code="1">Москва город</townfrom> <townto code="56603">Иркутск город</townto> <mass>3.7</mass> <service name="Экспресс">1</service> <zone>2</zone> <price>1113</price> <mindeliverydays>1</mindeliverydays> <maxdeliverydays>3</maxdeliverydays> <mindeliverydate>2020-05-13</mindeliverydate> <intervals> <workdays> <interval>10:00-16:00</interval> <interval>16:00-22:00</interval> </workdays> <holidays> <interval>12:00-16:00</interval> </holidays> </intervals> <deliveryprice> <advprice code="1" price="1000">База</advprice> <advprice code="4" price="100">Процент от суммы руб</advprice> <advprice code="5" price="63">Процент от объявленной стоимости</advprice> <advprice code="6" price="-50">Скидка при доставке</advprice> </deliveryprice> </calc></calculator></source> Параметры:* '''townfrom''' — Город-отправитель так, как система его распознала и привязала к справочнику. Атрибут '''code''' — код из справочника городов системы.* '''townto''' — Город-получатель так, как система его распознала и привязала к справочнику. Атрибут '''code''' — код из справочника городов системы.* '''mass''' — Масса в килограммах* '''service''' — Режим доставки — число, указывающее на запись в справочнике видов срочности (см описание на этой странице).* '''zone''' — номер тарифной зоны, по которой рассчиталась стоимость. В зависимости от зоны выбирается тарифная сетка. Так же к цене могут применяться повышающие или понижающие коэффициенты при доставке не из/в региональный центр.* '''price''' — рассчитанная стоимость доставки в валюте прайс-листа курьерской службы. Рекомендуется к использованию в отличие от одноименного атрибута родительского контейнера.* '''maxdeliverydays''' — максимальный срок доставки в рабочих днях.* '''mindeliverydate''' — минимальная дата доставки в учетом выходных дней.* '''intervals''' — список интервалов доставки для соответствующей зоны и режима срочности.* '''deliveryprice''' — Данные по составляющим ценам доставки '''''Обратите внимание:''''' В реальном ответе сервера в теге calc присутствует атрибут «price». Он оставлен для обратной совместимости, не используйте его. Пользуйтесь вложенным тегом price. == Получение информации о клиенте =='''Пример запроса получения информации о клиенте:'''<source lang="xml"><?xml version="1.0" encoding="UTF-8" ?><client> <auth extra="8" login="login" pass="pass" /> </client></source> '''client''' — Корневой контейнер. Обязательный элемент.* '''auth''' — Авторизация. Обязательный элемент. '''Пример ответа на запрос получения информации о клиенте:'''<source lang="xml"><?xml version="1.0" encoding="UTF-8" ?><client> <code>1082</code></client></source> * '''code''' — Код клиента == Список актов передачи денег =='''Пример запроса списка актов передачи денег:'''<source lang="xml"><?xml version="1.0" encoding="UTF-8" ?><smalist> <auth extra="8" login="login" pass="pass" /> <datefrom>2016-02-10</datefrom> <dateto>2016-03-10</dateto></smalist></source> '''smalist''' — Корневой контейнер. Обязательный элемент.* '''auth''' — Авторизация. Обязательный элемент.* '''datefrom''' — Дата «с». Необязательный элемент.* '''dateto''' — Дата «по». Необязательный элемент.Если интервал дат не указан, то возвращаются акты передачи денег за последний месяц. '''Пример ответа на запрос списка актов передачи денег:'''<source lang="xml"><?xml version="1.0" encoding="UTF-8"?><smalist count="1"> <sma> <code>6278</code> <number>3992</number> <actdate>2016-02-12</actdate> <datepay></datepay> <dateto>2016-02-12</dateto> <promiseddatepay></promiseddatepay> <price>637.00</price> <pricecorr>113.00</pricecorr> <rur>13430.00</rur> <pricekur>570.00</pricekur> <priceag>67.00</priceag> <payno>42423</payno> <paytype>1</paytype> <paytypename>Безнал</paytypename> <signedcopyreceived>NO</signedcopyreceived> </sma></smalist></source> * '''code''' — Код акта* '''number''' — Номер акта в системе* '''actdate''' — Дата акта* '''datepay''' — Дата оплаты по акту* '''dateto''' — Дата конечного периода для формирования АПД* '''promiseddatepay''' — Плановая дата оплаты* '''price''' — Стоимость услуг* '''pricecorr''' — Сумма корректировки* '''rur''' — Сумма заказа* '''pricekur''' — Стоимость курьерской доставки* '''priceag''' — Агентское вознаграждение* '''payno''' — Номер платежного поручения* '''paytype''' — Тип оплаты: 1 — безнал, 2 — наличными курьером, 3 — наличными в офисе, 4 — перевод на карту* '''paytypename''' — Строковое представление типа оплаты* '''signedcopyreceived''' — Признак факта возврата акта YES/NO == Детализация актов передачи денег =='''Пример запроса детализации актов передачи денег:'''<source lang="xml"><?xml version="1.0" encoding="UTF-8" ?><smadetail> <auth extra="8" login="login" pass="pass" /> <code>6278</code></smadetail></source> '''smadetail''' — Корневой контейнер. Обязательный элемент.* '''auth''' — Авторизация. Обязательный элемент.* '''code''' — Код акта передачи денег (см. запрос списка АПД). Обязательный элемент. '''Пример ответа на запрос детализации актов передачи денег:'''<source lang="xml"><?xml version="1.0" encoding="UTF-8"?><smadetail count="2"> <specialsma> <code>42494</code> <ordercode>14424</ordercode> <orderno>11111</orderno>
<orderdate>2018-01-01</orderdate>
<delivereddate>2018-10-01</delivereddate> <company>Компания</company> <price>314.00</price> <rur>8800.00</rur> <inshprice>314.00</inshprice> <pricekur>270.00</pricekur> <priceag>44.00</priceag> <pricecalc>8486.00</pricecalc> <paytype>2</paytype> <paytypename>наличными курьером</paytypename> <weight>0.400</weight> <distance>0.0</distance> <status>Доставлено</status> </specialsma></smadetail></source> * '''code''' — Код записи.* '''ordercode''' — Код заказа.* '''orderno''' — Шифр заказа.* '''orderdate''' — Дата заказа.* '''delivereddate''' — Дата доставки.* '''company''' — Получатель.* '''price''' — Стоимость услуг.* '''rur''' — Сумма заказа.* '''inshprice''' — Стоимость заказа.* '''pricekur''' — Стоимость курьерской доставки.* '''priceag''' — Агентское вознаграждение.* '''pricecalc''' — Сумма для передачи агенту.* '''paytype''' — Тип оплаты: 1 — безнал, 2 — наличными курьером, 3 — наличными в офисе, 4 — перевод на карту.* '''paytypename''' — Строковое представление типа оплаты* '''weight''' — Вес заказа.* '''distance''' — Дистанция по заказу* '''status''' — Статус заказа. == Генерация коротких ссылок ==В некоторых случаях, например, при использовании в СМС, может потребоваться использование коротких ссылок на ЛК.Для этого, необходимо отправить запрос с полной ссылкой, в ответ на который придёт хэш-код для ссылки. '''Пример запроса генерации коротких ссылок:'''<source lang="xml"><?xml version="1.0" encoding="UTF-8" ?><shortlink> <link short="0"> https://home.courierexe.ru/8/site/orders </link></shortlink></source> '''shortlink''' — Корневой контейнер. Обязательный элемент.* '''link''' — Полная ссылка, для которой необходимо получить код. Обязательный элемент. Если атрибут '''short''' равен 1, то ответ не будет содержать XML, а только хэш-код. '''Пример ответа на запрос генерации коротких ссылок:'''<source lang="xml"><?xml version="1.0" encoding="UTF-8"?><shortlink> <hash>35AF350C</hash></shortlink></source> * '''hash''' — Хэш-код ссылки. Далее, можно использовать ссылку на ЛК: <nowiki>https://home.courierexe.ru/35AF350C или curie.ru/35AF350C</nowiki>  '''Примечание!''' Сервис коротких ссылок работает только для ресурсов компании MeaSoft. == Проверка надежности покупателя ==Проверка надежности работает только для тарифа «Максимум» личного кабинета. <source lang="xml"><?xml version="1.0" encoding="UTF-8" ?><mcheck> <auth extra="8" login="login" pass="pass" /> <phones> <phone>89161147992</phone> </phones></mcheck></source> Ответ: <source lang="xml"><?xml version="1.0" encoding="UTF-8" ?><mcheck> <phones> <phone rate="90">89161147992</phone> </phones></mcheck>
</source>
*'''code''' - Код записи.
*'''ordercode''' - Код заказа.
*'''orderno''' - Шифр заказа.
*'''orderdate''' - Дата заказа.
*'''delivereddate''' - Дата доставки.
*'''company''' - Получатель.
*'''price''' - Стоимость услуг.
*'''rur''' - Сумма заказа.
*'''inshprice''' - Стоимость заказа.
*'''pricekur''' - Стоимость курьерской доставки.
*'''priceag''' - Агентское вознаграждение.
*'''pricecalc''' - Сумма для передачи агенту.
*'''paytype''' - Тип оплаты: 1 - безнал, 2 - наличными курьером, 3 - наличными в офисе, 4 - перевод на карту.
*'''paytypename''' - Строковое представление типа оплаты
*'''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>
*'''hash''' - Хэш-код ссылки. Далее, Для удобства пользователей вашего сайта можно использовать ссылку указать язык интерфейса (который переключается непосредственно на ЛК: <nowiki>https://home.courierexe.ru/35AF350C или curie.ru/35AF350C</nowiki>  сайте) параметром '''Примечание!lang''' Сервис коротких ссылок работает только для ресурсов компании MeaSoft. == Проверка надежности покупателя == Проверка надежности работает только для тарифа "Максимум" личного кабинета.:
<source lang="xmlhtml"><?xml versioniframe id="1.0frame" encodingsrc="UTF-https://home.courierexe.ru/8" /calculator?><mcheck> <auth extra="8" loginlang=2"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''' — узбекский

Навигация