Просмотр исходного текста страницы Api

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

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

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

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

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

</div>


<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 Documentation|HERE!]]'''
</div>

Вы можете настроить интеграцию с MeaSoft средствами XML API по протоколу HTTP POST.

API предназначено для интеграции клиентов (интернет-магазинов и прочих компаний-заказчиков доставки) с [http://courierexe.ru/our_clients.htm курьерскими службами], работающими под управлением системы [https://curie.ru/ MeaSoft].

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

Если вы '''подрядчик''', вы можете забирать заказы, используя значение client=AGENT в запросе [[#Пример запроса статуса заказа|statusreq]], и передавать статусы заказов, используя метод [[#Изменение статуса агентом|setorderinfo]]. Также для интеграций с подрядчиками у нас есть специальная платформа, но добавлять подрядчиков в нее можно только на нашей стороне. Присылайте нам коммерческое предложение, описание вашего сервиса, и мы с радостью его рассмотрим.

При написании этой документации мы предполагаем, что ее читатель обладает необходимой для понимания квалификацией программиста, владеет XML и средой разработки, в которой он делает интеграцию. Если вы не программист, вам необходимо привлечь к проекту профессионального программиста.

Если у вас после прочтения документации остались вопросы, задайте их по почте [mailto:support@courierexe.ru support@courierexe.ru]. Обязательно представьтесь, напишите ваши контактные данные (телефон, скайп) и название компании, с которой вы хотите интегрироваться.

== Готовые интеграции ==
Для работы с популярными CMS и CRM-системами разработаны модули интеграции, перечисленные в таблице ниже.

'''Модули распространяются бесплатно, без гарантий со стороны разработчика''', и не являются средством полной автоматизации взаимодействия с курьерской службой. Модули — это помощь разработчикам интернет-магазинов в построении интеграции с курьерскими службами. '''Ответственность за корректность передачи данных лежит на интернет-магазине.'''
Модули сторонних разработчиков обслуживаются и разрабатываются сторонними компаниями. Все вопросы по их приобретению и поддержке необходимо задавать им.

Сообщайте нам свои пожелания по работе наших модулей. Мы учтем их в новых версиях.

{| class="wikitable" align="center" style="width: 80%; margin: auto; background-color:#ffffff; border: 1px solid #999999;" cellpadding="10" cellspacing="0"
!style="width: 35%;"|Система управления контентом (CMS)
!style="width: 15%;"|Ссылка
!style="width: 35%;"|Примечание
|-
|[[Файл:bitrix.png|center|x44px]]
|style="text-align: center;" | [https://marketplace.1c-bitrix.ru/solutions/measoft.courier/ Установить] <!--[https://courierexe.ru/download/api/measoft.courier.zip Скачать] -->
|Поддерживает версии 20.5.0 и выше. Подробнее см. [[1C-Битрикс|описание]].
|-
|[[Файл:prestashop.png|center|x60px]]
|style="text-align: center;"|[https://courierexe.ru/download/api/prestashop.zip Скачать]
|Поддерживает версии 1.5.2.0 и выше. Инструкция в архиве
|-
|[[Файл:OpencartOCStore.png|center|x60px]]
|style="text-align: center;"|[https://courierexe.ru/download/api/opencart.zip Скачать для версии 1.5.5.1]<br>[https://courierexe.ru/download/api/measoft_oc2.ocmod.zip Скачать для версии 2.0]<br>[https://courierexe.ru/download/api/measoft_oc2.3.ocmod.zip Скачать для версии 2.3]<br>[https://courierexe.ru/download/api/measoft_oc3.ocmod.zip Скачать для версии 3.0]
|Поддерживает версии с 1.5.5.1.<br>Скачивайте модули для своей версии OpenCart.<br>Подробнее см. [[OpenCart|описание]].
|-
|[[Файл:webasyst-shopscript.png|center|x44px]]
|style="text-align: center;"|[https://www.webasyst.ru/store/plugin/shop/measoftcourier/ Установить модуль]<br>[https://www.webasyst.ru/store/plugin/shipping/measoftcourier/ Установить плагин]
|Модуль предназначен для отправки заявок в КС, а плагин для расчета стоимости доставки при оформлении заказа. Инструкции в маркете
|-
<!--|[[Файл:advantshop.png|center|x44px]]
|style="text-align: center;"|[https://promo-z.ru/ Сайт компании PROMO]
|Компания PROMO разработала этот модуль и настраивает интеграцию MeaSoft с ADVANTSHOP своим клиентам.
|- -->
|[[Файл:insales.png|center|x80px]]
|style="text-align: center;"|Настраивается в [[Личный кабинет клиента|ЛК пользователя]]
|[[InSales|Инструкция по настройке]]
|-
|[[Файл:iiko.jpg|center|x80px]]
|style="text-align: center;"|Настраивается в [[Личный кабинет клиента|ЛК пользователя]]
|[[Iiko|Инструкция по настройке]]
|-
|[[Файл:Leadvertex.png|center|x44px]]
|style="text-align: center;"|[https://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]
|[[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;"|[https://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;"|[https://courierexe.ru/wordpress/wordpress.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.

На вкладке '''Интеграция''' > '''Отладка''' вы можете пробовать выполнять запросы к API для отладки, а также видеть историю отправленных запросов. Созданные заказы появятся в пункте основного меню '''Отслеживание'''.

Для упрощения интеграции можно скачать [https://courierexe.ru/download/api/php_sample.zip пример обращения к сервису на PHP].

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

<source lang=xml>
<auth extra="8" login="login" pass="pass"></auth>
</source>

Описание параметров:
* '''extra''' — экстра-код, уникальный идентификатор компании, с которой вы интегрируетесь.
* '''login''' — логин клиента;
* '''pass''' — пароль клиента;
* '''measoftid''' — системная переменная, используемая системой.

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

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

<source lang=xml>
<auth extra="8" login="login" pass="pass" clientcode="123"></auth>
</source>

Описание:
* '''extra''' — уникальный идентификатор компании;
* '''login''' — логин курьерской службы;
* '''pass''' — пароль курьерской службы;
* '''clientcode''' — внутренний код клиента (вкладка '''Клиенты''', столбец «Внутренний код»).

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

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

Тестовые авторизационные данные: логин: login пароль: pass, параметр extra: 8. Обратите внимание, что тестовая площадка для всех одна. Не нужно передавать в нее заказы с конфиденциальными данными, их смогут увидеть другие участники.

Для использования интеграции в «боевом» режиме, запросите '''логин''', '''пароль''', и параметр '''extra''' у той компании, с которой интегрируетесь.

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

Клиент отправляет запросы к сервису методом HTTP POST, сервис обрабатывает запросы и возвращает результат выполнения. Все запросы и ответы передаются в формате XML.
Кодировка — UTF-8. Разделитель целой и дробной частей чисел — используется символ точки. Даты представляются в виде YYYY-MM-DD, время — HH:MM.

В силу [https://ru.wikipedia.org/wiki/XML#.D0.A0.D0.B5.D1.88.D0.B5.D0.BD.D0.B8.D0.B5_.D0.BF.D1.80.D0.BE.D0.B1.D0.BB.D0.B5.D0.BC.D1.8B_.D0.BD.D0.B5.D0.BE.D0.B4.D0.BD.D0.BE.D0.B7.D0.BD.D0.B0.D1.87.D0.BD.D0.BE.D1.81.D1.82.D0.B8_.D1.80.D0.B0.D0.B7.D0.BC.D0.B5.D1.82.D0.BA.D0.B8 особенностей языка XML], некоторые символы в тексте должны быть заменены: & на &amp;amp; < на &amp;lt; > на &amp;gt; " на &amp;quot;

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

== Ограничения ==
С целью защиты от нецелевого использования сервисов и DDoS-атак действуют следующие ограничения:
* 30 запросов tracking с одного IP-адреса за 1 минуту (используйте statusreq!);
* 150 запросов с одного IP-адреса/акаунта за 1 минуту;
* 1500 запросов с одного IP-адреса/акаунта за 20 минут;
* 3000 запросов с одного аккаунта за 1 час;
* 200 Мб скачанных текстовых данных за 3 часа.
* Превышение количества запросов статусов несуществующих заказов над существующими

В случае превышения IP-адрес или аккаунт блокируется на время до 3-х часов.

Чтобы не происходило блокировок:
* не нужно «бомбить» наше API запросами статусов, последовательно перебирая номера всех ваших заказов, особенно запросами «tracking», они предназначены не для этого (смотрите описание). Особенно ровно в 00 минут каждого часа;
* не нужно каждые 5 минут делать запросы «Покажите статусы всех заказов за последние 3 месяца»;
* для проверки статусов заказов лучше всего использовать запросы [[#Передача только изменившихся статусов|измененных статусов changes=ONLY_LAST]];
* при запросе измененных статусов ОБЯЗАТЕЛЬНО нужно подтверждать успешное получение запросом [[#Передача только изменившихся статусов|commitlaststatus]].
* вы должны знать номера заказов, которые вы отправили. Не нужно перебирать номера всех заказов или брутфорсом перебирать все возможные номера.

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

== Оформление заказа ==

=== Пример оформления заказа ===
<source lang=xml>
<?xml version="1.0" encoding="UTF-8"?>
<neworder newfolder="NO">
 <auth extra="8" login="login" pass="pass"></auth>
 <order orderno="111111">
   <barcode>111111</barcode>
   <sender>
     <company>МВД</company>
     <person>Иванов И.И.</person>
     <phone>123-45-67</phone>
     <town>Санкт-Петербург</town>
     <address>Петровка 38 офис 35</address>
     <date>2014-03-22</date>
     <time_min>09:00</time_min>
     <time_max>14:00</time_max>
   </sender>
   <receiver>
     <company>МВД</company>
     <person>Чип &amp; Дейл</person>
     <phone>123-45-67</phone>
     <zipcode>125480</zipcode>
     <town regioncode="78" country="RU">Санкт-Петербург</town>
     <address>Петровка 38 офис 35</address>
     <pvz>124</pvz>
     <inn>1112223335</inn>
     <date>2014-03-22</date>
     <time_min>09:00</time_min>
     <time_max>14:00</time_max>
     <deliveryPIN>1234</deliveryPIN>
     <coords lat="55.680327" lon="37.604456"></coords>
   </receiver>
   <price>387.5</price>
   <inshprice>387.5</inshprice>
   <deliveryprice VATrate="20">150</deliveryprice>
   <discount>120</discount>
   <paytype>CASH</paytype>
   <weight>5.1</weight>
   <quantity>2</quantity>
   <service>2</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>
   <receiverpays>NO</receiverpays>
   <enclosure>Детские игрушки</enclosure>
   <instruction>Проверить при покупателе, подписать акт</instruction>
   <department>Отдел</department>
   <pickup>NO</pickup>
   <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>
   <deliveryset above_price="100" return_price="1000" VATrate="10">
      <below below_sum="500" price="500" />
      <below below_sum="2000" price="300" />
   </deliveryset>
   <advprices>
    <advprice>
       <code>1</code>
       <value>123</value>
    </advprice>
    <advprice>
       <code>2</code>
       <value>10.5</value>
    </advprice>
    <advprice>
       <code>3</code>
       <value>true</value>
    </advprice>
  </advprices>
  <overall_volume>81</overall_volume>
  <userid>user123</userid>
  <groupid>customer</groupid>
 </order>
</neworder>
</source>

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

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

<spoiler text="Заполнение номера заказа (шифра) и штрих-кода">
Шифр и штрих-код заполняются исходя из начальных значений:

# Если шифр и ШК пустые - оба поля заполняются автоматически значением вида XXX#YYY, а после ШК проверяется на корректность (валидируется)
# Если ШК пустой, а шифр заполнен - ШК заполняется значением из шифра и валидируется
# Если шифр пустой, а ШК заполнен - шифр заполняется значением из ШК, после чего ШК валидируется
# Если оба непустые - валидируется ШК, шифр не проверяется

Корректный (валидный) ШК отвечает следующим требованиям:
* длина не меньше 5 символов
* значение не меньше значения переменной <mparam code="MinPrePrintedNum"/>
* содержит символы, которые можно использовать для формирования штрих-код а формате Code128 (т.е.все печатные символы, кроме кириллицы)

Если ШК не прошел проверку, то:
* если переменная <mparam code="StoreInvLength"/> равна 0, ШК заполняются автоматически значением вида XXX#YYY (или приравнивается шифру в том же формате)
* если переменная <mparam code="StoreInvLength"/> больше 0, ШК заполняются автоматически сквозным номером (если шифр в формате XXX#YYY, то шифр приравнивается ШК)
</spoiler>

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

* '''sender''' — Информация о отправителе заказа. Необязательный контейнер.
<source lang="xml">
   <sender>
     <company>Название компании отправителя</company>
     <person>Контактное лицо отправителя</person>
     <phone>Телефон, Email отправителя</phone>
     <town>Город отправителя в формате "Москва город"</town>
     <address>Адрес отправителя</address>
     <date>Дата забора в формате "YYYY-MM-DD"</date>
     <time_min>Желаемое время забора в формате "HH:MM"</time_min>
     <time_max>Желаемое время забора в формате "HH:MM"</time_max>
   </sender>
</source>

* '''receiver''' — Информация о получателе заказа. Обязательный контейнер.
<source lang="xml">
   <receiver>
     <company>Название компании получателя</company>
     <person>Контактное лицо получателя</person>
     <phone>Телефон, Email получателя</phone>
     <town regioncode="Код региона">Город получателя в формате "Москва город"</town>
     <address>Адрес получателя</address>
     <inn>ИНН получателя</inn>
     <pvz>Код пункта самовывоза по справочнику</pvz>
     <date>Дата доставки в формате "YYYY-MM-DD"</date>
     <time_min>Желаемое время доставки в формате "HH:MM"</time_min>
     <time_max>Желаемое время доставки в формате "HH:MM"</time_max>
     <deliveryPIN>Пин-код для подтверждения получателем</deliveryPIN>
     <coords lat="55.680327" lon="37.604456"></coords>
   </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», «RUS» или «643» для России.

Кроме того, поиск города осуществляется с учетом почтового индекса, указанного в теге '''zipcode'''.

Поле '''Город''' контейнеров '''sender''' и '''receiver''' можно указать одним из следующих способов:
:* код населенного пункта из [[#Справочник городов|справочника городов]]
:* 13-ти значный код адресного классификатора КЛАДР
:* 36-ти значный код адресной системы <rspoiler text="ФИАС">Федеральная информационная адресная система — единый российский государственный адресный реестр</rspoiler> (AOID)
:* название города (не рекомендуется!)

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

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

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

:* '''''extraTags''''' — Строка в формате JSON для отправки в ОФД.

:: Тэг 1265 - значение отраслевого реквизита = код места деятельности аптеки

:: Тэг 1262 – идентификатор ФОИВ = "020" (константа ФОИВ МИНЗДРАВа)

:: Тэг 1263 - дата нормативного акта федерального органа исполнительной власти = "14.12.2018" (константа)

:: Тэг 1264 - номер нормативного акта федерального органа исполнительной власти = "1556"(константа)

:: Тэг 1212 - Признак предмета расчета

:: Пример:

<source lang="json">
"item_industry_props":{"tag1262":"020","tag1263":"14.12.2018","tag1264":"1556","tag1265":"tm=mdlp&sid=00000000XXXXXX"},
"tag1212": "1"
</source>


* '''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 — штрихкод заказа.

'''Пример успешного ответа'''

<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<neworder>
   <createorder orderno="AB23541" barcode="67567#114" error="0" errormsg="Success" errormsgru="Успешно" orderprice="5000" />
   <createorder orderno="AB23542" barcode="67567#115" error="0" errormsg="Success" errormsgru="Успешно" orderprice="6000" />
   <createorder orderno="AB23543" barcode="67567#116" error="0" errormsg="Success" errormsgru="Успешно" orderprice="0" />
</neworder>   
</source>

'''Пример ответа с ошибкой'''

<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<neworder>
   <createorder orderno="AB23541" barcode="67567#114" error="67" errormsg="Order barcode already exists in the database." errormsgru="Такой штрихкод заказа уже есть в базе." />
   <createorder orderno="AB23542" barcode="67567#115" error="17" errormsg="Order number already exists in the database." errormsgru="Такой номер заказа уже есть в базе." />
   <createorder orderno="AB23543" barcode="67567#116" error="67" errormsg="Order barcode already exists in the database." errormsgru="Такой штрихкод заказа уже есть в базе." />
</neworder> 
</source>

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

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

=== Коды и описание ошибок ===
{|class=wikitable
!Код ошибки
!Английское описание
!Русское описание
|-
|0||Success||Успешно
|-
|1||Wrong XML||Некорректный файл XML.
|-
|2||Lat is empty||Укажите широту.
|-
|3||Specify a valid «Price» field value.||Укажите корректное значение поля «Сумма».
|-
|4||Specify a valid «Weight» field value.||Укажите корректное значение поля «Вес».
|-
|5||Recepient city/town not found.||Город назначения не найден.
|-
|6||Sender city/town not found.||Город отправления не найден.
|-
|7||Specify the «Recipient address» field value.||Укажите значение поля «Адрес получателя».
|-
|8||Specify the «Recipient phone» field value.||Укажите значение поля «Телефон получателя».
|-
|9||Specify the «Recipient name» field value.||Укажите значение поля «ФИО получателя».
|-
|10||Specify a valid «Quantity» field value.||Укажите корректное значение поля «Количество».
|-
|11||Specify a valid «Declared value» field value.||Укажите корректное значение поля «Объявленная ценность».
|-
|12||Supplier SKU ID not found.||Артикул не найден.
|-
|17||Order number already exists in the database.||Такой номер заказа уже есть в базе.
|-
|18||Order code already exists in the database.||Такой код заказа уже есть в базе.
|-
|19||The delivery date format is not valid. Specify a date in YYYY-MM-DD format.||Укажите значение поля «Дата доставки» в формате гггг-мм-дд.
|-
|20||Specify a valid «Delivery mode» field value.||Укажите корректное значение поля «Режим доставки».
|-
|21||Specify a valid «Return trip mode» field value.||Укажите корректное значение поля «Режим возврата».
|-
|22||Specify a valid «Delivery type» field value.||Укажите корректное значение поля «Тип доставки».
|-
|23||Specify a valid «Return shipment type» field value.||Укажите корректное значение поля «Тип возврата».
|-
|30||Specify the «Order number» field value.||Укажите значение поля «Номер заказа».
|-
|31||Specify the «Barcode» field value.||Укажите значение поля «Штрихкод».
|-
|32||Specify the «Sender company» field value.||Укажите значение поля «Компания-отправитель».
|-
|33||Specify the «Sender name» field value.||Укажите значение поля «ФИО отправителя».
|-
|34||Specify the «Sender phone» field value.||Укажите значение поля «Телефон отправителя».
|-
|35||Specify the «Sender city/town» field value.||Укажите значение поля «Город отправителя».
|-
|36||Specify the «Sender address» field value.||Укажите значение поля «Адрес отправителя».
|-
|37||Specify the «Pickup date» field value.||Укажите значение поля «Дата забора».
|-
|38||Specify the «Pickup time from» field value.||Укажите значение поля «Время забора с».
|-
|39||Specify the «Pickup time to» field value.||Укажите значение поля «Время забора до».
|-
|40||Specify the «Recipient company» field value.||Укажите значение поля «Компания-получатель».
|-
|41||Specify the «Recipient name» field value.||Укажите значение поля «ФИО получателя».
|-
|42||Specify the «Recipient phone» field value.||Укажите значение поля «Телефон получателя».
|-
|43||Specify the «Recipient city/town» field value.||Укажите значение поля «Город получателя».
|-
|44||Specify the «Recipient address» field value.||Укажите значение поля «Адрес получателя».
|-
|45||Specify the «Delivery date» field value.||Укажите значение поля «Дата доставки».
|-
|46||Specify the «Delivery time from» field value.||Укажите значение поля «Время доставки с».
|-
|47||Specify the «Delivery time to» field value.||Укажите значение поля «Время доставки до».
|-
|48||Specify the «Recipient postcode» field value.||Укажите значение поля «Индекс получателя».
|-
|49||Specify the «Weight» field value.||Укажите значение поля «Вес».
|-
|50||Specify the «Payment type» field value.||Укажите значение поля «Тип оплаты».
|-
|51||Specify the «Quantity» field value.||Укажите значение поля «Количество».
|-
|52||Specify the «Amount» field value.||Укажите значение поля «Сумма».
|-
|53||Specify the «Declared value» field value.||Укажите значение поля «Объявленная стоимость».
|-
|54||Specify the «Description» field value.||Укажите значение поля «Описание».
|-
|55||Specify the «Instruction» field value.||Укажите значение поля «Поручение».
|-
|56||Specify the «Delivery mode» field value.||Укажите значение поля «Режим доставки».
|-
|57||Specify the «Shipment type» field value.||Укажите значение поля «Тип отправления».
|-
|58||Specify whether return trip is required.||Укажите значение поля «Необходимость возврата».
|-
|59||Specify the «Return trip mode» field value.||Укажите значение поля «Режим возврата»
|-
|60||Specify the «Return shipment type» field value.||Укажите значение поля «Тип возврата».
|-
|61||Specify barcode.||Укажите штрихкод.
|-
|62||Specify item weight.||Укажите массу единицы товара.
|-
|63||Specify item quantity.||Укажите количество товара.
|-
|64||Specify item price.||Укажите цену единицы товара.
|-
|65||Specify item name.||Укажите название товара.
|-
|66||Wrong XLS file||Некорректный файл XLS.
|-
|67||Order barcode already exists in the database.||Такой штрихкод заказа уже есть в базе.
|-
|68||Select the «Payment by recipient» field value.||Укажите значение поля «Оплата получателем».
|-
|69||Specify department.||Укажите отдел.
|-
|70||Specify service partner code.||Укажите значение поля «Код подрядчика».
|-
|71||Date cannot be earlier than tomorrow.||Дата не может быть раньше чем завтра.
|-
|72||Date cannot be later than 15 days from now.||Дата не может быть позже чем через 15 дней.
|-
|73||Date cannot be earlier than today.||Дата не может быть раньше чем сегодня.
|-
|74||Date cannot be later than {0} days from now.||Дата не может быть позже, чем через {0} дней.
|-
|75||Specify a valid «Item weight» field value.||Укажите корректное значение поля «Масса единицы товара».
|-
|76||Specify a valid «Quantity» field value.||Укажите корректное значение поля «Количество товара».
|-
|77||Specify a valid «Item price» field value.||Укажите корректное значение поля «Цена единицы товара».
|-
|78||Specify a valid «Delivery time from» field value.||Укажите корректное значение поля «Время доставки с».
|-
|79||Specify a valid «Delivery time to» field value.||Укажите корректное значение поля «Время доставки до».
|-
|80||Specify a valid «Pickup time from» field value.||Укажите корректное значение поля «Время забора с».
|-
|81||Specify a valid «Pickup time to» field value.||Укажите корректное значение поля «Время забора до».
|-
|82||Specify a valid «Pickup point» field value.||Укажите корректное значение поля «ПВЗ».
|-
|83||Duplicate number in the registry.||Дублирование номера в реестре.
|-
|84||Duplicate barcode in the registry.||Дублирование штрихкода в реестре.
|-
|85||Specify a valid «Weight at return trip» field value.||Укажите корректное значение поля «Вес возврата».
|-
|86||Specify the «Weight at return trip» field value.||Укажите значение поля «Вес возврата».
|-
|87||Order weight exceeds the allowed maximum for the pickup point.||Вес превышает допустимое значение для этого ПВЗ.
|-
|88||Pickup date cannot be earlier than today.||Дата забора не может быть раньше чем сегодня.
|-
|89||Specify a later delivery date.||Укажите более позднюю дату доставки.
|-
|90||Inappropriate «Weight» or «Pay type» field value for the selected city or town. Please review and correct the values.||Значение поля «Масса» или «Тип оплаты» для выбранного города указано некорректно или отсутствует. Проверьте значения и исправьте.
|-
|91||{deliverytype} {deliverydate} is {holidaytype}. Select another date.||{deliverytype} {deliverydate} является {holidaytype}. Выберите другую дату.
|-
|92||{deliverytype} {deliverydate} is {holidaytype}. Select another date.||{deliverytype} {deliverydate} является {holidaytype}. Выберите другую дату.
|-
|93||Add items.||Добавьте товары.
|-
|95||The selected pickup point only allows paid orders.||Выбранный ПВЗ выдает только предоплаченные заказы.
|-
|96||Order barcode exceeds the allowed maximum (25) symbols.||Длина штрихкода заказа превышает максимально допустимую (25 символов).
|-
|97||The pickup date format is not valid. Specify a date in YYYY-MM-DD format.||Укажите значение поля «Дата забора» в формате гггг-мм-дд.
|-
|98||Specify the cost code.||Укажите значение поля «Кост-код».
|-
|99||The item is not in stock.||Товар отсутствует на складе.
|-
|100||Set the quantity of the item marked with Chestny ZNAK to one.||Укажите количество товара, маркированного кодом «Честный ЗНАК», равным единице.
|-
|101||Quantity of item Delivery cannot be greater than 1||Количество вложений типа «Доставка» не может быть более 1.
|-
|102||А database error occurred. Please try later again.||Ошибка базы данных. Попробуйте позже.
|-
|103||Order not found.||Заказ не найден.
|-
|104||Cannot edit order in the current status.||Невозможно изменить заказ в текущем статусе.
|-
|105||Discount cannot be greater than the order amount. Specify a smaller value.||Размер скидки не может превышать сумму заказа. Укажите меньшее значение скидки.
|-
|106||Specify the correct additional service code.||Укажите корректный код дополнительной услуги.
|-
|107||Specify the correct additional service name.||Укажите корректное значение поля [advprice][value].
|-
|108||Specify the «Additional services» field value.||Укажите значение поля «Дополнительные услуги».
|-
|110||Specify the correct TIN.||Укажите корректный ИНН.
|-
|111||Specify the correct IIN (KZ).||Укажите корректный ИИН (КЗ).
|-
|112||Specify the overall volume.||Укажите общий объем.
|-
|113||Cannot apply the delivery mode. Select another delivery mode.||Режим доставки не подходит для заказа. Выберите другой режим.
|-
|114||The pickup point does not support the selected delivery mode. Specify another pickup point.||ПВЗ не подходит для выбранного режима доставки. Укажите другой ПВЗ.
|-
|115||Specify a valid recipient phone number.||Укажите корректный телефон получателя.
|-
|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/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.||Укажите тип оплаты для города
|-
|}

=== Передача значений полей в форме создания заказа в Личном Кабинете через GET параметры ===
Если вам требуется передавать значения полей в форме создания заказа в Личном Кабинете через GET параметры, то вы можете подробно ознакомиться с этим на данной странице - [[Личный_кабинет_клиента#Передача и подстановка значений полей формы создания заказа через GET параметры]]

== Запрос статуса заказов ==

=== Пример запроса статуса заказа ===
<source lang="xml">
<?xml version="1.0" encoding="UTF-8" ?>
<statusreq>
  <auth extra="8" 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».



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

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

<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<statusreq count="23">
 <order orderno="111111" awb="qwerty" orderno2="123123" ordercode="34534234" givencode="2345334">
   <barcode>111111</barcode>
   <sender>
     <company>МВД</company>
     <person>Иванов И.И.</person>
     <phone>123-45-67</phone>
     <contacts>
       <phone>+74951234567</phone>
     </contacts>
     <town code="23432">Санкт-Петербург</town>
     <address>Петровка 38 офис 35</address>
     <date>2014-03-22</date>
     <time_min>09:00</time_min>
     <time_max>14:00</time_max>
   </sender>
   <receiver>
     <company>МВД</company>
     <person>Иванов И.И.</person>
     <phone>123-45-67 - Иван (916)234.45.21 Петр,mvd@mail.ru</phone>
     <contacts>
       <phone>+74951234567</phone>
       <phone>+79162344521</phone>
       <email>mvd@mail.ru</email>
     </contacts>
     <inn>1112223335</inn>
     <zipcode>125480</zipcode>
     <town code="153361" regioncode="78" regionname="Санкт-Петербург город">Санкт-Петербург город</town>
     <address>Петровка 38 офис 35</address>
     <area>Район 1</area>
     <pvz>
       <code>126</code>
       <clientcode>QWERTY</clientcode>
     </pvz>
     <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>
   <paytype code="1">CASH</paytype>
   <weight>5.1</weight>
   <quantity>2</quantity>
   <service>2</service>
   <type>3</type>
   <return>NO</return>
   <return_service>2</service>
   <return_type>3</return_type>
   <return_weight>5.1</return_weight>
   <return_message>Доставлено в целости</return_message>
   <pickup>NO</pickup>
   <print_check>YES</print_check>
   <waittime>12</waittime>
   <enclosure>Детские игрушки</enclosure>
   <instruction>Проверить при покупателе, подписать акт</instruction>   
   <currcoords lat="55.680327" lon="37.604456" accuracy="50" RequestDateTime="2014-04-21 18:07:45"></currcoords>
   <courier>
	<code>26</code>
	<name>Иванов Владимир Петрович</name>
	<phone>+79161234567</phone>
   </courier>
   <deliveryprice total="158.6" delivery="100.00" return="58.6">
      <advprice code="1" price="150">База</advprice>
      <advprice code="2" price="0">% от объявленной стоимости</advprice>
      <advprice code="3" price="8.6">Топливный сбор</advprice>
      <advprice code="4" price="0">Округление</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>
</statusreq> 
</source>

'''Пример ответа если нет заказов'''

<source lang="xml">
<?xml version="1.0" encoding="utf-8"?>
<statusreq count="0">
</statusreq> 
</source>

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

<source lang="xml">
<?xml version="1.0" encoding="utf-8"?>
<request>
<error error="1" errormsg="authorization error"></error>
</request>
</source>

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

<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''''' — внутренний код заказа в системе, применяется для некоторых внутренних операций.

*'''paytype''' - Тип оплаты заказа получателем. Принимает значения:
:: CASH - Наличными при получении (по-умолчанию)
:: CARD - Картой при получении
:: NO - Без оплаты.
:: OTHER - Прочее (Предусмотрен для того, чтобы оплата поступала непосредственно в курьерскую службу посредством прочих типов оплаты - таких как: вебмани, яденьги, картой на сайте, прочие платежные системы и т.д.)
* Атрибуты контейнера '''paytype''':
** '''''code''''' - (integer) внутренний код типа оплаты заказа в системном справочнике "Типы оплаты корреспонденции". Не обязательный элемент.


* атрибут '''''code''''' контейнера '''item''' — внутренний код строки заказа в системе, применяется для некоторых внутренних операций.
:* '''''returns''''' — количество данного товара, от которого отказался получатель. Не нулевое только в случае частичного отказа.

* атрибут '''''got''''' контейнера '''package''' — признак принятого места YES / NO.
:* '''''returns''''' — количество данного товара, от которого отказался получатель. Не нулевое только в случае частичного отказа.

* '''''area''''' в контейнере '''receiver''' — район/метро получателя.
* '''''coords''''' в контейнере '''receiver''' — координаты получателя.
* '''''deliveryPIN''''' в контейнере '''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''' — код у подрядчика (код заказа во внешней системе). Используется в интеграциях с внешними системами.
* '''partner''' — текущий филиал/подрядчик.
* '''return_message''' — информация о возврате
* '''department''' — Подразделение, в котором оформляется заказ.

Контейнер '''status''' может принимать следующие значения:
: AWAITING_SYNC — Ожидает синхронизации. Данные заказа пока не появились в службе доставки.
: '''NEW''' — Успешно создан, передан в службу доставки.
: NEWPICKUP — Создан забор.
: PICKUP — Забран у отправителя.
: WMSASSEMBLED — Скомплектован на складе фулфилмента.
: WMSDISASSEMBLED — Разукомплектован на склад фулфилмента.
: '''ACCEPTED''' — Получен складом.
: CUSTOMSPROCESS — Производится таможенный контроль.
: CUSTOMSFINISHED — Таможенный контроль произведен.
: CONFIRM — Согласована доставка.
: UNCONFIRM — Не удалось согласовать доставку.
: DEPARTURING — Планируется отправка со склада на другой склад.
: DEPARTURE — Отправлено со склада на другой склад.
: INVENTORY — Инвентаризация. Убедились в наличии отправления на складе.
: PICKUPREADY — Готов к выдаче в ПВЗ.
: '''DELIVERY''' — Выдан курьеру на доставку.
: COURIERDELIVERED — Доставлен (предварительно, ожидает подтверждения менеджером, чтобы перейти в статус COMPLETE).
: COURIERPARTIALLY — Частично доставлен (предварительно, ожидает подтверждения менеджером, чтобы перейти в статус PARTIALLY).
: COURIERCANCELED — Отказ (предварительно, после этого ожидается COURIERRETURN).
: COURIERRETURN — Возвращено курьером. Курьер не смог доставить до получателя и вернул заказ обратно на склад. Это промежуточный статус, после которого менеджер выясняет, нужно ли повторно доставлять (статусы DATECHANGE/DELIVERY) или это окончательная недоставка (CANCELED).
: DATECHANGE — Перенос даты доставки.

: '''COMPLETE''' — Доставлен.
: '''PARTIALLY''' — Доставлен частично.
: '''CANCELED''' — Не доставлен (Возврат/Отмена). После этого статуса отправление должны вернуть заказчику, будут статусы RETURNING и RETURNED

: RETURNING — Планируется возврат заказчику (после CANCELED).
: RETURNED — Возвращен заказчику.
: LOST — Утрачен/утерян.

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


'''Примечание.''' В будущем возможно дополнение используемого набора статусов.

<div style="color: #a94442; background-color: #f2dede; border: 1px solid #ebccd1; padding: 3px 10px 10px;">
'''Обратите внимание!'''

# Контейнер '''statushistory''' и '''deliveryprice''' заполняется для тарифов [[Личный кабинет курьерской службы#Функции личного кабинета|Премиум и Максимум]].
# Система никогда не гарантирует последовательность прохождения заказом набора статусов. То есть Вы можете получить статус «COMPLETE», а следующим запросом — «NEW» — такое может произойти, например, если оператор ошибочно отметил заказ выполненным, а затем исправил ошибку.
</div>
<br>

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

Для получения только изменившихся статусов отправьте запрос:
<source lang="xml">
<?xml version="1.0" encoding="UTF-8" ?>
<statusreq>
  <auth extra="8" login="login" pass="pass"></auth>
  <changes>ONLY_LAST</changes>
  <streamid>1234</streamid>
</statusreq>
</source>

Система выдает все заказы, в которых с момента последнего запроса в этом режиме изменилось хотя бы одно из полей:
 orderno
 status
 delivereddate
 deliveredtime
 deliveredto
 receiver->date
 receiver->address
 price

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

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

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

В случае успеха вы получите ответ:
<source lang="xml">
<?xml version="1.0" encoding="UTF-8" ?>
<commitlaststatus error="0">OK</commitlaststatus>
</source>

Такой способ передачи статусов гарантирует полную корректную передачу статусов, даже если в нашей системе статус изменился между запросом статусов и подтверждением их получения. Если система не получила подтверждение передачи статуса, она будет считать информацию непереданной и выдаст ее при повторном запросе.

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

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

'''Пример запроса:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<tracking>
  <extra>8</extra>
  <orderno>1234</orderno>
</tracking>
</source>

'''Пример ответа:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<tracking>
 <order orderno="111111">
   <barcode>111111</barcode>
   <AWB>111111</AWB>
   <sender>
     <town code="1" country="RU">Москва город</town>
     <date>2014-03-22</date>
     <time_min>09:00</time_min>
     <time_max>14:00</time_max>
   </sender>
   <receiver>
     <town code="1" country="RU">Москва город</town>
     <zipcode>125480</zipcode>
     <date>2014-03-22</date>
     <time_min>09:00</time_min>
     <time_max>14:00</time_max>
   </receiver>
   <price>387.5</price>
   <inshprice>387.5</inshprice>
   <paytype>CASH</paytype>
   <weight>5.1</weight>
   <quantity>2</quantity>
   <service>2</service>
   <type>3</type>
   <return>NO</return>
   <return_service>2</return_service>
   <return_date></return_date>
   <return_time></return_time>
   <return_message></return_message>
   <waittime>12</waittime>
   <enclosure>Детские игрушки</enclosure>
   <instruction>Проверить при покупателе, подписать акт</instruction>
   <deliveryprice total="158.6" delivery="100.00" return="58.6" />
   <courier>
	<code>26</code>
	<name>Иванов Владимир Петрович</name>
	<phone>+79161234567</phone>
   </courier>
   <currcoords lat="55.680327" lon="37.604456" accuracy="50" RequestDateTime="2014-04-21 18:07:45" />
   <status eventstore="филиал в Санкт-Петербурге" eventtime="2016-06-02 17:22:00" createtimegmt="2016-06-03 16:14:44" message="" title="Доставлен">COMPLETE</status>
   <statushistory>
     <status eventstore="Офис в Москве" eventtime="2016-05-30 10:20:00" createtimegmt="2016-06-03 16:14:44" message="" title="Новый">NEW</status>
     <status eventstore="Офис в Москве" eventtime="2016-06-01 17:38:00" createtimegmt="2016-06-03 16:14:44" message="филиал в Санкт-Петербурге" title="Планируется отправка">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</status>
     <status eventstore="филиал в Санкт-Петербурге" eventtime="2016-06-02 09:17:00" createtimegmt="2016-06-03 16:14:44" message="" title="Выдан курьеру на доставку">DELIVERY</status>
     <status eventstore="филиал в Санкт-Петербурге" eventtime="2016-06-02 17:22:00" createtimegmt="2016-06-03 16:14:44" message="" title="Доставлен (предварительно)">COURIERDELIVERED</status>
     <status eventstore="филиал в Санкт-Петербурге" eventtime="2016-06-02 17:22:00" createtimegmt="2016-06-03 16:14:44" message="" title="Доставлен">COMPLETE</status>
   </statushistory>
   <deliveredto>Иванова, секр.</deliveredto>
   <delivereddate>2016-06-02</delivereddate>
   <deliveredtime>17:22</deliveredtime>
   <outstrbarcode>EXT123456</outstrbarcode>
   <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" article="3" returns="0" governmentCode="">Погремушка желтая</item>
   </items>
 </order>
</tracking>
</source>


'''Получение информации в формате 17 TRACK'''

'''Пример запроса:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<tracking17>
  <extra>8</extra>
  <orderno>1234</orderno>
</tracking17>
</source>

'''Пример ответа:'''
<pre>{
	"number":"ExtNumber",
	"oriNumber":"1234",
	"oriCountry":"RU",
	"destCountry":"RU",
	"status":"Complete",
	"events":[
		{
			"time":"2016-06-02 17:22:00",
			"location":"RU",
			"content":"Complete"
		},
		{
			"time":"2016-06-02 17:22:00",
			"location":"RU",
			"content":"Courierdelivered"
		},
		{
			"time":"2016-06-02 09:17:00",
			"location":"RU",
			"content":"Delivery"
		},
		{
			"time":"2016-06-02 07:41:00",
			"location":"RU",
			"content":"Accepted"
		},
		{
			"time":"2016-06-01 19:53:00",
			"location":"RU",
			"content":"Departure"
		},
		{
			"time":"2016-06-01 17:38:00",
			"location":"RU",
			"content":"Departuring"
		},
		{
			"time":"2016-05-30 10:20:00",
			"location":"RU",
			"content":"New"
		}
	]
}</pre>

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

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

Изменять заказы могут курьерские службы с тарифами «Премиум» и «Максимум». Чтобы разрешить изменение заказов, в личном кабинете курьерской службы перейдите в '''Настройки''' > '''Заказы''' и в разделе '''Отмена и редактирование''' установите флажок '''Разрешить отмену и изменение заказов'''.  Вы также можете пометить в списке '''Статусы для отмены и редактирования заказов'''   галками статусы корреспонденции, для которых возможны отмена и изменение заказов. По умолчанию (когда в этом списке ничего не выбрано) редактирование и отмена разрешены для статуса  «Новый»

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

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

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

* значение '''orderno''' данным методом изменить нельзя.
* значение '''barcode''' изменяется в случае явного его указания. В случае отсутствия или пустого значения - остается прежним.
* вместо корневого тэга '''neworder''' указывается '''editorder''';
* тэг курьера '''courier''' можно изменить только при включенной настройке '''Разрешить изменение курьера по АПИ''';
* для вложений '''item''' указывается внутренний код вложения в атрибуте '''code''', который можно получить при получении статуса заказа.
* для мест '''package''' указывается внутренний код вложения в атрибуте '''code''', который можно получить при получении статуса заказа.


Необходимо иметь в виду, что:

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

=== Описание полей ответа изменения ===
Все поля ответа соответствуют ответу при создании заказа за исключением корневого тэга — вместо '''neworder''' возвращается '''editorder'''.

== Отмена заказа ==
Запрос предназначен для отмены заказов.

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

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


'''Пример запроса отмены заказа:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8" ?>
<cancelorder>
  <auth extra="8" login="login" pass="pass" />
  <order orderno="" ordercode="123456" />
  <order orderno="123aaa" ordercode="" />
</cancelorder>
</source>


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

'''cancelorder''' — Корневой контейнер. Обязательный элемент.
* '''auth''' — Авторизация. Обязательный элемент.
* '''order''' — Контейнер отменяемого заказа. Обязательный элемент. Запрос может содержать более одного контейнера '''order'''. Атрибуты:
:* '''''orderno''''' — Шифр заказа.
:* '''''ordercode''''' — Внутренний код заказа.
Обратите внимание, что должен быть указан хотя бы один из атрибутов ''orderno'' или ''ordercode''!


'''Пример ответа:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8" ?>
<cancelorder>
  <order orderno="123test" ordercode="123456" error="0" errormsg="OK" errormsgru="Успешно" />
  <order orderno="123aaa" ordercode="" error="52" errormsg="order not found" errormsgru="Заказ не найден" />
</cancelorder>
</source>

== Добавление вложений к накладной ==

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

'''Пример запроса:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8" ?>
<addattachments>
  <auth extra="8" 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>
</addattachments>
</source>


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

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


'''Пример ответа:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<addattachments>
  <attachments>
    <item name="photo1.jpg" error="0" errormsg="OK" errormsgru="Успешно" />
    <item name="photo2.jpg" error="0" errormsg="OK" errormsgru="Успешно" />
  </attachments>
</addattachments>
</source>

== Получение вложений к накладной ==
'''Пример запроса:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8" ?>
<attachments>
  <auth extra="8" login="login" pass="pass" />
  <orderno>1234567</orderno>
</attachments>
</source>

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

'''attachments''' — Корневой контейнер. Обязательный элемент.
* '''auth''' — Авторизация. Обязательный элемент.
* '''orderno''' — Номер/код заказа. Обязательный элемент.


'''Пример ответа:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<attachments>
  <item name="doc1.docx" size="35654">JVBERi0xLjMN
  JUBQREYwMTIzNDU2Nzg5IDI NMyAwIG9iag08PA0vVHlwZSA
  U3VidHlwZSAvSW1hZ2UNL1d pZHRoIDE4MDgNL0hlaWdodCA
  ggNCAwIFINL0JpdHNQZXJDb 21wb25lbnQgMQ0vRGVjb2RlU
  ENL0NvbHVtbnMgMTgwOA0+P g0vSW1hZ2VNYXNrIHRydWUNL
  XhEZWNvZGUNPj4Nc3RyZWFt DQ</item>
  <item name="photo2.jpg" size="74861">VBERi0xLjMN 
  JUBQREYwMTIzNDU2Nzg5IDI NMyAwIG9iag08PA0vVHlwZSA
  vWE9iamVjdA0vU3VidHlwZS AvSW1hZ2UNL1dpZHRoIDEzNj 
  gNL0hlaWdodCAxMzMzDS9MZ W5ndGggNCAwIFINL0JpdHNQZ 
  XJDb21wb25lbnQgMQ0vRGVj b2RlUGFybXMgPDwNL0sgLTEN 
  L0NvbHVtbnMgMTM2OA0+Pg0 vSW</item>
</attachments>
</source>

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

== Изменение статуса агентом ==
Запрос изменения статуса заказа позволяет установить окончательный статус заказа — «Доставлен» или «Не доставлен (Возврат/Отмена)».

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

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


'''Пример запроса изменения статуса:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8" ?>
<setorderinfo>
  <auth extra="8" login="login" pass="pass" />
  <order ordercode="123456">
    <message>Получил Иванов</message>
    <outstrbarcode>7654312</outstrbarcode>
  </order>
  <order ordercode="234567">
    <status>PICKUPREADY</status>
    <eventtime>2016-05-30 10:20:00</eventtime>
    <message>Клиент отказался от покупки</message>
    <paytype>CASH</paytype>
    <storeprice>123</storeprice>
    <items>
       <item code="34533" quantity="1" reason="0" governmentCode="11223311" />
       <item code="34456" quantity="0" reason="0" />
       <item code="34421" quantity="2" reason="0" />
    </items>
    <image filename="filename1.jpg"> /9j/4AAQSkZJRgA
    BAQAAAQABAAD/2wBDAA0JCg sKCA0LCgsODg0PEyAVExISEy
    ccHhcgLikxMC4pLSwzOko+M zZGNywtQFdBRkxOUlNSMj5aY
    VpQYEpRUk//2wBDAQ4ODhMR EyYVFSZPNS01T09PT09PT09P
    T09PT09PT09PT09PT09PT09 PT09PT09PT09PT09PT09PT09
    PT09PT0//wAARCAYACAADAS IA</image>
  </order>
</setorderinfo>
</source>


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

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



'''Пример ответа:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<setorderinfo>
  <order ordercode="123456" error="0" errormsg="OK" errormsgru="Успешно" />
  <order ordercode="234567" error="59" errormsg="value [date_put] is already set" errormsgru="Значение [Дата доставки] уже указано" />
</setorderinfo>
</source>

== Получение документов для печати ==
'''Пример запроса получения печатных форм:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8" ?>
<waybill>
  <auth extra="8" login="login" pass="pass" />
  <orders>
    <order orderno="1234567" ordercode="33331" />
    <order orderno="1234568" ordercode="33332" />
  </orders>
  <form>1</form>
  <start>5</start>
</waybill>
</source>

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

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


'''Пример ответа:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<waybill>
  <content>EODIcaI8KSBlwQ 4MnEOR7Px8U8EBAyGICBnwpw 
  IZhQgz0ZxuPs8EBM/GcbjzB AwhBl8hwQYIO00GmEwg1CeEG 
  mqYTChNU0wqf8l8nz4zgc+K fCno+zwU5GjOZmzXGcbEQYIM 
  4zkegRE40zWzONyoNNMIOIa cWnp6aDCGEGE9NQmoQd2mg00 
  79U4f3hPTwnfp6Sdrafeqpa JDpFw/1aYT077VNNNdO00G3q 
  mqqvp9p2E7T0/wiFemv8uG6 OM</content>
</waybill>
</source>


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


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


'''Пример ответа с ошибкой:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<waybill>
  <error>Текст ошибки</error>
</waybill>
</source>

== Справочник городов ==
'''Пример запроса справочника городов:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<townlist>
  <auth extra="8" />
  <codesearch>
    <zipcode>110000</zipcode>
    <kladrcode>0100000100800</kladrcode>
    <fiascode>bd21979d-46f8-49d0-9105-e8d65172a983</fiascode>
    <code>123</code>
  </codesearch>
  <conditions>
    <city>Краснодарский край</city>
    <namecontains>новгород</namecontains>
    <namecontainsparts>молоково моск</namecontainsparts>
    <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''' — Задает условия поиска. Все вложенные элементы одновременно накладывают условие «И».
:* '''city''' — Поиск по всем населенным пунктам региона.
:* '''namecontainsparts''' — Поиск населенных пунктов, название которых содержит все указанные слова, с разбиением поисковой фразы через пробел. Например "моск моло" найдет деревню "Молоково" в Московской области.
:* '''namecontains''' — Поиск населенных пунктов, название которых содержит указанный текст.
:* '''namestarts''' — Поиск населенных пунктов, название которых начинается с указанного текста.
:* '''name''' — Поиск населенных пунктов, название которых соответствует указанному тексту.
:* '''fullname''' — Поиск населенных пунктов, название вместе с типом населенного пункта которых соответствует указанному тексту.
:* '''country''' — Поиск только по стране с указанным внутренним кодом или текстовым кодом в соответствии [https://ru.wikipedia.org/wiki/ISO_3166-1 стандартом ISO_3166-1], например, «RU», «RUS» для России.

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

'''Пример ответа:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<townlist count="3" page="1" totalcount="3" totalpages="1">
  <town>
    <code>26379</code>
    <city>
      <code>23</code>
      <name>Краснодарский край</name>
    </city>
    <name>Сочи город</name>
    <fiascode>79da737a-603b-4c19-9b54-9114c96fb912</fiascode>
    <kladrcode>2300000700000</kladrcode>
    <shortname />  (not yet supported)
    <typename />  (not yet supported)
    <coords lat="43.5855" lon="39.7231" />
  </town>
  <town>
    <code>40331</code>
    <city>
      <code>32</code>
      <name>Брянская область</name>
    </city>
    <name>Сочилов хутор</name>
    <fiascode>c9c96c67-2cc9-4f10-afde-fd32417ea216</fiascode>
    <kladrcode>3201900011100</kladrcode>
    <shortname />
    <typename />
    <coords lat="52.6407" lon="33.1724" />
  </town>
  <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 lat="56.6003" lon="29.3542" />
  </town>
</townlist>
</source>

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

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

'''Пример ответа:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<regionlist count="2">
  <city>
    <code>80</code>
    <country>
      <code>1</code>
      <name>Россия</name>
      <id>643</id>
      <ShortName1>RU</ShortName1>
      <ShortName2>RUS</ShortName2>
    </country>
    <name>Агинский Бурятский автономный округ</name>
  </city>
  <city>
    <code>1</code>
    <country>
      <code>1</code>
      <name>Россия</name>
      <id>643</id>
      <ShortName1>RU</ShortName1>
      <ShortName2>RUS</ShortName2>
    </country>
    <name>Адыгея республика</name>
  </city>
</regionlist>
</source>

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

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

* '''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>
     <code>124</code>
     <name>Академика Хохлова ул.</name>
     <shortname>Академика Хохлова</shortname>
     <typename>ул.</typename>
  </street>
</streetlist>
</source>

В ответе улицы сортируются по алфавиту.

== Справочник номенклатуры ==
'''Пример запроса справочника номенклатуры:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8" ?>
<itemlist>
  <auth extra="8" login="login" pass="pass"></auth>
    <codesearch>
      <code>123456</code>
      <article>FD343</article>
      <barcode>2345625213125</barcode>
    </codesearch>
    <conditions>
      <namecontains>телевизор</namecontains>
      <namestarts>sony</namestarts>
      <name>Sony KDL-55W905 ЖК-телевизор</name>
      <quantity>EXISTING_ONLY</quantity>
      <store>2</store>
    </conditions>
    <except>
      <code>123478</code>
    </except>
    <limit>
      <limitfrom>30</limitfrom>
      <limitcount>10</limitcount>
      <countall>YES</countall>
    </limit>
</itemlist>
</source>

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

* '''conditions''' — Задает условия поиска. Все вложенные элементы одновременно накладывают условие «И».
:* '''namecontains''' — Поиск товаров, название которых содержит указанный текст.
:* '''namestarts''' — Поиск товаров, название которых начинается с указанного текста.
:* '''name''' — Поиск товаров, название которых соответствует указанному тексту.
:* '''quantity''' — Наличие на складе. Принимает значения EXISTING_ONLY — Только в наличии, NOT_EXISTING_ONLY — Только не в наличии, ALL — Все. ''Это поле может быть недоступным в некоторых установках.''
:* '''store''' — Поиск товаров по определенному складу.

* '''except''' — Описание исключений для корректного определения количества зарезервированной номенклатуры.
:* '''code''' — Код заказа.

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

'''Пример ответа:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<itemlist count="3" totalcount="3" page="1" totalpages="1">
  <item>
    <code>123456</code>
    <article>FD343</article>
    <barcode>2345625213125</barcode>
    <name>Sony KDL-55W905 ЖК-телевизор</name>
    <retprice>65000</retprice>
    <purchprice>50000</purchprice>
    <weight>5.1</weight>
    <length>50</length>
    <width>30</width>
    <height>40</height>
    <VATrate>20</VATrate>
    <CountInPallet>30</CountInPallet>
    <CountInBox>2</CountInBox>
    <HasSerials>1</HasSerials>
    <CountryOfOrigin>Малайзия</CountryOfOrigin>  (not yet supported)
    <Message>Хороший телевизор</Message>
    <Message2>Снова хороший телевизор</Message2>
    <quantity>12</quantity>
    <reserved>3</reserved>
  <item>
  ...
</itemlist>
</source>

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

== Движение номенклатуры ==
'''Пример запроса движения номенклатуры:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8" ?>
<itemmovements>
 <auth extra="8" login="login" pass="pass"></auth>
 <code>4259</code>
 <datefrom>2020-10-01</datefrom>
 <dateto>2020-10-02</dateto>
</itemmovements>
</source>

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


'''Пример ответа движения номенклатуры:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8" ?>
<itemmovements count="16">
  <itemmovement>
    <code>151500</code>
    <date>2017-05-26</date>
    <retprice>0</retprice>
    <quantity>1</quantity>
    <delivered>0</delivered>
    <item>
      <code>4259</code>
      <name>Настольная игра Дженга</name>
    </item>
    <status>
      <code>5</code>
      <name>Возврат от покупателя</name>
    </status>
    <store>
      <code>1</code>
      <name>офис в Москве</name>
    </store>
    <order>
      <ordercode>3374830</ordercode>
      <number>123660-0</number>
      <date>2017-05-24</date>
      <orderno>14123</orderno>
      <barcode>0000000670</barcode>
      <company>ТОВАР</company>
      <address>Кравченко ул., 1</address>
      <delivereddate>2017-05-29</delivereddate>
      <deliveredtime>12:00:00</deliveredtime>
      <deliveredto />
    </order>
    <document>
      <code>21991</code>
      <number>318</number>
      <date>2017-05-26</date>
      <message></message>
    </document>
  </itemmovements>
</itemlist>
</source>

''' Описание полей ответа '''
* '''code''' — внутренний код операции движения
* '''date''' — дата операции
* '''retprice''' — цена товара
* '''quantity''' — количество товара операции
* '''delivered''' — количество доставленного товара

* '''item''' — контейнер товара
:* '''code''' — внутренний код товара
:* '''name''' — наименование товара

* '''status''' — контейнер статуса операции
:* '''code''' — код статуса
:* '''name''' — наименование

* '''store''' — контейнер филиала, к которому относится операция
:* '''code''' — код филиала
:* '''name''' — наименование филиала

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

* '''document''' — контейнер документа операции
:* '''code''' — внутренний код документа
:* '''number''' — номер документа
:* '''extnumber''' — внешний номер документа
:* '''date''' — дата документа
:* '''message''' — комментарий

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

'''Пример запроса справочника тарифов по городам'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<tariffs>
 <auth extra="8" login="login" pass="pass" />
 <townfrom>Москва</townfrom>
 <service>1</service>
 <mainonly>1</mainonly>    
</tariffs>
</source>

* '''auth''' — атрибут '''extra''' обязателен, по нему определяется курьерская служба.
* '''townfrom''' — город-отправитель. Если не передан, то городом будет «Москва».
* '''service''' — режим доставки. Обязательный элемент.
* '''mainonly''' — необязательный элемент. Если передан, то в ответе будут данные только по городам из справочника '''Межгород''' > '''Зоны'''.



'''Пример ответа справочника тарифов по городам'''
<source lang="json">
{
    "townfrom": "0c5b2444-70a0-4932-980c-b4dc0d3f02b5",
    "service": 1,
    "tariffs": [
        {
            "towntofias": "0c5b2444-70a0-4932-980c-b4dc0d3f02b5",
            "towntocode": 1,
            "towntoname": "Москва город",
            "townregion": "Город Москва",
            "distance": 0,
            "pricedistance": 0,
            "pricesnew": {
                "before": [
                    {
                        "price": 100,
                        "every": 0,
                        "mass": 1
                    },
                    {
                        "price": 150,
                        "every": 0,
                        "mass": 5
                    }
                ],
                "after": [
                    {
                        "price": 0,
                        "every": 1,
                        "mass": 38.01
                    },
                    {
                        "price": 15,
                        "every": 1,
                        "mass": 51.01
                    }
                ]
            },
            "deliveryPeriodMin": 1,
            "deliveryPeriodMax": 2
        }
    ]
}
</source>

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

== Номенклатура приходной накладной ==
'''Пример запроса номенклатуры приходной накладной:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8" ?>
<itemdoc>
 <auth extra="8" login="login" pass="pass"></auth>
 <code>21991</code>
</itemdoc>
</source>

* '''code''' — внутренний код документа приходной накладной (см. предыдущий запрос).


'''Пример ответа движения номенклатуры:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8" ?>
<itemdoc>
  <code>21991</code>
  <number>318</number>
  <date>2017-05-26</date>
  <message></message>
  <items>
    <item code="4259" quantity="1" barcode="200300" article="123555">Настольная игра Дженга</item>
  </items>
</itemdoc>
</source>

''' Описание полей ответа '''
* '''code''' — внутренний код приходной накладной
* '''number''' — номер документа
* '''date''' — дата документа
* '''message''' — комментарий

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

== Справочник филиалов ==
'''Пример запроса списка филиалов:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8" ?>
<storelist>
 <auth extra="8"></auth>
 <json>YES</json>
 <client_code>7890</client_code>
</storelist>
</source>

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

'''Пример ответа:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8" ?>
<storelist count="2">
  <store>
    <code>123</code>    
    <name>ABC</name> 
  </store>
  <store>
    <code>456</code>   
    <name>Филиал 2</name> 
  </store>
</storelist>
</source>

* '''code''' — Код филиала.
* '''name''' — Наименование филиала.

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

Уникальные запросы списка ПВЗ кешируются на стороне личного кабинета и хранятся до 7 часов утра по московскому времени следующего дня. Например, если уникальный запрос с массой 2 кг был отправлен сегодня в 10 часов, то завтра в 7 утра он сбросится. Если сегодня в 18 часов в этом же запросе вы укажете массу 2 кг, в ответе вернется тот же список ПВЗ. Если передадите массу 3 кг, список может быть другим.

Обратите внимание, что если в выборке количество ПВЗ больше '''10000''' и не указаны параметры '''code''', '''json''' или '''limitcount''', то будет возвращаться ошибка. В этом случае необходимо использовать блок '''limit'''.

'''Пример запроса пунктов самовывоза:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8" ?>
<pvzlist>
 <auth extra="8" login="login" pass="pass"></auth>
 <code>1234</code>
 <client_code>7890</client_code>
 <city>Свердловская область</city>
 <town regioncode="66" country="RU">Нижний Тагил</town>
 <address>Щёлковское шоссе</address>
 <house>77</house>
 <parentcode>6</parentcode>
 <acceptcash>YES</acceptcash>
 <acceptcard>YES</acceptcard>
 <acceptfitting>YES</acceptfitting>
 <maxweight>30</maxweight>
 <acceptindividuals>YES</acceptindividuals>
 <lt>57.924737</lt>
 <lg>59.940019</lg>
 <rt>57.905682</rt>
 <rg>59.984669</rg>
 <json>YES</json>
 <with_coords>YES</with_coords>
 <limit>
    <limitfrom>30</limitfrom>
    <limitcount>2</limitcount>
    <countall>YES</countall>
 </limit>
</pvzlist>
</source>

* '''auth''' — Атрибут '''extra''' — обязателен, по нему определяется курьерская служба, '''login''' и '''pass''' позволяют авторизоваться под клиентом: для отдельного клиента могут быть ограничения по доступности некоторых ПВЗ, и в этом случае они будут учтены.
* '''code''' — Внутренний код.
* '''client_code''' — Код клиента курьерской службы.
* '''city''' — Регион получателя. Можно указать код региона или полное наименование региона из [[#Справочник регионов|справочника регионов]].
* '''town''' — Город получателя.
Для тега города '''town''' можно указать код региона в атрибуте '''''regioncode''''' из [[#Справочник регионов|справочника регионов]]. Поиск будет производиться в указанном регионе.

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

* '''address''' — Фильтр по адресу, работает только в связке с фильтром по городу
* '''house''' — Фильтр по номеру дома, работает только в связке с фильтрами по адресу и городу
* '''parentcode''' — Фильтр по родительскому [[#Справочник филиалов|филиалу]]
* '''acceptcash''' — Фильтр по приему наличных YES/NO
* '''acceptcard''' — Фильтр по приему банковских карт YES/NO
* '''acceptfitting''' — Фильтр по наличию примерки YES/NO
* '''maxweight''' — Фильтр по максимальному весу, с которым работает ПВЗ
* '''acceptindividuals''' — Фильтр по доступности физическим лицам YES/NO
* '''lt''' — Широта левого верхнего угла
* '''lg''' — Долгота левого верхнего угла
* '''rt''' — Широта правого нижнего угла
* '''rg''' — Долгота правого нижнего угла
* '''json''' — Признак вывода ответа в виде JSON YES/NO
* '''with_coords''' — Признак вывода ПВЗ только с наличием координат YES/NO
* '''limit''' — Ограничивает вывод результата.
:* '''limitfrom''' — Задает номер записи результата, начиная с которой выдавать ответ. По-умолчанию — 0.
:* '''limitcount'''- Задает количество записей результата, которые нужно вернуть. По-умолчанию — 100.
:* '''countall''' — YES указывает на необходимость подсчета общего количества найденных совпадений. Это может замедлять выполнение запроса. Если отключено — в ответе не указываeтся totalcount.


'''Пример ответа справочника пунктов самовывоза:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8" ?>
<pvzlist count="2" totalcount="40465">
  <pvz>
    <code>126</code>
    <clientcode>3</clientcode>
    <name>Нижний Тагил</name>
    <parentcode>6</parentcode>
    <parentname>Интеграция</parentname>
    <town code="124267" regioncode="66" regionname="Свердловская область">Нижний Тагил город</town>
    <address>622036, г. Нижний Тагил, ул. Циолковского, д. 17</address>
    <phone>+73435417709, +73435254989</phone>
    <comment>Новый пункт доставки</comment>
    <worktime>Вс 10:00-16:00, Сб 10:00-16:00, Пн-Пт 10:00-20:00</worktime>
    <traveldescription>Жилое 5-ти этажное здание, торцом к дороге, второе здание от перекрестка Пархоменко-Циолковского</traveldescription>
    <maxweight>10</maxweight>
    <acceptcash>YES</acceptcash>
    <acceptcard>YES</acceptcard>
    <acceptfitting>YES</acceptfitting>
    <acceptindividuals>YES</acceptindividuals>
    <latitude>57.93457</latitude>
    <longitude>59.95131</longitude>
    <uid>40606d00-9c51-11eb-b2c9-cfd6c1111392</uid>
  </pvz>
  <pvz>
    <code>245</code>
    <clientcode>NTG1</clientcode>
    <name>На Красноармейской</name>
    <parentcode>6</parentcode>
    <parentname>Интеграция</parentname>
    <town code="124267" regioncode="66" regionname="Свердловская область">Нижний Тагил город</town>
    <address>КРАСНОАРМЕЙСКАЯ, д.79</address>
    <phone>+7(3435)379-044</phone>
    <comment>Возможность примерки отсутствует</comment>
    <worktime>Вс 10:00-16:00, Сб 10:00-16:00, Пн-Пт 10:00-20:00</worktime>
    <traveldescription>Напротив ТЦ Пирамида</traveldescription>
    <maxweight>20</maxweight>
    <acceptcash>YES</acceptcash>
    <acceptcard>YES</acceptcard>
    <acceptfitting>NO</acceptfitting>
    <acceptindividuals>YES</acceptindividuals>
    <latitude>57.93468</latitude>
    <longitude>60.55476</longitude>
    <uid>41116853-9c51-11eb-b2c9-cfd6c1451392</uid>
  </pvz>
</pvzlist>
</source>

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

== Получение фискальных данных заказа ==
'''Пример запроса получения фискальных данных:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<receiptdata>
   <auth extra="8" login="login" pass="pass" />
   <orders>
      <order orderno="123456" />
      <order orderno="890111C" />
   </orders>
</receiptdata>


</source>

'''Пример ответа получения фискальных данных:'''
<source lang="xml">


<?xml version="1.0" encoding="UTF-8"?>
<receipts count="1">
   <receipt>
      <orderno>123456</orderno>
      <fdDatetime>2020-06-07 12:14:00</fdDatetime>
      <fdValue>123</fdValue>
      <fdNum>456</fdNum>
      <fnSn>789</fnSn>
      <kktNum>100</kktNum>
      <inn>222</inn>
      <ofdUrl>gate.ofd.ru</ofdUrl>
      <fullUrl>https://check.ofd.ru/123</fullUrl>
      <price>12345</price>
      <lines count="1">
         <line>
            <item>1111764</item>
            <name>Сапоги</name>
            <qty>1</qty>
            <price>1000</price>
            <vatRate>20</vatRate>
            <governmentCode>Z16513LK2</governmentCode>
            <itemType>1</itemType>
         </line>
      </lines>
   </receipt>
</receipts>
</source>

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

== Справочник Виды срочности ==
'''Пример запроса видов срочности:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8" ?>
<services>
<auth extra="8"/>
</services>
</source>

'''Пример ответа справочника видов срочности:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8" ?>
<services count="2">
  <service>
     <code>1</code>
     <name>Эконом</name>
  </service>
  <service>
     <code>2</code>
     <name>Срочно</name>
  </service>
</services>
</source>

== Справочник дополнительных услуг ==
'''Пример запроса дополнительных услуг:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<advprices>
   <auth extra="8" login="login" pass="pass" />
</advprices>
</source>

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


'''Пример ответа справочника дополнительных услуг:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8" ?>
<advprices>
   <advprice>
       <code>1</code>
       <name>Этажей в доме</name>
       <type>int</type>
   </advprice>
   <advprice>
       <code>2</code>
       <name>Коэффициент надбавки</name>
       <type>float</type>
   </advprice>
   <advprice>
       <code>3</code>
       <name>Расписаться на упаковке</name>
       <type>bool</type>
   </advprice>
</advprices>
</source>

Параметры:
* '''code''' — внутренний код услуги
* '''name''' — наименование услуги. Если поле «название в ЛК» в настройках услуги не пусто, то возвращает значение поля «название в ЛК».
* '''hine''' — подсказка по доп услуге для пользователя
* '''type''' — тип услуги. Может иметь значения:
:* '''bool''' — для услуг вида «чекбокс», «Да»
:* '''float''' — для числа с плавающей точкой
:* '''int''' — для целого числа

== Расчет стоимости доставки ==
'''Пример запроса стоимости доставки:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8" ?>
<calculator>
 <auth extra="8" login="login" pass="pass" />
 <order>
  <pricetype>CUSTOMER</pricetype>
  <sender>
     <town>Санкт-Петербург</town>
     <address>Петровка 38 офис 35</address>
     <coords lat="55.680327" lon="37.604456"></coords>
   </sender>
   <receiver>
     <zipcode>125480</zipcode>
     <town regioncode="78" country="RU">Санкт-Петербург</town>
     <address>Петровка 38 офис 35</address>
     <pvz>124</pvz>
     <coords lat="55.680327" lon="37.604456"></coords>
   </receiver>
   <weight>5.1</weight>
   <service>2</service>
   <paytype>CASH</paytype>
   <price>387.5</price>
   <deliveryprice>150</deliveryprice>
   <inshprice>387.5</inshprice>
   <packages>
      <package mass="1" quantity="5"></package>
      <package mass="2.5" length="10" width="20" height="30"></package>
   </packages>
   <userid>user123</userid>
   <groupid>customer</groupid>
 </order>
</calculator>
</source>


Параметры:
Структура данных и заполнение полей аналогичны и совместимы с [[#Оформление заказа]].

Дополнительные поля:
* '''pricetype''' — тип требуемой цены. Возможные значения: «CUSTOMER» (по-умолчанию) — [[Личный кабинет клиента#Цена доставки для получателя|цена для конечного получателя]], «CLIENT» — цена курьерской службы для клиента.
* '''userid''' — Идентификатор пользователя, строковый или числовой тип. Виртуальное поле. Необязательное. Данное поле используется совместно с настройками «Цена доставки для получателя», определяя приоритет правила. Можно использовать в различных CMS/CRM системах, настраивая цены для определенного покупателя.
* '''groupid''' — Идентификатор группы пользователя, строковый или числовой тип. Виртуальное поле. Необязательное. Данное поле используется совместно с настройками «Цена доставки для получателя», определяя приоритет правила. Можно использовать в различных CMS/CRM системах, настраивая цены для определенной группы покупателей.

Суммы НП и ОЦ, а также тип оплаты CARD имеют значение при настроенных в тарифе на вкладке Прочее долях (в процентах) от данных сумм.

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


'''Пример ответа стоимости доставки:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<calculator>
  <calc>
    <townfrom code="1">Москва город</townfrom>
    <townto code="56603">Иркутск город</townto>
    <mass>3.7</mass>
    <service name="Экспресс">1</service>
    <zone>2</zone>
    <price>1113</price>
    <mindeliverydays>1</mindeliverydays>
    <maxdeliverydays>3</maxdeliverydays>
    <mindeliverydate>2020-05-13</mindeliverydate>
    <intervals>
        <workdays>
            <interval>10:00-16:00</interval>
            <interval>16:00-22:00</interval>
        </workdays>
        <holidays>
            <interval>12:00-16:00</interval>
        </holidays>
    </intervals>
    <deliveryprice>
     <advprice code="1" price="1000">База</advprice>
     <advprice code="4" price="100">Процент от суммы руб</advprice>
     <advprice code="5" price="63">Процент от объявленной стоимости</advprice>
     <advprice code="6" price="-50">Скидка при доставке</advprice>
    </deliveryprice>
  </calc>
</calculator>
</source>

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

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

== Получение информации о клиенте ==
'''Пример запроса получения информации о клиенте:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8" ?>
<client>
  <auth extra="8" login="login" pass="pass" /> 
</client>
</source>

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

'''Пример ответа на запрос получения информации о клиенте:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8" ?>
<client>
  <code>1082</code>
</client>
</source>

* '''code''' — Код клиента

== Список актов передачи денег ==
'''Пример запроса списка актов передачи денег:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8" ?>
<smalist>
  <auth extra="8" login="login" pass="pass" />
  <datefrom>2016-02-10</datefrom>
  <dateto>2016-03-10</dateto>
</smalist>
</source>

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

'''Пример ответа на запрос списка актов передачи денег:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<smalist count="1">
  <sma>
    <code>6278</code>
    <number>3992</number>
    <actdate>2016-02-12</actdate>
    <datepay></datepay>
    <dateto>2016-02-12</dateto>
    <promiseddatepay></promiseddatepay>
    <price>637.00</price>
    <pricecorr>113.00</pricecorr>
    <rur>13430.00</rur>
    <pricekur>570.00</pricekur>
    <priceag>67.00</priceag>
    <payno>42423</payno>
    <paytype>1</paytype>
    <paytypename>Безнал</paytypename>
    <signedcopyreceived>NO</signedcopyreceived>
  </sma>
</smalist>
</source>

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

== Детализация актов передачи денег ==
'''Пример запроса детализации актов передачи денег:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8" ?>
<smadetail>
  <auth extra="8" login="login" pass="pass" />
  <code>6278</code>
</smadetail>
</source>

'''smadetail''' — Корневой контейнер. Обязательный элемент.
* '''auth''' — Авторизация. Обязательный элемент.
* '''code''' — Код акта передачи денег (см. запрос списка АПД). Обязательный элемент.

'''Пример ответа на запрос детализации актов передачи денег:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<smadetail count="2">
  <specialsma>
    <code>42494</code>
    <ordercode>14424</ordercode>
    <orderno>11111</orderno>
    <orderdate>2018-01-01</orderdate>
    <delivereddate>2018-10-01</delivereddate>
    <company>Компания</company>
    <price>314.00</price>
    <rur>8800.00</rur>
    <inshprice>314.00</inshprice>
    <pricekur>270.00</pricekur>
    <priceag>44.00</priceag>
    <pricecalc>8486.00</pricecalc>
    <paytype>2</paytype>
    <paytypename>наличными курьером</paytypename>
    <weight>0.400</weight>
    <distance>0.0</distance>
    <status>Доставлено</status>
  </specialsma>
</smadetail>
</source>

* '''code''' — Код записи.
* '''ordercode''' — Код заказа.
* '''orderno''' — Шифр заказа.
* '''orderdate''' — Дата заказа.
* '''delivereddate''' — Дата доставки.
* '''company''' — Получатель.
* '''price''' — Стоимость услуг.
* '''rur''' — Сумма заказа.
* '''inshprice''' — Стоимость заказа.
* '''pricekur''' — Стоимость курьерской доставки.
* '''priceag''' — Агентское вознаграждение.
* '''pricecalc''' — Сумма для передачи агенту.
* '''paytype''' — Тип оплаты: 1 — безнал, 2 — наличными курьером, 3 — наличными в офисе, 4 — перевод на карту.
* '''paytypename''' — Строковое представление типа оплаты
* '''weight''' — Вес заказа.
* '''distance''' — Дистанция по заказу
* '''status''' — Статус заказа.

== Генерация коротких ссылок ==
В некоторых случаях, например, при использовании в СМС, может потребоваться использование коротких ссылок на ЛК.
Для этого, необходимо отправить запрос с полной ссылкой, в ответ на который придёт хэш-код для ссылки.

'''Пример запроса генерации коротких ссылок:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8" ?>
<shortlink>
  <link short="0"> https://home.courierexe.ru/8/site/orders </link>
</shortlink>
</source>

'''shortlink''' — Корневой контейнер. Обязательный элемент.
* '''link''' — Полная ссылка, для которой необходимо получить код. Обязательный элемент. Если атрибут '''short''' равен 1, то ответ не будет содержать XML, а только хэш-код.

'''Пример ответа на запрос генерации коротких ссылок:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<shortlink>
  <hash>35AF350C</hash>
</shortlink>
</source>

* '''hash''' — Хэш-код ссылки.

Далее, можно использовать ссылку на ЛК:

<nowiki>https://home.courierexe.ru/35AF350C или curie.ru/35AF350C</nowiki>


'''Примечание!''' Сервис коротких ссылок работает только для ресурсов компании MeaSoft.

== Проверка надежности покупателя ==
Проверка надежности работает только для тарифа «Максимум» личного кабинета.

<source lang="xml">
<?xml version="1.0" encoding="UTF-8" ?>
<mcheck>
  <auth extra="8" login="login" pass="pass" />
  <phones>
    <phone>89161147992</phone>
  </phones>
</mcheck>
</source>

Ответ:

<source lang="xml">
<?xml version="1.0" encoding="UTF-8" ?>
<mcheck>
  <phones>
    <phone rate="90">89161147992</phone>
  </phones>
</mcheck>
</source>


== Размещение страниц на своем сайте (iframe) ==

В некоторых случаях имеет смысл разметить те или иные страницы на своем сайте.

Например, чтобы клиенты могли рассчитать стоимость доставки не переходя по внешней ссылке, а там же, на сайте, калькулятор можно разместить прямо на странице такого сайта посредством так называемого фрейма — '''iframe'''.

[https://ya.ru/search/?text=iframe Фрейм] — контейнер внутри обычной страницы, который позволяет загружать сторонние страницы. Пример загрузки калькулятора:

<source lang="html">
<iframe id="frame" src="https://home.courierexe.ru/8/calculator">
    Здесь должен отобразиться калькулятор
</iframe>
</source>

Для удобства пользователей вашего сайта можно указать язык интерфейса (который переключается непосредственно на сайте) параметром '''lang''':

<source lang="html">
<iframe id="frame" src="https://home.courierexe.ru/8/calculator?lang=2">
    Здесь должен отобразиться калькулятор
</iframe>
</source>

Обратите внимание! Если язык не указать, то на страницах калькулятора и трекинга отображается свой переключатель языка. Если язык указан, то переключатель не отоборажается.

Поддерживаемые языки и их коды:
:'''1''' — русский
:'''2''' — английский
:'''4''' — узбекский