Меасофт - Вклад участника [ru]

API

2019-05-13T08:52:51Z

Boyko: /* Трекинг заказа по номеру */

<div style="font-size: 24px; 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>

В системе "Курьерская служба 2008" имеется возможность интеграции средствами XML API, по протоколу HTTP POST.

Данное API предназначено для интеграции клиентов (интернет-магазинов и прочих компаний-заказчиков доставки) с [http://courierexe.ru/our_clients.htm курьерскими службами], работающими под управлением системы [https://curie.ru/ MeaSoft "Курьерская служба 2008"]. Если Вы являетесь '''агрегатором''', передающим данные от клиентов, возможно, Вам придется последовательно подключаться под разными пользователями, если курьерская служба должна вести раздельный учет взаиморасчетов по клиентам. Если Вы являетесь '''подрядчиком''' - Вы можете забирать заказы, используя значение client=AGENT в запросе [[#Пример запроса статуса заказа|statusreq]], и передавать статусы заказов используя метод [[#Изменение статуса агентом|setorderinfo]]. Так же для интеграций с подрядчиками у нас есть специальная платформа, но добавлять подрядчиков в нее можно только на нашей стороне. Присылайте нам коммерческое предложение, описание Вашего сервиса, и мы с радостью его рассмотрим.

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

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

== Готовые интеграции ==

Для интеграции с популярными CMS можно скачать модули интеграции

{| class="wikitable" align="center" style="width: 80%; margin: auto; color: black; boreder: 1px solid #999999;" cellpadding="10" cellspacing="0"
!style="width: 35%;"|Система управления контентом (CMS)
!style="width: 15%;"|Версия модуля
!style="width: 15%;"|Ссылка
!style="width: 35%;"|Примечание
|-
|[[Файл:bitrix.png|center|x44px]]
|style="text-align: center;"|1.5.9 от 13.12.2018
|style="text-align: center;"|[http://marketplace.1c-bitrix.ru/solutions/measoft.courier/ Установить] 
|Поддерживает версии 14.5 и выше
|-
|[[Файл:prestashop.png|center|x44px]]
|style="text-align: center;"|1.4.5 от 10.10.2018
|style="text-align: center;"|[http://courierexe.ru/download/api/prestashop.zip Скачать]
|Поддерживает версии 1.5.2.0 и выше (2.x в том числе!)
|-
|[[Файл:OpencartOCStore.png|center|x44px]]
|style="text-align: center;"|1.7.5 от 10.08.2018<br>2.0.0 от 01.12.2018<br>3.1.1 от 28.02.2019
|style="text-align: center;"|[http://courierexe.ru/download/api/opencart.zip Скачать]<br><br>[http://courierexe.ru/download/api/opencart_2.zip Скачать]<br><br>[http://courierexe.ru/download/api/opencart_3.zip Скачать]
|Поддерживает версии с 1.5.5.1<br>Версия 2.0.0 поддерживает версии с 2.0<br>[https://opencartforum.com/files/file/2906-avtomatizaciya-otpravki-i-otslezhivanie-dostavok-courierexe-dlya-opencart-15x/ Альтернативный модуль сторонних разработчиков]
|-
|[[Файл:webasyst-shopscript.png|center|x44px]]
|style="text-align: center;"|1.3.5 от 14.03.2018<br>1.3.4 от 02.03.2019
|style="text-align: center;"|[http://www.webasyst.ru/store/plugin/shop/measoftcourier/ Установить плагин]<br>[https://www.webasyst.ru/store/plugin/shipping/measoftcourier/ Установить модуль]
|Плагин предназначен для отправки заявок в КС, а модуль для расчета стоимости доставки при оформлении заказа.
|-
|[[Файл:insales.png|center|x44px]]
|style="text-align: center;"|1.2.1 от 06.09.2017
|style="text-align: center;"|[http://www.insales.ru/collection/all/product/kurierskaya-sluzhba-2008 Установить]
|[http://wiki.courierexe.ru/index.php?title=Интеграция_с_другими_системами#Insales Настраивается] в ЛК пользователя в системе
|-
|[[Файл:Leadvertex.png|center|x44px]]
|style="text-align: center;"|1.0 от 15.11.2016
|style="text-align: center;"|[[Файл:Leadvertex-howto.png|center|x44px]]
|[http://blog.leadvertex.ru/news/2110-integraciya-s-kurerkami-na-platforme-measoft/ Настраивается] в ЛК пользователя в системе [https://Leadvertex.ru Leadvertex]
|-
|[[Файл:Retailcrm.png|center|x44px]]
|style="text-align: center;"|1.0 от 11.01.2018
|style="text-align: center;"|[https://www.retailcrm.ru/ RetailCRM]
|[http://wiki.courierexe.ru/index.php?title=Интеграция_с_другими_системами#RetailCRM Настраивается] в ЛК пользователя в системе
|-
|[[Файл:1C.jpg|center|x44px]]
|style="text-align: center;"|1.4 от 17.11.2017
|style="text-align: center;"|-
|[https://infostart.ru/public/692790/ Альтернативный модуль сторонних разработчиков]
|-
|[[Файл:Joomla2.jpg|center|x44px]]
|style="text-align: center;"|1.0.0 от 12.11.2018
|style="text-align: center;"|[http://courierexe.ru/download/api/com_measoft.zip Скачать]
|Внимание! Модуль новый, поэтому возможна некорректная передача данных. Проверяйте, если что - сообщайте, исправим!
|-
|[[Файл:Amocrm.png|center|x44px]]
|style="text-align: center;"|-
|style="text-align: center;"|[https://www.amocrm.ru/extensions/courier2008 Установить]
|Внимание! Модуль новый, поэтому возможна некорректная передача данных. Проверяйте, если что - сообщайте, исправим!
|-
|[[Файл:MoySclad.jpg|center|x44px]]
|style="text-align: center;"|-
|style="text-align: center;"|[https://home.courierexe.ru/moysklad/step1 Подключение] [[Инструкция Мой склад|Инструкция]]
|Ожидается в ближайшее время в магазине Мой Склад
|-
|}

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

== Тестовый аккаунт ==

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

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

== Рабочий аккаунт для подключения ==

Для подключения к площадке Вашего клиента необходимо иметь три параметра:

1. '''Параметр extra''' (Цифровой код, уникальный идентификатор компании. Запросите этот параметр у компании, с которой Вы интегрируетесь). Посмотреть этот код можно в интерфейсе программы КС2008 через основное меню '''"Справочники - Дополнительные возможности"'''. Цифровое значение будет указано во второй гиперссылке (на скриншоте ниже отмечено "звездочкой"):

[[Файл:extra1.png|750px]]

2. '''Логин''' - параметр учетной записи для ЛК клиента и API, указывается в карточке клиента на вкладке '''"Прочее"''' в поле '''"Имя пользователя"'''. Возможно, что в программе КС2008 понадобится создать новую карточку клиента (на скриншоте ниже).

3. '''Пароль''' - параметр учетной записи для ЛК клиента и API, указывается в карточке клиента на вкладке '''"Прочее"''' в поле '''"Пароль"''' (на скриншоте ниже).

[[Файл:33_client.png|500px]]

== Общие понятия ==

На стороне курьерской службы имеется веб-сервис по адресу: https://home.courierexe.ru/api/. <rspoiler text="Еще есть порт 8443.">Некоторые маршрутизаторы, используемые провайдерами, РНК и прочее, в попытке глубокого анализа, могут повреждать трафик на стандартный порт 443. Сделано по тикету 10964.</rspoiler> Тестовые авторизационные данные: логин: test пароль: testm, параметр 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; < на &lt; > на &gt; " на &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>

== Ограничения ==
С целью защиты от нецелевого использования сервисов, с 29.05.2017 ведено ограничение на запросы - 1500 запросов с одного IP-адреса за 20 минут. В случае превышения IP-адрес блокируется, разблокировка возможна путем обращения в техническую поддержку, с последующим обсуждением ваших алгоритмов и их коррекцией.

Для проверки статусов заказов лучше всего использовать запросы [[#Передача только изменившихся статусов|"statusreq" с параметром changes=ONLY_LAST]]. Не нужно пытаться "бомбить" наше API запросами с номерами всех ваших заказов, особенно - запросами "tracking", они предназначены не для этого (смотрите описание).

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

<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>Чип & Дейл</person>
<phone>123-45-67</phone>
<zipcode>125480</zipcode>
<town regioncode="78">Санкт-Петербург</town>
<address>Петровка 38 офис 35</address>
<pvz>124</pvz>
<date>2014-03-22</date>
<time_min>09:00</time_min>
<time_max>14:00</time_max>
</receiver>
<return>NO</return>
<weight>5.1</weight>
<return_weight>5.1</return_weight>
<quantity>2</quantity>
<paytype>CASH</paytype>
<service>2</service>
<return_service>1</return_service>
<type>3</type>
<return_type>3</return_type>
<price>387.5</price>
<deliveryprice>150</deliveryprice>
<inshprice>387.5</inshprice>
<receiverpays>NO</receiverpays>
<enclosure>Детские игрушки</enclosure>
<instruction>Проверить при покупателе, подписать акт</instruction>
<department>Отдел</department>
<pickup>NO</pickup>
<acceptpartially>NO</acceptpartially>
<items>
<item extcode="abc123" quantity="1" mass="0.2" retprice="37.5" VATrate="0" barcode="2345625213125" article="1" volume="3">Мяч</item>
<item extcode="abc124" quantity="2" mass="2" retprice="100" VATrate="10" barcode="4645625213138" article="2" length="10" width="20" height="30">Обруч</item>
<item extcode="abc125" quantity="3" mass="0.3" retprice="50" barcode="2345625213126" article="3" type="1">Погремушка желтая</item>
</items>
<packages>
<package strbarcode="ORD0000001" mass="1" message=""></package>
<package strbarcode="ORD0000002" mass="2.5" message="" length="10" width="20" height="30"></package>
</packages>
<deliveryset above_price="100" return_price="1000">
<below below_sum="500" price="500" />
<below below_sum="2000" price="300" />
</deliveryset>
</order>
</neworder>
</source>

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

*'''neworder''' - Корневой контейнер, обязательный элемент.

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

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

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

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

*'''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>
<pvz>Код пункта самовывоза по справочнику</pvz>
<date>Дата доставки в формате "YYYY-MM-DD"</date>
<time_min>Желаемое время доставки в формате "HH:MM"</time_min>
<time_max>Желаемое время доставки в формате "HH:MM"</time_max>
</receiver>
</source>

*'''company''' - Компания-получатель.
*'''person''' - Контактное лицо. ''Должно быть заполнено хотя бы одно из полей - company или person!''
*'''phone''' - Телефон. Можно указывать несколько телефонов, E-mail в этом поле.
*'''town''' - Город.

Для тега города '''town''' можно указать код региона в атрибуте '''''regioncode''''' из [[#Справочник регионов|справочника регионов]]. Поиск будет производиться в указанном регионе.

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

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

*'''paytype''' - Тип оплаты заказа получателем. Принимает значения:
:* CASH - Наличными при получении (по-умолчанию)
:* CARD - Картой при получении
:* NO - Без оплаты. Поле Price будет проигнорировано. (Этот тип оплаты передается, если заказ уже оплачен и не требует инкассации, API добавит в систему товары по нулевой цене. Если необходимо передать общую сумму заказа - можно это сделать в поле <inshprice>, указав объявленную ценность)
:* OTHER - Прочее (Предусмотрен для того, чтобы оплата поступала непосредственно в курьерскую службу посредством прочих типов оплаты - таких как: вебмани, яденьги, картой на сайте, прочие платежные системы и т.д.)
:* OPTION - На выбор получателя. Этот тип оплаты нельзя передавать с заказом. Он выставляется автоматически в зависимости от настройки клиента.

*'''zipcode''' - Почтовый индекс.
*'''weight''' - Общий вес заказа в килограммах.
*'''return_weight''' - Общий вес возврата заказа в килограммах.
*'''quantity''' - Количество мест.
*'''service''' - Режим доставки (тип услуги) передается код из справочника "Виды срочности".
*'''return_service''' - Режим возврата (тип услуги) передается код из справочника "Виды срочности".
*'''type''' - Тип корреспонденции (отправления) передается код из справочника "Типы корреспонденции".
*'''return_type''' - Тип возвратной корреспонденции (отправления) передается код из справочника "Типы корреспонденции".
*'''price''' - Сумма заказа. В случае наличия контейнера items значение данного параметра будет проигнорировано, и рассчитано автоматически.
*'''deliveryprice''' - Сумма доставки. В случае наличия контейнера items, в него будет добавлено вложение "Доставка".
*'''return''' - Признак необходимости возврата.
*'''return_service''' - Режим возврата (тип услуги) передается код из справочника "Виды срочности".
*'''enclosure''' - Вложение.
*'''inshprice''' - Объявленная ценность.
*'''instruction''' - Поручение - Примечание.
*'''receiverpays''' - Признак оплаты стоимости доставки получателем YES/NO. Если стоит YES, то курьер увидит, что с получателя нужно также взять стоимость доставки.
*'''department''' - Подразделение, в котором оформляется заказ.
*'''pickup''' - Признак оформления забора YES/NO. Если стоит YES, то весь заказ считается заданием на забор груза, а не на доставку! Применяется для вызова курьера к отправителю для забора других отправлений.
*'''acceptpartially''' - Признак возможности частичного выкупа товаров отправления YES/NO.

*'''items''' - Контейнер для описания вложений. Необязательный контейнер. Атрибуты:
:* '''''item''''' - Название вложения.
:* '''''quantity''''' - Количество единиц товара.
:* '''''mass''''' - Масса единицы товара в килограммах.
:* '''''volume''''' - Объемный вес единицы товара в килограммах. При указании объемного веса значение подставляется вместо массы
:* '''''length''''' - Длина единицы товара.
:* '''''width''''' - Ширина единицы товара.
:* '''''height''''' - Высота единицы товара.
:* '''''retprice''''' - Цена единицы товара.
:* '''''VATrate''''' - Ставка НДС - целое число процентов. Если значение не указано, подставляется значение "18".
:* '''''barcode''''' - Штрих-код вложения. [[Файл:Article.png|thumb|100px|right]]
:* '''''article''''' - Артикул вложения. ''Внимание!'' Указание артикула используется только тогда, когда товар хранится на ответственном хранении в службе доставки, и необходима комплектация. В этом случае система пытается привязать товар к [[API#Справочник номенклатуры|справочнику номенклатуры]]. Если товар в справочнике не найден - система выдаст соответствующую ошибку. Если по артикулу найдено несколько товаров - система выберет один из них случайным образом, что может привести к ошибочной комплектации! Если товар НЕ на ответственном хранении - артикул указывать НЕ нужно. Позиция попадет в систему просто текстом.
:* '''''type''''' - Тип вложения. Принимает значения:
:: 1 - Товар
:: 2 - Доставка (Такое вложение добавится автоматически, если заполнить order->deliveryprice)
:: 3 - Услуга
:: 4 - Предоплата (сумма)
:: 6 - Оплата кредитом (сумма)
:* '''''extcode''''' - Внешний код строки. Используется для идентификации строк заказов при получении статусов. Необязательное поле.

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

* '''deliveryset''' - настройка [[Дифференциальная стоимость доставки | дифференциальной стоимости доставки]]. Атрибуты:
:* '''''above_price''''' - стоимость в случае полного выкупа заказа
:* '''''return_price''''' - стоимость в случае возврата заказа

* '''below''' - граница стоимости настроек
:* '''''below_sum''''' - граница стоимости выкупаемого заказа
:* '''''price''''' - стоимость выкупаемого заказа до соответствующей границы

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

=== Примеры ответов ===

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

<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<neworder>
<createorder orderno="AB23541" error="0" errormsg="success"></createorder>
<createorder orderno="55_6542" error="0" errormsg="success"></createorder>
<createorder orderno="AB23542" error="0" errormsg="success"></createorder>
</neworder>
</source>

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

<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<neworder>
<createorder orderno="AB23541" error="17" errormsg="Such number exists"></createorder>
<createorder orderno="AB23542" error="13" errormsg="empty company"></createorder>
<createorder orderno="AB23543" error="14" errormsg="empty person"></createorder>
</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>

=== Коды ошибок при оформлении заказа ===

0 - Ошибок нет.

1 - Ошибка авторизации. (отсутствуют теги <auth login="" pass=""></auth>, неверный логин или пароль).

2 - Отправлен пустой запрос (отсутствует контейнер <neworder></neworder> в XML документе).

3 - Некорректно указана сумма заказа.

4 - Некорректный общий вес заказа.

5 - Не найден город получатель.

6 - Не найден город отправитель.

7 - Не заполнен адрес получателя.

8 - Не заполнен телефон получателя.

9 - Не заполнено контактное имя получателя.

10 - Не заполнено название компании получателя.

11 - Некорректная сумма объявленной ценности.

12 - Артикул не найден.

13 - Не заполнено название компании отправителя.

14 - Не заполнено контактное имя отправителя.

15 - Не заполнен телефон отправителя.

16 - Не заполнен адрес отправителя.

17 - Заказ с таким номером уже существует.

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

=== Пример запроса статуса заказа ===

<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>
<ordercode>34234</ordercode>
<givencode>234534</givencode>
<datefrom>2016-07-21</datefrom>
<dateto>2016-07-21</dateto>
<target>Автозавод</target>
<done>ONLY_NOT_DONE</done>
<changes>ONLY_LAST</changes>
<quickstatus>NO</quickstatus>
</statusreq>
</source>

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

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

*'''changes''' - может принимать значение только ONLY_LAST. Если указан этот параметр, все остальные, кроме quickstatus, игнорируются. Описание данного режима приведено здесь: [[#Передача только изменившихся статусов|Передача только изменившихся статусов]]

*'''quickstatus''' - Указывает "глубину" передаваемых статусов: "YES" (по-умолчанию) - передаются статусы начиная с информации, поступившей от курьера. Такие статусы являются быстрыми (как правило, проставляются курьером сразу после доставки) но не всегда точными. Значение NO запрещает передачу статуса со слов курьера, и выдает только статусы, введенные оператором, как правило вручную. На это требуется больше времени, однако точность гораздо выше. Не рекомендуется совмещать эти типы передачи статусов (чередовать их) при запросе только изменившихся статусов, т.к. в этом случае система будет считать, что статусы у отправлений меняются.

<div style="color: #a94442; background-color: #f2dede; border: 1px solid #ebccd1; padding: 3px 10px 10px;">
'''Обратите внимание!'''
# Периода запроса статусов (контейнеры '''datefrom''' и '''dateto''') ограничивается двумя месяцами — два месяца до даты '''"по"'''.
# Если не указаны обе даты — '''dateto''' принимается равной текущей дате.
# Если не указана дата '''dateto''' — она принимается равной '''datefrom''' плюс 2 месяца.
# Если не указана дата '''datefrom''' — она принимается равной '''dateto''' минус 2 месяца.
</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>
<zipcode>125480</zipcode>
<town code="153361" regioncode="78" regionname="Санкт-Петербург город">Санкт-Петербург город</town>
<address>Петровка 38 офис 35</address>
<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>
</receiver>
<weight>5.1</weight>
<return_weight>5.1</return_weight>
<quantity>2</quantity>
<paytype>CASH</paytype>
<service>2</service>
<return_service>2</service>
<type>3</type>
<return_type>3</return_type>
<waittime>12</waittime>
<price>387.5</price>
<print_check>YES</print_check>
<inshprice>387.5</inshprice>
<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">
<>..</> (price details are not yet supported)
..
</deliveryprice>
<receiverpays>NO</receiverpays>
<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>
<customstatecode>2<customstatecode>
<clientstatecode></clientstatecode>
<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">Мяч</item>
<item code="34456" extcode="abc124" quantity="2" mass="2" retprice="100" VATrate="10" barcode="4645625213138" article="2" returns="0">Обруч</item>
<item code="34421" extcode="abc125" quantity="3" mass="0.3" retprice="50" VATrate="18" barcode="2345625213126" article="3" returns="0">Погремушка желтая</item>
</items>
<packages>
<package code="33331" strbarcode="ORD0000001" mass="1" message=""></package>
<package code="33332" strbarcode="ORD0000002" mass="2.5" message=""></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''''' - внутренний код заказа в системе, применяется для некоторых внутренних операций.

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

* '''''coords''''' в контейнере '''receiver''' - координаты получателя.
* '''currcoords''' - текущие координаты заказа. Атрибуты:
:* '''''lat''''' - широта
:* '''''lon''''' - долгота
:* '''''accuracy''''' - точность в метрах
:* '''''RequestDateTime''''' - дата/время последнего обновления координат.

* '''waittime ''' - Время ожидания курьера.
* '''deliveryprice''' - стоимость доставки в валюте расчетов с клиентом.
* '''status''' - статус доставки (список статусов см. ниже). Атрибуты (заполняются начиная с версии системы 2008.0.0.670):
:* '''''eventstore''''' - филиал, к которому относится текущий статус
:* '''''eventtime''''' - время изменения статуса (время зависит от местонахождения филиала)
:* '''''createtimegmt''''' - время фактического изменения статуса (GMT)
:* '''''message''''' - наименование филиала-получателя, при передаче между филиалами
:* '''''title''''' - русское наименование статуса

* '''statushistory''' - история статусов доставки. Содержит список контейнеров '''status'''. Заполняется только для тарифа "Премиум" начиная с версии системы 2008.0.0.670.
* '''customstatecode''' - код внутреннего статуса курьерской службы. Значения уточняйте в курьерской службе. Назначаются курьерской службой в разделе "Справочники" - "Статусы" - "15 Статусы корреспонденции". Справочник не передается через API клиенту по причине возможного наличия в нем внутренних технологических статусов курьерской службы.
* '''clientstatecode''' - код статуса клиента. Используется, если клиент предлагает свои коды статусов доставки/причин недоставки.
* '''deliveredto''' - данные о вручении, либо причина недоставки.
* '''delivereddate''' - дата вручения.
* '''deliveredtime''' - время вручения. В случае недоставки может быть пустым.
* '''outstrbarcode''' - код у подрядчика (код заказа во внешней системе). Используется в интеграциях с внешними системами.

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

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

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

# Атрибуты контейнера '''status''' заполняются для версий системы '''2008.0.0.670''' и новее.
# Контейнер '''statushistory''' заполняется для тарифа "[[Личный_кабинет#.D0.9F.D0.BE.D0.B4.D0.BA.D0.BB.D1.8E.D1.87.D0.B5.D0.BD.D0.B8.D0.B5|Премиум]]" и версий системы '''2008.0.0.670''' и новее.
</div>
<br />

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

Для получения только изменившихся статусов отправьте запрос
<source lang="xml">
<?xml version="1.0" encoding="UTF-8" ?>
<statusreq>
<auth extra="8" login="login" pass="pass"></auth>
<changes>ONLY_LAST</changes>
<quickstatus>NO</quickstatus>
</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>
</commitlaststatus>
</source>

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

*'''auth''' - Авторизация. Обязательный элемент.
*'''client''' - Признак клиента или агента. Необязательный элемент.
:* CLIENT - Признак клиента, значение по умолчанию
:* AGENT - Признак агента. В ответ отдается информация по заказам, переданным агенту на доставку

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

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

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

# При данном способе передачи (<changes>ONLY_LAST</changes>) система просматривает заказы, оформленные за последние 3 месяца. Если заказ сделан ранее - изменение статуса по нему не попадет в результат выполнения данного запроса.
# Система всегда выдает текущий статус. Т.е. Вы можете одним запросом получить статус "NEW", а следующим - "COMPLETE". В промежутке между запросами отправление могло пройти через несколько промежуточных статусов.
# Система никогда не гарантирует последовательность прохождения заказом набора статусов. Т.е. Вы можете получить статус "COMPLETE", а следующим запросом - "NEW" - такое может произойти, например, если оператор ошибочно отметил заказ выполненным, а затем исправил ошибку.
</div>
<br />

== Получение вложений к накладной ==

'''Пример запроса:'''
<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.

== Трекинг заказа по номеру ==

Запрос трекинга по номеру предназначен для выдачи минимальной обезличенной информации о конкретном заказе не авторизованному пользователю. Наша система имеет для этого интерфейс по адресу "home.courierexe.ru/{код экстра}/tracking". Вы можете либо сделать ссылку на такую страницу на своем сайте, либо разместить ее 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="1234">
<sender>
<town code="1" country="RU">Москва город</town>
<date></date>
</sender>
<receiver>
<town code="1" country="RU">Москва город</town>
<date>2015-04-18</date>
</receiver>
<AWB>BarCode</AWB>
<weight>0</weight>
<quantity>1</quantity>
<currcoords lat="" lon="" accuracy="" RequestDateTime="" />
<status eventstore="филиал в Санкт-Петербурге" eventtime="2016-06-02 17:22:00" createtimegmt="2016-06-03 16:14:44" message="" title="Доставлен" country="RU">COMPLETE</status>
<statushistory>
<status eventstore="Офис в Москве" eventtime="2016-05-30 10:20:00" createtimegmt="2016-06-03 16:14:44" message="" title="Новый" country="RU">NEW</status>
<status eventstore="Офис в Москве" eventtime="2016-06-01 17:38:00" createtimegmt="2016-06-03 16:14:44" message="филиал в Санкт-Петербурге" title="Планируется отправка" country="RU">DEPARTURING</status>
<status eventstore="Офис в Москве" eventtime="2016-06-01 19:53:00" createtimegmt="2016-06-03 16:14:44" message="филиал в Санкт-Петербурге" title="Отправлено со склада" country="RU">DEPARTURE</status>
<status eventstore="филиал в Санкт-Петербурге" eventtime="2016-06-02 07:41:00" createtimegmt="2016-06-03 16:14:44" message="" title="Получен складом" country="RU">ACCEPTED</status>
<status eventstore="филиал в Санкт-Петербурге" eventtime="2016-06-02 09:17:00" createtimegmt="2016-06-03 16:14:44" message="" title="Выдан курьеру на доставку" country="RU">DELIVERY</status>
<status eventstore="филиал в Санкт-Петербурге" eventtime="2016-06-02 17:22:00" createtimegmt="2016-06-03 16:14:44" message="" title="Доставлен (предварительно)" country="RU">COURIERDELIVERED</status>
<status eventstore="филиал в Санкт-Петербурге" eventtime="2016-06-02 17:22:00" createtimegmt="2016-06-03 16:14:44" message="" title="Доставлен" country="RU">COMPLETE</status>
</statushistory>
</order>
</tracking>
</source>

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

'''Пример запроса:'''
<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|Запроса статусов заказов]].

== Изменение статуса агентом ==

Запрос изменения статуса заказа позволяет установить окончательный статус заказа - "Доставлен" или "Не доставлен (Возврат/Отмена)".

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

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

'''Пример запроса изменения статуса:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8" ?>
<setorderinfo>
<auth extra="8" login="login" pass="pass" />
<order ordercode="123456" date="2018-03-01" time="10:00" message="Клиент отказался от покупки"/>
<order ordercode="234567" date="2018-03-01" time="10:00" message="">
<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''''' - Внутренний код заказа.
:* '''''date''''' - Дата изменения статуса.
:* '''''time''''' - Время изменения статуса.
:* '''''message''''' - текст сообщения.

*'''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>
</waybill>
</source>

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

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

'''Пример ответа:'''
<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" ?>
<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>

== Справочник городов ==

'''Пример запроса справочника городов:'''
<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>
<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''' - Поиск по всем населенным пунктам региона.
:* '''namecontains''' - Поиск населенных пунктов, название которых содержит указанный текст.
:* '''namestarts''' - Поиск населенных пунктов, название которых начинается с указанного текста.
:* '''name''' - Поиск населенных пунктов, название которых соответствует указанному тексту.
:* '''fullname''' - Поиск населенных пунктов, название вместе с типом населенного пункта которых соответствует указанному тексту.
:* '''country''' - Поиск только по стране с указанным кодом.

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

'''Пример ответа:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<townlist 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)
</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 />
</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 />
</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>1</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>
<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>
</conditions>
<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 - Все. ''Это поле может быть недоступным в некоторых установках.''

*'''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>
<CountInPallet>30</CountInPallet>
<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''' - Высота в сантиметрах.
*'''CountInPallet''' - Количество штук в паллете.
*'''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>
</itemmovements>
</source>

*'''code''' - внутренний код товара в справочнике номенклатуры.

'''Пример ответа движения номенклатуры:'''
<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''' - номер документа
:* '''date''' - дата документа
:* '''message''' - комментарий

== Справочник пунктов самовывоза ==

'''Пример запроса пунктов самовывоза:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8" ?>
<pvzlist>
<auth extra="8" login="login" pass="pass"></auth>
<town>Нижний Тагил</town>
</pvzlist>
</source>

*'''town''' - Город получателя.

'''Пример ответа справочника пунктов самовывоза:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8" ?>
<pvzlist count="2">
<pvz>
<code>126</code>
<clientcode>3</clientcode>
<name>Нижний Тагил</name>
<address>622036, г. Нижний Тагил, ул. Циолковского, д. 17</address>
<phone>+73435417709, +73435254989</phone>
<comment>Жилое 5-ти этажное здание, торцом к дороге, второе здание от перекрестка Пархоменко-Циолковского.</comment>
<maxweight>10</maxweight>
</pvz>
<pvz>
<code>245</code>
<clientcode>NTG1</clientcode>
<name>На Красноармейской</name>
<address>КРАСНОАРМЕЙСКАЯ, д.79</address>
<phone>+7(3435)379-044</phone>
<comment>Время работы: пн.-пт. 9-18, сб. 10-14</comment>
<maxweight>20</maxweight>
</pvz>
</pvzlist>
</source>

*'''code''' - Код ПВЗ в системе. Используется в запросе [[API#Оформление заказа|оформления заказов]]
*'''clientcode''' - Код ПВЗ используемый компанией-подрядчиком.
*'''name''' - Наименование ПВЗ.
*'''address''' - Адрес ПВЗ.
*'''phone''' - Телефоны ПВЗ.
*'''comment''' - Дополнительная информация.
*'''maxweight''' - Максимальный вес, с которым работает ПВЗ.

== Справочник Видов срочности ==

'''Пример запроса Видов срочности:'''
<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" ?>
<calculator>
<auth extra="8" login="login" pass="pass" />
<calc townfrom="Москва" townto="3800000300000" l="10" w="20" h="30" mass="3.7" service="1" />
</calculator>
</source>

Параметры:
*'''townfrom''' - Город-отправитель
*'''townto''' - Город-получатель
*'''l''' - Длина в сантиметрах (не обязательный параметр)
*'''w''' - Ширина в сантиметрах (не обязательный параметр)
*'''h''' - Высота в сантиметрах (не обязательный параметр)
*'''mass''' - Масса в килограммах
*'''service''' - Режим доставки - число, указывающее на запись в справочнике [[#Справочник Видов срочности|видов срочности]]. Если этот параметр опустить, система выдаст расчет для всех доступных видов срочности, передав много контейнеров <calc> в ответе.

В авторизации можно опустить параметры 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>1163</price>
<maxdeliverydays>3</maxdeliverydays>
</calc>
</calculator>
</source>

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

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

== Список актов передачи денег ==

'''Пример запроса списка актов передачи денег:'''
<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>
<status>Доставлено</status>
</specialsma>
</smadetail>
</source>

*'''code''' - Код записи.
*'''ordercode''' - Код заказа.
*'''orderno''' - Шифр заказа.
*'''orderdate''' - Дата заказа.
*'''delivereddate''' - Дата доставки.
*'''company''' - Получатель.
*'''price''' - Стоимость услуг.
*'''rur''' - Сумма заказа.
*'''inshprice''' - Стоимость заказа.
*'''pricekur''' - Стоимость курьерской доставки.
*'''priceag''' - Агентское вознаграждение.
*'''pricecalc''' - Сумма для передачи агенту.
*'''paytype''' - Тип оплаты: 1 - безнал, 2 - наличными курьером, 3 - наличными в офисе, 4 - перевод на карту.
*'''paytypename''' - Строковое представление типа оплаты
*'''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.

API

2019-04-15T14:30:52Z

Boyko: /* Описание полей ответа статусов */

<div style="font-size: 24px; 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>

В системе "Курьерская служба 2008" имеется возможность интеграции средствами XML API, по протоколу HTTP POST.

Данное API предназначено для интеграции клиентов (интернет-магазинов и прочих компаний-заказчиков доставки) с [http://courierexe.ru/our_clients.htm курьерскими службами], работающими под управлением системы [https://curie.ru/ MeaSoft "Курьерская служба 2008"]. Если Вы являетесь '''агрегатором''', передающим данные от клиентов, возможно, Вам придется последовательно подключаться под разными пользователями, если курьерская служба должна вести раздельный учет взаиморасчетов по клиентам. Если Вы являетесь '''подрядчиком''' - Вы можете забирать заказы, используя значение client=AGENT в запросе [[#Пример запроса статуса заказа|statusreq]], и передавать статусы заказов используя метод [[#Изменение статуса агентом|setorderinfo]]. Так же для интеграций с подрядчиками у нас есть специальная платформа, но добавлять подрядчиков в нее можно только на нашей стороне. Присылайте нам коммерческое предложение, описание Вашего сервиса, и мы с радостью его рассмотрим.

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

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

== Готовые интеграции ==

Для интеграции с популярными CMS можно скачать модули интеграции

{| class="wikitable" align="center" style="width: 80%; margin: auto; color: black; boreder: 1px solid #999999;" cellpadding="10" cellspacing="0"
!style="width: 35%;"|Система управления контентом (CMS)
!style="width: 15%;"|Версия модуля
!style="width: 15%;"|Ссылка
!style="width: 35%;"|Примечание
|-
|[[Файл:bitrix.png|center|x44px]]
|style="text-align: center;"|1.5.9 от 13.12.2018
|style="text-align: center;"|[http://marketplace.1c-bitrix.ru/solutions/measoft.courier/ Установить] 
|Поддерживает версии 14.5 и выше
|-
|[[Файл:prestashop.png|center|x44px]]
|style="text-align: center;"|1.4.5 от 10.10.2018
|style="text-align: center;"|[http://courierexe.ru/download/api/prestashop.zip Скачать]
|Поддерживает версии 1.5.2.0 и выше (2.x в том числе!)
|-
|[[Файл:OpencartOCStore.png|center|x44px]]
|style="text-align: center;"|1.7.5 от 10.08.2018<br>2.0.0 от 01.12.2018<br>3.1.1 от 28.02.2019
|style="text-align: center;"|[http://courierexe.ru/download/api/opencart.zip Скачать]<br><br>[http://courierexe.ru/download/api/opencart_2.zip Скачать]<br><br>[http://courierexe.ru/download/api/opencart_3.zip Скачать]
|Поддерживает версии с 1.5.5.1<br>Версия 2.0.0 поддерживает версии с 2.0<br>[https://opencartforum.com/files/file/2906-avtomatizaciya-otpravki-i-otslezhivanie-dostavok-courierexe-dlya-opencart-15x/ Альтернативный модуль сторонних разработчиков]
|-
|[[Файл:webasyst-shopscript.png|center|x44px]]
|style="text-align: center;"|1.3.5 от 14.03.2018<br>1.3.4 от 02.03.2019
|style="text-align: center;"|[http://www.webasyst.ru/store/plugin/shop/measoftcourier/ Установить плагин]<br>[https://www.webasyst.ru/store/plugin/shipping/measoftcourier/ Установить модуль]
|Плагин предназначен для отправки заявок в КС, а модуль для расчета стоимости доставки при оформлении заказа.
|-
|[[Файл:insales.png|center|x44px]]
|style="text-align: center;"|1.2.1 от 06.09.2017
|style="text-align: center;"|[http://www.insales.ru/collection/all/product/kurierskaya-sluzhba-2008 Установить]
|[http://wiki.courierexe.ru/index.php?title=Интеграция_с_другими_системами#Insales Настраивается] в ЛК пользователя в системе
|-
|[[Файл:Leadvertex.png|center|x44px]]
|style="text-align: center;"|1.0 от 15.11.2016
|style="text-align: center;"|[[Файл:Leadvertex-howto.png|center|x44px]]
|[http://blog.leadvertex.ru/news/2110-integraciya-s-kurerkami-na-platforme-measoft/ Настраивается] в ЛК пользователя в системе [https://Leadvertex.ru Leadvertex]
|-
|[[Файл:Retailcrm.png|center|x44px]]
|style="text-align: center;"|1.0 от 11.01.2018
|style="text-align: center;"|[https://www.retailcrm.ru/ RetailCRM]
|[http://wiki.courierexe.ru/index.php?title=Интеграция_с_другими_системами#RetailCRM Настраивается] в ЛК пользователя в системе
|-
|[[Файл:1C.jpg|center|x44px]]
|style="text-align: center;"|1.4 от 17.11.2017
|style="text-align: center;"|-
|[https://infostart.ru/public/692790/ Альтернативный модуль сторонних разработчиков]
|-
|[[Файл:Joomla2.jpg|center|x44px]]
|style="text-align: center;"|1.0.0 от 12.11.2018
|style="text-align: center;"|[http://courierexe.ru/download/api/com_measoft.zip Скачать]
|Внимание! Модуль новый, поэтому возможна некорректная передача данных. Проверяйте, если что - сообщайте, исправим!
|-
|[[Файл:Amocrm.png|center|x44px]]
|style="text-align: center;"|-
|style="text-align: center;"|[https://www.amocrm.ru/extensions/courier2008 Установить]
|Внимание! Модуль новый, поэтому возможна некорректная передача данных. Проверяйте, если что - сообщайте, исправим!
|-
|[[Файл:MoySclad.jpg|center|x44px]]
|style="text-align: center;"|-
|style="text-align: center;"|[https://home.courierexe.ru/moysklad/step1 Подключение] [[Инструкция Мой склад|Инструкция]]
|Ожидается в ближайшее время в магазине Мой Склад
|-
|}

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

== Тестовый аккаунт ==

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

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

== Рабочий аккаунт для подключения ==

Для подключения к площадке Вашего клиента необходимо иметь три параметра:

1. '''Параметр extra''' (Цифровой код, уникальный идентификатор компании. Запросите этот параметр у компании, с которой Вы интегрируетесь). Посмотреть этот код можно в интерфейсе программы КС2008 через основное меню '''"Справочники - Дополнительные возможности"'''. Цифровое значение будет указано во второй гиперссылке (на скриншоте ниже отмечено "звездочкой"):

[[Файл:extra1.png|750px]]

2. '''Логин''' - параметр учетной записи для ЛК клиента и API, указывается в карточке клиента на вкладке '''"Прочее"''' в поле '''"Имя пользователя"'''. Возможно, что в программе КС2008 понадобится создать новую карточку клиента (на скриншоте ниже).

3. '''Пароль''' - параметр учетной записи для ЛК клиента и API, указывается в карточке клиента на вкладке '''"Прочее"''' в поле '''"Пароль"''' (на скриншоте ниже).

[[Файл:33_client.png|500px]]

== Общие понятия ==

На стороне курьерской службы имеется веб-сервис по адресу: https://home.courierexe.ru/api/. Тестовые авторизационные данные: логин: test пароль: testm, параметр 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; < на &lt; > на &gt; " на &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>

== Ограничения ==
С целью защиты от нецелевого использования сервисов, с 29.05.2017 ведено ограничение на запросы - 1500 запросов с одного IP-адреса за 20 минут. В случае превышения IP-адрес блокируется, разблокировка возможна путем обращения в техническую поддержку, с последующим обсуждением ваших алгоритмов и их коррекцией.

Для проверки статусов заказов лучше всего использовать запросы [[#Передача только изменившихся статусов|"statusreq" с параметром changes=ONLY_LAST]]. Не нужно пытаться "бомбить" наше API запросами с номерами всех ваших заказов, особенно - запросами "tracking", они предназначены не для этого (смотрите описание).

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

<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>Чип & Дейл</person>
<phone>123-45-67</phone>
<zipcode>125480</zipcode>
<town regioncode="78">Санкт-Петербург</town>
<address>Петровка 38 офис 35</address>
<pvz>124</pvz>
<date>2014-03-22</date>
<time_min>09:00</time_min>
<time_max>14:00</time_max>
</receiver>
<return>NO</return>
<weight>5.1</weight>
<return_weight>5.1</return_weight>
<quantity>2</quantity>
<paytype>CASH</paytype>
<service>2</service>
<return_service>1</return_service>
<type>3</type>
<return_type>3</return_type>
<price>387.5</price>
<deliveryprice>150</deliveryprice>
<discount>0</discount>
<inshprice>387.5</inshprice>
<receiverpays>NO</receiverpays>
<enclosure>Детские игрушки</enclosure>
<instruction>Проверить при покупателе, подписать акт</instruction>
<department>Отдел</department>
<pickup>NO</pickup>
<acceptpartially>NO</acceptpartially>
<items>
<item extcode="abc123" quantity="1" mass="0.2" retprice="37.5" VATrate="0" barcode="2345625213125" article="1" volume="3">Мяч</item>
<item extcode="abc124" quantity="2" mass="2" retprice="100" VATrate="10" barcode="4645625213138" article="2" length="10" width="20" height="30">Обруч</item>
<item extcode="abc125" quantity="3" mass="0.3" retprice="50" barcode="2345625213126" article="3">Погремушка желтая</item>
</items>
<packages>
<package strbarcode="ORD0000001" mass="1" message=""></package>
<package strbarcode="ORD0000002" mass="2.5" message="" length="10" width="20" height="30"></package>
</packages>
<deliveryset above_price="100" return_price="1000">
<below below_sum="500" price="500" />
<below below_sum="2000" price="300" />
</deliveryset>
</order>
</neworder>
</source>

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

*'''neworder''' - Корневой контейнер, обязательный элемент.

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

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

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

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

*'''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>
<pvz>Код пункта самовывоза по справочнику</pvz>
<date>Дата доставки в формате "YYYY-MM-DD"</date>
<time_min>Желаемое время доставки в формате "HH:MM"</time_min>
<time_max>Желаемое время доставки в формате "HH:MM"</time_max>
</receiver>
</source>

*'''company''' - Компания-получатель.
*'''person''' - Контактное лицо. ''Должно быть заполнено хотя бы одно из полей - company или person!''
*'''phone''' - Телефон. Можно указывать несколько телефонов, E-mail в этом поле.
*'''town''' - Город.

Для тега города '''town''' можно указать код региона в атрибуте '''''regioncode''''' из [[#Справочник регионов|справочника регионов]]. Поиск будет производиться в указанном регионе.

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

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

*'''paytype''' - Тип оплаты заказа получателем. Принимает значения:
:* CASH - Наличными при получении (по-умолчанию)
:* CARD - Картой при получении
:* NO - Без оплаты. Поле Price будет проигнорировано. (Этот тип оплаты передается, если заказ уже оплачен и не требует инкассации, API добавит в систему товары по нулевой цене. Если необходимо передать общую сумму заказа - можно это сделать в поле <inshprice>, указав объявленную ценность)
:* OTHER - Прочее (Предусмотрен для того, чтобы оплата поступала непосредственно в курьерскую службу посредством прочих типов оплаты - таких как: вебмани, яденьги, картой на сайте, прочие платежные системы и т.д.)
:* OPTION - На выбор получателя. Этот тип оплаты нельзя передавать с заказом. Он выставляется автоматически в зависимости от настройки клиента.

*'''zipcode''' - Почтовый индекс.
*'''weight''' - Общий вес заказа в килограммах.
*'''return_weight''' - Общий вес возврата заказа в килограммах.
*'''quantity''' - Количество мест.
*'''service''' - Режим доставки (тип услуги) передается код из справочника "Виды срочности".
*'''return_service''' - Режим возврата (тип услуги) передается код из справочника "Виды срочности".
*'''type''' - Тип корреспонденции (отправления) передается код из справочника "Типы корреспонденции".
*'''return_type''' - Тип возвратной корреспонденции (отправления) передается код из справочника "Типы корреспонденции".
*'''price''' - Сумма заказа. В случае наличия контейнера items значение данного параметра будет проигнорировано, и рассчитано автоматически.
*'''deliveryprice''' - Сумма доставки. В случае наличия контейнера items, в него будет добавлено вложение "Доставка".
*'''discount''' - Скидка на заказ. В результате сумма заказа будет уменьшена на размер скидки.
*'''return''' - Признак необходимости возврата.
*'''return_service''' - Режим возврата (тип услуги) передается код из справочника "Виды срочности".
*'''enclosure''' - Вложение.
*'''inshprice''' - Объявленная ценность.
*'''instruction''' - Поручение - Примечание.
*'''receiverpays''' - Признак оплаты стоимости доставки получателем YES/NO. Если стоит YES, то курьер увидит, что с получателя нужно также взять стоимость доставки.
*'''department''' - Подразделение, в котором оформляется заказ.
*'''pickup''' - Признак оформления забора YES/NO. Если стоит YES, то весь заказ считается заданием на забор груза, а не на доставку! Применяется для вызова курьера к отправителю для забора других отправлений.
*'''acceptpartially''' - Признак возможности частичного выкупа товаров отправления YES/NO.

*'''items''' - Контейнер для описания вложенных товаров. Необязательный контейнер. Атрибуты:
:* '''''item''''' - Название товара.
:* '''''quantity''''' - Количество единиц товара.
:* '''''mass''''' - Масса единицы товара в килограммах.
:* '''''volume''''' - Объемный вес единицы товара в килограммах. При указании объемного веса значение подставляется вместо массы
:* '''''length''''' - Длина единицы товара.
:* '''''width''''' - Ширина единицы товара.
:* '''''height''''' - Высота единицы товара.
:* '''''retprice''''' - Цена единицы товара.
:* '''''VATrate''''' - Ставка НДС - целое число процентов. Если значение не указано, подставляется значение "18".
:* '''''barcode''''' - Штрих-код товара. [[Файл:Article.png|thumb|100px|right]]
:* '''''article''''' - Артикул товара. ''Внимание!'' Указание артикула используется только тогда, когда товар хранится на ответственном хранении в службе доставки, и необходима комплектация. В этом случае система пытается привязать товар к [[API#Справочник номенклатуры|справочнику номенклатуры]]. Если товар в справочнике не найден - система выдаст соответствующую ошибку. Если по артикулу найдено несколько товаров - система выберет один из них случайным образом, что может привести к ошибочной комплектации! Если товар НЕ на ответственном хранении - артикул указывать НЕ нужно. Позиция попадет в систему просто текстом.
:* '''''extcode''''' - Внешний код строки. Используется для идентификации строк заказов при получении статусов. Необязательное поле. ПОКА НЕ ПОДДЕРЖИВАЕТСЯ.

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

* '''deliveryset''' - настройка [[Дифференциальная стоимость доставки | дифференциальной стоимости доставки]]. Атрибуты:
:* '''''above_price''''' - стоимость в случае полного выкупа заказа
:* '''''return_price''''' - стоимость в случае возврата заказа

* '''below''' - граница стоимости настроек
:* '''''below_sum''''' - граница стоимости выкупаемого заказа
:* '''''price''''' - стоимость выкупаемого заказа до соответствующей границы

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

=== Примеры ответов ===

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

<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<neworder>
<createorder orderno="AB23541" error="0" errormsg="success"></createorder>
<createorder orderno="55_6542" error="0" errormsg="success"></createorder>
<createorder orderno="AB23542" error="0" errormsg="success"></createorder>
</neworder>
</source>

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

<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<neworder>
<createorder orderno="AB23541" error="17" errormsg="Such number exists"></createorder>
<createorder orderno="AB23542" error="13" errormsg="empty company"></createorder>
<createorder orderno="AB23543" error="14" errormsg="empty person"></createorder>
</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>

=== Коды ошибок при оформлении заказа ===

0 - Ошибок нет.

1 - Ошибка авторизации. (отсутствуют теги <auth login="" pass=""></auth>, неверный логин или пароль).

2 - Отправлен пустой запрос (отсутствует контейнер <neworder></neworder> в XML документе).

3 - Некорректно указана сумма заказа.

4 - Некорректный общий вес заказа.

5 - Не найден город получатель.

6 - Не найден город отправитель.

7 - Не заполнен адрес получателя.

8 - Не заполнен телефон получателя.

9 - Не заполнено контактное имя получателя.

10 - Не заполнено название компании получателя.

11 - Некорректная сумма объявленной ценности.

12 - Артикул не найден.

13 - Не заполнено название компании отправителя.

14 - Не заполнено контактное имя отправителя.

15 - Не заполнен телефон отправителя.

16 - Не заполнен адрес отправителя.

17 - Заказ с таким номером уже существует.

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

=== Пример запроса статуса заказа ===

<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>
<ordercode>34234</ordercode>
<givencode>234534</givencode>
<datefrom>2016-07-21</datefrom>
<dateto>2016-07-21</dateto>
<target>Автозавод</target>
<done>ONLY_NOT_DONE</done>
<changes>ONLY_LAST</changes>
<quickstatus>NO</quickstatus>
</statusreq>
</source>

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

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

*'''changes''' - может принимать значение только ONLY_LAST. Если указан этот параметр, все остальные, кроме quickstatus, игнорируются. Описание данного режима приведено здесь: [[#Передача только изменившихся статусов|Передача только изменившихся статусов]]

*'''quickstatus''' - Указывает "глубину" передаваемых статусов: "YES" (по-умолчанию) - передаются статусы начиная с информации, поступившей от курьера. Такие статусы являются быстрыми (как правило, проставляются курьером сразу после доставки) но не всегда точными. Значение NO запрещает передачу статуса со слов курьера, и выдает только статусы, введенные оператором, как правило вручную. На это требуется больше времени, однако точность гораздо выше. Не рекомендуется совмещать эти типы передачи статусов (чередовать их) при запросе только изменившихся статусов, т.к. в этом случае система будет считать, что статусы у отправлений меняются.

<div style="color: #a94442; background-color: #f2dede; border: 1px solid #ebccd1; padding: 3px 10px 10px;">
'''Обратите внимание!'''
# Периода запроса статусов (контейнеры '''datefrom''' и '''dateto''') ограничивается двумя месяцами — два месяца до даты '''"по"'''.
# Если не указаны обе даты — '''dateto''' принимается равной текущей дате.
# Если не указана дата '''dateto''' — она принимается равной '''datefrom''' плюс 2 месяца.
# Если не указана дата '''datefrom''' — она принимается равной '''dateto''' минус 2 месяца.
</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>
<zipcode>125480</zipcode>
<town code="153361" regioncode="78" regionname="Санкт-Петербург город">Санкт-Петербург город</town>
<address>Петровка 38 офис 35</address>
<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>
</receiver>
<weight>5.1</weight>
<return_weight>5.1</return_weight>
<quantity>2</quantity>
<paytype>CASH</paytype>
<service>2</service>
<return_service>2</service>
<type>3</type>
<return_type>3</return_type>
<waittime>12</waittime>
<price>387.5</price>
<print_check>YES</print_check>
<inshprice>387.5</inshprice>
<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">
<>..</> (price details are not yet supported)
..
</deliveryprice>
<receiverpays>NO</receiverpays>
<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>
<customstatecode>2<customstatecode>
<clientstatecode></clientstatecode>
<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">Мяч</item>
<item code="34456" extcode="abc124" quantity="2" mass="2" retprice="100" VATrate="10" barcode="4645625213138" article="2" returns="0">Обруч</item>
<item code="34421" extcode="abc125" quantity="3" mass="0.3" retprice="50" VATrate="18" barcode="2345625213126" article="3" returns="0">Погремушка желтая</item>
</items>
<packages>
<package code="33331" strbarcode="ORD0000001" mass="1" message=""></package>
<package code="33332" strbarcode="ORD0000002" mass="2.5" message=""></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''''' - внутренний код заказа в системе, применяется для некоторых внутренних операций.

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

* '''''coords''''' в контейнере '''receiver''' - координаты получателя.
* '''currcoords''' - текущие координаты заказа. Атрибуты:
:* '''''lat''''' - широта
:* '''''lon''''' - долгота
:* '''''accuracy''''' - точность в метрах
:* '''''RequestDateTime''''' - дата/время последнего обновления координат.

* '''waittime ''' - Время ожидания курьера.
* '''deliveryprice''' - стоимость доставки в валюте расчетов с клиентом.
* '''status''' - статус доставки (список статусов см. ниже). Атрибуты (заполняются начиная с версии системы 2008.0.0.670):
:* '''''eventstore''''' - филиал, к которому относится текущий статус
:* '''''eventtime''''' - время изменения статуса (время зависит от местонахождения филиала)
:* '''''createtimegmt''''' - время фактического изменения статуса (GMT)
:* '''''message''''' - наименование филиала-получателя, при передаче между филиалами
:* '''''title''''' - русское наименование статуса

* '''statushistory''' - история статусов доставки. Содержит список контейнеров '''status'''. Заполняется только для тарифа "Премиум" начиная с версии системы 2008.0.0.670.
* '''customstatecode''' - код внутреннего статуса курьерской службы. Значения уточняйте в курьерской службе. Назначаются курьерской службой в разделе "Справочники" - "Статусы" - "15 Статусы корреспонденции". Справочник не передается через API клиенту по причине возможного наличия в нем внутренних технологических статусов курьерской службы.
* '''clientstatecode''' - код статуса клиента. Используется, если клиент предлагает свои коды статусов доставки/причин недоставки.
* '''deliveredto''' - данные о вручении, либо причина недоставки.
* '''delivereddate''' - дата вручения.
* '''deliveredtime''' - время вручения. В случае недоставки может быть пустым.
* '''outstrbarcode''' - код у подрядчика (код заказа во внешней системе). Используется в интеграциях с внешними системами.

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

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

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

# Атрибуты контейнера '''status''' заполняются для версий системы '''2008.0.0.670''' и новее.
# Контейнер '''statushistory''' заполняется для тарифа "[[Личный_кабинет#.D0.9F.D0.BE.D0.B4.D0.BA.D0.BB.D1.8E.D1.87.D0.B5.D0.BD.D0.B8.D0.B5|Премиум]]" и версий системы '''2008.0.0.670''' и новее.
</div>
<br />

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

Для получения только изменившихся статусов отправьте запрос
<source lang="xml">
<?xml version="1.0" encoding="UTF-8" ?>
<statusreq>
<auth extra="8" login="login" pass="pass"></auth>
<changes>ONLY_LAST</changes>
<quickstatus>NO</quickstatus>
</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>
</commitlaststatus>
</source>

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

*'''auth''' - Авторизация. Обязательный элемент.
*'''client''' - Признак клиента или агента. Необязательный элемент.
:* CLIENT - Признак клиента, значение по умолчанию
:* AGENT - Признак агента. В ответ отдается информация по заказам, переданным агенту на доставку

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

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

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

# При данном способе передачи (<changes>ONLY_LAST</changes>) система просматривает заказы, оформленные за последние 3 месяца. Если заказ сделан ранее - изменение статуса по нему не попадет в результат выполнения данного запроса.
# Система всегда выдает текущий статус. Т.е. Вы можете одним запросом получить статус "NEW", а следующим - "COMPLETE". В промежутке между запросами отправление могло пройти через несколько промежуточных статусов.
# Система никогда не гарантирует последовательность прохождения заказом набора статусов. Т.е. Вы можете получить статус "COMPLETE", а следующим запросом - "NEW" - такое может произойти, например, если оператор ошибочно отметил заказ выполненным, а затем исправил ошибку.
</div>
<br />

== Получение вложений к накладной ==

'''Пример запроса:'''
<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.

== Трекинг заказа по номеру ==

Запрос трекинга по номеру предназначен для выдачи минимальной обезличенной информации о конкретном заказе не авторизованному пользователю. Наша система имеет для этого интерфейс по адресу "home.courierexe.ru/{код экстра}/tracking". Вы можете либо сделать ссылку на такую страницу на своем сайте, либо разместить ее 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="1234">
<sender>
<town code="1" country="RU">Москва город</town>
<date></date>
</sender>
<receiver>
<town code="1" country="RU">Москва город</town>
<date>2015-04-18</date>
</receiver>
<AWB>BarCode</AWB>
<weight>0</weight>
<quantity>1</quantity>
<currcoords lat="" lon="" accuracy="" RequestDateTime="" />
<status eventstore="филиал в Санкт-Петербурге" eventtime="2016-06-02 17:22:00" createtimegmt="2016-06-03 16:14:44" message="" title="Доставлен" country="RU">COMPLETE</status>
<statushistory>
<status eventstore="Офис в Москве" eventtime="2016-05-30 10:20:00" createtimegmt="2016-06-03 16:14:44" message="" title="Новый" country="RU">NEW</status>
<status eventstore="Офис в Москве" eventtime="2016-06-01 17:38:00" createtimegmt="2016-06-03 16:14:44" message="филиал в Санкт-Петербурге" title="Планируется отправка" country="RU">DEPARTURING</status>
<status eventstore="Офис в Москве" eventtime="2016-06-01 19:53:00" createtimegmt="2016-06-03 16:14:44" message="филиал в Санкт-Петербурге" title="Отправлено со склада" country="RU">DEPARTURE</status>
<status eventstore="филиал в Санкт-Петербурге" eventtime="2016-06-02 07:41:00" createtimegmt="2016-06-03 16:14:44" message="" title="Получен складом" country="RU">ACCEPTED</status>
<status eventstore="филиал в Санкт-Петербурге" eventtime="2016-06-02 09:17:00" createtimegmt="2016-06-03 16:14:44" message="" title="Выдан курьеру на доставку" country="RU">DELIVERY</status>
<status eventstore="филиал в Санкт-Петербурге" eventtime="2016-06-02 17:22:00" createtimegmt="2016-06-03 16:14:44" message="" title="Доставлен (предварительно)" country="RU">COURIERDELIVERED</status>
<status eventstore="филиал в Санкт-Петербурге" eventtime="2016-06-02 17:22:00" createtimegmt="2016-06-03 16:14:44" message="" title="Доставлен" country="RU">COMPLETE</status>
</statushistory>
</order>
</tracking>
</source>

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

== Изменение статуса агентом ==

Запрос изменения статуса заказа позволяет установить окончательный статус заказа - "Доставлен" или "Не доставлен (Возврат/Отмена)".

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

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

'''Пример запроса изменения статуса:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8" ?>
<setorderinfo>
<auth extra="8" login="login" pass="pass" />
<order ordercode="123456" date="2018-03-01" time="10:00" message="Клиент отказался от покупки"/>
<order ordercode="234567" date="2018-03-01" time="10:00" message="">
<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''''' - Внутренний код заказа.
:* '''''date''''' - Дата изменения статуса.
:* '''''time''''' - Время изменения статуса.
:* '''''message''''' - текст сообщения.

*'''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>
</waybill>
</source>

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

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

'''Пример ответа:'''
<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" ?>
<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>

== Справочник городов ==

'''Пример запроса справочника городов:'''
<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>
<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''' - Поиск по всем населенным пунктам региона.
:* '''namecontains''' - Поиск населенных пунктов, название которых содержит указанный текст.
:* '''namestarts''' - Поиск населенных пунктов, название которых начинается с указанного текста.
:* '''name''' - Поиск населенных пунктов, название которых соответствует указанному тексту.
:* '''fullname''' - Поиск населенных пунктов, название вместе с типом населенного пункта которых соответствует указанному тексту.
:* '''country''' - Поиск только по стране с указанным кодом.

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

'''Пример ответа:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<townlist 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)
</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 />
</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 />
</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>1</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>
<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>
</conditions>
<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 - Все. ''Это поле может быть недоступным в некоторых установках.''

*'''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>
<CountInPallet>30</CountInPallet>
<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''' - Высота в сантиметрах.
*'''CountInPallet''' - Количество штук в паллете.
*'''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>
</itemmovements>
</source>

*'''code''' - внутренний код товара в справочнике номенклатуры.

'''Пример ответа движения номенклатуры:'''
<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''' - номер документа
:* '''date''' - дата документа
:* '''message''' - комментарий

== Справочник пунктов самовывоза ==

'''Пример запроса пунктов самовывоза:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8" ?>
<pvzlist>
<auth extra="8" login="login" pass="pass"></auth>
<town>Нижний Тагил</town>
</pvzlist>
</source>

*'''town''' - Город получателя.

'''Пример ответа справочника пунктов самовывоза:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8" ?>
<pvzlist count="2">
<pvz>
<code>126</code>
<clientcode>3</clientcode>
<name>Нижний Тагил</name>
<address>622036, г. Нижний Тагил, ул. Циолковского, д. 17</address>
<phone>+73435417709, +73435254989</phone>
<comment>Жилое 5-ти этажное здание, торцом к дороге, второе здание от перекрестка Пархоменко-Циолковского.</comment>
<maxweight>10</maxweight>
</pvz>
<pvz>
<code>245</code>
<clientcode>NTG1</clientcode>
<name>На Красноармейской</name>
<address>КРАСНОАРМЕЙСКАЯ, д.79</address>
<phone>+7(3435)379-044</phone>
<comment>Время работы: пн.-пт. 9-18, сб. 10-14</comment>
<maxweight>20</maxweight>
</pvz>
</pvzlist>
</source>

*'''code''' - Код ПВЗ в системе. Используется в запросе [[API#Оформление заказа|оформления заказов]]
*'''clientcode''' - Код ПВЗ используемый компанией-подрядчиком.
*'''name''' - Наименование ПВЗ.
*'''address''' - Адрес ПВЗ.
*'''phone''' - Телефоны ПВЗ.
*'''comment''' - Дополнительная информация.
*'''maxweight''' - Максимальный вес, с которым работает ПВЗ.

== Справочник Видов срочности ==

'''Пример запроса Видов срочности:'''
<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" ?>
<calculator>
<auth extra="8" login="login" pass="pass" />
<calc townfrom="Москва" townto="3800000300000" l="10" w="20" h="30" mass="3.7" service="1" />
</calculator>
</source>

Параметры:
*'''townfrom''' - Город-отправитель
*'''townto''' - Город-получатель
*'''l''' - Длина в сантиметрах (не обязательный параметр)
*'''w''' - Ширина в сантиметрах (не обязательный параметр)
*'''h''' - Высота в сантиметрах (не обязательный параметр)
*'''mass''' - Масса в килограммах
*'''service''' - Режим доставки - число, указывающее на запись в справочнике [[#Справочник Видов срочности|видов срочности]]. Если этот параметр опустить, система выдаст расчет для всех доступных видов срочности, передав много контейнеров <calc> в ответе.

В авторизации можно опустить параметры 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>1163</price>
<maxdeliverydays>3</maxdeliverydays>
</calc>
</calculator>
</source>

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

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

== Список актов передачи денег ==

'''Пример запроса списка актов передачи денег:'''
<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>
<promiseddatepay></promiseddatepay>
<price>637.00</price>
<rur>13430.00</rur>
<pricekur>570.00</pricekur>
<priceag>67.00</priceag>
<payno>42423</payno>
<paytype>1</paytype>
<paytypename>Безнал</paytypename>
</sma>
</smalist>
</source>

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

== Детализация актов передачи денег ==

'''Пример запроса детализации актов передачи денег:'''
<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>
<status>Доставлено</status>
</specialsma>
</smadetail>
</source>

*'''code''' - Код записи.
*'''ordercode''' - Код заказа.
*'''orderno''' - Шифр заказа.
*'''orderdate''' - Дата заказа.
*'''delivereddate''' - Дата доставки.
*'''company''' - Получатель.
*'''price''' - Стоимость услуг.
*'''rur''' - Сумма заказа.
*'''inshprice''' - Стоимость заказа.
*'''pricekur''' - Стоимость курьерской доставки.
*'''priceag''' - Агентское вознаграждение.
*'''pricecalc''' - Сумма для передачи агенту.
*'''paytype''' - Тип оплаты: 1 - безнал, 2 - наличными курьером, 3 - наличными в офисе, 4 - перевод на карту.
*'''paytypename''' - Строковое представление типа оплаты
*'''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.

API

2019-03-06T08:07:47Z

Boyko: /* Готовые интеграции */

<div style="font-size: 24px; 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>

В системе "Курьерская служба 2008" имеется возможность интеграции средствами XML API, по протоколу HTTP POST.

Данное API предназначено для интеграции клиентов (интернет-магазинов и прочих компаний-заказчиков доставки) с [http://courierexe.ru/our_clients.htm курьерскими службами], работающими под управлением системы [https://curie.ru/ MeaSoft "Курьерская служба 2008"]. Если Вы являетесь '''агрегатором''', передающим данные от клиентов, возможно, Вам придется последовательно подключаться под разными пользователями, если курьерская служба должна вести раздельный учет взаиморасчетов по клиентам. Если Вы являетесь '''подрядчиком''' - Вы можете забирать заказы, используя значение client=AGENT в запросе [[#Пример запроса статуса заказа|statusreq]], и передавать статусы заказов используя метод [[#Изменение статуса агентом|setorderinfo]]. Так же для интеграций с подрядчиками у нас есть специальная платформа, но добавлять подрядчиков в нее можно только на нашей стороне. Присылайте нам коммерческое предложение, описание Вашего сервиса, и мы с радостью его рассмотрим.

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

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

== Готовые интеграции ==

Для интеграции с популярными CMS можно скачать модули интеграции

{| class="wikitable" align="center" style="width: 80%; margin: auto; color: black; boreder: 1px solid #999999;" cellpadding="10" cellspacing="0"
!style="width: 35%;"|Система управления контентом (CMS)
!style="width: 15%;"|Версия модуля
!style="width: 15%;"|Ссылка
!style="width: 35%;"|Примечание
|-
|[[Файл:bitrix.png|center|x44px]]
|style="text-align: center;"|1.5.9 от 13.12.2018
|style="text-align: center;"|[http://marketplace.1c-bitrix.ru/solutions/measoft.courier/ Установить] 
|Поддерживает версии 14.5 и выше
|-
|[[Файл:prestashop.png|center|x44px]]
|style="text-align: center;"|1.4.5 от 10.10.2018
|style="text-align: center;"|[http://courierexe.ru/download/api/prestashop.zip Скачать]
|Поддерживает версии 1.5.2.0 и выше (2.x в том числе!)
|-
|[[Файл:OpencartOCStore.png|center|x44px]]
|style="text-align: center;"|1.7.5 от 10.08.2018<br>2.0.0 от 01.12.2018<br>3.1.1 от 28.02.2019
|style="text-align: center;"|[http://courierexe.ru/download/api/opencart.zip Скачать]<br><br>[http://courierexe.ru/download/api/opencart_2.zip Скачать]<br><br>[http://courierexe.ru/download/api/opencart_3.zip Скачать]
|Поддерживает версии с 1.5.5.1<br>Версия 2.0.0 поддерживает версии с 2.0<br>[https://opencartforum.com/files/file/2906-avtomatizaciya-otpravki-i-otslezhivanie-dostavok-courierexe-dlya-opencart-15x/ Альтернативный модуль сторонних разработчиков]
|-
|[[Файл:webasyst-shopscript.png|center|x44px]]
|style="text-align: center;"|1.3.5 от 14.03.2018<br>1.3.4 от 02.03.2019
|style="text-align: center;"|[http://www.webasyst.ru/store/plugin/shop/measoftcourier/ Установить плагин]<br>[https://www.webasyst.ru/store/plugin/shipping/measoftcourier/ Установить модуль]
|Плагин предназначен для отправки заявок в КС, а модуль для расчета стоимости доставки при оформлении заказа.
|-
|[[Файл:insales.png|center|x44px]]
|style="text-align: center;"|1.2.1 от 06.09.2017
|style="text-align: center;"|[http://www.insales.ru/collection/all/product/kurierskaya-sluzhba-2008 Установить]
|[http://wiki.courierexe.ru/index.php?title=Интеграция_с_другими_системами#Insales Настраивается] в ЛК пользователя в системе
|-
|[[Файл:Leadvertex.png|center|x44px]]
|style="text-align: center;"|1.0 от 15.11.2016
|style="text-align: center;"|[[Файл:Leadvertex-howto.png|center|x44px]]
|[http://blog.leadvertex.ru/news/2110-integraciya-s-kurerkami-na-platforme-measoft/ Настраивается] в ЛК пользователя в системе [https://Leadvertex.ru Leadvertex]
|-
|[[Файл:Retailcrm.png|center|x44px]]
|style="text-align: center;"|1.0 от 11.01.2018
|style="text-align: center;"|[https://www.retailcrm.ru/ RetailCRM]
|[http://wiki.courierexe.ru/index.php?title=Интеграция_с_другими_системами#RetailCRM Настраивается] в ЛК пользователя в системе
|-
|[[Файл:1C.jpg|center|x44px]]
|style="text-align: center;"|1.4 от 17.11.2017
|style="text-align: center;"|-
|[https://infostart.ru/public/692790/ Альтернативный модуль сторонних разработчиков]
|-
|[[Файл:Joomla2.jpg|center|x44px]]
|style="text-align: center;"|1.0.0 от 12.11.2018
|style="text-align: center;"|[http://courierexe.ru/download/api/com_measoft.zip Скачать]
|Внимание! Модуль новый, поэтому возможна некорректная передача данных. Проверяйте, если что - сообщайте, исправим!
|-
|[[Файл:Amocrm.png|center|x44px]]
|style="text-align: center;"|-
|style="text-align: center;"|[https://www.amocrm.ru/extensions/courier2008 Установить]
|Внимание! Модуль новый, поэтому возможна некорректная передача данных. Проверяйте, если что - сообщайте, исправим!
|-
|[[Файл:MoySclad.jpg|center|x44px]]
|style="text-align: center;"|-
|style="text-align: center;"|[https://home.courierexe.ru/moysklad/step1 Подключение] [[Инструкция Мой склад|Инструкция]]
|Ожидается в ближайшее время в магазине Мой Склад
|-
|}

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

== Тестовый аккаунт ==

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

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

== Рабочий аккаунт для подключения ==

Для подключения к площадке Вашего клиента необходимо иметь три параметра:

1. '''Параметр extra''' (Цифровой код, уникальный идентификатор компании. Запросите этот параметр у компании, с которой Вы интегрируетесь). Посмотреть этот код можно в интерфейсе программы КС2008 через основное меню '''"Справочники - Дополнительные возможности"'''. Цифровое значение будет указано во второй гиперссылке (на скриншоте ниже отмечено "звездочкой"):

[[Файл:extra1.png|750px]]

2. '''Логин''' - параметр учетной записи для ЛК клиента и API, указывается в карточке клиента на вкладке '''"Прочее"''' в поле '''"Имя пользователя"'''. Возможно, что в программе КС2008 понадобится создать новую карточку клиента (на скриншоте ниже).

3. '''Пароль''' - параметр учетной записи для ЛК клиента и API, указывается в карточке клиента на вкладке '''"Прочее"''' в поле '''"Пароль"''' (на скриншоте ниже).

[[Файл:33_client.png|500px]]

== Общие понятия ==

На стороне курьерской службы имеется веб-сервис по адресу: https://home.courierexe.ru/api/. Тестовые авторизационные данные: логин: test пароль: testm, параметр 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; < на &lt; > на &gt; " на &quot;

== Ограничения ==
С целью защиты от нецелевого использования сервисов, с 29.05.2017 ведено ограничение на запросы - 1500 запросов с одного IP-адреса за 20 минут. В случае превышения IP-адрес блокируется, разблокировка возможна путем обращения в техническую поддержку, с последующим обсуждением ваших алгоритмов и их коррекцией.

Для проверки статусов заказов лучше всего использовать запросы [[#Передача только изменившихся статусов|"statusreq" с параметром changes=ONLY_LAST]]. Не нужно пытаться "бомбить" наше API запросами с номерами всех ваших заказов, особенно - запросами "tracking", они предназначены не для этого (смотрите описание).

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

<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>Чип & Дейл</person>
<phone>123-45-67</phone>
<zipcode>125480</zipcode>
<town regioncode="78">Санкт-Петербург</town>
<address>Петровка 38 офис 35</address>
<pvz>124</pvz>
<date>2014-03-22</date>
<time_min>09:00</time_min>
<time_max>14:00</time_max>
</receiver>
<return>NO</return>
<weight>5.1</weight>
<return_weight>5.1</return_weight>
<quantity>2</quantity>
<paytype>CASH</paytype>
<service>2</service>
<return_service>1</return_service>
<type>3</type>
<return_type>3</return_type>
<price>387.5</price>
<deliveryprice>150</deliveryprice>
<discount>0</discount>
<inshprice>387.5</inshprice>
<enclosure>Детские игрушки</enclosure>
<instruction>Проверить при покупателе, подписать акт</instruction>
<department>Отдел</department>
<pickup>NO</pickup>
<acceptpartially>NO</acceptpartially>
<items>
<item extcode="abc123" quantity="1" mass="0.2" retprice="37.5" VATrate="0" barcode="2345625213125" article="1" volume="3">Мяч</item>
<item extcode="abc124" quantity="2" mass="2" retprice="100" VATrate="10" barcode="4645625213138" article="2" length="10" width="20" height="30">Обруч</item>
<item extcode="abc125" quantity="3" mass="0.3" retprice="50" barcode="2345625213126" article="3">Погремушка желтая</item>
</items>
</order>
</neworder>
</source>

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

*'''neworder''' - Корневой контейнер, обязательный элемент.

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

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

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

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

*'''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>
<pvz>Код пункта самовывоза по справочнику</pvz>
<date>Дата доставки в формате "YYYY-MM-DD"</date>
<time_min>Желаемое время доставки в формате "HH:MM"</time_min>
<time_max>Желаемое время доставки в формате "HH:MM"</time_max>
</receiver>
</source>

*'''company''' - Компания-получатель.
*'''person''' - Контактное лицо. ''Должно быть заполнено хотя бы одно из полей - company или person!''
*'''phone''' - Телефон. Можно указывать несколько телефонов, E-mail в этом поле.
*'''town''' - Город.

Для тега города '''town''' можно указать код региона в атрибуте '''''regioncode''''' из [[#Справочник регионов|справочника регионов]]. Поиск будет производиться в указанном регионе.

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

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

*'''paytype''' - Тип оплаты заказа получателем. Принимает значения:
:* CASH - Наличными при получении (по-умолчанию)
:* CARD - Картой при получении
:* NO - Без оплаты. Поле Price будет проигнорировано. (Этот тип оплаты передается, если заказ уже оплачен и не требует инкассации, API добавит в систему товары по нулевой цене. Если необходимо передать общую сумму заказа - можно это сделать в поле <inshprice>, указав объявленную ценность)
:* OTHER - Прочее (Предусмотрен для того, чтобы оплата поступала непосредственно в курьерскую службу посредством прочих типов оплаты - таких как: вебмани, яденьги, картой на сайте, прочие платежные системы и т.д.)
:* OPTION - На выбор получателя. Этот тип оплаты нельзя передавать с заказом. Он выставляется автоматически в зависимости от настройки клиента.

*'''zipcode''' - Почтовый индекс.
*'''weight''' - Общий вес заказа в килограммах.
*'''return_weight''' - Общий вес возврата заказа в килограммах.
*'''quantity''' - Количество мест.
*'''service''' - Режим доставки (тип услуги) передается код из справочника "Виды срочности".
*'''return_service''' - Режим возврата (тип услуги) передается код из справочника "Виды срочности".
*'''type''' - Тип корреспонденции (отправления) передается код из справочника "Типы корреспонденции".
*'''return_type''' - Тип возвратной корреспонденции (отправления) передается код из справочника "Типы корреспонденции".
*'''price''' - Сумма заказа. В случае наличия контейнера items значение данного параметра будет проигнорировано, и рассчитано автоматически.
*'''deliveryprice''' - Сумма доставки. В случае наличия контейнера items, в него будет добавлено вложение "Доставка".
*'''discount''' - Скидка на заказ. В результате сумма заказа будет уменьшена на размер скидки.
*'''return''' - Признак необходимости возврата.
*'''return_service''' - Режим возврата (тип услуги) передается код из справочника "Виды срочности".
*'''enclosure''' - Вложение.
*'''inshprice''' - Объявленная ценность.
*'''instruction''' - Поручение - Примечание.
*'''receiverpays''' - Признак оплаты стоимости доставки получателем YES/NO. Если стоит YES, то курьер увидит, что с получателя нужно также взять стоимость доставки.
*'''department''' - Подразделение, в котором оформляется заказ.
*'''pickup''' - Признак оформления забора YES/NO. Если стоит YES, то весь заказ считается заданием на забор груза, а не на доставку! Применяется для вызова курьера к отправителю для забора других отправлений.
*'''acceptpartially''' - Признак возможности частичного выкупа товаров отправления YES/NO.

*'''items''' - Контейнер для описания вложенных товаров. Необязательный контейнер. Атрибуты:
:* '''''item''''' - Название товара.
:* '''''quantity''''' - Количество единиц товара.
:* '''''mass''''' - Масса единицы товара в килограммах.
:* '''''volume''''' - Объемный вес единицы товара в килограммах. При указании объемного веса значение подставляется вместо массы
:* '''''length''''' - Длина единицы товара.
:* '''''width''''' - Ширина единицы товара.
:* '''''height''''' - Высота единицы товара.
:* '''''retprice''''' - Цена единицы товара.
:* '''''VATrate''''' - Ставка НДС - целое число процентов. Если значение не указано, подставляется значение "18".
:* '''''barcode''''' - Штрих-код товара. [[Файл:Article.png|thumb|100px|right]]
:* '''''article''''' - Артикул товара. ''Внимание!'' Указание артикула используется только тогда, когда товар хранится на ответственном хранении в службе доставки, и необходима комплектация. В этом случае система пытается привязать товар к [[API#Справочник номенклатуры|справочнику номенклатуры]]. Если товар в справочнике не найден - система выдаст соответствующую ошибку. Если по артикулу найдено несколько товаров - система выберет один из них случайным образом, что может привести к ошибочной комплектации! Если товар НЕ на ответственном хранении - артикул указывать НЕ нужно. Позиция попадет в систему просто текстом.
:* '''''extcode''''' - Внешний код строки. Используется для идентификации строк заказов при получении статусов. Необязательное поле. ПОКА НЕ ПОДДЕРЖИВАЕТСЯ.

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

=== Примеры ответов ===

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

<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<neworder>
<createorder orderno="AB23541" error="0" errormsg="success"></createorder>
<createorder orderno="55_6542" error="0" errormsg="success"></createorder>
<createorder orderno="AB23542" error="0" errormsg="success"></createorder>
</neworder>
</source>

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

<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<neworder>
<createorder orderno="AB23541" error="17" errormsg="Such number exists"></createorder>
<createorder orderno="AB23542" error="13" errormsg="empty company"></createorder>
<createorder orderno="AB23543" error="14" errormsg="empty person"></createorder>
</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>

=== Коды ошибок при оформлении заказа ===

0 - Ошибок нет.

1 - Ошибка авторизации. (отсутствуют теги <auth login="" pass=""></auth>, неверный логин или пароль).

2 - Отправлен пустой запрос (отсутствует контейнер <neworder></neworder> в XML документе).

3 - Некорректно указана сумма заказа.

4 - Некорректный общий вес заказа.

5 - Не найден город получатель.

6 - Не найден город отправитель.

7 - Не заполнен адрес получателя.

8 - Не заполнен телефон получателя.

9 - Не заполнено контактное имя получателя.

10 - Не заполнено название компании получателя.

11 - Некорректная сумма объявленной ценности.

12 - Артикул не найден.

13 - Не заполнено название компании отправителя.

14 - Не заполнено контактное имя отправителя.

15 - Не заполнен телефон отправителя.

16 - Не заполнен адрес отправителя.

17 - Заказ с таким номером уже существует.

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

=== Пример запроса статуса заказа ===

<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>
<ordercode>34234</ordercode>
<givencode>234534</givencode>
<datefrom>2016-07-21</datefrom>
<dateto>2016-07-21</dateto>
<target>Автозавод</target>
<done>ONLY_NOT_DONE</done>
<changes>ONLY_LAST</changes>
<quickstatus>NO</quickstatus>
</statusreq>
</source>

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

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

*'''changes''' - может принимать значение только ONLY_LAST. Если указан этот параметр, все остальные, кроме quickstatus, игнорируются. Описание данного режима приведено здесь: [[#Передача только изменившихся статусов|Передача только изменившихся статусов]]

*'''quickstatus''' - Указывает "глубину" передаваемых статусов: "YES" (по-умолчанию) - передаются статусы начиная с информации, поступившей от курьера. Такие статусы являются быстрыми (как правило, проставляются курьером сразу после доставки) но не всегда точными. Значение NO запрещает передачу статуса со слов курьера, и выдает только статусы, введенные оператором, как правило вручную. На это требуется больше времени, однако точность гораздо выше. Не рекомендуется совмещать эти типы передачи статусов (чередовать их) при запросе только изменившихся статусов, т.к. в этом случае система будет считать, что статусы у отправлений меняются.

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

=== Примеры ответов ===

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

<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<statusreq count="23">
<order orderno="111111" 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>
<zipcode>125480</zipcode>
<town code="153361" regioncode="78" regionname="Санкт-Петербург город">Санкт-Петербург город</town>
<address>Петровка 38 офис 35</address>
<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>
</receiver>
<weight>5.1</weight>
<return_weight>5.1</return_weight>
<quantity>2</quantity>
<paytype>CASH</paytype>
<service>2</service>
<return_service>2</service>
<type>3</type>
<return_type>3</return_type>
<waittime>12</waittime>
<price>387.5</price>
<print_check>YES</print_check>
<inshprice>387.5</inshprice>
<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">
<>..</> (price details are not yet supported)
..
</deliveryprice>
<receiverpays>NO</receiverpays>
<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>
<customstatecode>2<customstatecode>
<clientstatecode></clientstatecode>
<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">Мяч</item>
<item code="34456" extcode="abc124" quantity="2" mass="2" retprice="100" VATrate="10" barcode="4645625213138" article="2" returns="0">Обруч</item>
<item code="34421" extcode="abc125" quantity="3" mass="0.3" retprice="50" VATrate="18" barcode="2345625213126" article="3" returns="0">Погремушка желтая</item>
</items>
<packages>
<package code="33123" strbarcode="4625333555001" mass="0" message="">Место 1</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''':
:* '''''ordercode''''' - внутренний код заказа в системе, применяется для некоторых внутренних операций.
:* '''''givencode''''' - внутренний код заказа в системе, применяется для некоторых внутренних операций.
:* '''''returns''''' - количество данного товара, от которого отказался получатель. Не нулевое только в случае частичного отказа.

* атрибут '''''code''''' контейнера '''item''' - внутренний код строки заказа в системе, применяется для некоторых внутренних операций.
* '''''coords''''' в контейнере '''receiver''' - координаты получателя.
* '''currcoords''' - текущие координаты заказа. Атрибуты:
:* '''''lat''''' - широта
:* '''''lon''''' - долгота
:* '''''accuracy''''' - точность в метрах
:* '''''RequestDateTime''''' - дата/время последнего обновления координат.

* '''waittime ''' - Время ожидания курьера.
* '''deliveryprice''' - стоимость доставки в валюте расчетов с клиентом.
* '''status''' - статус доставки (список статусов см. ниже). Атрибуты (заполняются начиная с версии системы 2008.0.0.670):
:* '''''eventstore''''' - филиал, к которому относится текущий статус
:* '''''eventtime''''' - время изменения статуса (время зависит от местонахождения филиала)
:* '''''createtimegmt''''' - время фактического изменения статуса (GMT)
:* '''''message''''' - наименование филиала-получателя, при передаче между филиалами
:* '''''title''''' - русское наименование статуса

* '''statushistory''' - история статусов доставки. Содержит список контейнеров '''status'''. Заполняется только для тарифа "Премиум" начиная с версии системы 2008.0.0.670.
* '''customstatecode''' - код внутреннего статуса курьерской службы. Значения уточняйте в курьерской службе. Назначаются курьерской службой в разделе "Справочники" - "Статусы" - "15 Статусы корреспонденции". Справочник не передается через API клиенту по причине возможного наличия в нем внутренних технологических статусов курьерской службы.
* '''clientstatecode''' - код статуса клиента. Используется, если клиент предлагает свои коды статусов доставки/причин недоставки.
* '''deliveredto''' - данные о вручении, либо причина недоставки.
* '''delivereddate''' - дата вручения.
* '''deliveredtime''' - время вручения. В случае недоставки может быть пустым.
* '''outstrbarcode''' - код у подрядчика (код заказа во внешней системе). Используется в интеграциях с внешними системами.

*'''packages''' - Контейнер для описания мест. Необязательный контейнер. Атрибуты:
:* '''''package''''' - Название места.
:* '''''code''''' - Внутренний код строки.
:* '''''strbarcode''''' - Штрих-код места.
:* '''''mass''''' - Масса места в килограммах.
:* '''''message''''' - Строка сообщения.

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

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

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

# Атрибуты контейнера '''status''' заполняются для версий системы '''2008.0.0.670''' и новее.
# Контейнер '''statushistory''' заполняется для тарифа "[[Личный_кабинет#.D0.9F.D0.BE.D0.B4.D0.BA.D0.BB.D1.8E.D1.87.D0.B5.D0.BD.D0.B8.D0.B5|Премиум]]" и версий системы '''2008.0.0.670''' и новее.
</div>
<br />

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

Для получения только изменившихся статусов отправьте запрос
<source lang="xml">
<?xml version="1.0" encoding="UTF-8" ?>
<statusreq>
<auth extra="8" login="login" pass="pass"></auth>
<changes>ONLY_LAST</changes>
<quickstatus>NO</quickstatus>
</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>
</commitlaststatus>
</source>

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

*'''auth''' - Авторизация. Обязательный элемент.
*'''client''' - Признак клиента или агента. Необязательный элемент.
:* CLIENT - Признак клиента, значение по умолчанию
:* AGENT - Признак агента. В ответ отдается информация по заказам, переданным агенту на доставку

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

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

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

# При данном способе передачи (<changes>ONLY_LAST</changes>) система просматривает заказы, оформленные за последние 3 месяца. Если заказ сделан ранее - изменение статуса по нему не попадет в результат выполнения данного запроса.
# Система всегда выдает текущий статус. Т.е. Вы можете одним запросом получить статус "NEW", а следующим - "COMPLETE". В промежутке между запросами отправление могло пройти через несколько промежуточных статусов.
# Система никогда не гарантирует последовательность прохождения заказом набора статусов. Т.е. Вы можете получить статус "COMPLETE", а следующим запросом - "NEW" - такое может произойти, например, если оператор ошибочно отметил заказ выполненным, а затем исправил ошибку.
</div>
<br />

== Получение вложений к накладной ==

'''Пример запроса:'''
<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.

== Трекинг заказа по номеру ==

Запрос трекинга по номеру предназначен для выдачи минимальной обезличенной информации о конкретном заказе не авторизованному пользователю. Наша система имеет для этого интерфейс по адресу "home.courierexe.ru/{код экстра}/tracking". Вы можете либо сделать ссылку на такую страницу на своем сайте, либо разместить ее 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="1234">
<sender>
<town code="1" country="RU">Москва город</town>
<date></date>
</sender>
<receiver>
<town code="1" country="RU">Москва город</town>
<date>2015-04-18</date>
</receiver>
<AWB>BarCode</AWB>
<weight>0</weight>
<quantity>1</quantity>
<currcoords lat="" lon="" accuracy="" RequestDateTime="" />
<status eventstore="филиал в Санкт-Петербурге" eventtime="2016-06-02 17:22:00" createtimegmt="2016-06-03 16:14:44" message="" title="Доставлен" country="RU">COMPLETE</status>
<statushistory>
<status eventstore="Офис в Москве" eventtime="2016-05-30 10:20:00" createtimegmt="2016-06-03 16:14:44" message="" title="Новый" country="RU">NEW</status>
<status eventstore="Офис в Москве" eventtime="2016-06-01 17:38:00" createtimegmt="2016-06-03 16:14:44" message="филиал в Санкт-Петербурге" title="Планируется отправка" country="RU">DEPARTURING</status>
<status eventstore="Офис в Москве" eventtime="2016-06-01 19:53:00" createtimegmt="2016-06-03 16:14:44" message="филиал в Санкт-Петербурге" title="Отправлено со склада" country="RU">DEPARTURE</status>
<status eventstore="филиал в Санкт-Петербурге" eventtime="2016-06-02 07:41:00" createtimegmt="2016-06-03 16:14:44" message="" title="Получен складом" country="RU">ACCEPTED</status>
<status eventstore="филиал в Санкт-Петербурге" eventtime="2016-06-02 09:17:00" createtimegmt="2016-06-03 16:14:44" message="" title="Выдан курьеру на доставку" country="RU">DELIVERY</status>
<status eventstore="филиал в Санкт-Петербурге" eventtime="2016-06-02 17:22:00" createtimegmt="2016-06-03 16:14:44" message="" title="Доставлен (предварительно)" country="RU">COURIERDELIVERED</status>
<status eventstore="филиал в Санкт-Петербурге" eventtime="2016-06-02 17:22:00" createtimegmt="2016-06-03 16:14:44" message="" title="Доставлен" country="RU">COMPLETE</status>
</statushistory>
</order>
</tracking>
</source>

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

== Изменение статуса агентом ==

Запрос изменения статуса заказа позволяет установить окончательный статус заказа - "Доставлен" или "Не доставлен (Возврат/Отмена)".

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

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

'''Пример запроса изменения статуса:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8" ?>
<setorderinfo>
<auth extra="8" login="login" pass="pass" />
<order ordercode="123456" date="2018-03-01" time="10:00" message="Клиент отказался от покупки"/>
<order ordercode="234567" date="2018-03-01" time="10:00" message="">
<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''''' - Внутренний код заказа.
:* '''''date''''' - Дата изменения статуса.
:* '''''time''''' - Время изменения статуса.
:* '''''message''''' - текст сообщения.

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

== Получение накладной в формате pdf ==

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

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

'''waybill''' - Корневой контейнер. Обязательный элемент.
*'''auth''' - Авторизация. Обязательный элемент.
*'''orderno''' - Номер/код заказа. Обязательный элемент.
*'''form''' - Формат накладной. Не обязательный элемент. Принимает значения:
:* 1 - Подробная накладная (по-умолчанию)
:* 2 - Наклейки (Zebra)

'''Пример ответа:'''
<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" ?>
<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>

== Справочник городов ==

'''Пример запроса справочника городов:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<townlist>
<codesearch>
<zipcode>110000</zipcode>
<kladrcode>0100000100800</kladrcode>
<fiascode>bd21979d-46f8-49d0-9105-e8d65172a983</fiascode>
<code>123</code>
</codesearch>
<conditions>
<city>Краснодарский край</city>
<namecontains>новгород</namecontains>
<namestarts>Моск</namestarts>
<name>Москва</name>
<fullname>Москва город</fullname>
<country>1</country>
</conditions>
<limit>
<limitfrom>30</limitfrom>
<limitcount>10</limitcount>
<countall>YES</countall>
</limit>
</townlist>
</source>

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

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

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

'''Пример ответа:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<townlist 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)
</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 />
</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 />
</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>1</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>
<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>
</conditions>
<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 - Все. ''Это поле может быть недоступным в некоторых установках.''

*'''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>
<CountInPallet>30</CountInPallet>
<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''' - Высота в сантиметрах.
*'''CountInPallet''' - Количество штук в паллете.
*'''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>
</itemmovements>
</source>

*'''code''' - внутренний код товара в справочнике номенклатуры.

'''Пример ответа движения номенклатуры:'''
<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''' - номер документа
:* '''date''' - дата документа
:* '''message''' - комментарий

== Справочник пунктов самовывоза ==

'''Пример запроса пунктов самовывоза:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8" ?>
<pvzlist>
<auth extra="8" login="login" pass="pass"></auth>
<town>Нижний Тагил</town>
</pvzlist>
</source>

*'''town''' - Город получателя.

'''Пример ответа справочника пунктов самовывоза:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8" ?>
<pvzlist count="2">
<pvz>
<code>126</code>
<clientcode>3</clientcode>
<name>Нижний Тагил</name>
<address>622036, г. Нижний Тагил, ул. Циолковского, д. 17</address>
<phone>+73435417709, +73435254989</phone>
<comment>Жилое 5-ти этажное здание, торцом к дороге, второе здание от перекрестка Пархоменко-Циолковского.</comment>
<maxweight>10</maxweight>
</pvz>
<pvz>
<code>245</code>
<clientcode>NTG1</clientcode>
<name>На Красноармейской</name>
<address>КРАСНОАРМЕЙСКАЯ, д.79</address>
<phone>+7(3435)379-044</phone>
<comment>Время работы: пн.-пт. 9-18, сб. 10-14</comment>
<maxweight>20</maxweight>
</pvz>
</pvzlist>
</source>

*'''code''' - Код ПВЗ в системе. Используется в запросе [[API#Оформление заказа|оформления заказов]]
*'''clientcode''' - Код ПВЗ используемый компанией-подрядчиком.
*'''name''' - Наименование ПВЗ.
*'''address''' - Адрес ПВЗ.
*'''phone''' - Телефоны ПВЗ.
*'''comment''' - Дополнительная информация.
*'''maxweight''' - Максимальный вес, с которым работает ПВЗ.

== Справочник Видов срочности ==

'''Пример запроса Видов срочности:'''
<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" ?>
<calculator>
<auth extra="8" login="login" pass="pass" />
<calc townfrom="Москва" townto="3800000300000" l="10" w="20" h="30" mass="3.7" service="1" />
</calculator>
</source>

Параметры:
*'''townfrom''' - Город-отправитель
*'''townto''' - Город-получатель
*'''l''' - Длина в сантиметрах (не обязательный параметр)
*'''w''' - Ширина в сантиметрах (не обязательный параметр)
*'''h''' - Высота в сантиметрах (не обязательный параметр)
*'''mass''' - Масса в килограммах
*'''service''' - Режим доставки - число, указывающее на запись в справочнике [[#Справочник Видов срочности|видов срочности]]. Если этот параметр опустить, система выдаст расчет для всех доступных видов срочности, передав много контейнеров <calc> в ответе.

В авторизации можно опустить параметры 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>1163</price>
<maxdeliverydays>3</maxdeliverydays>
</calc>
</calculator>
</source>

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

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

== Список актов передачи денег ==

'''Пример запроса списка актов передачи денег:'''
<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>
<price>637.00</price>
<rur>13430.00</rur>
<pricekur>570.00</pricekur>
<priceag>67.00</priceag>
<payno>42423</payno>
<paytype>1</paytype>
<paytypename>Безнал</paytypename>
</sma>
</smalist>
</source>

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

== Детализация актов передачи денег ==

'''Пример запроса детализации актов передачи денег:'''
<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>
<status>Доставлено</status>
</specialsma>
</smadetail>
</source>

*'''code''' - Код записи.
*'''ordercode''' - Код заказа.
*'''orderno''' - Шифр заказа.
*'''orderdate''' - Дата заказа.
*'''delivereddate''' - Дата доставки.
*'''company''' - Получатель.
*'''price''' - Стоимость услуг.
*'''rur''' - Сумма заказа.
*'''inshprice''' - Стоимость заказа.
*'''pricekur''' - Стоимость курьерской доставки.
*'''priceag''' - Агентское вознаграждение.
*'''pricecalc''' - Сумма для передачи агенту.
*'''paytype''' - Тип оплаты: 1 - безнал, 2 - наличными курьером, 3 - наличными в офисе, 4 - перевод на карту.
*'''paytypename''' - Строковое представление типа оплаты
*'''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.

API

2019-03-05T13:01:15Z

Boyko: /* Готовые интеграции */

<div style="font-size: 24px; 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>

В системе "Курьерская служба 2008" имеется возможность интеграции средствами XML API, по протоколу HTTP POST.

Данное API предназначено для интеграции клиентов (интернет-магазинов и прочих компаний-заказчиков доставки) с [http://courierexe.ru/our_clients.htm курьерскими службами], работающими под управлением системы [https://curie.ru/ MeaSoft "Курьерская служба 2008"]. Если Вы являетесь '''агрегатором''', передающим данные от клиентов, возможно, Вам придется последовательно подключаться под разными пользователями, если курьерская служба должна вести раздельный учет взаиморасчетов по клиентам. Если Вы являетесь '''подрядчиком''' - Вы можете забирать заказы, используя значение client=AGENT в запросе [[#Пример запроса статуса заказа|statusreq]], и передавать статусы заказов используя метод [[#Изменение статуса агентом|setorderinfo]]. Так же для интеграций с подрядчиками у нас есть специальная платформа, но добавлять подрядчиков в нее можно только на нашей стороне. Присылайте нам коммерческое предложение, описание Вашего сервиса, и мы с радостью его рассмотрим.

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

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

== Готовые интеграции ==

Для интеграции с популярными CMS можно скачать модули интеграции

{| class="wikitable" align="center" style="width: 80%; margin: auto; color: black; boreder: 1px solid #999999;" cellpadding="10" cellspacing="0"
!style="width: 35%;"|Система управления контентом (CMS)
!style="width: 15%;"|Версия модуля
!style="width: 15%;"|Ссылка
!style="width: 35%;"|Примечание
|-
|[[Файл:bitrix.png|center|x44px]]
|style="text-align: center;"|1.5.9 от 13.12.2018
|style="text-align: center;"|[http://marketplace.1c-bitrix.ru/solutions/measoft.courier/ Установить] 
|Поддерживает версии 14.5 и выше
|-
|[[Файл:prestashop.png|center|x44px]]
|style="text-align: center;"|1.4.5 от 10.10.2018
|style="text-align: center;"|[http://courierexe.ru/download/api/prestashop.zip Скачать]
|Поддерживает версии 1.5.2.0 и выше (2.x в том числе!)
|-
|[[Файл:OpencartOCStore.png|center|x44px]]
|style="text-align: center;"|1.7.5 от 10.08.2018<br>2.0.0 от 01.12.2018
|style="text-align: center;"|[http://courierexe.ru/download/api/opencart.zip Скачать]<br>[http://courierexe.ru/download/api/opencart_2.zip Скачать]<br>
|Поддерживает версии с 1.5.5.1<br>Версия 2.0.0 поддерживает версии с 2.0<br>[https://opencartforum.com/files/file/2906-avtomatizaciya-otpravki-i-otslezhivanie-dostavok-courierexe-dlya-opencart-15x/ Альтернативный модуль сторонних разработчиков]
|-
|[[Файл:webasyst-shopscript.png|center|x44px]]
|style="text-align: center;"|1.3.5 от 14.03.2018
|style="text-align: center;"|[http://www.webasyst.ru/store/plugin/shop/measoftcourier/ Установить плагин]<br>[https://www.webasyst.ru/store/plugin/shipping/measoftcourier/ Установить модуль]
|Плагин предназначен для отправки заявок в КС, а модуль для расчета стоимости доставки при оформлении заказа.
|-
|[[Файл:insales.png|center|x44px]]
|style="text-align: center;"|1.2.1 от 06.09.2017
|style="text-align: center;"|[http://www.insales.ru/collection/all/product/kurierskaya-sluzhba-2008 Установить]
|[http://wiki.courierexe.ru/index.php?title=Интеграция_с_другими_системами#Insales Настраивается] в ЛК пользователя в системе
|-
|[[Файл:Leadvertex.png|center|x44px]]
|style="text-align: center;"|1.0 от 15.11.2016
|style="text-align: center;"|[[Файл:Leadvertex-howto.png|center|x44px]]
|[http://blog.leadvertex.ru/news/2110-integraciya-s-kurerkami-na-platforme-measoft/ Настраивается] в ЛК пользователя в системе [https://Leadvertex.ru Leadvertex]
|-
|[[Файл:Retailcrm.png|center|x44px]]
|style="text-align: center;"|1.0 от 11.01.2018
|style="text-align: center;"|[https://www.retailcrm.ru/ RetailCRM]
|[http://wiki.courierexe.ru/index.php?title=Интеграция_с_другими_системами#RetailCRM Настраивается] в ЛК пользователя в системе
|-
|[[Файл:1C.jpg|center|x44px]]
|style="text-align: center;"|1.4 от 17.11.2017
|style="text-align: center;"|-
|[https://infostart.ru/public/692790/ Альтернативный модуль сторонних разработчиков]
|-
|[[Файл:Joomla2.jpg|center|x44px]]
|style="text-align: center;"|1.0.0 от 12.11.2018
|style="text-align: center;"|[http://courierexe.ru/download/api/com_measoft.zip Скачать]
|Внимание! Модуль новый, поэтому возможна некорректная передача данных. Проверяйте, если что - сообщайте, исправим!
|-
|[[Файл:Amocrm.png|center|x44px]]
|style="text-align: center;"|-
|style="text-align: center;"|[https://www.amocrm.ru/extensions/courier2008 Установить]
|Внимание! Модуль новый, поэтому возможна некорректная передача данных. Проверяйте, если что - сообщайте, исправим!
|-
|[[Файл:MoySclad.jpg|center|x44px]]
|style="text-align: center;"|-
|style="text-align: center;"|[https://home.courierexe.ru/moysklad/step1 Подключение] [[Инструкция Мой склад|Инструкция]]
|Ожидается в ближайшее время в магазине Мой Склад
|-
|}

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

== Тестовый аккаунт ==

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

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

== Рабочий аккаунт для подключения ==

Для подключения к площадке Вашего клиента необходимо иметь три параметра:

1. '''Параметр extra''' (Цифровой код, уникальный идентификатор компании. Запросите этот параметр у компании, с которой Вы интегрируетесь). Посмотреть этот код можно в интерфейсе программы КС2008 через основное меню '''"Справочники - Дополнительные возможности"'''. Цифровое значение будет указано во второй гиперссылке (на скриншоте ниже отмечено "звездочкой"):

[[Файл:extra1.png|750px]]

2. '''Логин''' - параметр учетной записи для ЛК клиента и API, указывается в карточке клиента на вкладке '''"Прочее"''' в поле '''"Имя пользователя"'''. Возможно, что в программе КС2008 понадобится создать новую карточку клиента (на скриншоте ниже).

3. '''Пароль''' - параметр учетной записи для ЛК клиента и API, указывается в карточке клиента на вкладке '''"Прочее"''' в поле '''"Пароль"''' (на скриншоте ниже).

[[Файл:33_client.png|500px]]

== Общие понятия ==

На стороне курьерской службы имеется веб-сервис по адресу: https://home.courierexe.ru/api/. Тестовые авторизационные данные: логин: test пароль: testm, параметр 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; < на &lt; > на &gt; " на &quot;

== Ограничения ==
С целью защиты от нецелевого использования сервисов, с 29.05.2017 ведено ограничение на запросы - 1500 запросов с одного IP-адреса за 20 минут. В случае превышения IP-адрес блокируется, разблокировка возможна путем обращения в техническую поддержку, с последующим обсуждением ваших алгоритмов и их коррекцией.

Для проверки статусов заказов лучше всего использовать запросы [[#Передача только изменившихся статусов|"statusreq" с параметром changes=ONLY_LAST]]. Не нужно пытаться "бомбить" наше API запросами с номерами всех ваших заказов, особенно - запросами "tracking", они предназначены не для этого (смотрите описание).

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

<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>Чип & Дейл</person>
<phone>123-45-67</phone>
<zipcode>125480</zipcode>
<town regioncode="78">Санкт-Петербург</town>
<address>Петровка 38 офис 35</address>
<pvz>124</pvz>
<date>2014-03-22</date>
<time_min>09:00</time_min>
<time_max>14:00</time_max>
</receiver>
<return>NO</return>
<weight>5.1</weight>
<return_weight>5.1</return_weight>
<quantity>2</quantity>
<paytype>CASH</paytype>
<service>2</service>
<return_service>1</return_service>
<type>3</type>
<return_type>3</return_type>
<price>387.5</price>
<deliveryprice>150</deliveryprice>
<discount>0</discount>
<inshprice>387.5</inshprice>
<enclosure>Детские игрушки</enclosure>
<instruction>Проверить при покупателе, подписать акт</instruction>
<department>Отдел</department>
<pickup>NO</pickup>
<acceptpartially>NO</acceptpartially>
<items>
<item extcode="abc123" quantity="1" mass="0.2" retprice="37.5" VATrate="0" barcode="2345625213125" article="1" volume="3">Мяч</item>
<item extcode="abc124" quantity="2" mass="2" retprice="100" VATrate="10" barcode="4645625213138" article="2" length="10" width="20" height="30">Обруч</item>
<item extcode="abc125" quantity="3" mass="0.3" retprice="50" barcode="2345625213126" article="3">Погремушка желтая</item>
</items>
</order>
</neworder>
</source>

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

*'''neworder''' - Корневой контейнер, обязательный элемент.

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

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

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

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

*'''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>
<pvz>Код пункта самовывоза по справочнику</pvz>
<date>Дата доставки в формате "YYYY-MM-DD"</date>
<time_min>Желаемое время доставки в формате "HH:MM"</time_min>
<time_max>Желаемое время доставки в формате "HH:MM"</time_max>
</receiver>
</source>

*'''company''' - Компания-получатель.
*'''person''' - Контактное лицо. ''Должно быть заполнено хотя бы одно из полей - company или person!''
*'''phone''' - Телефон. Можно указывать несколько телефонов, E-mail в этом поле.
*'''town''' - Город.

Для тега города '''town''' можно указать код региона в атрибуте '''''regioncode''''' из [[#Справочник регионов|справочника регионов]]. Поиск будет производиться в указанном регионе.

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

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

*'''paytype''' - Тип оплаты заказа получателем. Принимает значения:
:* CASH - Наличными при получении (по-умолчанию)
:* CARD - Картой при получении
:* NO - Без оплаты. Поле Price будет проигнорировано. (Этот тип оплаты передается, если заказ уже оплачен и не требует инкассации, API добавит в систему товары по нулевой цене. Если необходимо передать общую сумму заказа - можно это сделать в поле <inshprice>, указав объявленную ценность)
:* OTHER - Прочее (Предусмотрен для того, чтобы оплата поступала непосредственно в курьерскую службу посредством прочих типов оплаты - таких как: вебмани, яденьги, картой на сайте, прочие платежные системы и т.д.)
:* OPTION - На выбор получателя. Этот тип оплаты нельзя передавать с заказом. Он выставляется автоматически в зависимости от настройки клиента.

*'''zipcode''' - Почтовый индекс.
*'''weight''' - Общий вес заказа в килограммах.
*'''return_weight''' - Общий вес возврата заказа в килограммах.
*'''quantity''' - Количество мест.
*'''service''' - Режим доставки (тип услуги) передается код из справочника "Виды срочности".
*'''return_service''' - Режим возврата (тип услуги) передается код из справочника "Виды срочности".
*'''type''' - Тип корреспонденции (отправления) передается код из справочника "Типы корреспонденции".
*'''return_type''' - Тип возвратной корреспонденции (отправления) передается код из справочника "Типы корреспонденции".
*'''price''' - Сумма заказа. В случае наличия контейнера items значение данного параметра будет проигнорировано, и рассчитано автоматически.
*'''deliveryprice''' - Сумма доставки. В случае наличия контейнера items, в него будет добавлено вложение "Доставка".
*'''discount''' - Скидка на заказ. В результате сумма заказа будет уменьшена на размер скидки.
*'''return''' - Признак необходимости возврата.
*'''return_service''' - Режим возврата (тип услуги) передается код из справочника "Виды срочности".
*'''enclosure''' - Вложение.
*'''inshprice''' - Объявленная ценность.
*'''instruction''' - Поручение - Примечание.
*'''receiverpays''' - Признак оплаты стоимости доставки получателем YES/NO. Если стоит YES, то курьер увидит, что с получателя нужно также взять стоимость доставки.
*'''department''' - Подразделение, в котором оформляется заказ.
*'''pickup''' - Признак оформления забора YES/NO. Если стоит YES, то весь заказ считается заданием на забор груза, а не на доставку! Применяется для вызова курьера к отправителю для забора других отправлений.
*'''acceptpartially''' - Признак возможности частичного выкупа товаров отправления YES/NO.

*'''items''' - Контейнер для описания вложенных товаров. Необязательный контейнер. Атрибуты:
:* '''''item''''' - Название товара.
:* '''''quantity''''' - Количество единиц товара.
:* '''''mass''''' - Масса единицы товара в килограммах.
:* '''''volume''''' - Объемный вес единицы товара в килограммах. При указании объемного веса значение подставляется вместо массы
:* '''''length''''' - Длина единицы товара.
:* '''''width''''' - Ширина единицы товара.
:* '''''height''''' - Высота единицы товара.
:* '''''retprice''''' - Цена единицы товара.
:* '''''VATrate''''' - Ставка НДС - целое число процентов. Если значение не указано, подставляется значение "18".
:* '''''barcode''''' - Штрих-код товара. [[Файл:Article.png|thumb|100px|right]]
:* '''''article''''' - Артикул товара. ''Внимание!'' Указание артикула используется только тогда, когда товар хранится на ответственном хранении в службе доставки, и необходима комплектация. В этом случае система пытается привязать товар к [[API#Справочник номенклатуры|справочнику номенклатуры]]. Если товар в справочнике не найден - система выдаст соответствующую ошибку. Если по артикулу найдено несколько товаров - система выберет один из них случайным образом, что может привести к ошибочной комплектации! Если товар НЕ на ответственном хранении - артикул указывать НЕ нужно. Позиция попадет в систему просто текстом.
:* '''''extcode''''' - Внешний код строки. Используется для идентификации строк заказов при получении статусов. Необязательное поле. ПОКА НЕ ПОДДЕРЖИВАЕТСЯ.

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

=== Примеры ответов ===

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

<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<neworder>
<createorder orderno="AB23541" error="0" errormsg="success"></createorder>
<createorder orderno="55_6542" error="0" errormsg="success"></createorder>
<createorder orderno="AB23542" error="0" errormsg="success"></createorder>
</neworder>
</source>

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

<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<neworder>
<createorder orderno="AB23541" error="17" errormsg="Such number exists"></createorder>
<createorder orderno="AB23542" error="13" errormsg="empty company"></createorder>
<createorder orderno="AB23543" error="14" errormsg="empty person"></createorder>
</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>

=== Коды ошибок при оформлении заказа ===

0 - Ошибок нет.

1 - Ошибка авторизации. (отсутствуют теги <auth login="" pass=""></auth>, неверный логин или пароль).

2 - Отправлен пустой запрос (отсутствует контейнер <neworder></neworder> в XML документе).

3 - Некорректно указана сумма заказа.

4 - Некорректный общий вес заказа.

5 - Не найден город получатель.

6 - Не найден город отправитель.

7 - Не заполнен адрес получателя.

8 - Не заполнен телефон получателя.

9 - Не заполнено контактное имя получателя.

10 - Не заполнено название компании получателя.

11 - Некорректная сумма объявленной ценности.

12 - Артикул не найден.

13 - Не заполнено название компании отправителя.

14 - Не заполнено контактное имя отправителя.

15 - Не заполнен телефон отправителя.

16 - Не заполнен адрес отправителя.

17 - Заказ с таким номером уже существует.

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

=== Пример запроса статуса заказа ===

<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>
<ordercode>34234</ordercode>
<givencode>234534</givencode>
<datefrom>2016-07-21</datefrom>
<dateto>2016-07-21</dateto>
<target>Автозавод</target>
<done>ONLY_NOT_DONE</done>
<changes>ONLY_LAST</changes>
<quickstatus>NO</quickstatus>
</statusreq>
</source>

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

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

*'''changes''' - может принимать значение только ONLY_LAST. Если указан этот параметр, все остальные, кроме quickstatus, игнорируются. Описание данного режима приведено здесь: [[#Передача только изменившихся статусов|Передача только изменившихся статусов]]

*'''quickstatus''' - Указывает "глубину" передаваемых статусов: "YES" (по-умолчанию) - передаются статусы начиная с информации, поступившей от курьера. Такие статусы являются быстрыми (как правило, проставляются курьером сразу после доставки) но не всегда точными. Значение NO запрещает передачу статуса со слов курьера, и выдает только статусы, введенные оператором, как правило вручную. На это требуется больше времени, однако точность гораздо выше. Не рекомендуется совмещать эти типы передачи статусов (чередовать их) при запросе только изменившихся статусов, т.к. в этом случае система будет считать, что статусы у отправлений меняются.

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

=== Примеры ответов ===

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

<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<statusreq count="23">
<order orderno="111111" 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>
<zipcode>125480</zipcode>
<town code="153361" regioncode="78" regionname="Санкт-Петербург город">Санкт-Петербург город</town>
<address>Петровка 38 офис 35</address>
<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>
</receiver>
<weight>5.1</weight>
<return_weight>5.1</return_weight>
<quantity>2</quantity>
<paytype>CASH</paytype>
<service>2</service>
<return_service>2</service>
<type>3</type>
<return_type>3</return_type>
<waittime>12</waittime>
<price>387.5</price>
<print_check>YES</print_check>
<inshprice>387.5</inshprice>
<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">
<>..</> (price details are not yet supported)
..
</deliveryprice>
<receiverpays>NO</receiverpays>
<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>
<customstatecode>2<customstatecode>
<clientstatecode></clientstatecode>
<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">Мяч</item>
<item code="34456" extcode="abc124" quantity="2" mass="2" retprice="100" VATrate="10" barcode="4645625213138" article="2" returns="0">Обруч</item>
<item code="34421" extcode="abc125" quantity="3" mass="0.3" retprice="50" VATrate="18" barcode="2345625213126" article="3" returns="0">Погремушка желтая</item>
</items>
<packages>
<package code="33123" strbarcode="4625333555001" mass="0" message="">Место 1</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''':
:* '''''ordercode''''' - внутренний код заказа в системе, применяется для некоторых внутренних операций.
:* '''''givencode''''' - внутренний код заказа в системе, применяется для некоторых внутренних операций.
:* '''''returns''''' - количество данного товара, от которого отказался получатель. Не нулевое только в случае частичного отказа.

* атрибут '''''code''''' контейнера '''item''' - внутренний код строки заказа в системе, применяется для некоторых внутренних операций.
* '''''coords''''' в контейнере '''receiver''' - координаты получателя.
* '''currcoords''' - текущие координаты заказа. Атрибуты:
:* '''''lat''''' - широта
:* '''''lon''''' - долгота
:* '''''accuracy''''' - точность в метрах
:* '''''RequestDateTime''''' - дата/время последнего обновления координат.

* '''waittime ''' - Время ожидания курьера.
* '''deliveryprice''' - стоимость доставки в валюте расчетов с клиентом.
* '''status''' - статус доставки (список статусов см. ниже). Атрибуты (заполняются начиная с версии системы 2008.0.0.670):
:* '''''eventstore''''' - филиал, к которому относится текущий статус
:* '''''eventtime''''' - время изменения статуса (время зависит от местонахождения филиала)
:* '''''createtimegmt''''' - время фактического изменения статуса (GMT)
:* '''''message''''' - наименование филиала-получателя, при передаче между филиалами
:* '''''title''''' - русское наименование статуса

* '''statushistory''' - история статусов доставки. Содержит список контейнеров '''status'''. Заполняется только для тарифа "Премиум" начиная с версии системы 2008.0.0.670.
* '''customstatecode''' - код внутреннего статуса курьерской службы. Значения уточняйте в курьерской службе. Назначаются курьерской службой в разделе "Справочники" - "Статусы" - "15 Статусы корреспонденции". Справочник не передается через API клиенту по причине возможного наличия в нем внутренних технологических статусов курьерской службы.
* '''clientstatecode''' - код статуса клиента. Используется, если клиент предлагает свои коды статусов доставки/причин недоставки.
* '''deliveredto''' - данные о вручении, либо причина недоставки.
* '''delivereddate''' - дата вручения.
* '''deliveredtime''' - время вручения. В случае недоставки может быть пустым.
* '''outstrbarcode''' - код у подрядчика (код заказа во внешней системе). Используется в интеграциях с внешними системами.

*'''packages''' - Контейнер для описания мест. Необязательный контейнер. Атрибуты:
:* '''''package''''' - Название места.
:* '''''code''''' - Внутренний код строки.
:* '''''strbarcode''''' - Штрих-код места.
:* '''''mass''''' - Масса места в килограммах.
:* '''''message''''' - Строка сообщения.

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

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

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

# Атрибуты контейнера '''status''' заполняются для версий системы '''2008.0.0.670''' и новее.
# Контейнер '''statushistory''' заполняется для тарифа "[[Личный_кабинет#.D0.9F.D0.BE.D0.B4.D0.BA.D0.BB.D1.8E.D1.87.D0.B5.D0.BD.D0.B8.D0.B5|Премиум]]" и версий системы '''2008.0.0.670''' и новее.
</div>
<br />

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

Для получения только изменившихся статусов отправьте запрос
<source lang="xml">
<?xml version="1.0" encoding="UTF-8" ?>
<statusreq>
<auth extra="8" login="login" pass="pass"></auth>
<changes>ONLY_LAST</changes>
<quickstatus>NO</quickstatus>
</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>
</commitlaststatus>
</source>

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

*'''auth''' - Авторизация. Обязательный элемент.
*'''client''' - Признак клиента или агента. Необязательный элемент.
:* CLIENT - Признак клиента, значение по умолчанию
:* AGENT - Признак агента. В ответ отдается информация по заказам, переданным агенту на доставку

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

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

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

# При данном способе передачи (<changes>ONLY_LAST</changes>) система просматривает заказы, оформленные за последние 3 месяца. Если заказ сделан ранее - изменение статуса по нему не попадет в результат выполнения данного запроса.
# Система всегда выдает текущий статус. Т.е. Вы можете одним запросом получить статус "NEW", а следующим - "COMPLETE". В промежутке между запросами отправление могло пройти через несколько промежуточных статусов.
# Система никогда не гарантирует последовательность прохождения заказом набора статусов. Т.е. Вы можете получить статус "COMPLETE", а следующим запросом - "NEW" - такое может произойти, например, если оператор ошибочно отметил заказ выполненным, а затем исправил ошибку.
</div>
<br />

== Получение вложений к накладной ==

'''Пример запроса:'''
<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.

== Трекинг заказа по номеру ==

Запрос трекинга по номеру предназначен для выдачи минимальной обезличенной информации о конкретном заказе не авторизованному пользователю. Наша система имеет для этого интерфейс по адресу "home.courierexe.ru/{код экстра}/tracking". Вы можете либо сделать ссылку на такую страницу на своем сайте, либо разместить ее 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="1234">
<sender>
<town code="1" country="RU">Москва город</town>
<date></date>
</sender>
<receiver>
<town code="1" country="RU">Москва город</town>
<date>2015-04-18</date>
</receiver>
<AWB>BarCode</AWB>
<weight>0</weight>
<quantity>1</quantity>
<currcoords lat="" lon="" accuracy="" RequestDateTime="" />
<status eventstore="филиал в Санкт-Петербурге" eventtime="2016-06-02 17:22:00" createtimegmt="2016-06-03 16:14:44" message="" title="Доставлен" country="RU">COMPLETE</status>
<statushistory>
<status eventstore="Офис в Москве" eventtime="2016-05-30 10:20:00" createtimegmt="2016-06-03 16:14:44" message="" title="Новый" country="RU">NEW</status>
<status eventstore="Офис в Москве" eventtime="2016-06-01 17:38:00" createtimegmt="2016-06-03 16:14:44" message="филиал в Санкт-Петербурге" title="Планируется отправка" country="RU">DEPARTURING</status>
<status eventstore="Офис в Москве" eventtime="2016-06-01 19:53:00" createtimegmt="2016-06-03 16:14:44" message="филиал в Санкт-Петербурге" title="Отправлено со склада" country="RU">DEPARTURE</status>
<status eventstore="филиал в Санкт-Петербурге" eventtime="2016-06-02 07:41:00" createtimegmt="2016-06-03 16:14:44" message="" title="Получен складом" country="RU">ACCEPTED</status>
<status eventstore="филиал в Санкт-Петербурге" eventtime="2016-06-02 09:17:00" createtimegmt="2016-06-03 16:14:44" message="" title="Выдан курьеру на доставку" country="RU">DELIVERY</status>
<status eventstore="филиал в Санкт-Петербурге" eventtime="2016-06-02 17:22:00" createtimegmt="2016-06-03 16:14:44" message="" title="Доставлен (предварительно)" country="RU">COURIERDELIVERED</status>
<status eventstore="филиал в Санкт-Петербурге" eventtime="2016-06-02 17:22:00" createtimegmt="2016-06-03 16:14:44" message="" title="Доставлен" country="RU">COMPLETE</status>
</statushistory>
</order>
</tracking>
</source>

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

== Изменение статуса агентом ==

Запрос изменения статуса заказа позволяет установить окончательный статус заказа - "Доставлен" или "Не доставлен (Возврат/Отмена)".

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

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

'''Пример запроса изменения статуса:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8" ?>
<setorderinfo>
<auth extra="8" login="login" pass="pass" />
<order ordercode="123456" date="2018-03-01" time="10:00" message="Клиент отказался от покупки"/>
<order ordercode="234567" date="2018-03-01" time="10:00" message="">
<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''''' - Внутренний код заказа.
:* '''''date''''' - Дата изменения статуса.
:* '''''time''''' - Время изменения статуса.
:* '''''message''''' - текст сообщения.

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

== Получение накладной в формате pdf ==

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

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

'''waybill''' - Корневой контейнер. Обязательный элемент.
*'''auth''' - Авторизация. Обязательный элемент.
*'''orderno''' - Номер/код заказа. Обязательный элемент.
*'''form''' - Формат накладной. Не обязательный элемент. Принимает значения:
:* 1 - Подробная накладная (по-умолчанию)
:* 2 - Наклейки (Zebra)

'''Пример ответа:'''
<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" ?>
<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>

== Справочник городов ==

'''Пример запроса справочника городов:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<townlist>
<codesearch>
<zipcode>110000</zipcode>
<kladrcode>0100000100800</kladrcode>
<fiascode>bd21979d-46f8-49d0-9105-e8d65172a983</fiascode>
<code>123</code>
</codesearch>
<conditions>
<city>Краснодарский край</city>
<namecontains>новгород</namecontains>
<namestarts>Моск</namestarts>
<name>Москва</name>
<fullname>Москва город</fullname>
<country>1</country>
</conditions>
<limit>
<limitfrom>30</limitfrom>
<limitcount>10</limitcount>
<countall>YES</countall>
</limit>
</townlist>
</source>

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

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

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

'''Пример ответа:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<townlist 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)
</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 />
</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 />
</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>1</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>
<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>
</conditions>
<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 - Все. ''Это поле может быть недоступным в некоторых установках.''

*'''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>
<CountInPallet>30</CountInPallet>
<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''' - Высота в сантиметрах.
*'''CountInPallet''' - Количество штук в паллете.
*'''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>
</itemmovements>
</source>

*'''code''' - внутренний код товара в справочнике номенклатуры.

'''Пример ответа движения номенклатуры:'''
<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''' - номер документа
:* '''date''' - дата документа
:* '''message''' - комментарий

== Справочник пунктов самовывоза ==

'''Пример запроса пунктов самовывоза:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8" ?>
<pvzlist>
<auth extra="8" login="login" pass="pass"></auth>
<town>Нижний Тагил</town>
</pvzlist>
</source>

*'''town''' - Город получателя.

'''Пример ответа справочника пунктов самовывоза:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8" ?>
<pvzlist count="2">
<pvz>
<code>126</code>
<clientcode>3</clientcode>
<name>Нижний Тагил</name>
<address>622036, г. Нижний Тагил, ул. Циолковского, д. 17</address>
<phone>+73435417709, +73435254989</phone>
<comment>Жилое 5-ти этажное здание, торцом к дороге, второе здание от перекрестка Пархоменко-Циолковского.</comment>
<maxweight>10</maxweight>
</pvz>
<pvz>
<code>245</code>
<clientcode>NTG1</clientcode>
<name>На Красноармейской</name>
<address>КРАСНОАРМЕЙСКАЯ, д.79</address>
<phone>+7(3435)379-044</phone>
<comment>Время работы: пн.-пт. 9-18, сб. 10-14</comment>
<maxweight>20</maxweight>
</pvz>
</pvzlist>
</source>

*'''code''' - Код ПВЗ в системе. Используется в запросе [[API#Оформление заказа|оформления заказов]]
*'''clientcode''' - Код ПВЗ используемый компанией-подрядчиком.
*'''name''' - Наименование ПВЗ.
*'''address''' - Адрес ПВЗ.
*'''phone''' - Телефоны ПВЗ.
*'''comment''' - Дополнительная информация.
*'''maxweight''' - Максимальный вес, с которым работает ПВЗ.

== Справочник Видов срочности ==

'''Пример запроса Видов срочности:'''
<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" ?>
<calculator>
<auth extra="8" login="login" pass="pass" />
<calc townfrom="Москва" townto="3800000300000" l="10" w="20" h="30" mass="3.7" service="1" />
</calculator>
</source>

Параметры:
*'''townfrom''' - Город-отправитель
*'''townto''' - Город-получатель
*'''l''' - Длина в сантиметрах (не обязательный параметр)
*'''w''' - Ширина в сантиметрах (не обязательный параметр)
*'''h''' - Высота в сантиметрах (не обязательный параметр)
*'''mass''' - Масса в килограммах
*'''service''' - Режим доставки - число, указывающее на запись в справочнике [[#Справочник Видов срочности|видов срочности]]. Если этот параметр опустить, система выдаст расчет для всех доступных видов срочности, передав много контейнеров <calc> в ответе.

В авторизации можно опустить параметры 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>1163</price>
<maxdeliverydays>3</maxdeliverydays>
</calc>
</calculator>
</source>

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

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

== Список актов передачи денег ==

'''Пример запроса списка актов передачи денег:'''
<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>
<price>637.00</price>
<rur>13430.00</rur>
<pricekur>570.00</pricekur>
<priceag>67.00</priceag>
<payno>42423</payno>
<paytype>1</paytype>
<paytypename>Безнал</paytypename>
</sma>
</smalist>
</source>

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

== Детализация актов передачи денег ==

'''Пример запроса детализации актов передачи денег:'''
<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>
<status>Доставлено</status>
</specialsma>
</smadetail>
</source>

*'''code''' - Код записи.
*'''ordercode''' - Код заказа.
*'''orderno''' - Шифр заказа.
*'''orderdate''' - Дата заказа.
*'''delivereddate''' - Дата доставки.
*'''company''' - Получатель.
*'''price''' - Стоимость услуг.
*'''rur''' - Сумма заказа.
*'''inshprice''' - Стоимость заказа.
*'''pricekur''' - Стоимость курьерской доставки.
*'''priceag''' - Агентское вознаграждение.
*'''pricecalc''' - Сумма для передачи агенту.
*'''paytype''' - Тип оплаты: 1 - безнал, 2 - наличными курьером, 3 - наличными в офисе, 4 - перевод на карту.
*'''paytypename''' - Строковое представление типа оплаты
*'''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.

API

2019-01-23T10:14:31Z

Boyko: /* Трекинг заказа по номеру */

<div style="font-size: 24px; 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>

В системе "Курьерская служба 2008" имеется возможность интеграции средствами XML API, по протоколу HTTP POST.

Данное API предназначено для интеграции клиентов (интернет-магазинов и прочих компаний-заказчиков доставки) с [http://courierexe.ru/our_clients.htm курьерскими службами], работающими под управлением системы [https://curie.ru/ MeaSoft "Курьерская служба 2008"]. Если Вы являетесь '''агрегатором''', передающим данные от клиентов, возможно, Вам придется последовательно подключаться под разными пользователями, если курьерская служба должна вести раздельный учет взаиморасчетов по клиентам. Если Вы являетесь '''подрядчиком''' - Вы можете забирать заказы, используя значение client=AGENT в запросе [[#Пример запроса статуса заказа|statusreq]], и передавать статусы заказов используя метод [[#Изменение статуса агентом|setorderinfo]]. Так же для интеграций с подрядчиками у нас есть специальная платформа, но добавлять подрядчиков в нее можно только на нашей стороне. Присылайте нам коммерческое предложение, описание Вашего сервиса, и мы с радостью его рассмотрим.

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

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

== Готовые интеграции ==

Для интеграции с популярными CMS можно скачать модули интеграции

{| class="wikitable" align="center" style="width: 80%; margin: auto; color: black; boreder: 1px solid #999999;" cellpadding="10" cellspacing="0"
!style="width: 35%;"|Система управления контентом (CMS)
!style="width: 15%;"|Версия модуля
!style="width: 15%;"|Ссылка
!style="width: 35%;"|Примечание
|-
|[[Файл:bitrix.png|center|x44px]]
|style="text-align: center;"|1.5.9 от 13.12.2018
|style="text-align: center;"|[http://marketplace.1c-bitrix.ru/solutions/measoft.courier/ Установить] 
|Поддерживает версии 14.5 и выше
|-
|[[Файл:prestashop.png|center|x44px]]
|style="text-align: center;"|1.4.5 от 10.10.2018
|style="text-align: center;"|[http://courierexe.ru/download/api/prestashop.zip Скачать]
|Поддерживает версии 1.5.2.0 и выше (2.x в том числе!)
|-
|[[Файл:OpencartOCStore.png|center|x44px]]
|style="text-align: center;"|1.7.5 от 10.08.2018<br>2.0.0 от 01.12.2018
|style="text-align: center;"|[http://courierexe.ru/download/api/opencart.zip Скачать]<br>[http://courierexe.ru/download/api/opencart_2.zip Скачать]<br>
|Поддерживает версии с 1.5.5.1<br>Версия 2.0.0 поддерживает версии с 2.0<br>[https://opencartforum.com/files/file/2906-avtomatizaciya-otpravki-i-otslezhivanie-dostavok-courierexe-dlya-opencart-15x/ Альтернативный модуль сторонних разработчиков]
|-
|[[Файл:webasyst-shopscript.png|center|x44px]]
|style="text-align: center;"|1.3.5 от 14.03.2018
|style="text-align: center;"|[http://www.webasyst.ru/store/plugin/shop/measoftcourier/ Установить]
|
|-
|[[Файл:insales.png|center|x44px]]
|style="text-align: center;"|1.2.1 от 06.09.2017
|style="text-align: center;"|[http://www.insales.ru/collection/all/product/kurierskaya-sluzhba-2008 Установить]
|[[Интеграция_с_другими_системами#Insales|Настраивается]] в ЛК пользователя в системе
|-
|[[Файл:Leadvertex.png|center|x44px]]
|style="text-align: center;"|1.0 от 15.11.2016
|style="text-align: center;"|[[Файл:Leadvertex-howto.png|center|x44px]]
|[http://blog.leadvertex.ru/news/2110-integraciya-s-kurerkami-na-platforme-measoft/ Настраивается] в ЛК пользователя в системе [https://Leadvertex.ru Leadvertex]
|-
|[[Файл:Retailcrm.png|center|x44px]]
|style="text-align: center;"|1.0 от 11.01.2018
|style="text-align: center;"|[https://www.retailcrm.ru/ RetailCRM]
|[[Интеграция_с_другими_системами#RetailCRM|Настраивается]] в ЛК пользователя в системе
|-
|[[Файл:1C.jpg|center|x44px]]
|style="text-align: center;"|1.4 от 17.11.2017
|style="text-align: center;"|-
|[https://infostart.ru/public/692790/ Альтернативный модуль сторонних разработчиков]
|-
|[[Файл:Joomla2.jpg|center|x44px]]
|style="text-align: center;"|1.0.0 от 12.11.2018
|style="text-align: center;"|[http://courierexe.ru/download/api/com_measoft.zip Скачать]
|Внимание! Модуль новый, поэтому возможна некорректная передача данных. Проверяйте, если что - сообщайте, исправим!
|-
|[[Файл:Amocrm.png|center|x44px]]
|style="text-align: center;"|-
|style="text-align: center;"|[https://www.amocrm.ru/extensions/courier2008 Установить]
|Внимание! Модуль новый, поэтому возможна некорректная передача данных. Проверяйте, если что - сообщайте, исправим!
|-
|[[Файл:MoySclad.jpg|center|x44px]]
|style="text-align: center;"|-
|style="text-align: center;"|-
|Ожидается в ближайшее время в магазине Мой Склад
|-
|}

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

== Тестовый аккаунт ==

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

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

== Рабочий аккаунт для подключения ==

Для подключения к площадке Вашего клиента необходимо иметь три параметра:

1. '''Параметр extra''' (Цифровой код, уникальный идентификатор компании. Запросите этот параметр у компании, с которой Вы интегрируетесь). Посмотреть этот код можно в интерфейсе программы КС2008 через основное меню '''"Справочники - Дополнительные возможности"'''. Цифровое значение будет указано во второй гиперссылке (на скриншоте ниже отмечено "звездочкой"):

[[Файл:extra1.png|750px]]

2. '''Логин''' - параметр учетной записи для ЛК клиента и API, указывается в карточке клиента на вкладке '''"Прочее"''' в поле '''"Имя пользователя"'''. Возможно, что в программе КС2008 понадобится создать новую карточку клиента (на скриншоте ниже).

3. '''Пароль''' - параметр учетной записи для ЛК клиента и API, указывается в карточке клиента на вкладке '''"Прочее"''' в поле '''"Пароль"''' (на скриншоте ниже).

[[Файл:33_client.png|500px]]

== Общие понятия ==

На стороне курьерской службы имеется веб-сервис по адресу: https://home.courierexe.ru/api/. Тестовые авторизационные данные: логин: test пароль: testm, параметр 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; < на &lt; > на &gt; " на &quot;

== Ограничения ==
С целью защиты от нецелевого использования сервисов, с 29.05.2017 ведено ограничение на запросы - 1500 запросов с одного IP-адреса за 20 минут. В случае превышения IP-адрес блокируется, разблокировка возможна путем обращения в техническую поддержку, с последующим обсуждением ваших алгоритмов и их коррекцией.

Для проверки статусов заказов лучше всего использовать запросы [[#Передача только изменившихся статусов|"statusreq" с параметром changes=ONLY_LAST]]. Не нужно пытаться "бомбить" наше API запросами с номерами всех ваших заказов, особенно - запросами "tracking", они предназначены не для этого (смотрите описание).

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

<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>Чип & Дейл</person>
<phone>123-45-67</phone>
<zipcode>125480</zipcode>
<town regioncode="78">Санкт-Петербург</town>
<address>Петровка 38 офис 35</address>
<pvz>124</pvz>
<date>2014-03-22</date>
<time_min>09:00</time_min>
<time_max>14:00</time_max>
</receiver>
<return>NO</return>
<weight>5.1</weight>
<return_weight>5.1</return_weight>
<quantity>2</quantity>
<paytype>CASH</paytype>
<service>2</service>
<return_service>1</return_service>
<type>3</type>
<return_type>3</return_type>
<price>387.5</price>
<deliveryprice>150</deliveryprice>
<discount>0</discount>
<inshprice>387.5</inshprice>
<enclosure>Детские игрушки</enclosure>
<instruction>Проверить при покупателе, подписать акт</instruction>
<department>Отдел</department>
<pickup>NO</pickup>
<acceptpartially>NO</acceptpartially>
<items>
<item extcode="abc123" quantity="1" mass="0.2" retprice="37.5" VATrate="0" barcode="2345625213125" article="1" volume="3">Мяч</item>
<item extcode="abc124" quantity="2" mass="2" retprice="100" VATrate="10" barcode="4645625213138" article="2" length="10" width="20" height="30">Обруч</item>
<item extcode="abc125" quantity="3" mass="0.3" retprice="50" barcode="2345625213126" article="3">Погремушка желтая</item>
</items>
</order>
</neworder>
</source>

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

*'''neworder''' - Корневой контейнер, обязательный элемент.

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

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

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

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

*'''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>
<pvz>Код пункта самовывоза по справочнику</pvz>
<date>Дата доставки в формате "YYYY-MM-DD"</date>
<time_min>Желаемое время доставки в формате "HH:MM"</time_min>
<time_max>Желаемое время доставки в формате "HH:MM"</time_max>
</receiver>
</source>

*'''company''' - Компания-получатель.
*'''person''' - Контактное лицо. ''Должно быть заполнено хотя бы одно из полей - company или person!''
*'''phone''' - Телефон. Можно указывать несколько телефонов, E-mail в этом поле.
*'''town''' - Город.

Для тега города '''town''' можно указать код региона в атрибуте '''''regioncode''''' из [[#Справочник регионов|справочника регионов]]. Поиск будет производиться в указанном регионе.

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

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

*'''paytype''' - Тип оплаты заказа получателем. Принимает значения:
:* CASH - Наличными при получении (по-умолчанию)
:* CARD - Картой при получении
:* NO - Без оплаты. Поле Price будет проигнорировано. (Этот тип оплаты передается, если заказ уже оплачен и не требует инкассации, API добавит в систему товары по нулевой цене. Если необходимо передать общую сумму заказа - можно это сделать в поле <inshprice>, указав объявленную ценность)
:* OTHER - Прочее (Предусмотрен для того, чтобы оплата поступала непосредственно в курьерскую службу посредством прочих типов оплаты - таких как: вебмани, яденьги, картой на сайте, прочие платежные системы и т.д.)
:* OPTION - На выбор получателя. Этот тип оплаты нельзя передавать с заказом. Он выставляется автоматически в зависимости от настройки клиента.

*'''zipcode''' - Почтовый индекс.
*'''weight''' - Общий вес заказа в килограммах.
*'''return_weight''' - Общий вес возврата заказа в килограммах.
*'''quantity''' - Количество мест.
*'''service''' - Режим доставки (тип услуги) передается код из справочника "Виды срочности".
*'''return_service''' - Режим возврата (тип услуги) передается код из справочника "Виды срочности".
*'''type''' - Тип корреспонденции (отправления) передается код из справочника "Типы корреспонденции".
*'''return_type''' - Тип возвратной корреспонденции (отправления) передается код из справочника "Типы корреспонденции".
*'''price''' - Сумма заказа. В случае наличия контейнера items значение данного параметра будет проигнорировано, и рассчитано автоматически.
*'''deliveryprice''' - Сумма доставки. В случае наличия контейнера items, в него будет добавлено вложение "Доставка".
*'''discount''' - Скидка на заказ. В результате сумма заказа будет уменьшена на размер скидки.
*'''return''' - Признак необходимости возврата.
*'''return_service''' - Режим возврата (тип услуги) передается код из справочника "Виды срочности".
*'''enclosure''' - Вложение.
*'''inshprice''' - Объявленная ценность.
*'''instruction''' - Поручение - Примечание.
*'''receiverpays''' - Признак оплаты стоимости доставки получателем YES/NO. Если стоит YES, то курьер увидит, что с получателя нужно также взять стоимость доставки.
*'''department''' - Подразделение, в котором оформляется заказ.
*'''pickup''' - Признак оформления забора YES/NO. Если стоит YES, то весь заказ считается заданием на забор груза, а не на доставку! Применяется для вызова курьера к отправителю для забора других отправлений.
*'''acceptpartially''' - Признак возможности частичного выкупа товаров отправления YES/NO.

*'''items''' - Контейнер для описания вложенных товаров. Необязательный контейнер. Атрибуты:
:* '''''item''''' - Название товара.
:* '''''quantity''''' - Количество единиц товара.
:* '''''mass''''' - Масса единицы товара в килограммах.
:* '''''volume''''' - Объемный вес единицы товара в килограммах. При указании объемного веса значение подставляется вместо массы
:* '''''length''''' - Длина единицы товара.
:* '''''width''''' - Ширина единицы товара.
:* '''''height''''' - Высота единицы товара.
:* '''''retprice''''' - Цена единицы товара.
:* '''''VATrate''''' - Ставка НДС - целое число процентов. Если значение не указано, подставляется значение "18".
:* '''''barcode''''' - Штрих-код товара. [[Файл:Article.png|thumb|100px|right]]
:* '''''article''''' - Артикул товара. ''Внимание!'' Указание артикула используется только тогда, когда товар хранится на ответственном хранении в службе доставки, и необходима комплектация. В этом случае система пытается привязать товар к [[API#Справочник номенклатуры|справочнику номенклатуры]]. Если товар в справочнике не найден - система выдаст соответствующую ошибку. Если по артикулу найдено несколько товаров - система выберет один из них случайным образом, что может привести к ошибочной комплектации! Если товар НЕ на ответственном хранении - артикул указывать НЕ нужно. Позиция попадет в систему просто текстом.
:* '''''extcode''''' - Внешний код строки. Используется для идентификации строк заказов при получении статусов. Необязательное поле. ПОКА НЕ ПОДДЕРЖИВАЕТСЯ.

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

=== Примеры ответов ===

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

<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<neworder>
<createorder orderno="AB23541" error="0" errormsg="success"></createorder>
<createorder orderno="55_6542" error="0" errormsg="success"></createorder>
<createorder orderno="AB23542" error="0" errormsg="success"></createorder>
</neworder>
</source>

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

<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<neworder>
<createorder orderno="AB23541" error="17" errormsg="Such number exists"></createorder>
<createorder orderno="AB23542" error="13" errormsg="empty company"></createorder>
<createorder orderno="AB23543" error="14" errormsg="empty person"></createorder>
</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>

=== Коды ошибок при оформлении заказа ===

0 - Ошибок нет.

1 - Ошибка авторизации. (отсутствуют теги <auth login="" pass=""></auth>, неверный логин или пароль).

2 - Отправлен пустой запрос (отсутствует контейнер <neworder></neworder> в XML документе).

3 - Некорректно указана сумма заказа.

4 - Некорректный общий вес заказа.

5 - Не найден город получатель.

6 - Не найден город отправитель.

7 - Не заполнен адрес получателя.

8 - Не заполнен телефон получателя.

9 - Не заполнено контактное имя получателя.

10 - Не заполнено название компании получателя.

11 - Некорректная сумма объявленной ценности.

12 - Артикул не найден.

13 - Не заполнено название компании отправителя.

14 - Не заполнено контактное имя отправителя.

15 - Не заполнен телефон отправителя.

16 - Не заполнен адрес отправителя.

17 - Заказ с таким номером уже существует.

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

=== Пример запроса статуса заказа ===

<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>
<ordercode>34234</ordercode>
<givencode>234534</givencode>
<datefrom>2016-07-21</datefrom>
<dateto>2016-07-21</dateto>
<target>Автозавод</target>
<done>ONLY_NOT_DONE</done>
<changes>ONLY_LAST</changes>
<quickstatus>NO</quickstatus>
</statusreq>
</source>

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

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

*'''changes''' - может принимать значение только ONLY_LAST. Если указан этот параметр, все остальные, кроме quickstatus, игнорируются. Описание данного режима приведено здесь: [[#Передача только изменившихся статусов|Передача только изменившихся статусов]]

*'''quickstatus''' - Указывает "глубину" передаваемых статусов: "YES" (по-умолчанию) - передаются статусы начиная с информации, поступившей от курьера. Такие статусы являются быстрыми (как правило, проставляются курьером сразу после доставки) но не всегда точными. Значение NO запрещает передачу статуса со слов курьера, и выдает только статусы, введенные оператором, как правило вручную. На это требуется больше времени, однако точность гораздо выше. Не рекомендуется совмещать эти типы передачи статусов (чередовать их) при запросе только изменившихся статусов, т.к. в этом случае система будет считать, что статусы у отправлений меняются.

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

=== Примеры ответов ===

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

<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<statusreq count="23">
<order orderno="111111" 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>
<zipcode>125480</zipcode>
<town code="153361" regioncode="78" regionname="Санкт-Петербург город">Санкт-Петербург город</town>
<address>Петровка 38 офис 35</address>
<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>
</receiver>
<weight>5.1</weight>
<return_weight>5.1</return_weight>
<quantity>2</quantity>
<paytype>CASH</paytype>
<service>2</service>
<return_service>2</service>
<type>3</type>
<return_type>3</return_type>
<waittime>12</waittime>
<price>387.5</price>
<print_check>YES</print_check>
<inshprice>387.5</inshprice>
<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">
<>..</> (price details are not yet supported)
..
</deliveryprice>
<receiverpays>NO</receiverpays>
<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>
<customstatecode>2<customstatecode>
<clientstatecode></clientstatecode>
<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">Мяч</item>
<item code="34456" extcode="abc124" quantity="2" mass="2" retprice="100" VATrate="10" barcode="4645625213138" article="2" returns="0">Обруч</item>
<item code="34421" extcode="abc125" quantity="3" mass="0.3" retprice="50" VATrate="18" barcode="2345625213126" article="3" returns="0">Погремушка желтая</item>
</items>
<packages>
<package code="33123" strbarcode="4625333555001" mass="0" message="">Место 1</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''':
:* '''''ordercode''''' - внутренний код заказа в системе, применяется для некоторых внутренних операций.
:* '''''givencode''''' - внутренний код заказа в системе, применяется для некоторых внутренних операций.
:* '''''returns''''' - количество данного товара, от которого отказался получатель. Не нулевое только в случае частичного отказа.

* атрибут '''''code''''' контейнера '''item''' - внутренний код строки заказа в системе, применяется для некоторых внутренних операций.
* '''''coords''''' в контейнере '''receiver''' - координаты получателя.
* '''currcoords''' - текущие координаты заказа. Атрибуты:
:* '''''lat''''' - широта
:* '''''lon''''' - долгота
:* '''''accuracy''''' - точность в метрах
:* '''''RequestDateTime''''' - дата/время последнего обновления координат.

* '''waittime ''' - Время ожидания курьера.
* '''deliveryprice''' - стоимость доставки в валюте расчетов с клиентом.
* '''status''' - статус доставки (список статусов см. ниже). Атрибуты (заполняются начиная с версии системы 2008.0.0.670):
:* '''''eventstore''''' - филиал, к которому относится текущий статус
:* '''''eventtime''''' - время изменения статуса (время зависит от местонахождения филиала)
:* '''''createtimegmt''''' - время фактического изменения статуса (GMT)
:* '''''message''''' - наименование филиала-получателя, при передаче между филиалами
:* '''''title''''' - русское наименование статуса

* '''statushistory''' - история статусов доставки. Содержит список контейнеров '''status'''. Заполняется только для тарифа "Премиум" начиная с версии системы 2008.0.0.670.
* '''customstatecode''' - код внутреннего статуса курьерской службы. Значения уточняйте в курьерской службе. Назначаются курьерской службой в разделе "Справочники" - "Статусы" - "15 Статусы корреспонденции". Справочник не передается через API клиенту по причине возможного наличия в нем внутренних технологических статусов курьерской службы.
* '''clientstatecode''' - код статуса клиента. Используется, если клиент предлагает свои коды статусов доставки/причин недоставки.
* '''deliveredto''' - данные о вручении, либо причина недоставки.
* '''delivereddate''' - дата вручения.
* '''deliveredtime''' - время вручения. В случае недоставки может быть пустым.
* '''outstrbarcode''' - код у подрядчика (код заказа во внешней системе). Используется в интеграциях с внешними системами.

*'''packages''' - Контейнер для описания мест. Необязательный контейнер. Атрибуты:
:* '''''package''''' - Название места.
:* '''''code''''' - Внутренний код строки.
:* '''''strbarcode''''' - Штрих-код места.
:* '''''mass''''' - Масса места в килограммах.
:* '''''message''''' - Строка сообщения.

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

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

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

# Атрибуты контейнера '''status''' заполняются для версий системы '''2008.0.0.670''' и новее.
# Контейнер '''statushistory''' заполняется для тарифа "[[Личный_кабинет#.D0.9F.D0.BE.D0.B4.D0.BA.D0.BB.D1.8E.D1.87.D0.B5.D0.BD.D0.B8.D0.B5|Премиум]]" и версий системы '''2008.0.0.670''' и новее.
</div>
<br />

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

Для получения только изменившихся статусов отправьте запрос
<source lang="xml">
<?xml version="1.0" encoding="UTF-8" ?>
<statusreq>
<auth extra="8" login="login" pass="pass"></auth>
<changes>ONLY_LAST</changes>
<quickstatus>NO</quickstatus>
</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>
</commitlaststatus>
</source>

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

*'''auth''' - Авторизация. Обязательный элемент.
*'''client''' - Признак клиента или агента. Необязательный элемент.
:* CLIENT - Признак клиента, значение по умолчанию
:* AGENT - Признак агента. В ответ отдается информация по заказам, переданным агенту на доставку

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

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

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

# При данном способе передачи (<changes>ONLY_LAST</changes>) система просматривает заказы, оформленные за последние 3 месяца. Если заказ сделан ранее - изменение статуса по нему не попадет в результат выполнения данного запроса.
# Система всегда выдает текущий статус. Т.е. Вы можете одним запросом получить статус "NEW", а следующим - "COMPLETE". В промежутке между запросами отправление могло пройти через несколько промежуточных статусов.
# Система никогда не гарантирует последовательность прохождения заказом набора статусов. Т.е. Вы можете получить статус "COMPLETE", а следующим запросом - "NEW" - такое может произойти, например, если оператор ошибочно отметил заказ выполненным, а затем исправил ошибку.
</div>
<br />

== Получение вложений к накладной ==

'''Пример запроса:'''
<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.

== Трекинг заказа по номеру ==

Запрос трекинга по номеру предназначен для выдачи минимальной обезличенной информации о конкретном заказе не авторизованному пользователю. Наша система имеет для этого интерфейс по адресу "home.courierexe.ru/{код экстра}/tracking". Вы можете либо сделать ссылку на такую страницу на своем сайте, либо разместить ее 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="1234">
<sender>
<town code="1" country="RU">Москва город</town>
<date></date>
</sender>
<receiver>
<town code="1" country="RU">Москва город</town>
<date>2015-04-18</date>
</receiver>
<AWB>BarCode</AWB>
<weight>0</weight>
<quantity>1</quantity>
<currcoords lat="" lon="" accuracy="" RequestDateTime="" />
<status eventstore="филиал в Санкт-Петербурге" eventtime="2016-06-02 17:22:00" createtimegmt="2016-06-03 16:14:44" message="" title="Доставлен" country="RU">COMPLETE</status>
<statushistory>
<status eventstore="Офис в Москве" eventtime="2016-05-30 10:20:00" createtimegmt="2016-06-03 16:14:44" message="" title="Новый" country="RU">NEW</status>
<status eventstore="Офис в Москве" eventtime="2016-06-01 17:38:00" createtimegmt="2016-06-03 16:14:44" message="филиал в Санкт-Петербурге" title="Планируется отправка" country="RU">DEPARTURING</status>
<status eventstore="Офис в Москве" eventtime="2016-06-01 19:53:00" createtimegmt="2016-06-03 16:14:44" message="филиал в Санкт-Петербурге" title="Отправлено со склада" country="RU">DEPARTURE</status>
<status eventstore="филиал в Санкт-Петербурге" eventtime="2016-06-02 07:41:00" createtimegmt="2016-06-03 16:14:44" message="" title="Получен складом" country="RU">ACCEPTED</status>
<status eventstore="филиал в Санкт-Петербурге" eventtime="2016-06-02 09:17:00" createtimegmt="2016-06-03 16:14:44" message="" title="Выдан курьеру на доставку" country="RU">DELIVERY</status>
<status eventstore="филиал в Санкт-Петербурге" eventtime="2016-06-02 17:22:00" createtimegmt="2016-06-03 16:14:44" message="" title="Доставлен (предварительно)" country="RU">COURIERDELIVERED</status>
<status eventstore="филиал в Санкт-Петербурге" eventtime="2016-06-02 17:22:00" createtimegmt="2016-06-03 16:14:44" message="" title="Доставлен" country="RU">COMPLETE</status>
</statushistory>
</order>
</tracking>
</source>

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

== Изменение статуса агентом ==

Запрос изменения статуса заказа позволяет установить окончательный статус заказа - "Доставлен" или "Не доставлен (Возврат/Отмена)".

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

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

'''Пример запроса изменения статуса:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8" ?>
<setorderinfo>
<auth extra="8" login="login" pass="pass" />
<order ordercode="123456" date="2018-03-01" time="10:00" message="Клиент отказался от покупки"/>
<order ordercode="234567" date="2018-03-01" time="10:00" message="">
<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''''' - Внутренний код заказа.
:* '''''date''''' - Дата изменения статуса.
:* '''''time''''' - Время изменения статуса.
:* '''''message''''' - текст сообщения.

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

== Получение накладной в формате pdf ==

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

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

'''waybill''' - Корневой контейнер. Обязательный элемент.
*'''auth''' - Авторизация. Обязательный элемент.
*'''orderno''' - Номер/код заказа. Обязательный элемент.
*'''form''' - Формат накладной. Не обязательный элемент. Принимает значения:
:* 1 - Подробная накладная (по-умолчанию)
:* 2 - Наклейки (Zebra)

'''Пример ответа:'''
<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" ?>
<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>

== Справочник городов ==

'''Пример запроса справочника городов:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<townlist>
<codesearch>
<zipcode>110000</zipcode>
<kladrcode>0100000100800</kladrcode>
<fiascode>bd21979d-46f8-49d0-9105-e8d65172a983</fiascode>
<code>123</code>
</codesearch>
<conditions>
<city>Краснодарский край</city>
<namecontains>новгород</namecontains>
<namestarts>Моск</namestarts>
<name>Москва</name>
<fullname>Москва город</fullname>
<country>1</country>
</conditions>
<limit>
<limitfrom>30</limitfrom>
<limitcount>10</limitcount>
<countall>YES</countall>
</limit>
</townlist>
</source>

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

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

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

'''Пример ответа:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<townlist 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)
</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 />
</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 />
</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>1</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>
<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>
</conditions>
<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 - Все. ''Это поле может быть недоступным в некоторых установках.''

*'''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>
<CountInPallet>30</CountInPallet>
<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''' - Высота в сантиметрах.
*'''CountInPallet''' - Количество штук в паллете.
*'''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>
</itemmovements>
</source>

*'''code''' - внутренний код товара в справочнике номенклатуры.

'''Пример ответа движения номенклатуры:'''
<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''' - номер документа
:* '''date''' - дата документа
:* '''message''' - комментарий

== Справочник пунктов самовывоза ==

'''Пример запроса пунктов самовывоза:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8" ?>
<pvzlist>
<auth extra="8" login="login" pass="pass"></auth>
<town>Нижний Тагил</town>
</pvzlist>
</source>

*'''town''' - Город получателя.

'''Пример ответа справочника пунктов самовывоза:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8" ?>
<pvzlist count="2">
<pvz>
<code>126</code>
<clientcode>3</clientcode>
<name>Нижний Тагил</name>
<address>622036, г. Нижний Тагил, ул. Циолковского, д. 17</address>
<phone>+73435417709, +73435254989</phone>
<comment>Жилое 5-ти этажное здание, торцом к дороге, второе здание от перекрестка Пархоменко-Циолковского.</comment>
</pvz>
<pvz>
<code>245</code>
<clientcode>NTG1</clientcode>
<name>На Красноармейской</name>
<address>КРАСНОАРМЕЙСКАЯ, д.79</address>
<phone>+7(3435)379-044</phone>
<comment>Время работы: пн.-пт. 9-18, сб. 10-14</comment>
</pvz>
</pvzlist>
</source>

*'''code''' - Код ПВЗ в системе. Используется в запросе [[API#Оформление заказа|оформления заказов]]
*'''clientcode''' - Код ПВЗ используемый компанией-подрядчиком.
*'''name''' - Наименование ПВЗ.
*'''address''' - Адрес ПВЗ.
*'''phone''' - Телефоны ПВЗ.
*'''comment''' - Дополнительная информация.

== Справочник Видов срочности ==

'''Пример запроса Видов срочности:'''
<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" ?>
<calculator>
<auth extra="8" login="login" pass="pass" />
<calc townfrom="Москва" townto="3800000300000" l="10" w="20" h="30" mass="3.7" service="1" />
</calculator>
</source>

Параметры:
*'''townfrom''' - Город-отправитель
*'''townto''' - Город-получатель
*'''l''' - Длина в сантиметрах (не обязательный параметр)
*'''w''' - Ширина в сантиметрах (не обязательный параметр)
*'''h''' - Высота в сантиметрах (не обязательный параметр)
*'''mass''' - Масса в килограммах
*'''service''' - Режим доставки - число, указывающее на запись в справочнике [[#Справочник Видов срочности|видов срочности]]. Если этот параметр опустить, система выдаст расчет для всех доступных видов срочности, передав много контейнеров <calc> в ответе.

В авторизации можно опустить параметры 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>1163</price>
<maxdeliverydays>3</maxdeliverydays>
</calc>
</calculator>
</source>

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

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

== Список актов передачи денег ==

'''Пример запроса списка актов передачи денег:'''
<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>
<price>637.00</price>
<rur>13430.00</rur>
<pricekur>570.00</pricekur>
<priceag>67.00</priceag>
<payno>42423</payno>
<paytype>1</paytype>
<paytypename>Безнал</paytypename>
</sma>
</smalist>
</source>

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

== Детализация актов передачи денег ==

'''Пример запроса детализации актов передачи денег:'''
<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>
<status>Доставлено</status>
</specialsma>
</smadetail>
</source>

*'''code''' - Код записи.
*'''ordercode''' - Код заказа.
*'''orderno''' - Шифр заказа.
*'''orderdate''' - Дата заказа.
*'''delivereddate''' - Дата доставки.
*'''company''' - Получатель.
*'''price''' - Стоимость услуг.
*'''rur''' - Сумма заказа.
*'''inshprice''' - Стоимость заказа.
*'''pricekur''' - Стоимость курьерской доставки.
*'''priceag''' - Агентское вознаграждение.
*'''pricecalc''' - Сумма для передачи агенту.
*'''paytype''' - Тип оплаты: 1 - безнал, 2 - наличными курьером, 3 - наличными в офисе, 4 - перевод на карту.
*'''paytypename''' - Строковое представление типа оплаты
*'''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</nowiki>

API Documentation

2019-01-23T10:11:47Z

Boyko: /* Order tracking by number */

“Delivery Service 2008” system has an option of integration by means of XML API under HTTP POST protocol.
The given API is designed for integrating customers (online shops and other companies ordering delivery) with delivery services working under the control of “Delivery Service 2008” system. If you are an aggregator transferring customer data, you will probably have to log in using different user accounts in case a delivery service has to keep separate accounts for reciprocal payments for each customer. If you are a “contractor”, the integration should be done in the opposite direction – orders will be transferred to you from a delivery service. For that purpose we have a platform for external integration but contractors can be added to it only on our side. Please, send us your quote, the description of your service and we will gladly consider them.
When writing the given documentation we`ve been assuming that a person reading it has the required level of expertise in programming sufficient for the understanding of the contents of this documentation, has a knowledge of XML and development environment which he is integrating. If you are not qualified as a programmer you will have to hire a professional programmer for the implementation of your project.
If you still have questions after reading the given documentation, feel free to ask them via e-mail [mailto:support@courierexe.ru support@courierexe.ru]. In your e-mail message you should introduce yourself, leave your contact information (your phone number, Skype login) and the name of the company that you want to integrate with.

== Complete integrations ==

You can download integration modules to integrate with popular CMS

{| class="wikitable" align="center" style="width: 80%; margin: auto; color: black; boreder: 1px solid #999999;" cellpadding="10" cellspacing="0"
!style="width: 35%;"| Content Management System (CMS)
!style="width: 15%;"|Module version
!style="width: 15%;"|Link
!style="width: 35%;"|Note
|-
|[[File:bitrix.png|center|x44px]]
|style="text-align: center;"|1.5.8 от 13.11.2017
|style="text-align: center;"|[http://courierexe.ru/download/api/bitrix.zip Download Unicode]<br>[http://courierexe.ru/download/api/bitrix_ansi.zip Download ANSI]
|Supports version 14.5 and newer ones
|-
|[[File:prestashop.png|center|x44px]]
|style="text-align: center;"|1.4.2 dated from September 6, 2017
|style="text-align: center;"|[http://courierexe.ru/download/api/prestashop.zip Download]
|Supports version 1.5.2.0 and newer ones (including 2.x!)
|-
|[[File:opencart.png|center|x44px]] [[Файл:ocstore.png|center|x30px]]
|style="text-align: center;"|1.7.2 от 06.09.2017
|style="text-align: center;"|[http://courierexe.ru/download/api/opencart.zip Download]
| Supports versions from 1.5.5.1 till 2.2.<br>
[https://opencartforum.com/files/file/2906-avtomatizaciya-otpravki-i-otslezhivanie-dostavok-courierexe-dlya-opencart-15x/ Third-party alternative module]
|-
|[[File:webasyst-shopscript.png|center|x44px]]
|style="text-align: center;"|1.3.2 от 15.08.2017
|style="text-align: center;"|[http://www.webasyst.ru/store/plugin/shop/measoftcourier/ Install]
|
|-
|[[File:insales.png|center|x44px]]
|style="text-align: center;"|1.2.1 от 06.09.2017
|style="text-align: center;"|[http://www.insales.ru/collection/all/product/kurierskaya-sluzhba-2008 Install]
|[[Integration_with_other_systems#Insales|is set up]] in user area in the system
|-
|[[File:Leadvertex.png|center|x44px]]
|style="text-align: center;"|1.0 dated from November 15, 2016
|style="text-align: center;"|[[Файл:Leadvertex-howto.png|center|x44px]]
|[http://blog.leadvertex.ru/news/2110-integraciya-s-kurerkami-na-platforme-measoft/ is set up] in user area in the system [https://Leadvertex.ru Leadvertex]
|-
|[[File:Retailcrm.png|center|x44px]]
|style="text-align: center;"|1.0 dated from January 1, 2018
|style="text-align: center;"|[https://www.retailcrm.ru/ RetailCRM]
|[[Integration_with_other_systems#RetailCRM|is set up]] in user area in the system
|-
|}

The given modules are shared for free without any guarantee on the part of the developer. Their availability should be considered not as a means of complete automation of your interaction with the delivery service but more as an aid for online shop developers in building integration with delivery services. However, we will appreciate if you inform us about your needs and/or discrepancies found in our modules – this allows us to consider your demands when developing new versions of our modules.

== Test account ==

For debugging you can access your test personal account following the link: [https://home.courierexe.ru/8 https://home.courierexe.ru/8], your login will be: test, your password will be: testm. There you will be able to see all your requests with the “eyes” of our system by using “Automation” tab. You will also find a query execution interface there. You will see all created orders on “Tracking” tab.

In order to simplify the process of integration, you can download [http://courierexe.ru/download/api/php_sample.zip the example of addressing the service using PHP].

== Work account for the connection to your customer`s platform ==

It is necessary to have 3 parameters in order to connect to your customer`s platform:
1. '''Parameter extra''' (this is a digital code, company`s unique identifier. Request this parameter from a company that you are integrating with.) You can look this code up in “Delivery Service 2008” software interface by using its main menu '''"Reference – Additional Options"'''. Digital value will be given at the second hyperlink (it is marked with an “asterisk” in the screenshot below):

[[File:extra1.png|750px]]

2. '''Login''' is a user account parameter for customer`s member area and API that is entered in user card on '''"Miscellaneous"''' in '''"User Name"''' field. You will probably have to create a new user card (shown in the screenshot below) in “Delivery Service 2008” software.

3. '''Password''' is a user account parameter for customer`s member area and API that is entered in user card on '''"Miscellaneous"''' in '''" Password"''' field (shown in the screenshot below).
[[File:33_client.png|500px]]

== General terms ==

There is a web service on the side of the delivery service located at the following URL: https://home.courierexe.ru/api/. Test authorization data are: user login: test, user password: testm, “extra” parameter value: 8. Please, note that the test platform is common for everyone. You shouldn`t pass on orders containing confidential data through it as they might be seen by other users of the service.
Ask the company that you are integrating with for user “login”, “password” and “extra” parameter value in order to use the integration in the work mode.
You can send test queries to our service in the member area using “Automation” tab. You can also check the history of all queries sent by you in the member area.

A customer is sending queries to the service by using HTTP POST, the service is processing these queries and sending the execution result back. All queries and responses are transferred in XML format.
The encoding used is UTF-8. Dot sign is used as a decimal symbol. Dates are presented in YYYY-MM-DD format and time is presented in HH:MM format.
Due to [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 the peculiarities of XML extensible markup language], some symbols in the text should be replaced: & from &amp; < to &lt; > from &gt; " to &quot;

== Limitations ==
With the aim of protecting service from its improper use query limitation equal to 1500 queries from one IP-address for 20-minute period has been introduced since May 29, 2017. In case the above-mentioned limit is reached, the IP-address will be blocked; unblocking of the IP-address is possible by addressing the technical support service with the subsequent discussion of your algorithms and their correction.

The best option for checking your orders` status is using "statusreq" queries with changes=ONLY_LAST parameter. You shouldn`t try to “attack” our API with queries containing numbers of all your orders, especially, with "tracking" queries – they are not intended to be used for this (see their description).

== Ordering ==
=== Example of ordering ===

<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>Ministry of Internal Affairs</company>
<person>I. I. Ivanov</person>
<phone>123-45-67</phone>
<town>Saint-Petersburg</town>
<address>Room 35, 38 Petrovka Str.</address>
<date>March 22, 2014</date>
<time_min>09:00</time_min>
<time_max>14:00</time_max>
</sender>
<receiver>
<company>Ministry of Internal Affairs</company>
<person>Cheap & Dale</person>
<phone>123-45-67</phone>
<zipcode>125480</zipcode>
<town>Saint-Petersburg</town>
<address>Room 35, 38 Petrovka Str.</address>
<date>2014-03-22</date>
<time_min>09:00</time_min>
<time_max>14:00</time_max>
</receiver>
<return>NO</return>
<return_service>1</return_service>
<weight>5.1</weight>
<quantity>2</quantity>
<paytype>CASH</paytype>
<service>2</service>
<type>3</type>
<price>387.5</price>
<deliveryprice>150</deliveryprice>
<discount>0</discount>
<inshprice>387.5</inshprice>
<enclosure>Children`s toys</enclosure>
<instruction>Check in the presence of the buyer, sign acceptance act</instruction>
<pvz>124</pvz>
<department>Department</department>
<pickup>NO</pickup>
<items>
<item extcode="abc123" quantity="1" mass="0.2" retprice="37.5" VATrate="0" barcode="2345625213125" article="1">Ball</item>
<item extcode="abc124" quantity="2" mass="2" retprice="100" VATrate="10" barcode="4645625213138" article="2">Hula hoop</item>
<item extcode="abc125" quantity="3" mass="0.3" retprice="50" barcode="2345625213126" article="3">Yellow rattle</item>
</items>
</order>
</neworder>
</source>

=== Order elements description ===

*'''neworder''' is a root container, the mandatory element.
:* '''''newfolder''''' is an attribute of a new order – YES/NO. If there is YES, then a new order will be created for the given correspondence in the delivery service system. It is an optional element.

*'''order''' is a container used for the description of one order, the mandatory element. There may be a number of '''order''' containers in one '''neworder''' container for the creation of several orders by using one query.

:* '''''orderno''''' is an order number. It should be entered here if it is assigned by the customer. In case it is not assigned, this field can be left empty; the system will generate its own number and send it back in the response. The system checks the presence of orders with the entered number within the current calendar year and in case they already exist in the system, the order won`t be created and error 17 "Such number exists" will be send back in the response.

*'''barcode''' is an order barcode. In case the customer uses barcodes for his dispatches and the barcode is different from the order number, the barcode is entered into this field. In case there are several pieces packages present that are individually marked, masks in the form of underscore characters indicating barcode items, varying for different pieces packages within one order can be used. <br />
''For example'': There are 20 product units in order no. 123 packed in 3 pieces packages. The customer has to prepare 3 barcodes for each piece: CLNT0012301, CLNT0012302, CLNT0012303, where CLNT – is a customer`s prefix, 00123 is an order number, 01-03 is the number for each piece package in the order. CLNT00123__ should be entered into the “barcode” field (the system will understand that there may be any last 2 symbols in the field and will display barcodes for the same order).

*'''sender''' presents the information about order sender. It is an optional container.
<source lang="xml">
<sender>
<company>Name of the sender company</company>
<person>Sender company contact person</person>
<phone>Sender`s phone number, E-mail</phone>
<town>Sender`s location in “Moscow city” format</town>
<address>Sender`s address</address>
<date>Pick-up date in "YYYY-MM-DD" format</date>
<time_min>Desired pick-up time in "HH:MM" format</time_min>
<time_max>Desired pick-up time in "HH:MM" format</time_max>
</sender>
</source>

*'''receiver''' is the information about the receiver. It is a mandatory container.
<source lang="xml">
<receiver>
<company>Name of the receiving company</company>
<person>Receiving company contact person</person>
<phone>Receiver`s phone number, E-mail</phone>
<town>Receiver`s location in “Moscow city” format</town>
<address>Receiver`s address</address>
<date>Delivery date in "YYYY-MM-DD" format</date>
<time_min>Desired delivery time in "HH:MM" format</time_min>
<time_max>Desired delivery time in "HH:MM" format</time_max>
</receiver>
</source>

*'''company''' is a receiving company.
*'''person''' is a contact person. ''At least one field should be filled in – either company or person!''
*'''phone''' is a phone number. Several phone numbers and emails can be entered into this field.
*'''town''' is the name of the town.

''Town''' field of '''sender''' and '''receiver''' containers can be filled in by using:
:* locality dialing code [[#Dialing codes guide|dialing codes guide]]
:* 13-digit code from All-Russian Classifier of Addresses (Address Classifier used in Russia)
:* 36-digit code from the address system <rspoiler text="Federal Information Address System">Federal Information Address System (Address system used in Russia)</rspoiler> (AOID)
:* the name of the town (not recommended!)

*'''paytype''' is a type of payment used for checking out the order by the receiver. It can take on the following values:
:* CASH is paying with cash on delivery (by default)
:* CARD is paying with a credit card on delivery
:* NO which means that there won`t be any payment. “Price” field value will be ignored. (This type of payment is transferred in case the order has already been paid for and doesn`t require cash collection; API will add goods from the order with a null price to the system. If it is necessary to transfer order total cost, it can be done by using <inshprice> field, indicating order items` declared value)
:* OTHER means other types of payment (It is designated for making payments directly to the delivery service by using other types of payment as: “Webmoney”, “Yandex Money”, online payment with a credit card other payment systems, etc.)
:* OPTION means choosing type of payment by the receiver. This type of payment can’t be transferred with the order. It is automatically set depending on customer`s data setup.

*'''zipcode''' is a zip code.
*'''weight''' is a total weight of the order in kilograms.
*'''quantity''' is the number of pieces packages.
*'''service''' - delivery mode (service type) is transferred in the form of a code from “Delivery priority types” guide.
*'''type''' – correspondence (dispatch) type is transferred in the form of a code from “Types of correspondence” guide.
*'''price''' is an order amount. In case “items” container is present, the value of the given parameter will be ignored and calculated automatically.
*'''deliveryprice''' is the cost of delivery. In case “items” container is present, “Delivery” enclosure will be added to it.
*'''discount''' is a discount for the order amount. As a result the order amount will be decreased by the discount amount.
*'''return''' is an attribute indicating the necessity of return.
*'''return_service''' is a return mode (type of service) which is transferred in the form of a code from “Delivery priority types” guide.
*'''enclosure''' is an enclosure.
*'''inshprice''' is a declared value.
*'''instruction''' is an instruction – a note.
*'''pvz''' is a pick-up point code. You can find out pick-up point codes on request or in user`s member area on “pvz” tab.
*'''department''' is the name of the department which the order is raised in.
*'''pickup''' is YES/NO attribute of pickup arrangement. If there is YES, then the entire order will be considered to be the assignment for cargo pickup but not for cargo delivery! It is applied for calling a courier to the receiver for the pickup of other packaging units.

*'''items''' is a container used for the description of goods enclosed. It is an optional container. It has the following attributes:
:* '''''item''''' is the name of a product.
:* '''''quantity''''' is the amount of product units.
:* '''''mass''''' is the weight of a product unit in kilograms.
:* '''''retprice''''' is the price of a product unit.
:* '''''VATrate''''' is a VAT rate which is specified as integer percentage. If a value is not indicated, then “18” value is entered.
:* '''''barcode''''' is a product unit barcode. [[File:Article.png|thumb|100px|right]]
:* '''''article''''' is product unit article number. ''Attention!'' Product unit article is displayed only in case when a product unit is stored at the delivery service in safe custody and order batching is required. In this case the system will try to assign a product unit to a corresponding item in [[API#Nomenclature list|nomenclature list]]. If the product unit is not found in the nomenclature list, the appropriate error message will be displayed by the system. If there are several product units found within one article number, the system will randomly select one of them what can result in incorrect order batching! If a product unit is NOT in safe custody – you DON`T have to specify its article number. Product item will be entered into the system by a plain text.
:* '''''extcode''''' is an external code of a string. It is used for the identification of strings of orders when obtaining statuses. It is an optional field. IT IS NOT SUPPORTED YET.

In case it is necessary to specify them besides product units, additional services (for example, DELIVERY, order batching, lifting the order up to the floor, etc.) – they should be specified in the same “items” container as product units but without article numbers.

=== Examples of responses ===
'''The example of a successful response'''

<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<neworder>
<createorder orderno="AB23541" error="0" errormsg="success"></createorder>
<createorder orderno="55_6542" error="0" errormsg="success"></createorder>
<createorder orderno="AB23542" error="0" errormsg="success"></createorder>
</neworder>
</source>

'''The example of a response with an error'''

<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<neworder>
<createorder orderno="AB23541" error="17" errormsg="Such number exists"></createorder>
<createorder orderno="AB23542" error="13" errormsg="empty company"></createorder>
<createorder orderno="AB23543" error="14" errormsg="empty person"></createorder>
</neworder>
</source>

'''The example of a response in case of the authorization error'''

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

'''The example of a response in case of a syntax error''''''

<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<request>
<error>column:1 line:11 message:expected '>'</error>
</request>
</source>

=== Error codes in case of ordering ===

0 – No errors.

1 - Authorization error. (<auth login="" pass=""></auth> tags are missing, incorrect login or password).

2 - Empty response is sent (<neworder></neworder> container is missing in a XML document).

3 - Order amount is set incorrectly.

4 - Order weight is set incorrectly.

5 - Receiver`s town is not found.

6 - Sender`s town is not found.

7 - Receiver`s address is not filled in.

8 - Receiver`s phone number is not filled in.

9 - Receiver`s contact name is not filled in.

10 - Receiver`s company name is not filled in.

11 - The amount of declared value is incorrect.

12 - Article number is not found.

13 - Sender`s company name is not filled in.

14 - Sender`s contact name is not filled in.

15 - Sender`s phone number is not filled in.

16 - Sender`s address is not filled in.

17 - Order with this number already exists.

== Order status query ==

=== The example of order status query ===

<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>
<ordercode>34234</ordercode>
<givencode>234534</givencode>
<datefrom>2016-07-21</datefrom>
<dateto>2016-07-21</dateto>
<target>Car-making factory</target>
<done>ONLY_NOT_DONE</done>
<changes>ONLY_LAST</changes>
<quickstatus>NO</quickstatus>
</statusreq>
</source>

=== The description of status query fields ===

'''statusreq''' is a root container. It is a mandatory element.
*'''auth''' is authorization. It is a mandatory element.
*'''client''' is an attribute of a customer or an agent. It is an optional element.
:* CLIENT is an attribute of a customer, the default value
:* AGENT is an attribute of an agent. In response the information on orders passed on to the agent for their delivery is returned
*'''orderno''' is an order number. It is an optional element.
*'''orderno2''' is an order number from the list of urgent orders. It is an optional element.
*'''datefrom''' is a date “from”. It is a mandatory element.
*'''dateto''' is a date “to”. It is a mandatory element.
*'''target''' is a find string. It allows indicating the text that company name or receiver`s address contains.
*'''done''' can have the following values:
:* ONLY_NOT_DONE - for undelivered only
:* ONLY_DONE - for delivered only
:* ONLY_NEW - for new only
:* ''Empty'' - for all correspondence

*'''changes''' can have only one value - ONLY_LAST. If this parameter is set, all other parameters, except quickstatus, will be ignored. The description of this mode is given here: [[#Newly changed statuses transfer|Newly changed statuses transfer]]

*'''quickstatus''' indicates the “depth” of transferred statuses: "YES" value (by default) - statuses are transferred starting from the information provided by a courier. Such statuses are quick (as a rule, they are provided by a courier immediately after delivery) but not always accurate. "NO" value prohibits status transfer according to oral information provided by the courier and provides only those statuses that have been entered by an operator manually, as a rule. It takes more time however the level of accuracy is much higher in this case. It is not recommended to combine (interleave) these two types of status transfer in case of newly changed statuses demand as in this case the system will consider that statuses of dispatches are changing.

<div style="color: #a94442; background-color: #f2dede; border: 1px solid #ebccd1; padding: 3px 10px 10px;">
'''Please, note!'''
# Period of status query ('''datefrom''' and '''dateto''' containers) is limited to two months — two months to the date '''"to"'''.
# In case both dates are not specified — '''dateto''' is accepted equal to the current date.
# In case '''dateto''' date is not specified — it is accepted equal to '''datefrom''' plus two months.
# In case '''datefrom''' date is not specified — it is accepted equal to '''dateto''' minus two months.
</div>
<br />

=== Examples of responses ===

'''The example of a successful response'''

<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<statusreq count="23">
<order orderno="111111" orderno2="123123" ordercode="34534234" givencode="2345334">
<barcode>111111</barcode>
<sender>
<company>Ministry of Internal Affairs</company>
<person>I. I. Ivanov</person>
<phone>123-45-67</phone>
<contacts>
<phone>+74951234567</phone>
</contacts>
<town code="23432">Saint-Petersburg</town>
<address>Room 35, 38 Petrovka Str.</address>
<date>2014-03-22</date>
<time_min>09:00</time_min>
<time_max>14:00</time_max>
</sender>
<receiver>
<company>Ministry of Internal Affairs</company>
<person>I. I. Ivanov</person>
<phone>123-45-67 - Ivan, (916)234.45.21 Pyotr, mvd@mail.ru</phone>
<contacts>
<phone>+74951234567</phone>
<phone>+79162344521</phone>
<email>mvd@mail.ru</email>
</contacts>
<zipcode>125480</zipcode>
<town code="23432">Saint-Petersburg</town>
<address>Room 35, 38 Petrovka Str.</address>
<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>
</receiver>
<weight>5.1</weight>
<quantity>2</quantity>
<paytype>CASH</paytype>
<service>2</service>
<price>387.5</price>
<print_check>YES</print_check>
<inshprice>387.5</inshprice>
<enclosure>Children`s toys</enclosure>
<instruction>Check in the presence of the buyer, sign acceptance act</instruction>
<currcoords lat="55.680327" lon="37.604456" accuracy="50" RequestDateTime="2014-04-21 18:07:45"></currcoords>
<courier>
<code>26</code>
<name>Vladimir Petrovich Ivanov</name>
<phone>+79161234567</phone>
</courier>
<deliveryprice total="158.6">
<>..</> (price details are not yet supported)
..
</deliveryprice>
<receiverpays>NO</receiverpays>
<status eventstore="Saint-Petersburg branch" eventtime="2016-06-02 17:22:00" createtimegmt="2016-06-03 16:14:44" message="" title="Delivered">COMPLETE</status>
<statushistory>
<status eventstore="Moscow branch" eventtime="2016-05-30 10:20:00" createtimegmt="2016-06-03 16:14:44" message="" title="New">NEW</status>
<status eventstore="Moscow branch" eventtime="2016-06-01 17:38:00" createtimegmt="2016-06-03 16:14:44" message="Saint-Petersburg branch" title="Dispatch is planned">DEPARTURING</status>
<status eventstore="Moscow branch" eventtime="2016-06-01 19:53:00" createtimegmt="2016-06-03 16:14:44" message="Saint-Petersburg branch" title="Dispatched from the warehouse">DEPARTURE</status>
<status eventstore="Saint-Petersburg branch" eventtime="2016-06-02 07:41:00" createtimegmt="2016-06-03 16:14:44" message="" title="Received by the warehouse">ACCEPTED</status>
<status eventstore="Saint-Petersburg branch" eventtime="2016-06-02 09:17:00" createtimegmt="2016-06-03 16:14:44" message="" title="Given to the courier to be delivered ">DELIVERY</status>
<status eventstore="Saint-Petersburg branch" eventtime="2016-06-02 17:22:00" createtimegmt="2016-06-03 16:14:44" message="" title="Delivered (to be confirmed)">COURIERDELIVERED</status>
<status eventstore="Saint-Petersburg branch" eventtime="2016-06-02 17:22:00" createtimegmt="2016-06-03 16:14:44" message="" title="Delivered">COMPLETE</status>
</statushistory>
<customstatecode>2<customstatecode>
<deliveredto>Ivanova, sec.</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">Ball</item>
<item code="34456" extcode="abc124" quantity="2" mass="2" retprice="100" VATrate="10" barcode="4645625213138" article="2" returns="0">Hula hoop</item>
<item code="34421" extcode="abc125" quantity="3" mass="0.3" retprice="50" VATrate="18" barcode="2345625213126" article="3" returns="0">Yellow rattler</item>
</items>
</order>
</statusreq>
</source>

'''A response example in the absence of orders'''

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

'''A response example in case of the authorization error'''

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

'''A response example in case of the syntax error'''

<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<request>
<error>column:1 line:11 message:expected '>'</error>
</request>
</source>

=== Status response fields description ===
All the fields of response correspond with order structure when creating an order, with some additions:

* ''order'' container attributes:
:* '''''ordercode''''' is an internal code of the order in the system which is applied for some internal operations.
:* '''''givencode''''' is an internal code of the order in the system which is applied for some internal operations.
:* '''''returns''''' is the amount of a certain product unit which a receiver has refused. It will have a non-zero value only in case of a partial refusal.

* '''''code''''' attribute of '''item''' container is an internal code of order string in the system which is applied for some internal operations.
* '''''coords''''' in '''receiver''' container indicates receiver position.
* '''currcoords''' indicates current order position. Its attributes are:
:* '''''lat''''' is latitude
:* '''''lon''''' is longitude
:* '''''accuracy''''' indicates the degree of accuracy in meters
:* '''''RequestDateTime''''' is date/time of the latest position update.
* '''deliveryprice''' is the price of delivery in the customer`s settlement currency.
* '''status''' is a delivery status (see the list of statuses below). It has the following attributes (they are filled in starting from version 2008.0.0.670 of the system):
:* '''''eventstore''''' is a branch which the following status is related to
:* '''''eventtime''''' is the time of status change (time of status change depends on the location of a branch)
:* '''''createtimegmt''''' is the time of the actual status change (GMT)
:* '''''message''''' is the name of a receiving branch in case of a transfer between branches
:* '''''title''''' is the name of a status in Russian

* '''statushistory''' is the history of delivery statuses. It contains the list of '''status''' containers. It is filled in only for “Premium” plan starting from version 2008.0.0.670 of the system.
* '''customstatecode''' is an internal status code of a delivery service. Please, check with the delivery service for its values. They are assigned by the delivery service in “Guides” - “Statuses” - “15 Correspondence statuses” section. The guide is not transferred to the client via API due to a possible presence of delivery service technological statuses in it.
* '''clientstatecode''' is a customer`s status code. It is used in case a customer is transferring his codes of delivery/reasons for non-delivery statuses.
* '''deliveredto''' is the information on delivery or a reason for non-delivery.
* '''delivereddate''' is the date of delivery.
* '''deliveredtime''' is the time of delivery. It can be left empty in case of non-delivery.
* '''outstrbarcode''' is a contractor`s code (the order code within an external system). It is used in integrations with external systems.

'''status''' container can have the following values:
: NEW - New
: ACCEPTED - Received by the warehouse
: INVENTORY - Inventory
: DEPARTURING - Dispatch is planned
: DEPARTURE - Dispatched from the warehouse
: DELIVERY - Given to the courier to be delivered
: COURIERDELIVERED - Delivered (to be confirmed)
: COMPLETE - Delivered
: PARTIALLY - Partially delivered
: COURIERRETURN - Returned by the courier. The courier couldn`t deliver the order to the receiver and returned it back to the warehouse. This is an intermediate status after which the manager is checking whether the courier has to make another attempt to deliver the order or this is a final non-delivery.
: CANCELED - Not delivered (Return/Cancellation)
: RETURNING - Return is planned
: RETURNED - Returned
: CONFIRM - Dispatch is confirmed
: DATECHANGE - Postponement
: NEWPICKUP - Pickup is created
: UNCONFIRM - Dispatch has not been confirmed
: PICKUPREADY - Ready for pickup

''Note:'' The set of currently used statuses may be expanded and charged in the future.
<div style="color: #a94442; background-color: #f2dede; border: 1px solid #ebccd1; padding: 3px 10px 10px;">

'''Please, note!'''

# '''status''' container attributes should be specified for system version '''2008.0.0.670''' and newer ones.
# '''statushistory''' is filled in for tariff. "[[Member_area #.D0.9F.D0.BE.D0.B4.D0.BA.D0.BB.D1.8E.D1.87.D0.B5.D0.BD.D0.B8.D0.B5|Premium]]" as well as for system version '''2008.0.0.670''' and newer ones.
</div>
<br />

=== Newly changed statuses transfer ===
Send a query for getting newly changed statuses
<source lang="xml">
<?xml version="1.0" encoding="UTF-8" ?>
<statusreq>
<auth extra="8" login="login" pass="pass"></auth>
<changes>ONLY_LAST</changes>
<quickstatus>NO</quickstatus>
</statusreq>
</source>

The system will display all orders that have at least one of the fields changed since the time of the last query in this mode:
orderno
status
delivereddate
deliveredtime
deliveredto
receiver->date
receiver->address
price

After successful response processing it is necessary to mark received statuses as successfully received ones sending the following query
<source lang="xml">
<?xml version="1.0" encoding="UTF-8" ?>
<commitlaststatus>
<auth extra="8" login="login" pass="pass"></auth>
</commitlaststatus>
</source>

If successful you will get the following response
<source lang="xml">
<?xml version="1.0" encoding="UTF-8" ?>
<commitlaststatus>
<error error="0" errormsg="OK"></error>
</commitlaststatus>
</source>

This way of status transfer ensures a complete and correct status transfer even in case the status has changed in the time period between statuses` query and confirmation of their receipt. If the system hasn`t received the confirmation of a successful status transfer, it will consider this information to be not delivered and will display it in case of a requery.

<div style="color: #a94442; background-color: #f2dede; border: 1px solid #ebccd1; padding: 3px 10px 10px;">
'''Please, note!'''

# When this way of data transfer is used (<changes>ONLY_LAST</changes>), the system is reviewing those orders that have been checked out for the last 3 months. In case there is an order that has been checked out before this period, then status change for this order won`t get into the list of results of this query execution.
# The system always returns a current status, i. e., you can get "NEW" status for your first query and "COMPLETE" status - for your second query. A dispatch could have gone through several intermediate statuses in between queries.
# The system can never guarantee the order going through a set of statuses successively, i. e., you can get "COMPLETE" status after your first query and "NEW" status after your second query - such things can happen in case when, for example, the operator has mistakenly marked an order as a completed one and then corrected his mistake.
</div>
<br />

== Order tracking by number ==

Query for order tracking by number is intended to provide minimal anonymized information about a certain order to a non-authorized user. Our system has its own interface for this which is available at the following URL: "home.courierexe.ru/{extra code}/tracking". You can either create a link to such page at your web-site or put as an iframe there or create your own page and use our API. This interface is specially designed to issue information to a human web-site user. You need to use "statusreq" query, desirably with changes=ONLY_LAST parameter in order to obtain statuses of orders into your information system!

'''A query example:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<tracking>
<extra>8</extra>
<orderno>1234</orderno>
</tracking>
</source>

'''A response example:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<tracking>
<order orderno="1234">
<sender>
<town code="1" country="RU">Moscow city</town>
<date></date>
</sender>
<receiver>
<town code="1" country="RU">Moscow city</town>
<date>2015-04-18</date>
</receiver>
<AWB>BarCode</AWB>
<weight>0</weight>
<quantity>1</quantity>
<currcoords lat="" lon="" accuracy="" RequestDateTime="" />
<status eventstore="Saint-Petersburg branch" eventtime="2016-06-02 17:22:00" createtimegmt="2016-06-03 16:14:44" message="" title="Delivered" country="RU">COMPLETE</status>
<statushistory>
<status eventstore="Moscow office" eventtime="2016-05-30 10:20:00" createtimegmt="2016-06-03 16:14:44" message="" title="New" country="RU">NEW</status>
<status eventstore="Moscow office" eventtime="2016-06-01 17:38:00" createtimegmt="2016-06-03 16:14:44" message="Saint-Petersburg branch" title="Dispatch is planned" country="RU">DEPARTURING</status>
<status eventstore="Moscow office" eventtime="2016-06-01 19:53:00" createtimegmt="2016-06-03 16:14:44" message="Saint-Petersburg branch" title="Dispatched from the warehouse" country="RU">DEPARTURE</status>
<status eventstore="Saint-Petersburg branch" eventtime="2016-06-02 07:41:00" createtimegmt="2016-06-03 16:14:44" message="" title="Received by the warehouse" country="RU">ACCEPTED</status>
<status eventstore="Saint-Petersburg branch" eventtime="2016-06-02 09:17:00" createtimegmt="2016-06-03 16:14:44" message="" title="Given to the courier to be delivered" country="RU">DELIVERY</status>
<status eventstore="Saint-Petersburg branch" eventtime="2016-06-02 17:22:00" createtimegmt="2016-06-03 16:14:44" message="" title="Delivered (to be confirmed)" country="RU">COURIERDELIVERED</status>
<status eventstore="Saint-Petersburg branch" eventtime="2016-06-02 17:22:00" createtimegmt="2016-06-03 16:14:44" message="" title="Delivered" country="RU">COMPLETE</status>
</statushistory>
</order>
</tracking>
</source>

The function searches for the last order among the orders of all customers by its number (AWB or orderno). It provides anonymized information on a current state of the order. <br />
The description of response containers is similar to the description of [[API#.D0.97.D0.B0.D0.BF.D1.80.D0.BE.D1.81_.D1.81.D1.82.D0.B0.D1.82.D1.83.D1.81.D0.B0_.D0.B7.D0.B0.D0.BA.D0.B0.D0.B7.D0.BE.D0.B2|Order status query]].

== Status change by agent ==

Order change status query allows finding out the final status of the order - "Delivered" or "Not delivered (Return/Cancellation)."

Besides that, date and time (in necessary) of status change as well as a type of message in "Information on delivery" field are set.

If necessary, images can be attached to the order information.

'''The example of a status change request:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8" ?>
<setorderinfo>
<auth extra="8" login="login" pass="pass" />
<order ordercode="123456" date="2018-03-01" time="10:00" message="The customer has refused from the purchase"/>
<order ordercode="234567" date="2018-03-01" time="10:00" message="">
<image filename="filename1.jpg">/9j/4AAQSkZJRgABAQAAAQABAAD/2wBDAA0JCgsKCA0LCgsODg0PEyAVExISEy
ccHhcgLikxMC4pLSwzOko+MzZGNywtQFdBRkxOUlNSMj5aYVpQYEpRUk//2wBDAQ4ODhMREyYVFSZPNS01T09PT09PT09P
T09PT09PT09PT09PT09PT09PT09PT09PT09PT09PT09PT09PT09PT0//wAARCAYACAADASIA</image>
</order>
</setorderinfo>
</source>

'''The description of status response fields:'''

'''setorderinfo''' is a root container. It is a mandatory element.
*'''auth''' is authorization. It is a mandatory element.
*'''order''' is order container. It is a mandatory element. A query may contain more than one '''order''' container. It has the following attributes:
:* '''''ordercode''''' is an internal code of an order.
:* '''''date''''' is status change date.
:* '''''time''''' is status change time.
:* '''''message''''' is message text.

*'''image''' is an attached image container. It contains image file text coded according to ''base64'' standard. '''order''' container may contain more than one '''image''' container. It has the following attribute:
:* '''''filename''''' is a file name.
'''The example of a response:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<setorderinfo>
<order ordercode="123456" error="0" errormsg="OK" errormsgru="Successfully" />
<order ordercode="234567" error="59" errormsg="value [date_put] is already set" errormsgru="The value [Date of delivery] is already set" />
</setorderinfo>
</source>

== Obtaining the pdf waybill ==

'''Request example:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8" ?>
<waybill>
<auth extra="8" login="login" pass="pass" />
<orderno>1234567</orderno>
<form>1</form>
</waybill>
</source>

'''The fields description:'''

'''waybill''' - is a root container. It is a mandatory element.
*'''auth''' - is authorization. It is a mandatory element.
*'''orderno''' - Order number. It is a mandatory element.
*'''form''' - Form type. Is not mandatory. Can be:
:* 1 - A detailed waybill
:* 2 - Sticker (Zebra)

'''Response example:'''
<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>

The '''''content''''' tag contains pdf binary, base64 encoded.

== Cancellation of order ==

Cancel request is intended to be used for cancellation of those orders about which no changes have been made - like delivery status, correspondence status and delivery time - in other words, those orders which are not being processed.

In case of order cancellation “Delivery information” field gets the value “Cancelled by the customer” and “Delivery date” field gets a current date.

'''The example of a query for order cancellation:'''
<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>

'''The description of status query fields:'''

'''cancelorder''' is a root container. It is a mandatory element.
*'''auth''' is authorization. It is a mandatory element.
*'''order''' is a cancelled order container. It is a mandatory element. A query may contain more than one '''order''' container. It has the following attributes:
:* '''''orderno''''' is order`s cipher.
:* '''''ordercode''''' is an internal code of the order.
Please, note that at least one of ''orderno'' or ''ordercode'' attributes should be specified!

'''The example of a response:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8" ?>
<cancelorder>
<order orderno="123test" ordercode="123456" error="0" errormsg="OK" errormsgru="Successfully" />
<order orderno="123aaa" ordercode="" error="52" errormsg="order not found" errormsgru="The order is not found" />
</cancelorder>
</source>

== City names list ==

'''The example of the city names list query:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<townlist>
<codesearch>
<zipcode>110000</zipcode>
<kladrcode>0100000100800</kladrcode>
<fiascode>bd21979d-46f8-49d0-9105-e8d65172a983</fiascode>
<code>123</code>
</codesearch>
<conditions>
<city>Krasnodar Territory</city>
<namecontains>Novgorod</namecontains>
<namestarts>Mosc</namestarts>
<name>Moscow</name>
<fullname>Moscow city</fullname>
<country>1</country>
</conditions>
<limit>
<limitfrom>30</limitfrom>
<limitcount>10</limitcount>
<countall>YES</countall>
</limit>
</townlist>
</source>

All elements inside townlist container can either be absent or combine. The search is not case-sensitive.
*'''codesearch''' is a search by codes. In case when it is used, conditions and limit containers will be ignored.
:* '''zipcode''' is a search by zip codes. Please, note that one zip code can be applicable to several localities. In this case the system will return several records.
:* '''kladrcode''' is a search by 13-digit codes of All-Russian Classifier of Addresses.
:* '''fiascode''' is a search by codes of Federal Information Address System (Address system used in Russia) (AOID).
:* '''code''' is a search by codes of the system.

*'''conditions''' specifies search criteria. All enclose elements simultaneously impose “AND” condition.
:* '''city''' is a search by all the localities of a region.
:* '''namecontains''' is a search of the localities which names contain a specified text.
:* '''namestarts''' is a search of the localities which names start from a specified text.
:* '''name''' is a search of the localities which names match a specified text.
:* '''fullname''' is a search of the localities which names and type match a specified text.
:* '''country''' is a search of the country with a specified zip code.

*'''limit''' limits result output.
:* '''limitfrom''' specifies the record number of a search result starting with which a response should be given. It equals 0 by default.
:* '''limitcount''' specifies the number of search result records which should be returned. It equals 10000 by default.
:* '''countall''' - YES indicates the necessity of counting the amount of matches found. It may slow down the process of query execution. In case it is disabled, totalcount and totalpages values won`t be indicated in the response.

'''The example of a response:'''
<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>Krasnodar Territory</name>
</city>
<name>Sochi city</name>
<shortname>Sochi</shortname> (not yet supported)
<typename>city</typename> (not yet supported)
</town>
<town>
<code>40331</code>
<city>
<code>32</code>
<name>Bryanskaya oblast</name>
</city>
<name>Sochilov farmstead</name>
<shortname>Sochilov</shortname>
<typename>farmstead</typename>
</town>
<town>
<code>114016</code>
<city>
<code>60</code>
<name>Pskov oblast</name>
</city>
<name>Sochikhino village</name>
<shortname>Sochikhino</shortname>
<typename>village</typename>
</town>
</townlist>
</source>

In a response cities and towns are sorted by their popularity, importance (district centers, etc.) and only after that - alphabetically.

== Region names list ==

'''The example of the region names list query:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<regionlist>
<codesearch>
<code>77</code>
</codesearch>
<conditions>
<namecontains>Territory</namecontains>
<namestarts>Mosc</namestarts>
<fullname>Moscow region</fullname>
<country>1</country>
</conditions>
</regionlist>
</source>

'''The example of a response:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<regionlist count="2">
<city>
<code>80</code>
<country>
<code>1</code>
<name>Russia</name>
<id>643</id>
<ShortName1>RU</ShortName1>
<ShortName2>RUS</ShortName2>
</country>
<name>Agin-Buryat Autonomous Area</name>
</city>
<city>
<code>1</code>
<country>
<code>1</code>
<name>Russia</name>
<id>643</id>
<ShortName1>RU</ShortName1>
<ShortName2>RUS</ShortName2>
</country>
<name>Republic of Adygea</name>
</city>
</regionlist>
</source>

== Street names guide ==

'''The example of the city names list query:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<streetlist>
<conditions>
<town>Moscow city</town> // MANDATORY FIELD!
<namecontains>Khokhlo</namecontains>
<namestarts>Academician K</namestarts>
<name>Academician Khokhlov</name>
<fullname>Academician Khokhlov Str.</fullname>
</conditions>
<limit>
<limitfrom>30</limitfrom>
<limitcount>10</limitcount>
<countall>YES</countall>
</limit>
</streetlist >
</source>

*'''conditions''' specifies search criteria. All enclose elements simultaneously impose “AND” condition.
:* '''town''' is a mandatory field. It`s the name or the code of a locality.
:* '''namecontains''' is a search of the localities which names contain a specified text.
:* '''namestarts''' is a search of the localities which names start from a specified text.
:* '''name''' is a search of the localities which names match a specified text.
:* '''fullname''' is a search of the localities which names and type match a specified text.

*'''limit''' limits result output.
:* '''limitfrom''' specifies the record number of a search result starting with which a response should be given. It equals 0 by default.
:* '''limitcount''' specifies the number of search result records which should be returned. It equals 10000 by default.
:* '''countall''' - YES indicates the necessity of counting the amount of matches found. It may slow down the process of query execution. In case it is disabled, totalcount and totalpages values won`t be indicated in the response.

'''The example of a response:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<streetlist count="1" page="1" totalcount="3" totalpages="1">
<street>
<name>Academician Khokhlov Str.</name>
<shortname>Academician Khokhlov</shortname>
<typename>Str.</typename>
</street>
</streetlist>
</source>

In a response names of the streets are sorted in alphabetical order.

== Nomenclature list ==

'''The example of the nomenclature list query:'''
<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>TV set</namecontains>
<namestarts>sony</namestarts>
<name>Sony KDL-55W905 LCD television</name>
<quantity>EXISTING_ONLY</quantity>
</conditions>
<limit>
<limitfrom>30</limitfrom>
<limitcount>10</limitcount>
<countall>YES</countall>
</limit>
</itemlist>
</source>

All elements inside itemlist container can either be absent or combine. The search is not case-sensitive.
*'''codesearch''' is a search by codes. In case when it is used, conditions and limit containers will be ignored.
:* '''code''' is a search by codes of the system.
:* '''article''' is a search by article numbers.
:* '''barcode''' is a search by barcodes.

*'''conditions''' specifies search criteria. All enclose elements simultaneously impose “AND” condition.
:* '''namecontains''' is a search of the goods which names contain a specified text.
:* '''namestarts''' is a search of the goods which names start from a specified text.
:* '''name''' is a search of the goods which names match a specified text.
:* '''quantity''' is the availability of goods at the warehouse. It can have the following values: EXISTING_ONLY - only in stock, NOT_EXISTING_ONLY - only stock out, ALL - all. ''In some setups this field may be unavailable.''

*'''limit''' limits result output.
:* '''limitfrom''' specifies the record number of a search result starting with which a response should be given.
:* '''limitcount''' specifies the number of search result records which should be returned.

'''The example of a response:'''
<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 LCD television</name>
<retprice>65000</retprice>
<weight>5.1</weight>
<length>50</length>
<width>30</width>
<height>40</height>
<CountInPallet>30</CountInPallet>
<HasSerials>1</HasSerials>
<CountryOfOrigin>Malaysia</CountryOfOrigin> (not yet supported)
<Message>A good TV set</Message>
<Message2>Another good TV set</Message2>
<quantity>12</quantity>
<reserved>3</reserved>
<item>
...
</itemlist>
</source>

'''The description of fields:'''
*'''code''' is an internal identifier assigned by the system.
*'''article''' is an article assigned by a customer (a supplier).
*'''barcode''' is a manufacturer`s barcode.

*'''name''' is an item name.

*'''retprice''' is a retail price value by default. When ordering the price which is mentioned in the order is used.

*'''weight''' is weight in kilograms.
*'''length''' is length in centimeters.

*'''width''' is width in centimeters.

*'''height''' is height in centimeters.

*'''CountInPallet''' is the number of pieces in a pallet.

*'''HasSerials''' requires serial numbers accounting. It takes on the following values: 1 - yes, 0 - no.

*'''CountryOfOrigin''' is the name of a country of origin in Russian.
*'''Message''' is a commentary.

*'''Message2''' is an additional commentary.

*'''quantity''' is the number of goods in stock. Those goods that have already been batched into orders are not included in this number and considered to depart the depository for goods. ''This field may be unavailable in some setups.''

*'''reserved''' is the number of goods reserved. It may outnumber stock balance if customers are waiting for the next delivery. ''This field may be unavailable in some setups.''

== The list of pick-up points ==

'''The example of a pick-points query:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8" ?>
<pvzlist>
<auth extra="8" login="login" pass="pass"></auth>
<town>Nizhniy Tagil</town>
</pvzlist>
</source>

*'''town''' is a receiver`s residence.

'''The example of a response from the list of pick-up points:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8" ?>
<pvzlist count="2">
<pvz>
<code>126</code>
<clientcode>3</clientcode>
<name>Nizhniy Tagil</name>
<address>622036, 17 Tsiolkovsky Str., Nizhniy Tagil city</address>
<phone>+73435417709, +73435254989</phone>
<comment>5-storeyed apartment building with its end wall beside the highway, the second building from Parkhomenko-Tsiolkovsky street intersection.</comment>
</pvz>
<pvz>
<code>245</code>
<clientcode>NTG1</clientcode>
<name>At Krasnoarmeyskaya Street</name>
<address>79 KRASNOARMEYSKAYA STR.</address>
<phone>+7(3435)379-044</phone>
<comment>Working hours: from Monday through Friday, from 9 a. m. till 6 p. m., on Saturday - from 10 a. m. till 2 p. m.</comment>
</pvz>
</pvzlist>
</source>

*'''code''' is a code of a pick-up point in the system. It is used in an [[API#Ordering|ordering]] query.
*'''clientcode''' is a code of a pick-up point used by a contracting company.
*'''name''' is a name of a pick-up point.
*'''address''' is a pick-up point`s address.
*'''phone''' are pick-up point phone numbers.
*'''comment''' is additional information.

== The list of types of priority ==

'''The example of a type of priority query:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8" ?>
<services>
<auth extra="8"/>
</services>
</source>

'''The example of a response from the list of types of priority:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8" ?>
<services count="2">
<service>
<code>1</code>
<name>Economy</name>
</service>
<service>
<code>2</code>
<name>Urgently</name>
</service>
</services>
</source>

== Delivery cost calculation ==

'''The example of a delivery cost query:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8" ?>
<calculator>
<auth extra="8" login="login" pass="pass" />
<calc townfrom="Moscow" townto="3800000300000" mass="3.7" service="1" />
</calculator>
</source>

Parameters:
*'''townfrom''' is a sending town.
*'''townto''' is a receiving town.
*'''mass''' is weight in kilograms.
*'''service''' is a delivery mode - a number indicating the entry in the list of [The list of types of priority|types of priority]

In authorization login and pass parameters can be omitted, then calculation will be made according to a standard tariff rate of a delivery service with no account of possible differences for a certain customer. <br>
The name of a town (not recommended!), or its code from our list, or its 13-digit code of All-Russian Classifier of Addresses (Address Classifier used in Russia), or its 36-digit code of the Federal Information Address System (AOID) can be entered into the fields for a sending town and a receiving town.

'''The example of a cost of delivery response:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<calculator>
<calc>
<townfrom code="1">Moscow city</townfrom>
<townto code="56603">Irkutsk city</townto>
<mass>3.7</mass>
<service>1</service>
<zone>2</zone>
<price>1163</price>
<maxdeliverydays>3</maxdeliverydays>
</calc>
</calculator>
</source>

Parameters:
*'''townfrom''' is a sending town name which has been recognized and assigned to the list of towns by the system. '''code''' attribute is a code from the list of towns in the system.
*'''townto''' is a receiving town name which has been recognized and assigned to the list of towns by the system. '''code''' attribute is a code from the list of towns in the system.
*'''mass''' is weight in kilograms.
*'''service''' is a delivery mode - a number indicating the entry in the list of [The list of types of priority|types of priority]
*'''service''' is a delivery mode - the number indicating a certain entry in the list of types of priority (See the description on this page).
*'''zone''' is the number of a tariff zone according to which the price has been calculated. The tariff schedule is selected depending on the tariff zone. Multiplying or decreasing coefficients can be applied to the price of delivery in case of order delivery not from/to a regional center.
*'''price''' is a calculated delivery price in the currency of a delivery service`s price-list. It is recommended to be used rather than its homonymous attribute of the parent container.
*'''maxdeliverydays''' is the maximum delivery period in business days.

== The list of money transference certificates ==

'''The example of the query for the list of money transference certificates:'''
<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''' is a root container. It is a mandatory element.
*'''auth''' is authorization. It is a mandatory element.
*'''datefrom''' is a date “from”. It is an optional element.
*'''dateto''' is a date “to”. It is an optional element.

If the date range is not specified, then money transference certificates for the last month are returned.

'''The example of a response to the query for the list of money transference certificates:'''
<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>
<price>637.00</price>
<rur>13430.00</rur>
<pricekur>570.00</pricekur>
<priceag>67.00</priceag>
<payno>42423</payno>
<paytype>1</paytype>
</sma>
</smalist>
</source>

*'''code''' is a code of a money transference certificate.
*'''number''' is the number of a money transference certificate in the system.
*'''actdate''' is a date of a money transference certificate.
*'''datepay''' is a date of payment on a money transference certificate.
*'''price''' is a price of services.
*'''rur''' is a price of an order.
*'''pricekur''' is a price of courier delivery.
*'''priceag''' is agent`s commission.
*'''payno''' is a number of a payment order.
*'''paytype''' is a type of payment: 1- non-cash payment, 2 - paying a courier in cash, 3 - paying cash at the office, 4 - wire transfer.

== Detailing of money transference certificates ==

'''The examples of the query for money transference certificates detailing:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8" ?>
<smadetail>
<auth extra="8" login="login" pass="pass" />
<code>6278</code>
</smadetail>
</source>

'''smadetail''' is a root container. It is a mandatory element.
*'''auth''' is authorization. It is a mandatory element.
*'''code''' is a code of a money transference certificate (See the query of the list of money transference certificates). It is a mandatory element.

'''The example of a response to the query of money transference certificates:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<smadetail count="1">
<specialsma>
<code>42494</code>
<addresscode>14424</addresscode>
<price>314.00</price>
<rur>8800.00</rur>
<pricekur>270.00</pricekur>
<priceag>44.00</priceag>
<pricecalc>8486.00</pricecalc>
<paytype>Cash on delivery</paytype>
<status>Delivered</status>
</specialsma>
<specialsma>
<code>42495</code>
<addresscode>14415</addresscode>
<price>323.00</price>
<rur>4630.00</rur>
<pricekur>300.00</pricekur>
<priceag>23.00</priceag>
<pricecalc>4306.00</pricecalc>
<paytype>Cash on delivery</paytype>
<status>Delivered</status>
</specialsma>
</smadetail>
</source>

*'''code''' is a code of the record.
*'''addresscode''' is a code of the order.
*'''price''' is a price of service
*'''rur''' is the amount of the order.
*'''pricekur''' is a price of courier delivery.
*'''priceag''' is agent`s commission.
*'''pricecalc''' is the amount to be transferred to the agent.
*'''paytype''' is a type of payment: 1- non-cash payment, 2 - paying a courier in cash, 3 - paying cash at the office, 4 - wire transfer.
*'''status''' is a status of the order.

== Generation of short links ==

In some cases, for instance, when using them in SMS, the use of short links to member area may be required.

For doing that it is necessary to send a query containing a full link to which a response containing a hash code for a short link will be sent.

'''The example of a query for short links generation:'''
<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''' is a root container. It is a mandatory element.
*'''link''' is a full link for generation of which a code should be obtained. It is a mandatory element. If '''short''' attribute equals 1, then a response won`t contain XML but only a hash code.

'''The example of a response to the query for short links generation:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<shortlink>
<hash>35AF350C</hash>
</shortlink>
</source>

*'''hash''' is a hash code of a short link.

Further on the following link to member area can be used:

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

API

2019-01-23T10:07:51Z

Boyko: /* Трекинг заказа по номеру */

<div style="font-size: 24px; 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>

В системе "Курьерская служба 2008" имеется возможность интеграции средствами XML API, по протоколу HTTP POST.

Данное API предназначено для интеграции клиентов (интернет-магазинов и прочих компаний-заказчиков доставки) с [http://courierexe.ru/our_clients.htm курьерскими службами], работающими под управлением системы [https://curie.ru/ MeaSoft "Курьерская служба 2008"]. Если Вы являетесь '''агрегатором''', передающим данные от клиентов, возможно, Вам придется последовательно подключаться под разными пользователями, если курьерская служба должна вести раздельный учет взаиморасчетов по клиентам. Если Вы являетесь '''подрядчиком''' - Вы можете забирать заказы, используя значение client=AGENT в запросе [[#Пример запроса статуса заказа|statusreq]], и передавать статусы заказов используя метод [[#Изменение статуса агентом|setorderinfo]]. Так же для интеграций с подрядчиками у нас есть специальная платформа, но добавлять подрядчиков в нее можно только на нашей стороне. Присылайте нам коммерческое предложение, описание Вашего сервиса, и мы с радостью его рассмотрим.

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

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

== Готовые интеграции ==

Для интеграции с популярными CMS можно скачать модули интеграции

{| class="wikitable" align="center" style="width: 80%; margin: auto; color: black; boreder: 1px solid #999999;" cellpadding="10" cellspacing="0"
!style="width: 35%;"|Система управления контентом (CMS)
!style="width: 15%;"|Версия модуля
!style="width: 15%;"|Ссылка
!style="width: 35%;"|Примечание
|-
|[[Файл:bitrix.png|center|x44px]]
|style="text-align: center;"|1.5.9 от 13.12.2018
|style="text-align: center;"|[http://marketplace.1c-bitrix.ru/solutions/measoft.courier/ Установить] 
|Поддерживает версии 14.5 и выше
|-
|[[Файл:prestashop.png|center|x44px]]
|style="text-align: center;"|1.4.5 от 10.10.2018
|style="text-align: center;"|[http://courierexe.ru/download/api/prestashop.zip Скачать]
|Поддерживает версии 1.5.2.0 и выше (2.x в том числе!)
|-
|[[Файл:OpencartOCStore.png|center|x44px]]
|style="text-align: center;"|1.7.5 от 10.08.2018<br>2.0.0 от 01.12.2018
|style="text-align: center;"|[http://courierexe.ru/download/api/opencart.zip Скачать]<br>[http://courierexe.ru/download/api/opencart_2.zip Скачать]<br>
|Поддерживает версии с 1.5.5.1<br>Версия 2.0.0 поддерживает версии с 2.0<br>[https://opencartforum.com/files/file/2906-avtomatizaciya-otpravki-i-otslezhivanie-dostavok-courierexe-dlya-opencart-15x/ Альтернативный модуль сторонних разработчиков]
|-
|[[Файл:webasyst-shopscript.png|center|x44px]]
|style="text-align: center;"|1.3.5 от 14.03.2018
|style="text-align: center;"|[http://www.webasyst.ru/store/plugin/shop/measoftcourier/ Установить]
|
|-
|[[Файл:insales.png|center|x44px]]
|style="text-align: center;"|1.2.1 от 06.09.2017
|style="text-align: center;"|[http://www.insales.ru/collection/all/product/kurierskaya-sluzhba-2008 Установить]
|[[Интеграция_с_другими_системами#Insales|Настраивается]] в ЛК пользователя в системе
|-
|[[Файл:Leadvertex.png|center|x44px]]
|style="text-align: center;"|1.0 от 15.11.2016
|style="text-align: center;"|[[Файл:Leadvertex-howto.png|center|x44px]]
|[http://blog.leadvertex.ru/news/2110-integraciya-s-kurerkami-na-platforme-measoft/ Настраивается] в ЛК пользователя в системе [https://Leadvertex.ru Leadvertex]
|-
|[[Файл:Retailcrm.png|center|x44px]]
|style="text-align: center;"|1.0 от 11.01.2018
|style="text-align: center;"|[https://www.retailcrm.ru/ RetailCRM]
|[[Интеграция_с_другими_системами#RetailCRM|Настраивается]] в ЛК пользователя в системе
|-
|[[Файл:1C.jpg|center|x44px]]
|style="text-align: center;"|1.4 от 17.11.2017
|style="text-align: center;"|-
|[https://infostart.ru/public/692790/ Альтернативный модуль сторонних разработчиков]
|-
|[[Файл:Joomla2.jpg|center|x44px]]
|style="text-align: center;"|1.0.0 от 12.11.2018
|style="text-align: center;"|[http://courierexe.ru/download/api/com_measoft.zip Скачать]
|Внимание! Модуль новый, поэтому возможна некорректная передача данных. Проверяйте, если что - сообщайте, исправим!
|-
|[[Файл:Amocrm.png|center|x44px]]
|style="text-align: center;"|-
|style="text-align: center;"|[https://www.amocrm.ru/extensions/courier2008 Установить]
|Внимание! Модуль новый, поэтому возможна некорректная передача данных. Проверяйте, если что - сообщайте, исправим!
|-
|[[Файл:MoySclad.jpg|center|x44px]]
|style="text-align: center;"|-
|style="text-align: center;"|-
|Ожидается в ближайшее время в магазине Мой Склад
|-
|}

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

== Тестовый аккаунт ==

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

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

== Рабочий аккаунт для подключения ==

Для подключения к площадке Вашего клиента необходимо иметь три параметра:

1. '''Параметр extra''' (Цифровой код, уникальный идентификатор компании. Запросите этот параметр у компании, с которой Вы интегрируетесь). Посмотреть этот код можно в интерфейсе программы КС2008 через основное меню '''"Справочники - Дополнительные возможности"'''. Цифровое значение будет указано во второй гиперссылке (на скриншоте ниже отмечено "звездочкой"):

[[Файл:extra1.png|750px]]

2. '''Логин''' - параметр учетной записи для ЛК клиента и API, указывается в карточке клиента на вкладке '''"Прочее"''' в поле '''"Имя пользователя"'''. Возможно, что в программе КС2008 понадобится создать новую карточку клиента (на скриншоте ниже).

3. '''Пароль''' - параметр учетной записи для ЛК клиента и API, указывается в карточке клиента на вкладке '''"Прочее"''' в поле '''"Пароль"''' (на скриншоте ниже).

[[Файл:33_client.png|500px]]

== Общие понятия ==

На стороне курьерской службы имеется веб-сервис по адресу: https://home.courierexe.ru/api/. Тестовые авторизационные данные: логин: test пароль: testm, параметр 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; < на &lt; > на &gt; " на &quot;

== Ограничения ==
С целью защиты от нецелевого использования сервисов, с 29.05.2017 ведено ограничение на запросы - 1500 запросов с одного IP-адреса за 20 минут. В случае превышения IP-адрес блокируется, разблокировка возможна путем обращения в техническую поддержку, с последующим обсуждением ваших алгоритмов и их коррекцией.

Для проверки статусов заказов лучше всего использовать запросы [[#Передача только изменившихся статусов|"statusreq" с параметром changes=ONLY_LAST]]. Не нужно пытаться "бомбить" наше API запросами с номерами всех ваших заказов, особенно - запросами "tracking", они предназначены не для этого (смотрите описание).

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

<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>Чип & Дейл</person>
<phone>123-45-67</phone>
<zipcode>125480</zipcode>
<town regioncode="78">Санкт-Петербург</town>
<address>Петровка 38 офис 35</address>
<pvz>124</pvz>
<date>2014-03-22</date>
<time_min>09:00</time_min>
<time_max>14:00</time_max>
</receiver>
<return>NO</return>
<weight>5.1</weight>
<return_weight>5.1</return_weight>
<quantity>2</quantity>
<paytype>CASH</paytype>
<service>2</service>
<return_service>1</return_service>
<type>3</type>
<return_type>3</return_type>
<price>387.5</price>
<deliveryprice>150</deliveryprice>
<discount>0</discount>
<inshprice>387.5</inshprice>
<enclosure>Детские игрушки</enclosure>
<instruction>Проверить при покупателе, подписать акт</instruction>
<department>Отдел</department>
<pickup>NO</pickup>
<acceptpartially>NO</acceptpartially>
<items>
<item extcode="abc123" quantity="1" mass="0.2" retprice="37.5" VATrate="0" barcode="2345625213125" article="1" volume="3">Мяч</item>
<item extcode="abc124" quantity="2" mass="2" retprice="100" VATrate="10" barcode="4645625213138" article="2" length="10" width="20" height="30">Обруч</item>
<item extcode="abc125" quantity="3" mass="0.3" retprice="50" barcode="2345625213126" article="3">Погремушка желтая</item>
</items>
</order>
</neworder>
</source>

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

*'''neworder''' - Корневой контейнер, обязательный элемент.

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

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

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

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

*'''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>
<pvz>Код пункта самовывоза по справочнику</pvz>
<date>Дата доставки в формате "YYYY-MM-DD"</date>
<time_min>Желаемое время доставки в формате "HH:MM"</time_min>
<time_max>Желаемое время доставки в формате "HH:MM"</time_max>
</receiver>
</source>

*'''company''' - Компания-получатель.
*'''person''' - Контактное лицо. ''Должно быть заполнено хотя бы одно из полей - company или person!''
*'''phone''' - Телефон. Можно указывать несколько телефонов, E-mail в этом поле.
*'''town''' - Город.

Для тега города '''town''' можно указать код региона в атрибуте '''''regioncode''''' из [[#Справочник регионов|справочника регионов]]. Поиск будет производиться в указанном регионе.

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

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

*'''paytype''' - Тип оплаты заказа получателем. Принимает значения:
:* CASH - Наличными при получении (по-умолчанию)
:* CARD - Картой при получении
:* NO - Без оплаты. Поле Price будет проигнорировано. (Этот тип оплаты передается, если заказ уже оплачен и не требует инкассации, API добавит в систему товары по нулевой цене. Если необходимо передать общую сумму заказа - можно это сделать в поле <inshprice>, указав объявленную ценность)
:* OTHER - Прочее (Предусмотрен для того, чтобы оплата поступала непосредственно в курьерскую службу посредством прочих типов оплаты - таких как: вебмани, яденьги, картой на сайте, прочие платежные системы и т.д.)
:* OPTION - На выбор получателя. Этот тип оплаты нельзя передавать с заказом. Он выставляется автоматически в зависимости от настройки клиента.

*'''zipcode''' - Почтовый индекс.
*'''weight''' - Общий вес заказа в килограммах.
*'''return_weight''' - Общий вес возврата заказа в килограммах.
*'''quantity''' - Количество мест.
*'''service''' - Режим доставки (тип услуги) передается код из справочника "Виды срочности".
*'''return_service''' - Режим возврата (тип услуги) передается код из справочника "Виды срочности".
*'''type''' - Тип корреспонденции (отправления) передается код из справочника "Типы корреспонденции".
*'''return_type''' - Тип возвратной корреспонденции (отправления) передается код из справочника "Типы корреспонденции".
*'''price''' - Сумма заказа. В случае наличия контейнера items значение данного параметра будет проигнорировано, и рассчитано автоматически.
*'''deliveryprice''' - Сумма доставки. В случае наличия контейнера items, в него будет добавлено вложение "Доставка".
*'''discount''' - Скидка на заказ. В результате сумма заказа будет уменьшена на размер скидки.
*'''return''' - Признак необходимости возврата.
*'''return_service''' - Режим возврата (тип услуги) передается код из справочника "Виды срочности".
*'''enclosure''' - Вложение.
*'''inshprice''' - Объявленная ценность.
*'''instruction''' - Поручение - Примечание.
*'''receiverpays''' - Признак оплаты стоимости доставки получателем YES/NO. Если стоит YES, то курьер увидит, что с получателя нужно также взять стоимость доставки.
*'''department''' - Подразделение, в котором оформляется заказ.
*'''pickup''' - Признак оформления забора YES/NO. Если стоит YES, то весь заказ считается заданием на забор груза, а не на доставку! Применяется для вызова курьера к отправителю для забора других отправлений.
*'''acceptpartially''' - Признак возможности частичного выкупа товаров отправления YES/NO.

*'''items''' - Контейнер для описания вложенных товаров. Необязательный контейнер. Атрибуты:
:* '''''item''''' - Название товара.
:* '''''quantity''''' - Количество единиц товара.
:* '''''mass''''' - Масса единицы товара в килограммах.
:* '''''volume''''' - Объемный вес единицы товара в килограммах. При указании объемного веса значение подставляется вместо массы
:* '''''length''''' - Длина единицы товара.
:* '''''width''''' - Ширина единицы товара.
:* '''''height''''' - Высота единицы товара.
:* '''''retprice''''' - Цена единицы товара.
:* '''''VATrate''''' - Ставка НДС - целое число процентов. Если значение не указано, подставляется значение "18".
:* '''''barcode''''' - Штрих-код товара. [[Файл:Article.png|thumb|100px|right]]
:* '''''article''''' - Артикул товара. ''Внимание!'' Указание артикула используется только тогда, когда товар хранится на ответственном хранении в службе доставки, и необходима комплектация. В этом случае система пытается привязать товар к [[API#Справочник номенклатуры|справочнику номенклатуры]]. Если товар в справочнике не найден - система выдаст соответствующую ошибку. Если по артикулу найдено несколько товаров - система выберет один из них случайным образом, что может привести к ошибочной комплектации! Если товар НЕ на ответственном хранении - артикул указывать НЕ нужно. Позиция попадет в систему просто текстом.
:* '''''extcode''''' - Внешний код строки. Используется для идентификации строк заказов при получении статусов. Необязательное поле. ПОКА НЕ ПОДДЕРЖИВАЕТСЯ.

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

=== Примеры ответов ===

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

<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<neworder>
<createorder orderno="AB23541" error="0" errormsg="success"></createorder>
<createorder orderno="55_6542" error="0" errormsg="success"></createorder>
<createorder orderno="AB23542" error="0" errormsg="success"></createorder>
</neworder>
</source>

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

<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<neworder>
<createorder orderno="AB23541" error="17" errormsg="Such number exists"></createorder>
<createorder orderno="AB23542" error="13" errormsg="empty company"></createorder>
<createorder orderno="AB23543" error="14" errormsg="empty person"></createorder>
</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>

=== Коды ошибок при оформлении заказа ===

0 - Ошибок нет.

1 - Ошибка авторизации. (отсутствуют теги <auth login="" pass=""></auth>, неверный логин или пароль).

2 - Отправлен пустой запрос (отсутствует контейнер <neworder></neworder> в XML документе).

3 - Некорректно указана сумма заказа.

4 - Некорректный общий вес заказа.

5 - Не найден город получатель.

6 - Не найден город отправитель.

7 - Не заполнен адрес получателя.

8 - Не заполнен телефон получателя.

9 - Не заполнено контактное имя получателя.

10 - Не заполнено название компании получателя.

11 - Некорректная сумма объявленной ценности.

12 - Артикул не найден.

13 - Не заполнено название компании отправителя.

14 - Не заполнено контактное имя отправителя.

15 - Не заполнен телефон отправителя.

16 - Не заполнен адрес отправителя.

17 - Заказ с таким номером уже существует.

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

=== Пример запроса статуса заказа ===

<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>
<ordercode>34234</ordercode>
<givencode>234534</givencode>
<datefrom>2016-07-21</datefrom>
<dateto>2016-07-21</dateto>
<target>Автозавод</target>
<done>ONLY_NOT_DONE</done>
<changes>ONLY_LAST</changes>
<quickstatus>NO</quickstatus>
</statusreq>
</source>

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

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

*'''changes''' - может принимать значение только ONLY_LAST. Если указан этот параметр, все остальные, кроме quickstatus, игнорируются. Описание данного режима приведено здесь: [[#Передача только изменившихся статусов|Передача только изменившихся статусов]]

*'''quickstatus''' - Указывает "глубину" передаваемых статусов: "YES" (по-умолчанию) - передаются статусы начиная с информации, поступившей от курьера. Такие статусы являются быстрыми (как правило, проставляются курьером сразу после доставки) но не всегда точными. Значение NO запрещает передачу статуса со слов курьера, и выдает только статусы, введенные оператором, как правило вручную. На это требуется больше времени, однако точность гораздо выше. Не рекомендуется совмещать эти типы передачи статусов (чередовать их) при запросе только изменившихся статусов, т.к. в этом случае система будет считать, что статусы у отправлений меняются.

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

=== Примеры ответов ===

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

<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<statusreq count="23">
<order orderno="111111" 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>
<zipcode>125480</zipcode>
<town code="153361" regioncode="78" regionname="Санкт-Петербург город">Санкт-Петербург город</town>
<address>Петровка 38 офис 35</address>
<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>
</receiver>
<weight>5.1</weight>
<return_weight>5.1</return_weight>
<quantity>2</quantity>
<paytype>CASH</paytype>
<service>2</service>
<return_service>2</service>
<type>3</type>
<return_type>3</return_type>
<waittime>12</waittime>
<price>387.5</price>
<print_check>YES</print_check>
<inshprice>387.5</inshprice>
<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">
<>..</> (price details are not yet supported)
..
</deliveryprice>
<receiverpays>NO</receiverpays>
<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>
<customstatecode>2<customstatecode>
<clientstatecode></clientstatecode>
<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">Мяч</item>
<item code="34456" extcode="abc124" quantity="2" mass="2" retprice="100" VATrate="10" barcode="4645625213138" article="2" returns="0">Обруч</item>
<item code="34421" extcode="abc125" quantity="3" mass="0.3" retprice="50" VATrate="18" barcode="2345625213126" article="3" returns="0">Погремушка желтая</item>
</items>
<packages>
<package code="33123" strbarcode="4625333555001" mass="0" message="">Место 1</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''':
:* '''''ordercode''''' - внутренний код заказа в системе, применяется для некоторых внутренних операций.
:* '''''givencode''''' - внутренний код заказа в системе, применяется для некоторых внутренних операций.
:* '''''returns''''' - количество данного товара, от которого отказался получатель. Не нулевое только в случае частичного отказа.

* атрибут '''''code''''' контейнера '''item''' - внутренний код строки заказа в системе, применяется для некоторых внутренних операций.
* '''''coords''''' в контейнере '''receiver''' - координаты получателя.
* '''currcoords''' - текущие координаты заказа. Атрибуты:
:* '''''lat''''' - широта
:* '''''lon''''' - долгота
:* '''''accuracy''''' - точность в метрах
:* '''''RequestDateTime''''' - дата/время последнего обновления координат.

* '''waittime ''' - Время ожидания курьера.
* '''deliveryprice''' - стоимость доставки в валюте расчетов с клиентом.
* '''status''' - статус доставки (список статусов см. ниже). Атрибуты (заполняются начиная с версии системы 2008.0.0.670):
:* '''''eventstore''''' - филиал, к которому относится текущий статус
:* '''''eventtime''''' - время изменения статуса (время зависит от местонахождения филиала)
:* '''''createtimegmt''''' - время фактического изменения статуса (GMT)
:* '''''message''''' - наименование филиала-получателя, при передаче между филиалами
:* '''''title''''' - русское наименование статуса

* '''statushistory''' - история статусов доставки. Содержит список контейнеров '''status'''. Заполняется только для тарифа "Премиум" начиная с версии системы 2008.0.0.670.
* '''customstatecode''' - код внутреннего статуса курьерской службы. Значения уточняйте в курьерской службе. Назначаются курьерской службой в разделе "Справочники" - "Статусы" - "15 Статусы корреспонденции". Справочник не передается через API клиенту по причине возможного наличия в нем внутренних технологических статусов курьерской службы.
* '''clientstatecode''' - код статуса клиента. Используется, если клиент предлагает свои коды статусов доставки/причин недоставки.
* '''deliveredto''' - данные о вручении, либо причина недоставки.
* '''delivereddate''' - дата вручения.
* '''deliveredtime''' - время вручения. В случае недоставки может быть пустым.
* '''outstrbarcode''' - код у подрядчика (код заказа во внешней системе). Используется в интеграциях с внешними системами.

*'''packages''' - Контейнер для описания мест. Необязательный контейнер. Атрибуты:
:* '''''package''''' - Название места.
:* '''''code''''' - Внутренний код строки.
:* '''''strbarcode''''' - Штрих-код места.
:* '''''mass''''' - Масса места в килограммах.
:* '''''message''''' - Строка сообщения.

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

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

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

# Атрибуты контейнера '''status''' заполняются для версий системы '''2008.0.0.670''' и новее.
# Контейнер '''statushistory''' заполняется для тарифа "[[Личный_кабинет#.D0.9F.D0.BE.D0.B4.D0.BA.D0.BB.D1.8E.D1.87.D0.B5.D0.BD.D0.B8.D0.B5|Премиум]]" и версий системы '''2008.0.0.670''' и новее.
</div>
<br />

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

Для получения только изменившихся статусов отправьте запрос
<source lang="xml">
<?xml version="1.0" encoding="UTF-8" ?>
<statusreq>
<auth extra="8" login="login" pass="pass"></auth>
<changes>ONLY_LAST</changes>
<quickstatus>NO</quickstatus>
</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>
</commitlaststatus>
</source>

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

*'''auth''' - Авторизация. Обязательный элемент.
*'''client''' - Признак клиента или агента. Необязательный элемент.
:* CLIENT - Признак клиента, значение по умолчанию
:* AGENT - Признак агента. В ответ отдается информация по заказам, переданным агенту на доставку

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

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

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

# При данном способе передачи (<changes>ONLY_LAST</changes>) система просматривает заказы, оформленные за последние 3 месяца. Если заказ сделан ранее - изменение статуса по нему не попадет в результат выполнения данного запроса.
# Система всегда выдает текущий статус. Т.е. Вы можете одним запросом получить статус "NEW", а следующим - "COMPLETE". В промежутке между запросами отправление могло пройти через несколько промежуточных статусов.
# Система никогда не гарантирует последовательность прохождения заказом набора статусов. Т.е. Вы можете получить статус "COMPLETE", а следующим запросом - "NEW" - такое может произойти, например, если оператор ошибочно отметил заказ выполненным, а затем исправил ошибку.
</div>
<br />

== Получение вложений к накладной ==

'''Пример запроса:'''
<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.

== Трекинг заказа по номеру ==

Запрос трекинга по номеру предназначен для выдачи минимальной обезличенной информации о конкретном заказе не авторизованному пользователю. Наша система имеет для этого интерфейс по адресу "home.courierexe.ru/{код экстра}/tracking". Вы можете либо сделать ссылку на такую страницу на своем сайте, либо разместить ее 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="1234">
<sender>
<town code="1" country="RU">Москва город</town>
<date></date>
</sender>
<receiver>
<town code="1" country="RU">Москва город</town>
<date>2015-04-18</date>
</receiver>
<AWB>0</AWB>
<weight>0</weight>
<quantity>1</quantity>
<currcoords lat="" lon="" accuracy="" RequestDateTime="" />
<status eventstore="филиал в Санкт-Петербурге" eventtime="2016-06-02 17:22:00" createtimegmt="2016-06-03 16:14:44" message="" title="Доставлен" country="RU">COMPLETE</status>
<statushistory>
<status eventstore="Офис в Москве" eventtime="2016-05-30 10:20:00" createtimegmt="2016-06-03 16:14:44" message="" title="Новый" country="RU">NEW</status>
<status eventstore="Офис в Москве" eventtime="2016-06-01 17:38:00" createtimegmt="2016-06-03 16:14:44" message="филиал в Санкт-Петербурге" title="Планируется отправка" country="RU">DEPARTURING</status>
<status eventstore="Офис в Москве" eventtime="2016-06-01 19:53:00" createtimegmt="2016-06-03 16:14:44" message="филиал в Санкт-Петербурге" title="Отправлено со склада" country="RU">DEPARTURE</status>
<status eventstore="филиал в Санкт-Петербурге" eventtime="2016-06-02 07:41:00" createtimegmt="2016-06-03 16:14:44" message="" title="Получен складом" country="RU">ACCEPTED</status>
<status eventstore="филиал в Санкт-Петербурге" eventtime="2016-06-02 09:17:00" createtimegmt="2016-06-03 16:14:44" message="" title="Выдан курьеру на доставку" country="RU">DELIVERY</status>
<status eventstore="филиал в Санкт-Петербурге" eventtime="2016-06-02 17:22:00" createtimegmt="2016-06-03 16:14:44" message="" title="Доставлен (предварительно)" country="RU">COURIERDELIVERED</status>
<status eventstore="филиал в Санкт-Петербурге" eventtime="2016-06-02 17:22:00" createtimegmt="2016-06-03 16:14:44" message="" title="Доставлен" country="RU">COMPLETE</status>
</statushistory>
</order>
</tracking>
</source>

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

== Изменение статуса агентом ==

Запрос изменения статуса заказа позволяет установить окончательный статус заказа - "Доставлен" или "Не доставлен (Возврат/Отмена)".

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

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

'''Пример запроса изменения статуса:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8" ?>
<setorderinfo>
<auth extra="8" login="login" pass="pass" />
<order ordercode="123456" date="2018-03-01" time="10:00" message="Клиент отказался от покупки"/>
<order ordercode="234567" date="2018-03-01" time="10:00" message="">
<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''''' - Внутренний код заказа.
:* '''''date''''' - Дата изменения статуса.
:* '''''time''''' - Время изменения статуса.
:* '''''message''''' - текст сообщения.

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

== Получение накладной в формате pdf ==

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

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

'''waybill''' - Корневой контейнер. Обязательный элемент.
*'''auth''' - Авторизация. Обязательный элемент.
*'''orderno''' - Номер/код заказа. Обязательный элемент.
*'''form''' - Формат накладной. Не обязательный элемент. Принимает значения:
:* 1 - Подробная накладная (по-умолчанию)
:* 2 - Наклейки (Zebra)

'''Пример ответа:'''
<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" ?>
<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>

== Справочник городов ==

'''Пример запроса справочника городов:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<townlist>
<codesearch>
<zipcode>110000</zipcode>
<kladrcode>0100000100800</kladrcode>
<fiascode>bd21979d-46f8-49d0-9105-e8d65172a983</fiascode>
<code>123</code>
</codesearch>
<conditions>
<city>Краснодарский край</city>
<namecontains>новгород</namecontains>
<namestarts>Моск</namestarts>
<name>Москва</name>
<fullname>Москва город</fullname>
<country>1</country>
</conditions>
<limit>
<limitfrom>30</limitfrom>
<limitcount>10</limitcount>
<countall>YES</countall>
</limit>
</townlist>
</source>

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

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

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

'''Пример ответа:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<townlist 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)
</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 />
</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 />
</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>1</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>
<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>
</conditions>
<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 - Все. ''Это поле может быть недоступным в некоторых установках.''

*'''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>
<CountInPallet>30</CountInPallet>
<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''' - Высота в сантиметрах.
*'''CountInPallet''' - Количество штук в паллете.
*'''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>
</itemmovements>
</source>

*'''code''' - внутренний код товара в справочнике номенклатуры.

'''Пример ответа движения номенклатуры:'''
<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''' - номер документа
:* '''date''' - дата документа
:* '''message''' - комментарий

== Справочник пунктов самовывоза ==

'''Пример запроса пунктов самовывоза:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8" ?>
<pvzlist>
<auth extra="8" login="login" pass="pass"></auth>
<town>Нижний Тагил</town>
</pvzlist>
</source>

*'''town''' - Город получателя.

'''Пример ответа справочника пунктов самовывоза:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8" ?>
<pvzlist count="2">
<pvz>
<code>126</code>
<clientcode>3</clientcode>
<name>Нижний Тагил</name>
<address>622036, г. Нижний Тагил, ул. Циолковского, д. 17</address>
<phone>+73435417709, +73435254989</phone>
<comment>Жилое 5-ти этажное здание, торцом к дороге, второе здание от перекрестка Пархоменко-Циолковского.</comment>
</pvz>
<pvz>
<code>245</code>
<clientcode>NTG1</clientcode>
<name>На Красноармейской</name>
<address>КРАСНОАРМЕЙСКАЯ, д.79</address>
<phone>+7(3435)379-044</phone>
<comment>Время работы: пн.-пт. 9-18, сб. 10-14</comment>
</pvz>
</pvzlist>
</source>

*'''code''' - Код ПВЗ в системе. Используется в запросе [[API#Оформление заказа|оформления заказов]]
*'''clientcode''' - Код ПВЗ используемый компанией-подрядчиком.
*'''name''' - Наименование ПВЗ.
*'''address''' - Адрес ПВЗ.
*'''phone''' - Телефоны ПВЗ.
*'''comment''' - Дополнительная информация.

== Справочник Видов срочности ==

'''Пример запроса Видов срочности:'''
<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" ?>
<calculator>
<auth extra="8" login="login" pass="pass" />
<calc townfrom="Москва" townto="3800000300000" l="10" w="20" h="30" mass="3.7" service="1" />
</calculator>
</source>

Параметры:
*'''townfrom''' - Город-отправитель
*'''townto''' - Город-получатель
*'''l''' - Длина в сантиметрах (не обязательный параметр)
*'''w''' - Ширина в сантиметрах (не обязательный параметр)
*'''h''' - Высота в сантиметрах (не обязательный параметр)
*'''mass''' - Масса в килограммах
*'''service''' - Режим доставки - число, указывающее на запись в справочнике [[#Справочник Видов срочности|видов срочности]]. Если этот параметр опустить, система выдаст расчет для всех доступных видов срочности, передав много контейнеров <calc> в ответе.

В авторизации можно опустить параметры 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>1163</price>
<maxdeliverydays>3</maxdeliverydays>
</calc>
</calculator>
</source>

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

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

== Список актов передачи денег ==

'''Пример запроса списка актов передачи денег:'''
<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>
<price>637.00</price>
<rur>13430.00</rur>
<pricekur>570.00</pricekur>
<priceag>67.00</priceag>
<payno>42423</payno>
<paytype>1</paytype>
<paytypename>Безнал</paytypename>
</sma>
</smalist>
</source>

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

== Детализация актов передачи денег ==

'''Пример запроса детализации актов передачи денег:'''
<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>
<status>Доставлено</status>
</specialsma>
</smadetail>
</source>

*'''code''' - Код записи.
*'''ordercode''' - Код заказа.
*'''orderno''' - Шифр заказа.
*'''orderdate''' - Дата заказа.
*'''delivereddate''' - Дата доставки.
*'''company''' - Получатель.
*'''price''' - Стоимость услуг.
*'''rur''' - Сумма заказа.
*'''inshprice''' - Стоимость заказа.
*'''pricekur''' - Стоимость курьерской доставки.
*'''priceag''' - Агентское вознаграждение.
*'''pricecalc''' - Сумма для передачи агенту.
*'''paytype''' - Тип оплаты: 1 - безнал, 2 - наличными курьером, 3 - наличными в офисе, 4 - перевод на карту.
*'''paytypename''' - Строковое представление типа оплаты
*'''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</nowiki>

API

2018-11-23T13:56:23Z

Boyko: /* Описание элементов для оформления заказа */

<div style="font-size: 24px; 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>

В системе "Курьерская служба 2008" имеется возможность интеграции средствами XML API, по протоколу HTTP POST.

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

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

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

== Готовые интеграции ==

Для интеграции с популярными CMS можно скачать модули интеграции

{| class="wikitable" align="center" style="width: 80%; margin: auto; color: black; boreder: 1px solid #999999;" cellpadding="10" cellspacing="0"
!style="width: 35%;"|Система управления контентом (CMS)
!style="width: 15%;"|Версия модуля
!style="width: 15%;"|Ссылка
!style="width: 35%;"|Примечание
|-
|[[Файл:bitrix.png|center|x44px]]
|style="text-align: center;"|1.5.9 от 12.03.2018
|style="text-align: center;"|[http://courierexe.ru/download/api/bitrix.zip Скачать Unicode]<br>[http://courierexe.ru/download/api/bitrix_ansi.zip Скачать ANSI]
|Поддерживает версии 14.5 и выше
|-
|[[Файл:prestashop.png|center|x44px]]
|style="text-align: center;"|1.4.5 от 10.10.2018
|style="text-align: center;"|[http://courierexe.ru/download/api/prestashop.zip Скачать]
|Поддерживает версии 1.5.2.0 и выше (2.x в том числе!)
|-
|[[Файл:opencart.png|center|x44px]] [[Файл:ocstore.png|center|x30px]]
|style="text-align: center;"|1.7.5 от 10.08.2018
|style="text-align: center;"|[http://courierexe.ru/download/api/opencart.zip Скачать]
|Поддерживает версии с 1.5.5.1 по 2.2.<br>
[https://opencartforum.com/files/file/2906-avtomatizaciya-otpravki-i-otslezhivanie-dostavok-courierexe-dlya-opencart-15x/ Альтернативный модуль сторонних разработчиков]
|-
|[[Файл:webasyst-shopscript.png|center|x44px]]
|style="text-align: center;"|1.3.5 от 14.03.2018
|style="text-align: center;"|[http://www.webasyst.ru/store/plugin/shop/measoftcourier/ Установить]
|
|-
|[[Файл:insales.png|center|x44px]]
|style="text-align: center;"|1.2.1 от 06.09.2017
|style="text-align: center;"|[http://www.insales.ru/collection/all/product/kurierskaya-sluzhba-2008 Установить]
|[[Интеграция_с_другими_системами#Insales|Настраивается]] в ЛК пользователя в системе
|-
|[[Файл:Leadvertex.png|center|x44px]]
|style="text-align: center;"|1.0 от 15.11.2016
|style="text-align: center;"|[[Файл:Leadvertex-howto.png|center|x44px]]
|[http://blog.leadvertex.ru/news/2110-integraciya-s-kurerkami-na-platforme-measoft/ Настраивается] в ЛК пользователя в системе [https://Leadvertex.ru Leadvertex]
|-
|[[Файл:Retailcrm.png|center|x44px]]
|style="text-align: center;"|1.0 от 11.01.2018
|style="text-align: center;"|[https://www.retailcrm.ru/ RetailCRM]
|[[Интеграция_с_другими_системами#RetailCRM|Настраивается]] в ЛК пользователя в системе
|-
|[[Файл:1C.jpg|center|x44px]]
|style="text-align: center;"|1.4 от 17.11.2017
|style="text-align: center;"|-
|[https://infostart.ru/public/692790/ Альтернативный модуль сторонних разработчиков]
|-
|[[Файл:Joomla2.jpg|center|x44px]]
|style="text-align: center;"|1.0.0 от 12.11.2018
|style="text-align: center;"|[http://courierexe.ru/download/api/com_measoft.zip Скачать]
|Внимание! Модуль новый, поэтому возможна некорректная передача данных.
|-
|AMO CRM
|style="text-align: center;"|-
|style="text-align: center;"|-
|Ожидается в ближайшее время в магазине Amo
|-
|Мой склад
|style="text-align: center;"|-
|style="text-align: center;"|-
|Ожидается в ближайшее время в магазине Мой Склад
|-
|}

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

== Тестовый аккаунт ==

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

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

== Рабочий аккаунт для подключения ==

Для подключения к площадке Вашего клиента необходимо иметь три параметра:

1. '''Параметр extra''' (Цифровой код, уникальный идентификатор компании. Запросите этот параметр у компании, с которой Вы интегрируетесь). Посмотреть этот код можно в интерфейсе программы КС2008 через основное меню '''"Справочники - Дополнительные возможности"'''. Цифровое значение будет указано во второй гиперссылке (на скриншоте ниже отмечено "звездочкой"):

[[Файл:extra1.png|750px]]

2. '''Логин''' - параметр учетной записи для ЛК клиента и API, указывается в карточке клиента на вкладке '''"Прочее"''' в поле '''"Имя пользователя"'''. Возможно, что в программе КС2008 понадобится создать новую карточку клиента (на скриншоте ниже).

3. '''Пароль''' - параметр учетной записи для ЛК клиента и API, указывается в карточке клиента на вкладке '''"Прочее"''' в поле '''"Пароль"''' (на скриншоте ниже).

[[Файл:33_client.png|500px]]

== Общие понятия ==

На стороне курьерской службы имеется веб-сервис по адресу: https://home.courierexe.ru/api/. Тестовые авторизационные данные: логин: test пароль: testm, параметр 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; < на &lt; > на &gt; " на &quot;

== Ограничения ==
С целью защиты от нецелевого использования сервисов, с 29.05.2017 ведено ограничение на запросы - 1500 запросов с одного IP-адреса за 20 минут. В случае превышения IP-адрес блокируется, разблокировка возможна путем обращения в техническую поддержку, с последующим обсуждением ваших алгоритмов и их коррекцией.

Для проверки статусов заказов лучше всего использовать запросы [[#Передача только изменившихся статусов|"statusreq" с параметром changes=ONLY_LAST]]. Не нужно пытаться "бомбить" наше API запросами с номерами всех ваших заказов, особенно - запросами "tracking", они предназначены не для этого (смотрите описание).

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

<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>Чип & Дейл</person>
<phone>123-45-67</phone>
<zipcode>125480</zipcode>
<town>Санкт-Петербург</town>
<address>Петровка 38 офис 35</address>
<pvz>124</pvz>
<date>2014-03-22</date>
<time_min>09:00</time_min>
<time_max>14:00</time_max>
</receiver>
<return>NO</return>
<weight>5.1</weight>
<return_weight>5.1</return_weight>
<quantity>2</quantity>
<paytype>CASH</paytype>
<service>2</service>
<return_service>1</return_service>
<type>3</type>
<return_type>3</return_type>
<price>387.5</price>
<deliveryprice>150</deliveryprice>
<discount>0</discount>
<inshprice>387.5</inshprice>
<enclosure>Детские игрушки</enclosure>
<instruction>Проверить при покупателе, подписать акт</instruction>
<department>Отдел</department>
<pickup>NO</pickup>
<acceptpartially>NO</acceptpartially>
<items>
<item extcode="abc123" quantity="1" mass="0.2" retprice="37.5" VATrate="0" barcode="2345625213125" article="1" volume="3">Мяч</item>
<item extcode="abc124" quantity="2" mass="2" retprice="100" VATrate="10" barcode="4645625213138" article="2" length="10" width="20" height="30">Обруч</item>
<item extcode="abc125" quantity="3" mass="0.3" retprice="50" barcode="2345625213126" article="3">Погремушка желтая</item>
</items>
</order>
</neworder>
</source>

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

*'''neworder''' - Корневой контейнер, обязательный элемент.

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

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

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

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

*'''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>Город получателя в формате "Москва город"</town>
<address>Адрес получателя</address>
<pvz>Код пункта самовывоза по справочнику</pvz>
<date>Дата доставки в формате "YYYY-MM-DD"</date>
<time_min>Желаемое время доставки в формате "HH:MM"</time_min>
<time_max>Желаемое время доставки в формате "HH:MM"</time_max>
</receiver>
</source>

*'''company''' - Компания-получатель.
*'''person''' - Контактное лицо. ''Должно быть заполнено хотя бы одно из полей - company или person!''
*'''phone''' - Телефон. Можно указывать несколько телефонов, E-mail в этом поле.
*'''town''' - Город.

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

*'''paytype''' - Тип оплаты заказа получателем. Принимает значения:
:* CASH - Наличными при получении (по-умолчанию)
:* CARD - Картой при получении
:* NO - Без оплаты. Поле Price будет проигнорировано. (Этот тип оплаты передается, если заказ уже оплачен и не требует инкассации, API добавит в систему товары по нулевой цене. Если необходимо передать общую сумму заказа - можно это сделать в поле <inshprice>, указав объявленную ценность)
:* OTHER - Прочее (Предусмотрен для того, чтобы оплата поступала непосредственно в курьерскую службу посредством прочих типов оплаты - таких как: вебмани, яденьги, картой на сайте, прочие платежные системы и т.д.)
:* OPTION - На выбор получателя. Этот тип оплаты нельзя передавать с заказом. Он выставляется автоматически в зависимости от настройки клиента.

*'''zipcode''' - Почтовый индекс.
*'''weight''' - Общий вес заказа в килограммах.
*'''return_weight''' - Общий вес возврата заказа в килограммах.
*'''quantity''' - Количество мест.
*'''service''' - Режим доставки (тип услуги) передается код из справочника "Виды срочности".
*'''return_service''' - Режим возврата (тип услуги) передается код из справочника "Виды срочности".
*'''type''' - Тип корреспонденции (отправления) передается код из справочника "Типы корреспонденции".
*'''return_type''' - Тип возвратной корреспонденции (отправления) передается код из справочника "Типы корреспонденции".
*'''price''' - Сумма заказа. В случае наличия контейнера items значение данного параметра будет проигнорировано, и рассчитано автоматически.
*'''deliveryprice''' - Сумма доставки. В случае наличия контейнера items, в него будет добавлено вложение "Доставка".
*'''discount''' - Скидка на заказ. В результате сумма заказа будет уменьшена на размер скидки.
*'''return''' - Признак необходимости возврата.
*'''return_service''' - Режим возврата (тип услуги) передается код из справочника "Виды срочности".
*'''enclosure''' - Вложение.
*'''inshprice''' - Объявленная ценность.
*'''instruction''' - Поручение - Примечание.
*'''department''' - Подразделение, в котором оформляется заказ.
*'''pickup''' - Признак оформления забора YES/NO. Если стоит YES, то весь заказ считается заданием на забор груза, а не на доставку! Применяется для вызова курьера к отправителю для забора других отправлений.
*'''acceptpartially''' - Признак возможности частичного выкупа товаров отправления YES/NO.

*'''items''' - Контейнер для описания вложенных товаров. Необязательный контейнер. Атрибуты:
:* '''''item''''' - Название товара.
:* '''''quantity''''' - Количество единиц товара.
:* '''''mass''''' - Масса единицы товара в килограммах.
:* '''''volume''''' - Объемный вес единицы товара в килограммах. При указании объемного веса значение подставляется вместо массы
:* '''''length''''' - Длина единицы товара.
:* '''''width''''' - Ширина единицы товара.
:* '''''height''''' - Высота единицы товара.
:* '''''retprice''''' - Цена единицы товара.
:* '''''VATrate''''' - Ставка НДС - целое число процентов. Если значение не указано, подставляется значение "18".
:* '''''barcode''''' - Штрих-код товара. [[Файл:Article.png|thumb|100px|right]]
:* '''''article''''' - Артикул товара. ''Внимание!'' Указание артикула используется только тогда, когда товар хранится на ответственном хранении в службе доставки, и необходима комплектация. В этом случае система пытается привязать товар к [[API#Справочник номенклатуры|справочнику номенклатуры]]. Если товар в справочнике не найден - система выдаст соответствующую ошибку. Если по артикулу найдено несколько товаров - система выберет один из них случайным образом, что может привести к ошибочной комплектации! Если товар НЕ на ответственном хранении - артикул указывать НЕ нужно. Позиция попадет в систему просто текстом.
:* '''''extcode''''' - Внешний код строки. Используется для идентификации строк заказов при получении статусов. Необязательное поле. ПОКА НЕ ПОДДЕРЖИВАЕТСЯ.

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

=== Примеры ответов ===

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

<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<neworder>
<createorder orderno="AB23541" error="0" errormsg="success"></createorder>
<createorder orderno="55_6542" error="0" errormsg="success"></createorder>
<createorder orderno="AB23542" error="0" errormsg="success"></createorder>
</neworder>
</source>

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

<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<neworder>
<createorder orderno="AB23541" error="17" errormsg="Such number exists"></createorder>
<createorder orderno="AB23542" error="13" errormsg="empty company"></createorder>
<createorder orderno="AB23543" error="14" errormsg="empty person"></createorder>
</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>

=== Коды ошибок при оформлении заказа ===

0 - Ошибок нет.

1 - Ошибка авторизации. (отсутствуют теги <auth login="" pass=""></auth>, неверный логин или пароль).

2 - Отправлен пустой запрос (отсутствует контейнер <neworder></neworder> в XML документе).

3 - Некорректно указана сумма заказа.

4 - Некорректный общий вес заказа.

5 - Не найден город получатель.

6 - Не найден город отправитель.

7 - Не заполнен адрес получателя.

8 - Не заполнен телефон получателя.

9 - Не заполнено контактное имя получателя.

10 - Не заполнено название компании получателя.

11 - Некорректная сумма объявленной ценности.

12 - Артикул не найден.

13 - Не заполнено название компании отправителя.

14 - Не заполнено контактное имя отправителя.

15 - Не заполнен телефон отправителя.

16 - Не заполнен адрес отправителя.

17 - Заказ с таким номером уже существует.

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

=== Пример запроса статуса заказа ===

<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>
<ordercode>34234</ordercode>
<givencode>234534</givencode>
<datefrom>2016-07-21</datefrom>
<dateto>2016-07-21</dateto>
<target>Автозавод</target>
<done>ONLY_NOT_DONE</done>
<changes>ONLY_LAST</changes>
<quickstatus>NO</quickstatus>
</statusreq>
</source>

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

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

*'''changes''' - может принимать значение только ONLY_LAST. Если указан этот параметр, все остальные, кроме quickstatus, игнорируются. Описание данного режима приведено здесь: [[#Передача только изменившихся статусов|Передача только изменившихся статусов]]

*'''quickstatus''' - Указывает "глубину" передаваемых статусов: "YES" (по-умолчанию) - передаются статусы начиная с информации, поступившей от курьера. Такие статусы являются быстрыми (как правило, проставляются курьером сразу после доставки) но не всегда точными. Значение NO запрещает передачу статуса со слов курьера, и выдает только статусы, введенные оператором, как правило вручную. На это требуется больше времени, однако точность гораздо выше. Не рекомендуется совмещать эти типы передачи статусов (чередовать их) при запросе только изменившихся статусов, т.к. в этом случае система будет считать, что статусы у отправлений меняются.

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

=== Примеры ответов ===

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

<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<statusreq count="23">
<order orderno="111111" 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>
<zipcode>125480</zipcode>
<town code="153361" regioncode="78" regionname="Санкт-Петербург город">Санкт-Петербург город</town>
<address>Петровка 38 офис 35</address>
<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>
</receiver>
<weight>5.1</weight>
<return_weight>5.1</return_weight>
<quantity>2</quantity>
<paytype>CASH</paytype>
<service>2</service>
<return_service>2</service>
<type>3</type>
<return_type>3</return_type>
<waittime>12</waittime>
<price>387.5</price>
<print_check>YES</print_check>
<inshprice>387.5</inshprice>
<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">
<>..</> (price details are not yet supported)
..
</deliveryprice>
<receiverpays>NO</receiverpays>
<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>
<customstatecode>2<customstatecode>
<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">Мяч</item>
<item code="34456" extcode="abc124" quantity="2" mass="2" retprice="100" VATrate="10" barcode="4645625213138" article="2" returns="0">Обруч</item>
<item code="34421" extcode="abc125" quantity="3" mass="0.3" retprice="50" VATrate="18" barcode="2345625213126" article="3" returns="0">Погремушка желтая</item>
</items>
<packages>
<package code="33123" strbarcode="4625333555001" mass="0" message="">Место 1</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''':
:* '''''ordercode''''' - внутренний код заказа в системе, применяется для некоторых внутренних операций.
:* '''''givencode''''' - внутренний код заказа в системе, применяется для некоторых внутренних операций.
:* '''''returns''''' - количество данного товара, от которого отказался получатель. Не нулевое только в случае частичного отказа.

* атрибут '''''code''''' контейнера '''item''' - внутренний код строки заказа в системе, применяется для некоторых внутренних операций.
* '''''coords''''' в контейнере '''receiver''' - координаты получателя.
* '''currcoords''' - текущие координаты заказа. Атрибуты:
:* '''''lat''''' - широта
:* '''''lon''''' - долгота
:* '''''accuracy''''' - точность в метрах
:* '''''RequestDateTime''''' - дата/время последнего обновления координат.

* '''waittime ''' - Время ожидания курьера.
* '''deliveryprice''' - стоимость доставки в валюте расчетов с клиентом.
* '''status''' - статус доставки (список статусов см. ниже). Атрибуты (заполняются начиная с версии системы 2008.0.0.670):
:* '''''eventstore''''' - филиал, к которому относится текущий статус
:* '''''eventtime''''' - время изменения статуса (время зависит от местонахождения филиала)
:* '''''createtimegmt''''' - время фактического изменения статуса (GMT)
:* '''''message''''' - наименование филиала-получателя, при передаче между филиалами
:* '''''title''''' - русское наименование статуса

* '''statushistory''' - история статусов доставки. Содержит список контейнеров '''status'''. Заполняется только для тарифа "Премиум" начиная с версии системы 2008.0.0.670.
* '''customstatecode''' - код внутреннего статуса курьерской службы. Значения уточняйте в курьерской службе. Назначаются курьерской службой в разделе "Справочники" - "Статусы" - "15 Статусы корреспонденции". Справочник не передается через API клиенту по причине возможного наличия в нем внутренних технологических статусов курьерской службы.
* '''clientstatecode''' - код статуса клиента. Используется, если клиент предлагает свои коды статусов доставки/причин недоставки.
* '''deliveredto''' - данные о вручении, либо причина недоставки.
* '''delivereddate''' - дата вручения.
* '''deliveredtime''' - время вручения. В случае недоставки может быть пустым.
* '''outstrbarcode''' - код у подрядчика (код заказа во внешней системе). Используется в интеграциях с внешними системами.

*'''packages''' - Контейнер для описания мест. Необязательный контейнер. Атрибуты:
:* '''''package''''' - Название места.
:* '''''code''''' - Внутренний код строки.
:* '''''strbarcode''''' - Штрих-код места.
:* '''''mass''''' - Масса места в килограммах.
:* '''''message''''' - Строка сообщения.

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

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

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

# Атрибуты контейнера '''status''' заполняются для версий системы '''2008.0.0.670''' и новее.
# Контейнер '''statushistory''' заполняется для тарифа "[[Личный_кабинет#.D0.9F.D0.BE.D0.B4.D0.BA.D0.BB.D1.8E.D1.87.D0.B5.D0.BD.D0.B8.D0.B5|Премиум]]" и версий системы '''2008.0.0.670''' и новее.
</div>
<br />

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

Для получения только изменившихся статусов отправьте запрос
<source lang="xml">
<?xml version="1.0" encoding="UTF-8" ?>
<statusreq>
<auth extra="8" login="login" pass="pass"></auth>
<changes>ONLY_LAST</changes>
<quickstatus>NO</quickstatus>
</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>
</commitlaststatus>
</source>

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

*'''auth''' - Авторизация. Обязательный элемент.
*'''client''' - Признак клиента или агента. Необязательный элемент.
:* CLIENT - Признак клиента, значение по умолчанию
:* AGENT - Признак агента. В ответ отдается информация по заказам, переданным агенту на доставку

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

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

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

# При данном способе передачи (<changes>ONLY_LAST</changes>) система просматривает заказы, оформленные за последние 3 месяца. Если заказ сделан ранее - изменение статуса по нему не попадет в результат выполнения данного запроса.
# Система всегда выдает текущий статус. Т.е. Вы можете одним запросом получить статус "NEW", а следующим - "COMPLETE". В промежутке между запросами отправление могло пройти через несколько промежуточных статусов.
# Система никогда не гарантирует последовательность прохождения заказом набора статусов. Т.е. Вы можете получить статус "COMPLETE", а следующим запросом - "NEW" - такое может произойти, например, если оператор ошибочно отметил заказ выполненным, а затем исправил ошибку.
</div>
<br />

== Получение вложений к накладной ==

'''Пример запроса:'''
<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.

== Трекинг заказа по номеру ==

Запрос трекинга по номеру предназначен для выдачи минимальной обезличенной информации о конкретном заказе не авторизованному пользователю. Наша система имеет для этого интерфейс по адресу "home.courierexe.ru/{код экстра}/tracking". Вы можете либо сделать ссылку на такую страницу на своем сайте, либо разместить ее 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="1234">
<sender>
<town code="1">Москва город</town>
<date></date>
</sender>
<receiver>
<town code="1">Москва город</town>
<date>2015-04-18</date>
</receiver>
<weight>0</weight>
<quantity>1</quantity>
<currcoords lat="" lon="" accuracy="" RequestDateTime="" />
<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>
</order>
</tracking>
</source>

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

== Изменение статуса агентом ==

Запрос изменения статуса заказа позволяет установить окончательный статус заказа - "Доставлен" или "Не доставлен (Возврат/Отмена)".

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

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

'''Пример запроса изменения статуса:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8" ?>
<setorderinfo>
<auth extra="8" login="login" pass="pass" />
<order ordercode="123456" date="2018-03-01" time="10:00" message="Клиент отказался от покупки"/>
<order ordercode="234567" date="2018-03-01" time="10:00" message="">
<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''''' - Внутренний код заказа.
:* '''''date''''' - Дата изменения статуса.
:* '''''time''''' - Время изменения статуса.
:* '''''message''''' - текст сообщения.

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

== Получение накладной в формате pdf ==

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

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

'''waybill''' - Корневой контейнер. Обязательный элемент.
*'''auth''' - Авторизация. Обязательный элемент.
*'''orderno''' - Номер/код заказа. Обязательный элемент.
*'''form''' - Формат накладной. Не обязательный элемент. Принимает значения:
:* 1 - Подробная накладная (по-умолчанию)
:* 2 - Наклейки (Zebra)

'''Пример ответа:'''
<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" ?>
<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>

== Справочник городов ==

'''Пример запроса справочника городов:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<townlist>
<codesearch>
<zipcode>110000</zipcode>
<kladrcode>0100000100800</kladrcode>
<fiascode>bd21979d-46f8-49d0-9105-e8d65172a983</fiascode>
<code>123</code>
</codesearch>
<conditions>
<city>Краснодарский край</city>
<namecontains>новгород</namecontains>
<namestarts>Моск</namestarts>
<name>Москва</name>
<fullname>Москва город</fullname>
<country>1</country>
</conditions>
<limit>
<limitfrom>30</limitfrom>
<limitcount>10</limitcount>
<countall>YES</countall>
</limit>
</townlist>
</source>

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

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

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

'''Пример ответа:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<townlist count="3" page="1" totalcount="3" totalpages="1">
<town>
<code>26379</code>
<city>
<code>23</code>
<name>Краснодарский край</name>
</city>
<name>Сочи город</name>
<shortname>Сочи</shortname> (not yet supported)
<typename>город</typename> (not yet supported)
</town>
<town>
<code>40331</code>
<city>
<code>32</code>
<name>Брянская область</name>
</city>
<name>Сочилов хутор</name>
<shortname>Сочилов</shortname>
<typename>хутор</typename>
</town>
<town>
<code>114016</code>
<city>
<code>60</code>
<name>Псковская область</name>
</city>
<name>Сочихино деревня</name>
<shortname>Сочихино</shortname>
<typename>деревня</typename>
</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>1</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>
<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>
</conditions>
<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 - Все. ''Это поле может быть недоступным в некоторых установках.''

*'''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>
<CountInPallet>30</CountInPallet>
<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''' - Высота в сантиметрах.
*'''CountInPallet''' - Количество штук в паллете.
*'''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>
</itemmovements>
</source>

*'''code''' - внутренний код товара в справочнике номенклатуры.

'''Пример ответа движения номенклатуры:'''
<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''' - номер документа
:* '''date''' - дата документа
:* '''message''' - комментарий

== Справочник пунктов самовывоза ==

'''Пример запроса пунктов самовывоза:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8" ?>
<pvzlist>
<auth extra="8" login="login" pass="pass"></auth>
<town>Нижний Тагил</town>
</pvzlist>
</source>

*'''town''' - Город получателя.

'''Пример ответа справочника пунктов самовывоза:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8" ?>
<pvzlist count="2">
<pvz>
<code>126</code>
<clientcode>3</clientcode>
<name>Нижний Тагил</name>
<address>622036, г. Нижний Тагил, ул. Циолковского, д. 17</address>
<phone>+73435417709, +73435254989</phone>
<comment>Жилое 5-ти этажное здание, торцом к дороге, второе здание от перекрестка Пархоменко-Циолковского.</comment>
</pvz>
<pvz>
<code>245</code>
<clientcode>NTG1</clientcode>
<name>На Красноармейской</name>
<address>КРАСНОАРМЕЙСКАЯ, д.79</address>
<phone>+7(3435)379-044</phone>
<comment>Время работы: пн.-пт. 9-18, сб. 10-14</comment>
</pvz>
</pvzlist>
</source>

*'''code''' - Код ПВЗ в системе. Используется в запросе [[API#Оформление заказа|оформления заказов]]
*'''clientcode''' - Код ПВЗ используемый компанией-подрядчиком.
*'''name''' - Наименование ПВЗ.
*'''address''' - Адрес ПВЗ.
*'''phone''' - Телефоны ПВЗ.
*'''comment''' - Дополнительная информация.

== Справочник Видов срочности ==

'''Пример запроса Видов срочности:'''
<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" ?>
<calculator>
<auth extra="8" login="login" pass="pass" />
<calc townfrom="Москва" townto="3800000300000" l="10" w="20" h="30" mass="3.7" service="1" />
</calculator>
</source>

Параметры:
*'''townfrom''' - Город-отправитель
*'''townto''' - Город-получатель
*'''l''' - Длина в сантиметрах (не обязательный параметр)
*'''w''' - Ширина в сантиметрах (не обязательный параметр)
*'''h''' - Высота в сантиметрах (не обязательный параметр)
*'''mass''' - Масса в килограммах
*'''service''' - Режим доставки - число, указывающее на запись в справочнике [[#Справочник Видов срочности|видов срочности]]. Если этот параметр опустить, система выдаст расчет для всех доступных видов срочности, передав много контейнеров <calc> в ответе.

В авторизации можно опустить параметры 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>1163</price>
<maxdeliverydays>3</maxdeliverydays>
</calc>
</calculator>
</source>

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

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

== Список актов передачи денег ==

'''Пример запроса списка актов передачи денег:'''
<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>
<price>637.00</price>
<rur>13430.00</rur>
<pricekur>570.00</pricekur>
<priceag>67.00</priceag>
<payno>42423</payno>
<paytype>1</paytype>
<paytypename>Безнал</paytypename>
</sma>
</smalist>
</source>

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

== Детализация актов передачи денег ==

'''Пример запроса детализации актов передачи денег:'''
<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>
<status>Доставлено</status>
</specialsma>
</smadetail>
</source>

*'''code''' - Код записи.
*'''ordercode''' - Код заказа.
*'''orderno''' - Шифр заказа.
*'''orderdate''' - Дата заказа.
*'''delivereddate''' - Дата доставки.
*'''company''' - Получатель.
*'''price''' - Стоимость услуг.
*'''rur''' - Сумма заказа.
*'''inshprice''' - Стоимость заказа.
*'''pricekur''' - Стоимость курьерской доставки.
*'''priceag''' - Агентское вознаграждение.
*'''pricecalc''' - Сумма для передачи агенту.
*'''paytype''' - Тип оплаты: 1 - безнал, 2 - наличными курьером, 3 - наличными в офисе, 4 - перевод на карту.
*'''paytypename''' - Строковое представление типа оплаты
*'''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</nowiki>

API

2018-11-23T13:55:46Z

Boyko: /* Описание элементов для оформления заказа */

<div style="font-size: 24px; 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>

В системе "Курьерская служба 2008" имеется возможность интеграции средствами XML API, по протоколу HTTP POST.

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

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

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

== Готовые интеграции ==

Для интеграции с популярными CMS можно скачать модули интеграции

{| class="wikitable" align="center" style="width: 80%; margin: auto; color: black; boreder: 1px solid #999999;" cellpadding="10" cellspacing="0"
!style="width: 35%;"|Система управления контентом (CMS)
!style="width: 15%;"|Версия модуля
!style="width: 15%;"|Ссылка
!style="width: 35%;"|Примечание
|-
|[[Файл:bitrix.png|center|x44px]]
|style="text-align: center;"|1.5.9 от 12.03.2018
|style="text-align: center;"|[http://courierexe.ru/download/api/bitrix.zip Скачать Unicode]<br>[http://courierexe.ru/download/api/bitrix_ansi.zip Скачать ANSI]
|Поддерживает версии 14.5 и выше
|-
|[[Файл:prestashop.png|center|x44px]]
|style="text-align: center;"|1.4.5 от 10.10.2018
|style="text-align: center;"|[http://courierexe.ru/download/api/prestashop.zip Скачать]
|Поддерживает версии 1.5.2.0 и выше (2.x в том числе!)
|-
|[[Файл:opencart.png|center|x44px]] [[Файл:ocstore.png|center|x30px]]
|style="text-align: center;"|1.7.5 от 10.08.2018
|style="text-align: center;"|[http://courierexe.ru/download/api/opencart.zip Скачать]
|Поддерживает версии с 1.5.5.1 по 2.2.<br>
[https://opencartforum.com/files/file/2906-avtomatizaciya-otpravki-i-otslezhivanie-dostavok-courierexe-dlya-opencart-15x/ Альтернативный модуль сторонних разработчиков]
|-
|[[Файл:webasyst-shopscript.png|center|x44px]]
|style="text-align: center;"|1.3.5 от 14.03.2018
|style="text-align: center;"|[http://www.webasyst.ru/store/plugin/shop/measoftcourier/ Установить]
|
|-
|[[Файл:insales.png|center|x44px]]
|style="text-align: center;"|1.2.1 от 06.09.2017
|style="text-align: center;"|[http://www.insales.ru/collection/all/product/kurierskaya-sluzhba-2008 Установить]
|[[Интеграция_с_другими_системами#Insales|Настраивается]] в ЛК пользователя в системе
|-
|[[Файл:Leadvertex.png|center|x44px]]
|style="text-align: center;"|1.0 от 15.11.2016
|style="text-align: center;"|[[Файл:Leadvertex-howto.png|center|x44px]]
|[http://blog.leadvertex.ru/news/2110-integraciya-s-kurerkami-na-platforme-measoft/ Настраивается] в ЛК пользователя в системе [https://Leadvertex.ru Leadvertex]
|-
|[[Файл:Retailcrm.png|center|x44px]]
|style="text-align: center;"|1.0 от 11.01.2018
|style="text-align: center;"|[https://www.retailcrm.ru/ RetailCRM]
|[[Интеграция_с_другими_системами#RetailCRM|Настраивается]] в ЛК пользователя в системе
|-
|[[Файл:1C.jpg|center|x44px]]
|style="text-align: center;"|1.4 от 17.11.2017
|style="text-align: center;"|-
|[https://infostart.ru/public/692790/ Альтернативный модуль сторонних разработчиков]
|-
|[[Файл:Joomla2.jpg|center|x44px]]
|style="text-align: center;"|1.0.0 от 12.11.2018
|style="text-align: center;"|[http://courierexe.ru/download/api/com_measoft.zip Скачать]
|Внимание! Модуль новый, поэтому возможна некорректная передача данных.
|-
|AMO CRM
|style="text-align: center;"|-
|style="text-align: center;"|-
|Ожидается в ближайшее время в магазине Amo
|-
|Мой склад
|style="text-align: center;"|-
|style="text-align: center;"|-
|Ожидается в ближайшее время в магазине Мой Склад
|-
|}

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

== Тестовый аккаунт ==

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

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

== Рабочий аккаунт для подключения ==

Для подключения к площадке Вашего клиента необходимо иметь три параметра:

1. '''Параметр extra''' (Цифровой код, уникальный идентификатор компании. Запросите этот параметр у компании, с которой Вы интегрируетесь). Посмотреть этот код можно в интерфейсе программы КС2008 через основное меню '''"Справочники - Дополнительные возможности"'''. Цифровое значение будет указано во второй гиперссылке (на скриншоте ниже отмечено "звездочкой"):

[[Файл:extra1.png|750px]]

2. '''Логин''' - параметр учетной записи для ЛК клиента и API, указывается в карточке клиента на вкладке '''"Прочее"''' в поле '''"Имя пользователя"'''. Возможно, что в программе КС2008 понадобится создать новую карточку клиента (на скриншоте ниже).

3. '''Пароль''' - параметр учетной записи для ЛК клиента и API, указывается в карточке клиента на вкладке '''"Прочее"''' в поле '''"Пароль"''' (на скриншоте ниже).

[[Файл:33_client.png|500px]]

== Общие понятия ==

На стороне курьерской службы имеется веб-сервис по адресу: https://home.courierexe.ru/api/. Тестовые авторизационные данные: логин: test пароль: testm, параметр 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; < на &lt; > на &gt; " на &quot;

== Ограничения ==
С целью защиты от нецелевого использования сервисов, с 29.05.2017 ведено ограничение на запросы - 1500 запросов с одного IP-адреса за 20 минут. В случае превышения IP-адрес блокируется, разблокировка возможна путем обращения в техническую поддержку, с последующим обсуждением ваших алгоритмов и их коррекцией.

Для проверки статусов заказов лучше всего использовать запросы [[#Передача только изменившихся статусов|"statusreq" с параметром changes=ONLY_LAST]]. Не нужно пытаться "бомбить" наше API запросами с номерами всех ваших заказов, особенно - запросами "tracking", они предназначены не для этого (смотрите описание).

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

<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>Чип & Дейл</person>
<phone>123-45-67</phone>
<zipcode>125480</zipcode>
<town>Санкт-Петербург</town>
<address>Петровка 38 офис 35</address>
<pvz>124</pvz>
<date>2014-03-22</date>
<time_min>09:00</time_min>
<time_max>14:00</time_max>
</receiver>
<return>NO</return>
<weight>5.1</weight>
<return_weight>5.1</return_weight>
<quantity>2</quantity>
<paytype>CASH</paytype>
<service>2</service>
<return_service>1</return_service>
<type>3</type>
<return_type>3</return_type>
<price>387.5</price>
<deliveryprice>150</deliveryprice>
<discount>0</discount>
<inshprice>387.5</inshprice>
<enclosure>Детские игрушки</enclosure>
<instruction>Проверить при покупателе, подписать акт</instruction>
<department>Отдел</department>
<pickup>NO</pickup>
<acceptpartially>NO</acceptpartially>
<items>
<item extcode="abc123" quantity="1" mass="0.2" retprice="37.5" VATrate="0" barcode="2345625213125" article="1" volume="3">Мяч</item>
<item extcode="abc124" quantity="2" mass="2" retprice="100" VATrate="10" barcode="4645625213138" article="2" length="10" width="20" height="30">Обруч</item>
<item extcode="abc125" quantity="3" mass="0.3" retprice="50" barcode="2345625213126" article="3">Погремушка желтая</item>
</items>
</order>
</neworder>
</source>

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

*'''neworder''' - Корневой контейнер, обязательный элемент.

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

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

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

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

*'''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>Город получателя в формате "Москва город"</town>
<address>Адрес получателя</address>
<pvz>Код пункта самовывоза по [[#Справочник пунктов самовывоза|справочнику]]</pvz>
<date>Дата доставки в формате "YYYY-MM-DD"</date>
<time_min>Желаемое время доставки в формате "HH:MM"</time_min>
<time_max>Желаемое время доставки в формате "HH:MM"</time_max>
</receiver>
</source>

*'''company''' - Компания-получатель.
*'''person''' - Контактное лицо. ''Должно быть заполнено хотя бы одно из полей - company или person!''
*'''phone''' - Телефон. Можно указывать несколько телефонов, E-mail в этом поле.
*'''town''' - Город.

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

*'''paytype''' - Тип оплаты заказа получателем. Принимает значения:
:* CASH - Наличными при получении (по-умолчанию)
:* CARD - Картой при получении
:* NO - Без оплаты. Поле Price будет проигнорировано. (Этот тип оплаты передается, если заказ уже оплачен и не требует инкассации, API добавит в систему товары по нулевой цене. Если необходимо передать общую сумму заказа - можно это сделать в поле <inshprice>, указав объявленную ценность)
:* OTHER - Прочее (Предусмотрен для того, чтобы оплата поступала непосредственно в курьерскую службу посредством прочих типов оплаты - таких как: вебмани, яденьги, картой на сайте, прочие платежные системы и т.д.)
:* OPTION - На выбор получателя. Этот тип оплаты нельзя передавать с заказом. Он выставляется автоматически в зависимости от настройки клиента.

*'''zipcode''' - Почтовый индекс.
*'''weight''' - Общий вес заказа в килограммах.
*'''return_weight''' - Общий вес возврата заказа в килограммах.
*'''quantity''' - Количество мест.
*'''service''' - Режим доставки (тип услуги) передается код из справочника "Виды срочности".
*'''return_service''' - Режим возврата (тип услуги) передается код из справочника "Виды срочности".
*'''type''' - Тип корреспонденции (отправления) передается код из справочника "Типы корреспонденции".
*'''return_type''' - Тип возвратной корреспонденции (отправления) передается код из справочника "Типы корреспонденции".
*'''price''' - Сумма заказа. В случае наличия контейнера items значение данного параметра будет проигнорировано, и рассчитано автоматически.
*'''deliveryprice''' - Сумма доставки. В случае наличия контейнера items, в него будет добавлено вложение "Доставка".
*'''discount''' - Скидка на заказ. В результате сумма заказа будет уменьшена на размер скидки.
*'''return''' - Признак необходимости возврата.
*'''return_service''' - Режим возврата (тип услуги) передается код из справочника "Виды срочности".
*'''enclosure''' - Вложение.
*'''inshprice''' - Объявленная ценность.
*'''instruction''' - Поручение - Примечание.
*'''department''' - Подразделение, в котором оформляется заказ.
*'''pickup''' - Признак оформления забора YES/NO. Если стоит YES, то весь заказ считается заданием на забор груза, а не на доставку! Применяется для вызова курьера к отправителю для забора других отправлений.
*'''acceptpartially''' - Признак возможности частичного выкупа товаров отправления YES/NO.

*'''items''' - Контейнер для описания вложенных товаров. Необязательный контейнер. Атрибуты:
:* '''''item''''' - Название товара.
:* '''''quantity''''' - Количество единиц товара.
:* '''''mass''''' - Масса единицы товара в килограммах.
:* '''''volume''''' - Объемный вес единицы товара в килограммах. При указании объемного веса значение подставляется вместо массы
:* '''''length''''' - Длина единицы товара.
:* '''''width''''' - Ширина единицы товара.
:* '''''height''''' - Высота единицы товара.
:* '''''retprice''''' - Цена единицы товара.
:* '''''VATrate''''' - Ставка НДС - целое число процентов. Если значение не указано, подставляется значение "18".
:* '''''barcode''''' - Штрих-код товара. [[Файл:Article.png|thumb|100px|right]]
:* '''''article''''' - Артикул товара. ''Внимание!'' Указание артикула используется только тогда, когда товар хранится на ответственном хранении в службе доставки, и необходима комплектация. В этом случае система пытается привязать товар к [[API#Справочник номенклатуры|справочнику номенклатуры]]. Если товар в справочнике не найден - система выдаст соответствующую ошибку. Если по артикулу найдено несколько товаров - система выберет один из них случайным образом, что может привести к ошибочной комплектации! Если товар НЕ на ответственном хранении - артикул указывать НЕ нужно. Позиция попадет в систему просто текстом.
:* '''''extcode''''' - Внешний код строки. Используется для идентификации строк заказов при получении статусов. Необязательное поле. ПОКА НЕ ПОДДЕРЖИВАЕТСЯ.

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

=== Примеры ответов ===

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

<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<neworder>
<createorder orderno="AB23541" error="0" errormsg="success"></createorder>
<createorder orderno="55_6542" error="0" errormsg="success"></createorder>
<createorder orderno="AB23542" error="0" errormsg="success"></createorder>
</neworder>
</source>

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

<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<neworder>
<createorder orderno="AB23541" error="17" errormsg="Such number exists"></createorder>
<createorder orderno="AB23542" error="13" errormsg="empty company"></createorder>
<createorder orderno="AB23543" error="14" errormsg="empty person"></createorder>
</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>

=== Коды ошибок при оформлении заказа ===

0 - Ошибок нет.

1 - Ошибка авторизации. (отсутствуют теги <auth login="" pass=""></auth>, неверный логин или пароль).

2 - Отправлен пустой запрос (отсутствует контейнер <neworder></neworder> в XML документе).

3 - Некорректно указана сумма заказа.

4 - Некорректный общий вес заказа.

5 - Не найден город получатель.

6 - Не найден город отправитель.

7 - Не заполнен адрес получателя.

8 - Не заполнен телефон получателя.

9 - Не заполнено контактное имя получателя.

10 - Не заполнено название компании получателя.

11 - Некорректная сумма объявленной ценности.

12 - Артикул не найден.

13 - Не заполнено название компании отправителя.

14 - Не заполнено контактное имя отправителя.

15 - Не заполнен телефон отправителя.

16 - Не заполнен адрес отправителя.

17 - Заказ с таким номером уже существует.

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

=== Пример запроса статуса заказа ===

<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>
<ordercode>34234</ordercode>
<givencode>234534</givencode>
<datefrom>2016-07-21</datefrom>
<dateto>2016-07-21</dateto>
<target>Автозавод</target>
<done>ONLY_NOT_DONE</done>
<changes>ONLY_LAST</changes>
<quickstatus>NO</quickstatus>
</statusreq>
</source>

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

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

*'''changes''' - может принимать значение только ONLY_LAST. Если указан этот параметр, все остальные, кроме quickstatus, игнорируются. Описание данного режима приведено здесь: [[#Передача только изменившихся статусов|Передача только изменившихся статусов]]

*'''quickstatus''' - Указывает "глубину" передаваемых статусов: "YES" (по-умолчанию) - передаются статусы начиная с информации, поступившей от курьера. Такие статусы являются быстрыми (как правило, проставляются курьером сразу после доставки) но не всегда точными. Значение NO запрещает передачу статуса со слов курьера, и выдает только статусы, введенные оператором, как правило вручную. На это требуется больше времени, однако точность гораздо выше. Не рекомендуется совмещать эти типы передачи статусов (чередовать их) при запросе только изменившихся статусов, т.к. в этом случае система будет считать, что статусы у отправлений меняются.

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

=== Примеры ответов ===

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

<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<statusreq count="23">
<order orderno="111111" 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>
<zipcode>125480</zipcode>
<town code="153361" regioncode="78" regionname="Санкт-Петербург город">Санкт-Петербург город</town>
<address>Петровка 38 офис 35</address>
<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>
</receiver>
<weight>5.1</weight>
<return_weight>5.1</return_weight>
<quantity>2</quantity>
<paytype>CASH</paytype>
<service>2</service>
<return_service>2</service>
<type>3</type>
<return_type>3</return_type>
<waittime>12</waittime>
<price>387.5</price>
<print_check>YES</print_check>
<inshprice>387.5</inshprice>
<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">
<>..</> (price details are not yet supported)
..
</deliveryprice>
<receiverpays>NO</receiverpays>
<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>
<customstatecode>2<customstatecode>
<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">Мяч</item>
<item code="34456" extcode="abc124" quantity="2" mass="2" retprice="100" VATrate="10" barcode="4645625213138" article="2" returns="0">Обруч</item>
<item code="34421" extcode="abc125" quantity="3" mass="0.3" retprice="50" VATrate="18" barcode="2345625213126" article="3" returns="0">Погремушка желтая</item>
</items>
<packages>
<package code="33123" strbarcode="4625333555001" mass="0" message="">Место 1</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''':
:* '''''ordercode''''' - внутренний код заказа в системе, применяется для некоторых внутренних операций.
:* '''''givencode''''' - внутренний код заказа в системе, применяется для некоторых внутренних операций.
:* '''''returns''''' - количество данного товара, от которого отказался получатель. Не нулевое только в случае частичного отказа.

* атрибут '''''code''''' контейнера '''item''' - внутренний код строки заказа в системе, применяется для некоторых внутренних операций.
* '''''coords''''' в контейнере '''receiver''' - координаты получателя.
* '''currcoords''' - текущие координаты заказа. Атрибуты:
:* '''''lat''''' - широта
:* '''''lon''''' - долгота
:* '''''accuracy''''' - точность в метрах
:* '''''RequestDateTime''''' - дата/время последнего обновления координат.

* '''waittime ''' - Время ожидания курьера.
* '''deliveryprice''' - стоимость доставки в валюте расчетов с клиентом.
* '''status''' - статус доставки (список статусов см. ниже). Атрибуты (заполняются начиная с версии системы 2008.0.0.670):
:* '''''eventstore''''' - филиал, к которому относится текущий статус
:* '''''eventtime''''' - время изменения статуса (время зависит от местонахождения филиала)
:* '''''createtimegmt''''' - время фактического изменения статуса (GMT)
:* '''''message''''' - наименование филиала-получателя, при передаче между филиалами
:* '''''title''''' - русское наименование статуса

* '''statushistory''' - история статусов доставки. Содержит список контейнеров '''status'''. Заполняется только для тарифа "Премиум" начиная с версии системы 2008.0.0.670.
* '''customstatecode''' - код внутреннего статуса курьерской службы. Значения уточняйте в курьерской службе. Назначаются курьерской службой в разделе "Справочники" - "Статусы" - "15 Статусы корреспонденции". Справочник не передается через API клиенту по причине возможного наличия в нем внутренних технологических статусов курьерской службы.
* '''clientstatecode''' - код статуса клиента. Используется, если клиент предлагает свои коды статусов доставки/причин недоставки.
* '''deliveredto''' - данные о вручении, либо причина недоставки.
* '''delivereddate''' - дата вручения.
* '''deliveredtime''' - время вручения. В случае недоставки может быть пустым.
* '''outstrbarcode''' - код у подрядчика (код заказа во внешней системе). Используется в интеграциях с внешними системами.

*'''packages''' - Контейнер для описания мест. Необязательный контейнер. Атрибуты:
:* '''''package''''' - Название места.
:* '''''code''''' - Внутренний код строки.
:* '''''strbarcode''''' - Штрих-код места.
:* '''''mass''''' - Масса места в килограммах.
:* '''''message''''' - Строка сообщения.

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

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

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

# Атрибуты контейнера '''status''' заполняются для версий системы '''2008.0.0.670''' и новее.
# Контейнер '''statushistory''' заполняется для тарифа "[[Личный_кабинет#.D0.9F.D0.BE.D0.B4.D0.BA.D0.BB.D1.8E.D1.87.D0.B5.D0.BD.D0.B8.D0.B5|Премиум]]" и версий системы '''2008.0.0.670''' и новее.
</div>
<br />

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

Для получения только изменившихся статусов отправьте запрос
<source lang="xml">
<?xml version="1.0" encoding="UTF-8" ?>
<statusreq>
<auth extra="8" login="login" pass="pass"></auth>
<changes>ONLY_LAST</changes>
<quickstatus>NO</quickstatus>
</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>
</commitlaststatus>
</source>

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

*'''auth''' - Авторизация. Обязательный элемент.
*'''client''' - Признак клиента или агента. Необязательный элемент.
:* CLIENT - Признак клиента, значение по умолчанию
:* AGENT - Признак агента. В ответ отдается информация по заказам, переданным агенту на доставку

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

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

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

# При данном способе передачи (<changes>ONLY_LAST</changes>) система просматривает заказы, оформленные за последние 3 месяца. Если заказ сделан ранее - изменение статуса по нему не попадет в результат выполнения данного запроса.
# Система всегда выдает текущий статус. Т.е. Вы можете одним запросом получить статус "NEW", а следующим - "COMPLETE". В промежутке между запросами отправление могло пройти через несколько промежуточных статусов.
# Система никогда не гарантирует последовательность прохождения заказом набора статусов. Т.е. Вы можете получить статус "COMPLETE", а следующим запросом - "NEW" - такое может произойти, например, если оператор ошибочно отметил заказ выполненным, а затем исправил ошибку.
</div>
<br />

== Получение вложений к накладной ==

'''Пример запроса:'''
<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.

== Трекинг заказа по номеру ==

Запрос трекинга по номеру предназначен для выдачи минимальной обезличенной информации о конкретном заказе не авторизованному пользователю. Наша система имеет для этого интерфейс по адресу "home.courierexe.ru/{код экстра}/tracking". Вы можете либо сделать ссылку на такую страницу на своем сайте, либо разместить ее 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="1234">
<sender>
<town code="1">Москва город</town>
<date></date>
</sender>
<receiver>
<town code="1">Москва город</town>
<date>2015-04-18</date>
</receiver>
<weight>0</weight>
<quantity>1</quantity>
<currcoords lat="" lon="" accuracy="" RequestDateTime="" />
<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>
</order>
</tracking>
</source>

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

== Изменение статуса агентом ==

Запрос изменения статуса заказа позволяет установить окончательный статус заказа - "Доставлен" или "Не доставлен (Возврат/Отмена)".

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

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

'''Пример запроса изменения статуса:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8" ?>
<setorderinfo>
<auth extra="8" login="login" pass="pass" />
<order ordercode="123456" date="2018-03-01" time="10:00" message="Клиент отказался от покупки"/>
<order ordercode="234567" date="2018-03-01" time="10:00" message="">
<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''''' - Внутренний код заказа.
:* '''''date''''' - Дата изменения статуса.
:* '''''time''''' - Время изменения статуса.
:* '''''message''''' - текст сообщения.

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

== Получение накладной в формате pdf ==

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

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

'''waybill''' - Корневой контейнер. Обязательный элемент.
*'''auth''' - Авторизация. Обязательный элемент.
*'''orderno''' - Номер/код заказа. Обязательный элемент.
*'''form''' - Формат накладной. Не обязательный элемент. Принимает значения:
:* 1 - Подробная накладная (по-умолчанию)
:* 2 - Наклейки (Zebra)

'''Пример ответа:'''
<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" ?>
<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>

== Справочник городов ==

'''Пример запроса справочника городов:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<townlist>
<codesearch>
<zipcode>110000</zipcode>
<kladrcode>0100000100800</kladrcode>
<fiascode>bd21979d-46f8-49d0-9105-e8d65172a983</fiascode>
<code>123</code>
</codesearch>
<conditions>
<city>Краснодарский край</city>
<namecontains>новгород</namecontains>
<namestarts>Моск</namestarts>
<name>Москва</name>
<fullname>Москва город</fullname>
<country>1</country>
</conditions>
<limit>
<limitfrom>30</limitfrom>
<limitcount>10</limitcount>
<countall>YES</countall>
</limit>
</townlist>
</source>

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

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

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

'''Пример ответа:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<townlist count="3" page="1" totalcount="3" totalpages="1">
<town>
<code>26379</code>
<city>
<code>23</code>
<name>Краснодарский край</name>
</city>
<name>Сочи город</name>
<shortname>Сочи</shortname> (not yet supported)
<typename>город</typename> (not yet supported)
</town>
<town>
<code>40331</code>
<city>
<code>32</code>
<name>Брянская область</name>
</city>
<name>Сочилов хутор</name>
<shortname>Сочилов</shortname>
<typename>хутор</typename>
</town>
<town>
<code>114016</code>
<city>
<code>60</code>
<name>Псковская область</name>
</city>
<name>Сочихино деревня</name>
<shortname>Сочихино</shortname>
<typename>деревня</typename>
</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>1</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>
<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>
</conditions>
<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 - Все. ''Это поле может быть недоступным в некоторых установках.''

*'''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>
<CountInPallet>30</CountInPallet>
<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''' - Высота в сантиметрах.
*'''CountInPallet''' - Количество штук в паллете.
*'''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>
</itemmovements>
</source>

*'''code''' - внутренний код товара в справочнике номенклатуры.

'''Пример ответа движения номенклатуры:'''
<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''' - номер документа
:* '''date''' - дата документа
:* '''message''' - комментарий

== Справочник пунктов самовывоза ==

'''Пример запроса пунктов самовывоза:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8" ?>
<pvzlist>
<auth extra="8" login="login" pass="pass"></auth>
<town>Нижний Тагил</town>
</pvzlist>
</source>

*'''town''' - Город получателя.

'''Пример ответа справочника пунктов самовывоза:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8" ?>
<pvzlist count="2">
<pvz>
<code>126</code>
<clientcode>3</clientcode>
<name>Нижний Тагил</name>
<address>622036, г. Нижний Тагил, ул. Циолковского, д. 17</address>
<phone>+73435417709, +73435254989</phone>
<comment>Жилое 5-ти этажное здание, торцом к дороге, второе здание от перекрестка Пархоменко-Циолковского.</comment>
</pvz>
<pvz>
<code>245</code>
<clientcode>NTG1</clientcode>
<name>На Красноармейской</name>
<address>КРАСНОАРМЕЙСКАЯ, д.79</address>
<phone>+7(3435)379-044</phone>
<comment>Время работы: пн.-пт. 9-18, сб. 10-14</comment>
</pvz>
</pvzlist>
</source>

*'''code''' - Код ПВЗ в системе. Используется в запросе [[API#Оформление заказа|оформления заказов]]
*'''clientcode''' - Код ПВЗ используемый компанией-подрядчиком.
*'''name''' - Наименование ПВЗ.
*'''address''' - Адрес ПВЗ.
*'''phone''' - Телефоны ПВЗ.
*'''comment''' - Дополнительная информация.

== Справочник Видов срочности ==

'''Пример запроса Видов срочности:'''
<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" ?>
<calculator>
<auth extra="8" login="login" pass="pass" />
<calc townfrom="Москва" townto="3800000300000" l="10" w="20" h="30" mass="3.7" service="1" />
</calculator>
</source>

Параметры:
*'''townfrom''' - Город-отправитель
*'''townto''' - Город-получатель
*'''l''' - Длина в сантиметрах (не обязательный параметр)
*'''w''' - Ширина в сантиметрах (не обязательный параметр)
*'''h''' - Высота в сантиметрах (не обязательный параметр)
*'''mass''' - Масса в килограммах
*'''service''' - Режим доставки - число, указывающее на запись в справочнике [[#Справочник Видов срочности|видов срочности]]. Если этот параметр опустить, система выдаст расчет для всех доступных видов срочности, передав много контейнеров <calc> в ответе.

В авторизации можно опустить параметры 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>1163</price>
<maxdeliverydays>3</maxdeliverydays>
</calc>
</calculator>
</source>

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

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

== Список актов передачи денег ==

'''Пример запроса списка актов передачи денег:'''
<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>
<price>637.00</price>
<rur>13430.00</rur>
<pricekur>570.00</pricekur>
<priceag>67.00</priceag>
<payno>42423</payno>
<paytype>1</paytype>
<paytypename>Безнал</paytypename>
</sma>
</smalist>
</source>

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

== Детализация актов передачи денег ==

'''Пример запроса детализации актов передачи денег:'''
<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>
<status>Доставлено</status>
</specialsma>
</smadetail>
</source>

*'''code''' - Код записи.
*'''ordercode''' - Код заказа.
*'''orderno''' - Шифр заказа.
*'''orderdate''' - Дата заказа.
*'''delivereddate''' - Дата доставки.
*'''company''' - Получатель.
*'''price''' - Стоимость услуг.
*'''rur''' - Сумма заказа.
*'''inshprice''' - Стоимость заказа.
*'''pricekur''' - Стоимость курьерской доставки.
*'''priceag''' - Агентское вознаграждение.
*'''pricecalc''' - Сумма для передачи агенту.
*'''paytype''' - Тип оплаты: 1 - безнал, 2 - наличными курьером, 3 - наличными в офисе, 4 - перевод на карту.
*'''paytypename''' - Строковое представление типа оплаты
*'''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</nowiki>

API

2018-11-23T13:51:18Z

Boyko: /* Пример оформления заказа */

<div style="font-size: 24px; 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>

В системе "Курьерская служба 2008" имеется возможность интеграции средствами XML API, по протоколу HTTP POST.

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

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

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

== Готовые интеграции ==

Для интеграции с популярными CMS можно скачать модули интеграции

{| class="wikitable" align="center" style="width: 80%; margin: auto; color: black; boreder: 1px solid #999999;" cellpadding="10" cellspacing="0"
!style="width: 35%;"|Система управления контентом (CMS)
!style="width: 15%;"|Версия модуля
!style="width: 15%;"|Ссылка
!style="width: 35%;"|Примечание
|-
|[[Файл:bitrix.png|center|x44px]]
|style="text-align: center;"|1.5.9 от 12.03.2018
|style="text-align: center;"|[http://courierexe.ru/download/api/bitrix.zip Скачать Unicode]<br>[http://courierexe.ru/download/api/bitrix_ansi.zip Скачать ANSI]
|Поддерживает версии 14.5 и выше
|-
|[[Файл:prestashop.png|center|x44px]]
|style="text-align: center;"|1.4.5 от 10.10.2018
|style="text-align: center;"|[http://courierexe.ru/download/api/prestashop.zip Скачать]
|Поддерживает версии 1.5.2.0 и выше (2.x в том числе!)
|-
|[[Файл:opencart.png|center|x44px]] [[Файл:ocstore.png|center|x30px]]
|style="text-align: center;"|1.7.5 от 10.08.2018
|style="text-align: center;"|[http://courierexe.ru/download/api/opencart.zip Скачать]
|Поддерживает версии с 1.5.5.1 по 2.2.<br>
[https://opencartforum.com/files/file/2906-avtomatizaciya-otpravki-i-otslezhivanie-dostavok-courierexe-dlya-opencart-15x/ Альтернативный модуль сторонних разработчиков]
|-
|[[Файл:webasyst-shopscript.png|center|x44px]]
|style="text-align: center;"|1.3.5 от 14.03.2018
|style="text-align: center;"|[http://www.webasyst.ru/store/plugin/shop/measoftcourier/ Установить]
|
|-
|[[Файл:insales.png|center|x44px]]
|style="text-align: center;"|1.2.1 от 06.09.2017
|style="text-align: center;"|[http://www.insales.ru/collection/all/product/kurierskaya-sluzhba-2008 Установить]
|[[Интеграция_с_другими_системами#Insales|Настраивается]] в ЛК пользователя в системе
|-
|[[Файл:Leadvertex.png|center|x44px]]
|style="text-align: center;"|1.0 от 15.11.2016
|style="text-align: center;"|[[Файл:Leadvertex-howto.png|center|x44px]]
|[http://blog.leadvertex.ru/news/2110-integraciya-s-kurerkami-na-platforme-measoft/ Настраивается] в ЛК пользователя в системе [https://Leadvertex.ru Leadvertex]
|-
|[[Файл:Retailcrm.png|center|x44px]]
|style="text-align: center;"|1.0 от 11.01.2018
|style="text-align: center;"|[https://www.retailcrm.ru/ RetailCRM]
|[[Интеграция_с_другими_системами#RetailCRM|Настраивается]] в ЛК пользователя в системе
|-
|[[Файл:1C.jpg|center|x44px]]
|style="text-align: center;"|1.4 от 17.11.2017
|style="text-align: center;"|-
|[https://infostart.ru/public/692790/ Альтернативный модуль сторонних разработчиков]
|-
|[[Файл:Joomla2.jpg|center|x44px]]
|style="text-align: center;"|1.0.0 от 12.11.2018
|style="text-align: center;"|[http://courierexe.ru/download/api/com_measoft.zip Скачать]
|Внимание! Модуль новый, поэтому возможна некорректная передача данных.
|-
|AMO CRM
|style="text-align: center;"|-
|style="text-align: center;"|-
|Ожидается в ближайшее время в магазине Amo
|-
|Мой склад
|style="text-align: center;"|-
|style="text-align: center;"|-
|Ожидается в ближайшее время в магазине Мой Склад
|-
|}

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

== Тестовый аккаунт ==

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

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

== Рабочий аккаунт для подключения ==

Для подключения к площадке Вашего клиента необходимо иметь три параметра:

1. '''Параметр extra''' (Цифровой код, уникальный идентификатор компании. Запросите этот параметр у компании, с которой Вы интегрируетесь). Посмотреть этот код можно в интерфейсе программы КС2008 через основное меню '''"Справочники - Дополнительные возможности"'''. Цифровое значение будет указано во второй гиперссылке (на скриншоте ниже отмечено "звездочкой"):

[[Файл:extra1.png|750px]]

2. '''Логин''' - параметр учетной записи для ЛК клиента и API, указывается в карточке клиента на вкладке '''"Прочее"''' в поле '''"Имя пользователя"'''. Возможно, что в программе КС2008 понадобится создать новую карточку клиента (на скриншоте ниже).

3. '''Пароль''' - параметр учетной записи для ЛК клиента и API, указывается в карточке клиента на вкладке '''"Прочее"''' в поле '''"Пароль"''' (на скриншоте ниже).

[[Файл:33_client.png|500px]]

== Общие понятия ==

На стороне курьерской службы имеется веб-сервис по адресу: https://home.courierexe.ru/api/. Тестовые авторизационные данные: логин: test пароль: testm, параметр 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; < на &lt; > на &gt; " на &quot;

== Ограничения ==
С целью защиты от нецелевого использования сервисов, с 29.05.2017 ведено ограничение на запросы - 1500 запросов с одного IP-адреса за 20 минут. В случае превышения IP-адрес блокируется, разблокировка возможна путем обращения в техническую поддержку, с последующим обсуждением ваших алгоритмов и их коррекцией.

Для проверки статусов заказов лучше всего использовать запросы [[#Передача только изменившихся статусов|"statusreq" с параметром changes=ONLY_LAST]]. Не нужно пытаться "бомбить" наше API запросами с номерами всех ваших заказов, особенно - запросами "tracking", они предназначены не для этого (смотрите описание).

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

<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>Чип & Дейл</person>
<phone>123-45-67</phone>
<zipcode>125480</zipcode>
<town>Санкт-Петербург</town>
<address>Петровка 38 офис 35</address>
<pvz>124</pvz>
<date>2014-03-22</date>
<time_min>09:00</time_min>
<time_max>14:00</time_max>
</receiver>
<return>NO</return>
<weight>5.1</weight>
<return_weight>5.1</return_weight>
<quantity>2</quantity>
<paytype>CASH</paytype>
<service>2</service>
<return_service>1</return_service>
<type>3</type>
<return_type>3</return_type>
<price>387.5</price>
<deliveryprice>150</deliveryprice>
<discount>0</discount>
<inshprice>387.5</inshprice>
<enclosure>Детские игрушки</enclosure>
<instruction>Проверить при покупателе, подписать акт</instruction>
<department>Отдел</department>
<pickup>NO</pickup>
<acceptpartially>NO</acceptpartially>
<items>
<item extcode="abc123" quantity="1" mass="0.2" retprice="37.5" VATrate="0" barcode="2345625213125" article="1" volume="3">Мяч</item>
<item extcode="abc124" quantity="2" mass="2" retprice="100" VATrate="10" barcode="4645625213138" article="2" length="10" width="20" height="30">Обруч</item>
<item extcode="abc125" quantity="3" mass="0.3" retprice="50" barcode="2345625213126" article="3">Погремушка желтая</item>
</items>
</order>
</neworder>
</source>

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

*'''neworder''' - Корневой контейнер, обязательный элемент.

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

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

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

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

*'''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>Город получателя в формате "Москва город"</town>
<address>Адрес получателя</address>
<date>Дата доставки в формате "YYYY-MM-DD"</date>
<time_min>Желаемое время доставки в формате "HH:MM"</time_min>
<time_max>Желаемое время доставки в формате "HH:MM"</time_max>
</receiver>
</source>

*'''company''' - Компания-получатель.
*'''person''' - Контактное лицо. ''Должно быть заполнено хотя бы одно из полей - company или person!''
*'''phone''' - Телефон. Можно указывать несколько телефонов, E-mail в этом поле.
*'''town''' - Город.

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

*'''paytype''' - Тип оплаты заказа получателем. Принимает значения:
:* CASH - Наличными при получении (по-умолчанию)
:* CARD - Картой при получении
:* NO - Без оплаты. Поле Price будет проигнорировано. (Этот тип оплаты передается, если заказ уже оплачен и не требует инкассации, API добавит в систему товары по нулевой цене. Если необходимо передать общую сумму заказа - можно это сделать в поле <inshprice>, указав объявленную ценность)
:* OTHER - Прочее (Предусмотрен для того, чтобы оплата поступала непосредственно в курьерскую службу посредством прочих типов оплаты - таких как: вебмани, яденьги, картой на сайте, прочие платежные системы и т.д.)
:* OPTION - На выбор получателя. Этот тип оплаты нельзя передавать с заказом. Он выставляется автоматически в зависимости от настройки клиента.

*'''zipcode''' - Почтовый индекс.
*'''weight''' - Общий вес заказа в килограммах.
*'''return_weight''' - Общий вес возврата заказа в килограммах.
*'''quantity''' - Количество мест.
*'''service''' - Режим доставки (тип услуги) передается код из справочника "Виды срочности".
*'''return_service''' - Режим возврата (тип услуги) передается код из справочника "Виды срочности".
*'''type''' - Тип корреспонденции (отправления) передается код из справочника "Типы корреспонденции".
*'''return_type''' - Тип возвратной корреспонденции (отправления) передается код из справочника "Типы корреспонденции".
*'''price''' - Сумма заказа. В случае наличия контейнера items значение данного параметра будет проигнорировано, и рассчитано автоматически.
*'''deliveryprice''' - Сумма доставки. В случае наличия контейнера items, в него будет добавлено вложение "Доставка".
*'''discount''' - Скидка на заказ. В результате сумма заказа будет уменьшена на размер скидки.
*'''return''' - Признак необходимости возврата.
*'''return_service''' - Режим возврата (тип услуги) передается код из справочника "Виды срочности".
*'''enclosure''' - Вложение.
*'''inshprice''' - Объявленная ценность.
*'''instruction''' - Поручение - Примечание.
*'''pvz''' - Код пункта самовывоза по [[#Справочник пунктов самовывоза|справочнику]]
*'''department''' - Подразделение, в котором оформляется заказ.
*'''pickup''' - Признак оформления забора YES/NO. Если стоит YES, то весь заказ считается заданием на забор груза, а не на доставку! Применяется для вызова курьера к отправителю для забора других отправлений.
*'''acceptpartially''' - Признак возможности частичного выкупа товаров отправления YES/NO.

*'''items''' - Контейнер для описания вложенных товаров. Необязательный контейнер. Атрибуты:
:* '''''item''''' - Название товара.
:* '''''quantity''''' - Количество единиц товара.
:* '''''mass''''' - Масса единицы товара в килограммах.
:* '''''volume''''' - Объемный вес единицы товара в килограммах. При указании объемного веса значение подставляется вместо массы
:* '''''length''''' - Длина единицы товара.
:* '''''width''''' - Ширина единицы товара.
:* '''''height''''' - Высота единицы товара.
:* '''''retprice''''' - Цена единицы товара.
:* '''''VATrate''''' - Ставка НДС - целое число процентов. Если значение не указано, подставляется значение "18".
:* '''''barcode''''' - Штрих-код товара. [[Файл:Article.png|thumb|100px|right]]
:* '''''article''''' - Артикул товара. ''Внимание!'' Указание артикула используется только тогда, когда товар хранится на ответственном хранении в службе доставки, и необходима комплектация. В этом случае система пытается привязать товар к [[API#Справочник номенклатуры|справочнику номенклатуры]]. Если товар в справочнике не найден - система выдаст соответствующую ошибку. Если по артикулу найдено несколько товаров - система выберет один из них случайным образом, что может привести к ошибочной комплектации! Если товар НЕ на ответственном хранении - артикул указывать НЕ нужно. Позиция попадет в систему просто текстом.
:* '''''extcode''''' - Внешний код строки. Используется для идентификации строк заказов при получении статусов. Необязательное поле. ПОКА НЕ ПОДДЕРЖИВАЕТСЯ.

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

=== Примеры ответов ===

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

<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<neworder>
<createorder orderno="AB23541" error="0" errormsg="success"></createorder>
<createorder orderno="55_6542" error="0" errormsg="success"></createorder>
<createorder orderno="AB23542" error="0" errormsg="success"></createorder>
</neworder>
</source>

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

<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<neworder>
<createorder orderno="AB23541" error="17" errormsg="Such number exists"></createorder>
<createorder orderno="AB23542" error="13" errormsg="empty company"></createorder>
<createorder orderno="AB23543" error="14" errormsg="empty person"></createorder>
</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>

=== Коды ошибок при оформлении заказа ===

0 - Ошибок нет.

1 - Ошибка авторизации. (отсутствуют теги <auth login="" pass=""></auth>, неверный логин или пароль).

2 - Отправлен пустой запрос (отсутствует контейнер <neworder></neworder> в XML документе).

3 - Некорректно указана сумма заказа.

4 - Некорректный общий вес заказа.

5 - Не найден город получатель.

6 - Не найден город отправитель.

7 - Не заполнен адрес получателя.

8 - Не заполнен телефон получателя.

9 - Не заполнено контактное имя получателя.

10 - Не заполнено название компании получателя.

11 - Некорректная сумма объявленной ценности.

12 - Артикул не найден.

13 - Не заполнено название компании отправителя.

14 - Не заполнено контактное имя отправителя.

15 - Не заполнен телефон отправителя.

16 - Не заполнен адрес отправителя.

17 - Заказ с таким номером уже существует.

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

=== Пример запроса статуса заказа ===

<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>
<ordercode>34234</ordercode>
<givencode>234534</givencode>
<datefrom>2016-07-21</datefrom>
<dateto>2016-07-21</dateto>
<target>Автозавод</target>
<done>ONLY_NOT_DONE</done>
<changes>ONLY_LAST</changes>
<quickstatus>NO</quickstatus>
</statusreq>
</source>

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

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

*'''changes''' - может принимать значение только ONLY_LAST. Если указан этот параметр, все остальные, кроме quickstatus, игнорируются. Описание данного режима приведено здесь: [[#Передача только изменившихся статусов|Передача только изменившихся статусов]]

*'''quickstatus''' - Указывает "глубину" передаваемых статусов: "YES" (по-умолчанию) - передаются статусы начиная с информации, поступившей от курьера. Такие статусы являются быстрыми (как правило, проставляются курьером сразу после доставки) но не всегда точными. Значение NO запрещает передачу статуса со слов курьера, и выдает только статусы, введенные оператором, как правило вручную. На это требуется больше времени, однако точность гораздо выше. Не рекомендуется совмещать эти типы передачи статусов (чередовать их) при запросе только изменившихся статусов, т.к. в этом случае система будет считать, что статусы у отправлений меняются.

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

=== Примеры ответов ===

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

<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<statusreq count="23">
<order orderno="111111" 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>
<zipcode>125480</zipcode>
<town code="153361" regioncode="78" regionname="Санкт-Петербург город">Санкт-Петербург город</town>
<address>Петровка 38 офис 35</address>
<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>
</receiver>
<weight>5.1</weight>
<return_weight>5.1</return_weight>
<quantity>2</quantity>
<paytype>CASH</paytype>
<service>2</service>
<return_service>2</service>
<type>3</type>
<return_type>3</return_type>
<waittime>12</waittime>
<price>387.5</price>
<print_check>YES</print_check>
<inshprice>387.5</inshprice>
<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">
<>..</> (price details are not yet supported)
..
</deliveryprice>
<receiverpays>NO</receiverpays>
<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>
<customstatecode>2<customstatecode>
<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">Мяч</item>
<item code="34456" extcode="abc124" quantity="2" mass="2" retprice="100" VATrate="10" barcode="4645625213138" article="2" returns="0">Обруч</item>
<item code="34421" extcode="abc125" quantity="3" mass="0.3" retprice="50" VATrate="18" barcode="2345625213126" article="3" returns="0">Погремушка желтая</item>
</items>
<packages>
<package code="33123" strbarcode="4625333555001" mass="0" message="">Место 1</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''':
:* '''''ordercode''''' - внутренний код заказа в системе, применяется для некоторых внутренних операций.
:* '''''givencode''''' - внутренний код заказа в системе, применяется для некоторых внутренних операций.
:* '''''returns''''' - количество данного товара, от которого отказался получатель. Не нулевое только в случае частичного отказа.

* атрибут '''''code''''' контейнера '''item''' - внутренний код строки заказа в системе, применяется для некоторых внутренних операций.
* '''''coords''''' в контейнере '''receiver''' - координаты получателя.
* '''currcoords''' - текущие координаты заказа. Атрибуты:
:* '''''lat''''' - широта
:* '''''lon''''' - долгота
:* '''''accuracy''''' - точность в метрах
:* '''''RequestDateTime''''' - дата/время последнего обновления координат.

* '''waittime ''' - Время ожидания курьера.
* '''deliveryprice''' - стоимость доставки в валюте расчетов с клиентом.
* '''status''' - статус доставки (список статусов см. ниже). Атрибуты (заполняются начиная с версии системы 2008.0.0.670):
:* '''''eventstore''''' - филиал, к которому относится текущий статус
:* '''''eventtime''''' - время изменения статуса (время зависит от местонахождения филиала)
:* '''''createtimegmt''''' - время фактического изменения статуса (GMT)
:* '''''message''''' - наименование филиала-получателя, при передаче между филиалами
:* '''''title''''' - русское наименование статуса

* '''statushistory''' - история статусов доставки. Содержит список контейнеров '''status'''. Заполняется только для тарифа "Премиум" начиная с версии системы 2008.0.0.670.
* '''customstatecode''' - код внутреннего статуса курьерской службы. Значения уточняйте в курьерской службе. Назначаются курьерской службой в разделе "Справочники" - "Статусы" - "15 Статусы корреспонденции". Справочник не передается через API клиенту по причине возможного наличия в нем внутренних технологических статусов курьерской службы.
* '''clientstatecode''' - код статуса клиента. Используется, если клиент предлагает свои коды статусов доставки/причин недоставки.
* '''deliveredto''' - данные о вручении, либо причина недоставки.
* '''delivereddate''' - дата вручения.
* '''deliveredtime''' - время вручения. В случае недоставки может быть пустым.
* '''outstrbarcode''' - код у подрядчика (код заказа во внешней системе). Используется в интеграциях с внешними системами.

*'''packages''' - Контейнер для описания мест. Необязательный контейнер. Атрибуты:
:* '''''package''''' - Название места.
:* '''''code''''' - Внутренний код строки.
:* '''''strbarcode''''' - Штрих-код места.
:* '''''mass''''' - Масса места в килограммах.
:* '''''message''''' - Строка сообщения.

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

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

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

# Атрибуты контейнера '''status''' заполняются для версий системы '''2008.0.0.670''' и новее.
# Контейнер '''statushistory''' заполняется для тарифа "[[Личный_кабинет#.D0.9F.D0.BE.D0.B4.D0.BA.D0.BB.D1.8E.D1.87.D0.B5.D0.BD.D0.B8.D0.B5|Премиум]]" и версий системы '''2008.0.0.670''' и новее.
</div>
<br />

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

Для получения только изменившихся статусов отправьте запрос
<source lang="xml">
<?xml version="1.0" encoding="UTF-8" ?>
<statusreq>
<auth extra="8" login="login" pass="pass"></auth>
<changes>ONLY_LAST</changes>
<quickstatus>NO</quickstatus>
</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>
</commitlaststatus>
</source>

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

*'''auth''' - Авторизация. Обязательный элемент.
*'''client''' - Признак клиента или агента. Необязательный элемент.
:* CLIENT - Признак клиента, значение по умолчанию
:* AGENT - Признак агента. В ответ отдается информация по заказам, переданным агенту на доставку

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

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

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

# При данном способе передачи (<changes>ONLY_LAST</changes>) система просматривает заказы, оформленные за последние 3 месяца. Если заказ сделан ранее - изменение статуса по нему не попадет в результат выполнения данного запроса.
# Система всегда выдает текущий статус. Т.е. Вы можете одним запросом получить статус "NEW", а следующим - "COMPLETE". В промежутке между запросами отправление могло пройти через несколько промежуточных статусов.
# Система никогда не гарантирует последовательность прохождения заказом набора статусов. Т.е. Вы можете получить статус "COMPLETE", а следующим запросом - "NEW" - такое может произойти, например, если оператор ошибочно отметил заказ выполненным, а затем исправил ошибку.
</div>
<br />

== Получение вложений к накладной ==

'''Пример запроса:'''
<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.

== Трекинг заказа по номеру ==

Запрос трекинга по номеру предназначен для выдачи минимальной обезличенной информации о конкретном заказе не авторизованному пользователю. Наша система имеет для этого интерфейс по адресу "home.courierexe.ru/{код экстра}/tracking". Вы можете либо сделать ссылку на такую страницу на своем сайте, либо разместить ее 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="1234">
<sender>
<town code="1">Москва город</town>
<date></date>
</sender>
<receiver>
<town code="1">Москва город</town>
<date>2015-04-18</date>
</receiver>
<weight>0</weight>
<quantity>1</quantity>
<currcoords lat="" lon="" accuracy="" RequestDateTime="" />
<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>
</order>
</tracking>
</source>

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

== Изменение статуса агентом ==

Запрос изменения статуса заказа позволяет установить окончательный статус заказа - "Доставлен" или "Не доставлен (Возврат/Отмена)".

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

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

'''Пример запроса изменения статуса:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8" ?>
<setorderinfo>
<auth extra="8" login="login" pass="pass" />
<order ordercode="123456" date="2018-03-01" time="10:00" message="Клиент отказался от покупки"/>
<order ordercode="234567" date="2018-03-01" time="10:00" message="">
<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''''' - Внутренний код заказа.
:* '''''date''''' - Дата изменения статуса.
:* '''''time''''' - Время изменения статуса.
:* '''''message''''' - текст сообщения.

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

== Получение накладной в формате pdf ==

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

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

'''waybill''' - Корневой контейнер. Обязательный элемент.
*'''auth''' - Авторизация. Обязательный элемент.
*'''orderno''' - Номер/код заказа. Обязательный элемент.
*'''form''' - Формат накладной. Не обязательный элемент. Принимает значения:
:* 1 - Подробная накладная (по-умолчанию)
:* 2 - Наклейки (Zebra)

'''Пример ответа:'''
<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" ?>
<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>

== Справочник городов ==

'''Пример запроса справочника городов:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<townlist>
<codesearch>
<zipcode>110000</zipcode>
<kladrcode>0100000100800</kladrcode>
<fiascode>bd21979d-46f8-49d0-9105-e8d65172a983</fiascode>
<code>123</code>
</codesearch>
<conditions>
<city>Краснодарский край</city>
<namecontains>новгород</namecontains>
<namestarts>Моск</namestarts>
<name>Москва</name>
<fullname>Москва город</fullname>
<country>1</country>
</conditions>
<limit>
<limitfrom>30</limitfrom>
<limitcount>10</limitcount>
<countall>YES</countall>
</limit>
</townlist>
</source>

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

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

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

'''Пример ответа:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<townlist count="3" page="1" totalcount="3" totalpages="1">
<town>
<code>26379</code>
<city>
<code>23</code>
<name>Краснодарский край</name>
</city>
<name>Сочи город</name>
<shortname>Сочи</shortname> (not yet supported)
<typename>город</typename> (not yet supported)
</town>
<town>
<code>40331</code>
<city>
<code>32</code>
<name>Брянская область</name>
</city>
<name>Сочилов хутор</name>
<shortname>Сочилов</shortname>
<typename>хутор</typename>
</town>
<town>
<code>114016</code>
<city>
<code>60</code>
<name>Псковская область</name>
</city>
<name>Сочихино деревня</name>
<shortname>Сочихино</shortname>
<typename>деревня</typename>
</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>1</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>
<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>
</conditions>
<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 - Все. ''Это поле может быть недоступным в некоторых установках.''

*'''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>
<CountInPallet>30</CountInPallet>
<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''' - Высота в сантиметрах.
*'''CountInPallet''' - Количество штук в паллете.
*'''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>
</itemmovements>
</source>

*'''code''' - внутренний код товара в справочнике номенклатуры.

'''Пример ответа движения номенклатуры:'''
<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''' - номер документа
:* '''date''' - дата документа
:* '''message''' - комментарий

== Справочник пунктов самовывоза ==

'''Пример запроса пунктов самовывоза:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8" ?>
<pvzlist>
<auth extra="8" login="login" pass="pass"></auth>
<town>Нижний Тагил</town>
</pvzlist>
</source>

*'''town''' - Город получателя.

'''Пример ответа справочника пунктов самовывоза:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8" ?>
<pvzlist count="2">
<pvz>
<code>126</code>
<clientcode>3</clientcode>
<name>Нижний Тагил</name>
<address>622036, г. Нижний Тагил, ул. Циолковского, д. 17</address>
<phone>+73435417709, +73435254989</phone>
<comment>Жилое 5-ти этажное здание, торцом к дороге, второе здание от перекрестка Пархоменко-Циолковского.</comment>
</pvz>
<pvz>
<code>245</code>
<clientcode>NTG1</clientcode>
<name>На Красноармейской</name>
<address>КРАСНОАРМЕЙСКАЯ, д.79</address>
<phone>+7(3435)379-044</phone>
<comment>Время работы: пн.-пт. 9-18, сб. 10-14</comment>
</pvz>
</pvzlist>
</source>

*'''code''' - Код ПВЗ в системе. Используется в запросе [[API#Оформление заказа|оформления заказов]]
*'''clientcode''' - Код ПВЗ используемый компанией-подрядчиком.
*'''name''' - Наименование ПВЗ.
*'''address''' - Адрес ПВЗ.
*'''phone''' - Телефоны ПВЗ.
*'''comment''' - Дополнительная информация.

== Справочник Видов срочности ==

'''Пример запроса Видов срочности:'''
<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" ?>
<calculator>
<auth extra="8" login="login" pass="pass" />
<calc townfrom="Москва" townto="3800000300000" l="10" w="20" h="30" mass="3.7" service="1" />
</calculator>
</source>

Параметры:
*'''townfrom''' - Город-отправитель
*'''townto''' - Город-получатель
*'''l''' - Длина в сантиметрах (не обязательный параметр)
*'''w''' - Ширина в сантиметрах (не обязательный параметр)
*'''h''' - Высота в сантиметрах (не обязательный параметр)
*'''mass''' - Масса в килограммах
*'''service''' - Режим доставки - число, указывающее на запись в справочнике [[#Справочник Видов срочности|видов срочности]]. Если этот параметр опустить, система выдаст расчет для всех доступных видов срочности, передав много контейнеров <calc> в ответе.

В авторизации можно опустить параметры 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>1163</price>
<maxdeliverydays>3</maxdeliverydays>
</calc>
</calculator>
</source>

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

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

== Список актов передачи денег ==

'''Пример запроса списка актов передачи денег:'''
<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>
<price>637.00</price>
<rur>13430.00</rur>
<pricekur>570.00</pricekur>
<priceag>67.00</priceag>
<payno>42423</payno>
<paytype>1</paytype>
<paytypename>Безнал</paytypename>
</sma>
</smalist>
</source>

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

== Детализация актов передачи денег ==

'''Пример запроса детализации актов передачи денег:'''
<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>
<status>Доставлено</status>
</specialsma>
</smadetail>
</source>

*'''code''' - Код записи.
*'''ordercode''' - Код заказа.
*'''orderno''' - Шифр заказа.
*'''orderdate''' - Дата заказа.
*'''delivereddate''' - Дата доставки.
*'''company''' - Получатель.
*'''price''' - Стоимость услуг.
*'''rur''' - Сумма заказа.
*'''inshprice''' - Стоимость заказа.
*'''pricekur''' - Стоимость курьерской доставки.
*'''priceag''' - Агентское вознаграждение.
*'''pricecalc''' - Сумма для передачи агенту.
*'''paytype''' - Тип оплаты: 1 - безнал, 2 - наличными курьером, 3 - наличными в офисе, 4 - перевод на карту.
*'''paytypename''' - Строковое представление типа оплаты
*'''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</nowiki>

API

2018-11-20T09:20:48Z

Boyko: /* Расчет стоимости доставки */

<div style="font-size: 24px; 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>

В системе "Курьерская служба 2008" имеется возможность интеграции средствами XML API, по протоколу HTTP POST.

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

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

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

== Готовые интеграции ==

Для интеграции с популярными CMS можно скачать модули интеграции

{| class="wikitable" align="center" style="width: 80%; margin: auto; color: black; boreder: 1px solid #999999;" cellpadding="10" cellspacing="0"
!style="width: 35%;"|Система управления контентом (CMS)
!style="width: 15%;"|Версия модуля
!style="width: 15%;"|Ссылка
!style="width: 35%;"|Примечание
|-
|[[Файл:bitrix.png|center|x44px]]
|style="text-align: center;"|1.5.9 от 12.03.2018
|style="text-align: center;"|[http://courierexe.ru/download/api/bitrix.zip Скачать Unicode]<br>[http://courierexe.ru/download/api/bitrix_ansi.zip Скачать ANSI]
|Поддерживает версии 14.5 и выше
|-
|[[Файл:prestashop.png|center|x44px]]
|style="text-align: center;"|1.4.5 от 10.10.2018
|style="text-align: center;"|[http://courierexe.ru/download/api/prestashop.zip Скачать]
|Поддерживает версии 1.5.2.0 и выше (2.x в том числе!)
|-
|[[Файл:opencart.png|center|x44px]] [[Файл:ocstore.png|center|x30px]]
|style="text-align: center;"|1.7.5 от 10.08.2018
|style="text-align: center;"|[http://courierexe.ru/download/api/opencart.zip Скачать]
|Поддерживает версии с 1.5.5.1 по 2.2.<br>
[https://opencartforum.com/files/file/2906-avtomatizaciya-otpravki-i-otslezhivanie-dostavok-courierexe-dlya-opencart-15x/ Альтернативный модуль сторонних разработчиков]
|-
|[[Файл:webasyst-shopscript.png|center|x44px]]
|style="text-align: center;"|1.3.5 от 14.03.2018
|style="text-align: center;"|[http://www.webasyst.ru/store/plugin/shop/measoftcourier/ Установить]
|
|-
|[[Файл:insales.png|center|x44px]]
|style="text-align: center;"|1.2.1 от 06.09.2017
|style="text-align: center;"|[http://www.insales.ru/collection/all/product/kurierskaya-sluzhba-2008 Установить]
|[[Интеграция_с_другими_системами#Insales|Настраивается]] в ЛК пользователя в системе
|-
|[[Файл:Leadvertex.png|center|x44px]]
|style="text-align: center;"|1.0 от 15.11.2016
|style="text-align: center;"|[[Файл:Leadvertex-howto.png|center|x44px]]
|[http://blog.leadvertex.ru/news/2110-integraciya-s-kurerkami-na-platforme-measoft/ Настраивается] в ЛК пользователя в системе [https://Leadvertex.ru Leadvertex]
|-
|[[Файл:Retailcrm.png|center|x44px]]
|style="text-align: center;"|1.0 от 11.01.2018
|style="text-align: center;"|[https://www.retailcrm.ru/ RetailCRM]
|[[Интеграция_с_другими_системами#RetailCRM|Настраивается]] в ЛК пользователя в системе
|-
|[[Файл:1C.jpg|center|x44px]]
|style="text-align: center;"|1.4 от 17.11.2017
|style="text-align: center;"|-
|[https://infostart.ru/public/692790/ Альтернативный модуль сторонних разработчиков]
|-
|[[Файл:Joomla2.jpg|center|x44px]]
|style="text-align: center;"|1.0.0 от 12.11.2018
|style="text-align: center;"|[http://courierexe.ru/download/api/com_measoft.zip Скачать]
|Внимание! Модуль новый, поэтому возможна некорректная передача данных.
|-
|AMO CRM
|style="text-align: center;"|-
|style="text-align: center;"|-
|Ожидается в ближайшее время в магазине Amo
|-
|Мой склад
|style="text-align: center;"|-
|style="text-align: center;"|-
|Ожидается в ближайшее время в магазине Мой Склад
|-
|}

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

== Тестовый аккаунт ==

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

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

== Рабочий аккаунт для подключения ==

Для подключения к площадке Вашего клиента необходимо иметь три параметра:

1. '''Параметр extra''' (Цифровой код, уникальный идентификатор компании. Запросите этот параметр у компании, с которой Вы интегрируетесь). Посмотреть этот код можно в интерфейсе программы КС2008 через основное меню '''"Справочники - Дополнительные возможности"'''. Цифровое значение будет указано во второй гиперссылке (на скриншоте ниже отмечено "звездочкой"):

[[Файл:extra1.png|750px]]

2. '''Логин''' - параметр учетной записи для ЛК клиента и API, указывается в карточке клиента на вкладке '''"Прочее"''' в поле '''"Имя пользователя"'''. Возможно, что в программе КС2008 понадобится создать новую карточку клиента (на скриншоте ниже).

3. '''Пароль''' - параметр учетной записи для ЛК клиента и API, указывается в карточке клиента на вкладке '''"Прочее"''' в поле '''"Пароль"''' (на скриншоте ниже).

[[Файл:33_client.png|500px]]

== Общие понятия ==

На стороне курьерской службы имеется веб-сервис по адресу: https://home.courierexe.ru/api/. Тестовые авторизационные данные: логин: test пароль: testm, параметр 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; < на &lt; > на &gt; " на &quot;

== Ограничения ==
С целью защиты от нецелевого использования сервисов, с 29.05.2017 ведено ограничение на запросы - 1500 запросов с одного IP-адреса за 20 минут. В случае превышения IP-адрес блокируется, разблокировка возможна путем обращения в техническую поддержку, с последующим обсуждением ваших алгоритмов и их коррекцией.

Для проверки статусов заказов лучше всего использовать запросы [[#Передача только изменившихся статусов|"statusreq" с параметром changes=ONLY_LAST]]. Не нужно пытаться "бомбить" наше API запросами с номерами всех ваших заказов, особенно - запросами "tracking", они предназначены не для этого (смотрите описание).

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

<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>Чип & Дейл</person>
<phone>123-45-67</phone>
<zipcode>125480</zipcode>
<town>Санкт-Петербург</town>
<address>Петровка 38 офис 35</address>
<date>2014-03-22</date>
<time_min>09:00</time_min>
<time_max>14:00</time_max>
</receiver>
<return>NO</return>
<weight>5.1</weight>
<return_weight>5.1</return_weight>
<quantity>2</quantity>
<paytype>CASH</paytype>
<service>2</service>
<return_service>1</return_service>
<type>3</type>
<return_type>3</return_type>
<price>387.5</price>
<deliveryprice>150</deliveryprice>
<discount>0</discount>
<inshprice>387.5</inshprice>
<enclosure>Детские игрушки</enclosure>
<instruction>Проверить при покупателе, подписать акт</instruction>
<pvz>124</pvz>
<department>Отдел</department>
<pickup>NO</pickup>
<acceptpartially>NO</acceptpartially>
<items>
<item extcode="abc123" quantity="1" mass="0.2" retprice="37.5" VATrate="0" barcode="2345625213125" article="1" volume="3">Мяч</item>
<item extcode="abc124" quantity="2" mass="2" retprice="100" VATrate="10" barcode="4645625213138" article="2" length="10" width="20" height="30">Обруч</item>
<item extcode="abc125" quantity="3" mass="0.3" retprice="50" barcode="2345625213126" article="3">Погремушка желтая</item>
</items>
</order>
</neworder>
</source>

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

*'''neworder''' - Корневой контейнер, обязательный элемент.

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

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

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

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

*'''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>Город получателя в формате "Москва город"</town>
<address>Адрес получателя</address>
<date>Дата доставки в формате "YYYY-MM-DD"</date>
<time_min>Желаемое время доставки в формате "HH:MM"</time_min>
<time_max>Желаемое время доставки в формате "HH:MM"</time_max>
</receiver>
</source>

*'''company''' - Компания-получатель.
*'''person''' - Контактное лицо. ''Должно быть заполнено хотя бы одно из полей - company или person!''
*'''phone''' - Телефон. Можно указывать несколько телефонов, E-mail в этом поле.
*'''town''' - Город.

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

*'''paytype''' - Тип оплаты заказа получателем. Принимает значения:
:* CASH - Наличными при получении (по-умолчанию)
:* CARD - Картой при получении
:* NO - Без оплаты. Поле Price будет проигнорировано. (Этот тип оплаты передается, если заказ уже оплачен и не требует инкассации, API добавит в систему товары по нулевой цене. Если необходимо передать общую сумму заказа - можно это сделать в поле <inshprice>, указав объявленную ценность)
:* OTHER - Прочее (Предусмотрен для того, чтобы оплата поступала непосредственно в курьерскую службу посредством прочих типов оплаты - таких как: вебмани, яденьги, картой на сайте, прочие платежные системы и т.д.)
:* OPTION - На выбор получателя. Этот тип оплаты нельзя передавать с заказом. Он выставляется автоматически в зависимости от настройки клиента.

*'''zipcode''' - Почтовый индекс.
*'''weight''' - Общий вес заказа в килограммах.
*'''return_weight''' - Общий вес возврата заказа в килограммах.
*'''quantity''' - Количество мест.
*'''service''' - Режим доставки (тип услуги) передается код из справочника "Виды срочности".
*'''return_service''' - Режим возврата (тип услуги) передается код из справочника "Виды срочности".
*'''type''' - Тип корреспонденции (отправления) передается код из справочника "Типы корреспонденции".
*'''return_type''' - Тип возвратной корреспонденции (отправления) передается код из справочника "Типы корреспонденции".
*'''price''' - Сумма заказа. В случае наличия контейнера items значение данного параметра будет проигнорировано, и рассчитано автоматически.
*'''deliveryprice''' - Сумма доставки. В случае наличия контейнера items, в него будет добавлено вложение "Доставка".
*'''discount''' - Скидка на заказ. В результате сумма заказа будет уменьшена на размер скидки.
*'''return''' - Признак необходимости возврата.
*'''return_service''' - Режим возврата (тип услуги) передается код из справочника "Виды срочности".
*'''enclosure''' - Вложение.
*'''inshprice''' - Объявленная ценность.
*'''instruction''' - Поручение - Примечание.
*'''pvz''' - Код пункта самовывоза по [[#Справочник пунктов самовывоза|справочнику]]
*'''department''' - Подразделение, в котором оформляется заказ.
*'''pickup''' - Признак оформления забора YES/NO. Если стоит YES, то весь заказ считается заданием на забор груза, а не на доставку! Применяется для вызова курьера к отправителю для забора других отправлений.
*'''acceptpartially''' - Признак возможности частичного выкупа товаров отправления YES/NO.

*'''items''' - Контейнер для описания вложенных товаров. Необязательный контейнер. Атрибуты:
:* '''''item''''' - Название товара.
:* '''''quantity''''' - Количество единиц товара.
:* '''''mass''''' - Масса единицы товара в килограммах.
:* '''''volume''''' - Объемный вес единицы товара в килограммах. При указании объемного веса значение подставляется вместо массы
:* '''''length''''' - Длина единицы товара.
:* '''''width''''' - Ширина единицы товара.
:* '''''height''''' - Высота единицы товара.
:* '''''retprice''''' - Цена единицы товара.
:* '''''VATrate''''' - Ставка НДС - целое число процентов. Если значение не указано, подставляется значение "18".
:* '''''barcode''''' - Штрих-код товара. [[Файл:Article.png|thumb|100px|right]]
:* '''''article''''' - Артикул товара. ''Внимание!'' Указание артикула используется только тогда, когда товар хранится на ответственном хранении в службе доставки, и необходима комплектация. В этом случае система пытается привязать товар к [[API#Справочник номенклатуры|справочнику номенклатуры]]. Если товар в справочнике не найден - система выдаст соответствующую ошибку. Если по артикулу найдено несколько товаров - система выберет один из них случайным образом, что может привести к ошибочной комплектации! Если товар НЕ на ответственном хранении - артикул указывать НЕ нужно. Позиция попадет в систему просто текстом.
:* '''''extcode''''' - Внешний код строки. Используется для идентификации строк заказов при получении статусов. Необязательное поле. ПОКА НЕ ПОДДЕРЖИВАЕТСЯ.

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

=== Примеры ответов ===

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

<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<neworder>
<createorder orderno="AB23541" error="0" errormsg="success"></createorder>
<createorder orderno="55_6542" error="0" errormsg="success"></createorder>
<createorder orderno="AB23542" error="0" errormsg="success"></createorder>
</neworder>
</source>

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

<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<neworder>
<createorder orderno="AB23541" error="17" errormsg="Such number exists"></createorder>
<createorder orderno="AB23542" error="13" errormsg="empty company"></createorder>
<createorder orderno="AB23543" error="14" errormsg="empty person"></createorder>
</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>

=== Коды ошибок при оформлении заказа ===

0 - Ошибок нет.

1 - Ошибка авторизации. (отсутствуют теги <auth login="" pass=""></auth>, неверный логин или пароль).

2 - Отправлен пустой запрос (отсутствует контейнер <neworder></neworder> в XML документе).

3 - Некорректно указана сумма заказа.

4 - Некорректный общий вес заказа.

5 - Не найден город получатель.

6 - Не найден город отправитель.

7 - Не заполнен адрес получателя.

8 - Не заполнен телефон получателя.

9 - Не заполнено контактное имя получателя.

10 - Не заполнено название компании получателя.

11 - Некорректная сумма объявленной ценности.

12 - Артикул не найден.

13 - Не заполнено название компании отправителя.

14 - Не заполнено контактное имя отправителя.

15 - Не заполнен телефон отправителя.

16 - Не заполнен адрес отправителя.

17 - Заказ с таким номером уже существует.

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

=== Пример запроса статуса заказа ===

<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>
<ordercode>34234</ordercode>
<givencode>234534</givencode>
<datefrom>2016-07-21</datefrom>
<dateto>2016-07-21</dateto>
<target>Автозавод</target>
<done>ONLY_NOT_DONE</done>
<changes>ONLY_LAST</changes>
<quickstatus>NO</quickstatus>
</statusreq>
</source>

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

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

*'''changes''' - может принимать значение только ONLY_LAST. Если указан этот параметр, все остальные, кроме quickstatus, игнорируются. Описание данного режима приведено здесь: [[#Передача только изменившихся статусов|Передача только изменившихся статусов]]

*'''quickstatus''' - Указывает "глубину" передаваемых статусов: "YES" (по-умолчанию) - передаются статусы начиная с информации, поступившей от курьера. Такие статусы являются быстрыми (как правило, проставляются курьером сразу после доставки) но не всегда точными. Значение NO запрещает передачу статуса со слов курьера, и выдает только статусы, введенные оператором, как правило вручную. На это требуется больше времени, однако точность гораздо выше. Не рекомендуется совмещать эти типы передачи статусов (чередовать их) при запросе только изменившихся статусов, т.к. в этом случае система будет считать, что статусы у отправлений меняются.

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

=== Примеры ответов ===

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

<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<statusreq count="23">
<order orderno="111111" 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>
<zipcode>125480</zipcode>
<town code="23432">Санкт-Петербург</town>
<address>Петровка 38 офис 35</address>
<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>
</receiver>
<weight>5.1</weight>
<return_weight>5.1</return_weight>
<quantity>2</quantity>
<paytype>CASH</paytype>
<service>2</service>
<return_service>2</service>
<type>3</type>
<return_type>3</return_type>
<waittime>12</waittime>
<price>387.5</price>
<print_check>YES</print_check>
<inshprice>387.5</inshprice>
<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">
<>..</> (price details are not yet supported)
..
</deliveryprice>
<receiverpays>NO</receiverpays>
<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>
<customstatecode>2<customstatecode>
<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">Мяч</item>
<item code="34456" extcode="abc124" quantity="2" mass="2" retprice="100" VATrate="10" barcode="4645625213138" article="2" returns="0">Обруч</item>
<item code="34421" extcode="abc125" quantity="3" mass="0.3" retprice="50" VATrate="18" barcode="2345625213126" article="3" returns="0">Погремушка желтая</item>
</items>
<packages>
<package code="33123" strbarcode="4625333555001" mass="0" message="">Место 1</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''':
:* '''''ordercode''''' - внутренний код заказа в системе, применяется для некоторых внутренних операций.
:* '''''givencode''''' - внутренний код заказа в системе, применяется для некоторых внутренних операций.
:* '''''returns''''' - количество данного товара, от которого отказался получатель. Не нулевое только в случае частичного отказа.

* атрибут '''''code''''' контейнера '''item''' - внутренний код строки заказа в системе, применяется для некоторых внутренних операций.
* '''''coords''''' в контейнере '''receiver''' - координаты получателя.
* '''currcoords''' - текущие координаты заказа. Атрибуты:
:* '''''lat''''' - широта
:* '''''lon''''' - долгота
:* '''''accuracy''''' - точность в метрах
:* '''''RequestDateTime''''' - дата/время последнего обновления координат.

* '''waittime ''' - Время ожидания курьера.
* '''deliveryprice''' - стоимость доставки в валюте расчетов с клиентом.
* '''status''' - статус доставки (список статусов см. ниже). Атрибуты (заполняются начиная с версии системы 2008.0.0.670):
:* '''''eventstore''''' - филиал, к которому относится текущий статус
:* '''''eventtime''''' - время изменения статуса (время зависит от местонахождения филиала)
:* '''''createtimegmt''''' - время фактического изменения статуса (GMT)
:* '''''message''''' - наименование филиала-получателя, при передаче между филиалами
:* '''''title''''' - русское наименование статуса

* '''statushistory''' - история статусов доставки. Содержит список контейнеров '''status'''. Заполняется только для тарифа "Премиум" начиная с версии системы 2008.0.0.670.
* '''customstatecode''' - код внутреннего статуса курьерской службы. Значения уточняйте в курьерской службе. Назначаются курьерской службой в разделе "Справочники" - "Статусы" - "15 Статусы корреспонденции". Справочник не передается через API клиенту по причине возможного наличия в нем внутренних технологических статусов курьерской службы.
* '''clientstatecode''' - код статуса клиента. Используется, если клиент предлагает свои коды статусов доставки/причин недоставки.
* '''deliveredto''' - данные о вручении, либо причина недоставки.
* '''delivereddate''' - дата вручения.
* '''deliveredtime''' - время вручения. В случае недоставки может быть пустым.
* '''outstrbarcode''' - код у подрядчика (код заказа во внешней системе). Используется в интеграциях с внешними системами.

*'''packages''' - Контейнер для описания мест. Необязательный контейнер. Атрибуты:
:* '''''package''''' - Название места.
:* '''''code''''' - Внутренний код строки.
:* '''''strbarcode''''' - Штрих-код места.
:* '''''mass''''' - Масса места в килограммах.
:* '''''message''''' - Строка сообщения.

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

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

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

# Атрибуты контейнера '''status''' заполняются для версий системы '''2008.0.0.670''' и новее.
# Контейнер '''statushistory''' заполняется для тарифа "[[Личный_кабинет#.D0.9F.D0.BE.D0.B4.D0.BA.D0.BB.D1.8E.D1.87.D0.B5.D0.BD.D0.B8.D0.B5|Премиум]]" и версий системы '''2008.0.0.670''' и новее.
</div>
<br />

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

Для получения только изменившихся статусов отправьте запрос
<source lang="xml">
<?xml version="1.0" encoding="UTF-8" ?>
<statusreq>
<auth extra="8" login="login" pass="pass"></auth>
<changes>ONLY_LAST</changes>
<quickstatus>NO</quickstatus>
</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>
</commitlaststatus>
</source>

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

*'''auth''' - Авторизация. Обязательный элемент.
*'''client''' - Признак клиента или агента. Необязательный элемент.
:* CLIENT - Признак клиента, значение по умолчанию
:* AGENT - Признак агента. В ответ отдается информация по заказам, переданным агенту на доставку

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

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

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

# При данном способе передачи (<changes>ONLY_LAST</changes>) система просматривает заказы, оформленные за последние 3 месяца. Если заказ сделан ранее - изменение статуса по нему не попадет в результат выполнения данного запроса.
# Система всегда выдает текущий статус. Т.е. Вы можете одним запросом получить статус "NEW", а следующим - "COMPLETE". В промежутке между запросами отправление могло пройти через несколько промежуточных статусов.
# Система никогда не гарантирует последовательность прохождения заказом набора статусов. Т.е. Вы можете получить статус "COMPLETE", а следующим запросом - "NEW" - такое может произойти, например, если оператор ошибочно отметил заказ выполненным, а затем исправил ошибку.
</div>
<br />

== Получение вложений к накладной ==

'''Пример запроса:'''
<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.

== Трекинг заказа по номеру ==

Запрос трекинга по номеру предназначен для выдачи минимальной обезличенной информации о конкретном заказе не авторизованному пользователю. Наша система имеет для этого интерфейс по адресу "home.courierexe.ru/{код экстра}/tracking". Вы можете либо сделать ссылку на такую страницу на своем сайте, либо разместить ее 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="1234">
<sender>
<town code="1">Москва город</town>
<date></date>
</sender>
<receiver>
<town code="1">Москва город</town>
<date>2015-04-18</date>
</receiver>
<weight>0</weight>
<quantity>1</quantity>
<currcoords lat="" lon="" accuracy="" RequestDateTime="" />
<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>
</order>
</tracking>
</source>

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

== Изменение статуса агентом ==

Запрос изменения статуса заказа позволяет установить окончательный статус заказа - "Доставлен" или "Не доставлен (Возврат/Отмена)".

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

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

'''Пример запроса изменения статуса:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8" ?>
<setorderinfo>
<auth extra="8" login="login" pass="pass" />
<order ordercode="123456" date="2018-03-01" time="10:00" message="Клиент отказался от покупки"/>
<order ordercode="234567" date="2018-03-01" time="10:00" message="">
<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''''' - Внутренний код заказа.
:* '''''date''''' - Дата изменения статуса.
:* '''''time''''' - Время изменения статуса.
:* '''''message''''' - текст сообщения.

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

== Получение накладной в формате pdf ==

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

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

'''waybill''' - Корневой контейнер. Обязательный элемент.
*'''auth''' - Авторизация. Обязательный элемент.
*'''orderno''' - Номер/код заказа. Обязательный элемент.
*'''form''' - Формат накладной. Не обязательный элемент. Принимает значения:
:* 1 - Подробная накладная (по-умолчанию)
:* 2 - Наклейки (Zebra)

'''Пример ответа:'''
<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" ?>
<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>

== Справочник городов ==

'''Пример запроса справочника городов:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<townlist>
<codesearch>
<zipcode>110000</zipcode>
<kladrcode>0100000100800</kladrcode>
<fiascode>bd21979d-46f8-49d0-9105-e8d65172a983</fiascode>
<code>123</code>
</codesearch>
<conditions>
<city>Краснодарский край</city>
<namecontains>новгород</namecontains>
<namestarts>Моск</namestarts>
<name>Москва</name>
<fullname>Москва город</fullname>
<country>1</country>
</conditions>
<limit>
<limitfrom>30</limitfrom>
<limitcount>10</limitcount>
<countall>YES</countall>
</limit>
</townlist>
</source>

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

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

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

'''Пример ответа:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<townlist count="3" page="1" totalcount="3" totalpages="1">
<town>
<code>26379</code>
<city>
<code>23</code>
<name>Краснодарский край</name>
</city>
<name>Сочи город</name>
<shortname>Сочи</shortname> (not yet supported)
<typename>город</typename> (not yet supported)
</town>
<town>
<code>40331</code>
<city>
<code>32</code>
<name>Брянская область</name>
</city>
<name>Сочилов хутор</name>
<shortname>Сочилов</shortname>
<typename>хутор</typename>
</town>
<town>
<code>114016</code>
<city>
<code>60</code>
<name>Псковская область</name>
</city>
<name>Сочихино деревня</name>
<shortname>Сочихино</shortname>
<typename>деревня</typename>
</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>1</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>
<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>
</conditions>
<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 - Все. ''Это поле может быть недоступным в некоторых установках.''

*'''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>
<CountInPallet>30</CountInPallet>
<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''' - Высота в сантиметрах.
*'''CountInPallet''' - Количество штук в паллете.
*'''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>
</itemmovements>
</source>

*'''code''' - внутренний код товара в справочнике номенклатуры.

'''Пример ответа движения номенклатуры:'''
<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''' - номер документа
:* '''date''' - дата документа
:* '''message''' - комментарий

== Справочник пунктов самовывоза ==

'''Пример запроса пунктов самовывоза:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8" ?>
<pvzlist>
<auth extra="8" login="login" pass="pass"></auth>
<town>Нижний Тагил</town>
</pvzlist>
</source>

*'''town''' - Город получателя.

'''Пример ответа справочника пунктов самовывоза:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8" ?>
<pvzlist count="2">
<pvz>
<code>126</code>
<clientcode>3</clientcode>
<name>Нижний Тагил</name>
<address>622036, г. Нижний Тагил, ул. Циолковского, д. 17</address>
<phone>+73435417709, +73435254989</phone>
<comment>Жилое 5-ти этажное здание, торцом к дороге, второе здание от перекрестка Пархоменко-Циолковского.</comment>
</pvz>
<pvz>
<code>245</code>
<clientcode>NTG1</clientcode>
<name>На Красноармейской</name>
<address>КРАСНОАРМЕЙСКАЯ, д.79</address>
<phone>+7(3435)379-044</phone>
<comment>Время работы: пн.-пт. 9-18, сб. 10-14</comment>
</pvz>
</pvzlist>
</source>

*'''code''' - Код ПВЗ в системе. Используется в запросе [[API#Оформление заказа|оформления заказов]]
*'''clientcode''' - Код ПВЗ используемый компанией-подрядчиком.
*'''name''' - Наименование ПВЗ.
*'''address''' - Адрес ПВЗ.
*'''phone''' - Телефоны ПВЗ.
*'''comment''' - Дополнительная информация.

== Справочник Видов срочности ==

'''Пример запроса Видов срочности:'''
<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" ?>
<calculator>
<auth extra="8" login="login" pass="pass" />
<calc townfrom="Москва" townto="3800000300000" l="10" w="20" h="30" mass="3.7" service="1" />
</calculator>
</source>

Параметры:
*'''townfrom''' - Город-отправитель
*'''townto''' - Город-получатель
*'''l''' - Длина в сантиметрах (не обязательный параметр)
*'''w''' - Ширина в сантиметрах (не обязательный параметр)
*'''h''' - Высота в сантиметрах (не обязательный параметр)
*'''mass''' - Масса в килограммах
*'''service''' - Режим доставки - число, указывающее на запись в справочнике [[#Справочник Видов срочности|видов срочности]]. Если этот параметр опустить, система выдаст расчет для всех доступных видов срочности, передав много контейнеров <calc> в ответе.

В авторизации можно опустить параметры 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>1163</price>
<maxdeliverydays>3</maxdeliverydays>
</calc>
</calculator>
</source>

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

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

== Список актов передачи денег ==

'''Пример запроса списка актов передачи денег:'''
<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>
<price>637.00</price>
<rur>13430.00</rur>
<pricekur>570.00</pricekur>
<priceag>67.00</priceag>
<payno>42423</payno>
<paytype>1</paytype>
<paytypename>Безнал</paytypename>
</sma>
</smalist>
</source>

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

== Детализация актов передачи денег ==

'''Пример запроса детализации актов передачи денег:'''
<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>
<status>Доставлено</status>
</specialsma>
</smadetail>
</source>

*'''code''' - Код записи.
*'''ordercode''' - Код заказа.
*'''orderno''' - Шифр заказа.
*'''orderdate''' - Дата заказа.
*'''delivereddate''' - Дата доставки.
*'''company''' - Получатель.
*'''price''' - Стоимость услуг.
*'''rur''' - Сумма заказа.
*'''inshprice''' - Стоимость заказа.
*'''pricekur''' - Стоимость курьерской доставки.
*'''priceag''' - Агентское вознаграждение.
*'''pricecalc''' - Сумма для передачи агенту.
*'''paytype''' - Тип оплаты: 1 - безнал, 2 - наличными курьером, 3 - наличными в офисе, 4 - перевод на карту.
*'''paytypename''' - Строковое представление типа оплаты
*'''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</nowiki>

API

2018-11-20T09:20:13Z

Boyko: /* Расчет стоимости доставки */

<div style="font-size: 24px; 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>

В системе "Курьерская служба 2008" имеется возможность интеграции средствами XML API, по протоколу HTTP POST.

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

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

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

== Готовые интеграции ==

Для интеграции с популярными CMS можно скачать модули интеграции

{| class="wikitable" align="center" style="width: 80%; margin: auto; color: black; boreder: 1px solid #999999;" cellpadding="10" cellspacing="0"
!style="width: 35%;"|Система управления контентом (CMS)
!style="width: 15%;"|Версия модуля
!style="width: 15%;"|Ссылка
!style="width: 35%;"|Примечание
|-
|[[Файл:bitrix.png|center|x44px]]
|style="text-align: center;"|1.5.9 от 12.03.2018
|style="text-align: center;"|[http://courierexe.ru/download/api/bitrix.zip Скачать Unicode]<br>[http://courierexe.ru/download/api/bitrix_ansi.zip Скачать ANSI]
|Поддерживает версии 14.5 и выше
|-
|[[Файл:prestashop.png|center|x44px]]
|style="text-align: center;"|1.4.5 от 10.10.2018
|style="text-align: center;"|[http://courierexe.ru/download/api/prestashop.zip Скачать]
|Поддерживает версии 1.5.2.0 и выше (2.x в том числе!)
|-
|[[Файл:opencart.png|center|x44px]] [[Файл:ocstore.png|center|x30px]]
|style="text-align: center;"|1.7.5 от 10.08.2018
|style="text-align: center;"|[http://courierexe.ru/download/api/opencart.zip Скачать]
|Поддерживает версии с 1.5.5.1 по 2.2.<br>
[https://opencartforum.com/files/file/2906-avtomatizaciya-otpravki-i-otslezhivanie-dostavok-courierexe-dlya-opencart-15x/ Альтернативный модуль сторонних разработчиков]
|-
|[[Файл:webasyst-shopscript.png|center|x44px]]
|style="text-align: center;"|1.3.5 от 14.03.2018
|style="text-align: center;"|[http://www.webasyst.ru/store/plugin/shop/measoftcourier/ Установить]
|
|-
|[[Файл:insales.png|center|x44px]]
|style="text-align: center;"|1.2.1 от 06.09.2017
|style="text-align: center;"|[http://www.insales.ru/collection/all/product/kurierskaya-sluzhba-2008 Установить]
|[[Интеграция_с_другими_системами#Insales|Настраивается]] в ЛК пользователя в системе
|-
|[[Файл:Leadvertex.png|center|x44px]]
|style="text-align: center;"|1.0 от 15.11.2016
|style="text-align: center;"|[[Файл:Leadvertex-howto.png|center|x44px]]
|[http://blog.leadvertex.ru/news/2110-integraciya-s-kurerkami-na-platforme-measoft/ Настраивается] в ЛК пользователя в системе [https://Leadvertex.ru Leadvertex]
|-
|[[Файл:Retailcrm.png|center|x44px]]
|style="text-align: center;"|1.0 от 11.01.2018
|style="text-align: center;"|[https://www.retailcrm.ru/ RetailCRM]
|[[Интеграция_с_другими_системами#RetailCRM|Настраивается]] в ЛК пользователя в системе
|-
|[[Файл:1C.jpg|center|x44px]]
|style="text-align: center;"|1.4 от 17.11.2017
|style="text-align: center;"|-
|[https://infostart.ru/public/692790/ Альтернативный модуль сторонних разработчиков]
|-
|[[Файл:Joomla2.jpg|center|x44px]]
|style="text-align: center;"|1.0.0 от 12.11.2018
|style="text-align: center;"|[http://courierexe.ru/download/api/com_measoft.zip Скачать]
|Внимание! Модуль новый, поэтому возможна некорректная передача данных.
|-
|AMO CRM
|style="text-align: center;"|-
|style="text-align: center;"|-
|Ожидается в ближайшее время в магазине Amo
|-
|Мой склад
|style="text-align: center;"|-
|style="text-align: center;"|-
|Ожидается в ближайшее время в магазине Мой Склад
|-
|}

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

== Тестовый аккаунт ==

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

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

== Рабочий аккаунт для подключения ==

Для подключения к площадке Вашего клиента необходимо иметь три параметра:

1. '''Параметр extra''' (Цифровой код, уникальный идентификатор компании. Запросите этот параметр у компании, с которой Вы интегрируетесь). Посмотреть этот код можно в интерфейсе программы КС2008 через основное меню '''"Справочники - Дополнительные возможности"'''. Цифровое значение будет указано во второй гиперссылке (на скриншоте ниже отмечено "звездочкой"):

[[Файл:extra1.png|750px]]

2. '''Логин''' - параметр учетной записи для ЛК клиента и API, указывается в карточке клиента на вкладке '''"Прочее"''' в поле '''"Имя пользователя"'''. Возможно, что в программе КС2008 понадобится создать новую карточку клиента (на скриншоте ниже).

3. '''Пароль''' - параметр учетной записи для ЛК клиента и API, указывается в карточке клиента на вкладке '''"Прочее"''' в поле '''"Пароль"''' (на скриншоте ниже).

[[Файл:33_client.png|500px]]

== Общие понятия ==

На стороне курьерской службы имеется веб-сервис по адресу: https://home.courierexe.ru/api/. Тестовые авторизационные данные: логин: test пароль: testm, параметр 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; < на &lt; > на &gt; " на &quot;

== Ограничения ==
С целью защиты от нецелевого использования сервисов, с 29.05.2017 ведено ограничение на запросы - 1500 запросов с одного IP-адреса за 20 минут. В случае превышения IP-адрес блокируется, разблокировка возможна путем обращения в техническую поддержку, с последующим обсуждением ваших алгоритмов и их коррекцией.

Для проверки статусов заказов лучше всего использовать запросы [[#Передача только изменившихся статусов|"statusreq" с параметром changes=ONLY_LAST]]. Не нужно пытаться "бомбить" наше API запросами с номерами всех ваших заказов, особенно - запросами "tracking", они предназначены не для этого (смотрите описание).

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

<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>Чип & Дейл</person>
<phone>123-45-67</phone>
<zipcode>125480</zipcode>
<town>Санкт-Петербург</town>
<address>Петровка 38 офис 35</address>
<date>2014-03-22</date>
<time_min>09:00</time_min>
<time_max>14:00</time_max>
</receiver>
<return>NO</return>
<weight>5.1</weight>
<return_weight>5.1</return_weight>
<quantity>2</quantity>
<paytype>CASH</paytype>
<service>2</service>
<return_service>1</return_service>
<type>3</type>
<return_type>3</return_type>
<price>387.5</price>
<deliveryprice>150</deliveryprice>
<discount>0</discount>
<inshprice>387.5</inshprice>
<enclosure>Детские игрушки</enclosure>
<instruction>Проверить при покупателе, подписать акт</instruction>
<pvz>124</pvz>
<department>Отдел</department>
<pickup>NO</pickup>
<acceptpartially>NO</acceptpartially>
<items>
<item extcode="abc123" quantity="1" mass="0.2" retprice="37.5" VATrate="0" barcode="2345625213125" article="1" volume="3">Мяч</item>
<item extcode="abc124" quantity="2" mass="2" retprice="100" VATrate="10" barcode="4645625213138" article="2" length="10" width="20" height="30">Обруч</item>
<item extcode="abc125" quantity="3" mass="0.3" retprice="50" barcode="2345625213126" article="3">Погремушка желтая</item>
</items>
</order>
</neworder>
</source>

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

*'''neworder''' - Корневой контейнер, обязательный элемент.

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

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

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

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

*'''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>Город получателя в формате "Москва город"</town>
<address>Адрес получателя</address>
<date>Дата доставки в формате "YYYY-MM-DD"</date>
<time_min>Желаемое время доставки в формате "HH:MM"</time_min>
<time_max>Желаемое время доставки в формате "HH:MM"</time_max>
</receiver>
</source>

*'''company''' - Компания-получатель.
*'''person''' - Контактное лицо. ''Должно быть заполнено хотя бы одно из полей - company или person!''
*'''phone''' - Телефон. Можно указывать несколько телефонов, E-mail в этом поле.
*'''town''' - Город.

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

*'''paytype''' - Тип оплаты заказа получателем. Принимает значения:
:* CASH - Наличными при получении (по-умолчанию)
:* CARD - Картой при получении
:* NO - Без оплаты. Поле Price будет проигнорировано. (Этот тип оплаты передается, если заказ уже оплачен и не требует инкассации, API добавит в систему товары по нулевой цене. Если необходимо передать общую сумму заказа - можно это сделать в поле <inshprice>, указав объявленную ценность)
:* OTHER - Прочее (Предусмотрен для того, чтобы оплата поступала непосредственно в курьерскую службу посредством прочих типов оплаты - таких как: вебмани, яденьги, картой на сайте, прочие платежные системы и т.д.)
:* OPTION - На выбор получателя. Этот тип оплаты нельзя передавать с заказом. Он выставляется автоматически в зависимости от настройки клиента.

*'''zipcode''' - Почтовый индекс.
*'''weight''' - Общий вес заказа в килограммах.
*'''return_weight''' - Общий вес возврата заказа в килограммах.
*'''quantity''' - Количество мест.
*'''service''' - Режим доставки (тип услуги) передается код из справочника "Виды срочности".
*'''return_service''' - Режим возврата (тип услуги) передается код из справочника "Виды срочности".
*'''type''' - Тип корреспонденции (отправления) передается код из справочника "Типы корреспонденции".
*'''return_type''' - Тип возвратной корреспонденции (отправления) передается код из справочника "Типы корреспонденции".
*'''price''' - Сумма заказа. В случае наличия контейнера items значение данного параметра будет проигнорировано, и рассчитано автоматически.
*'''deliveryprice''' - Сумма доставки. В случае наличия контейнера items, в него будет добавлено вложение "Доставка".
*'''discount''' - Скидка на заказ. В результате сумма заказа будет уменьшена на размер скидки.
*'''return''' - Признак необходимости возврата.
*'''return_service''' - Режим возврата (тип услуги) передается код из справочника "Виды срочности".
*'''enclosure''' - Вложение.
*'''inshprice''' - Объявленная ценность.
*'''instruction''' - Поручение - Примечание.
*'''pvz''' - Код пункта самовывоза по [[#Справочник пунктов самовывоза|справочнику]]
*'''department''' - Подразделение, в котором оформляется заказ.
*'''pickup''' - Признак оформления забора YES/NO. Если стоит YES, то весь заказ считается заданием на забор груза, а не на доставку! Применяется для вызова курьера к отправителю для забора других отправлений.
*'''acceptpartially''' - Признак возможности частичного выкупа товаров отправления YES/NO.

*'''items''' - Контейнер для описания вложенных товаров. Необязательный контейнер. Атрибуты:
:* '''''item''''' - Название товара.
:* '''''quantity''''' - Количество единиц товара.
:* '''''mass''''' - Масса единицы товара в килограммах.
:* '''''volume''''' - Объемный вес единицы товара в килограммах. При указании объемного веса значение подставляется вместо массы
:* '''''length''''' - Длина единицы товара.
:* '''''width''''' - Ширина единицы товара.
:* '''''height''''' - Высота единицы товара.
:* '''''retprice''''' - Цена единицы товара.
:* '''''VATrate''''' - Ставка НДС - целое число процентов. Если значение не указано, подставляется значение "18".
:* '''''barcode''''' - Штрих-код товара. [[Файл:Article.png|thumb|100px|right]]
:* '''''article''''' - Артикул товара. ''Внимание!'' Указание артикула используется только тогда, когда товар хранится на ответственном хранении в службе доставки, и необходима комплектация. В этом случае система пытается привязать товар к [[API#Справочник номенклатуры|справочнику номенклатуры]]. Если товар в справочнике не найден - система выдаст соответствующую ошибку. Если по артикулу найдено несколько товаров - система выберет один из них случайным образом, что может привести к ошибочной комплектации! Если товар НЕ на ответственном хранении - артикул указывать НЕ нужно. Позиция попадет в систему просто текстом.
:* '''''extcode''''' - Внешний код строки. Используется для идентификации строк заказов при получении статусов. Необязательное поле. ПОКА НЕ ПОДДЕРЖИВАЕТСЯ.

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

=== Примеры ответов ===

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

<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<neworder>
<createorder orderno="AB23541" error="0" errormsg="success"></createorder>
<createorder orderno="55_6542" error="0" errormsg="success"></createorder>
<createorder orderno="AB23542" error="0" errormsg="success"></createorder>
</neworder>
</source>

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

<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<neworder>
<createorder orderno="AB23541" error="17" errormsg="Such number exists"></createorder>
<createorder orderno="AB23542" error="13" errormsg="empty company"></createorder>
<createorder orderno="AB23543" error="14" errormsg="empty person"></createorder>
</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>

=== Коды ошибок при оформлении заказа ===

0 - Ошибок нет.

1 - Ошибка авторизации. (отсутствуют теги <auth login="" pass=""></auth>, неверный логин или пароль).

2 - Отправлен пустой запрос (отсутствует контейнер <neworder></neworder> в XML документе).

3 - Некорректно указана сумма заказа.

4 - Некорректный общий вес заказа.

5 - Не найден город получатель.

6 - Не найден город отправитель.

7 - Не заполнен адрес получателя.

8 - Не заполнен телефон получателя.

9 - Не заполнено контактное имя получателя.

10 - Не заполнено название компании получателя.

11 - Некорректная сумма объявленной ценности.

12 - Артикул не найден.

13 - Не заполнено название компании отправителя.

14 - Не заполнено контактное имя отправителя.

15 - Не заполнен телефон отправителя.

16 - Не заполнен адрес отправителя.

17 - Заказ с таким номером уже существует.

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

=== Пример запроса статуса заказа ===

<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>
<ordercode>34234</ordercode>
<givencode>234534</givencode>
<datefrom>2016-07-21</datefrom>
<dateto>2016-07-21</dateto>
<target>Автозавод</target>
<done>ONLY_NOT_DONE</done>
<changes>ONLY_LAST</changes>
<quickstatus>NO</quickstatus>
</statusreq>
</source>

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

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

*'''changes''' - может принимать значение только ONLY_LAST. Если указан этот параметр, все остальные, кроме quickstatus, игнорируются. Описание данного режима приведено здесь: [[#Передача только изменившихся статусов|Передача только изменившихся статусов]]

*'''quickstatus''' - Указывает "глубину" передаваемых статусов: "YES" (по-умолчанию) - передаются статусы начиная с информации, поступившей от курьера. Такие статусы являются быстрыми (как правило, проставляются курьером сразу после доставки) но не всегда точными. Значение NO запрещает передачу статуса со слов курьера, и выдает только статусы, введенные оператором, как правило вручную. На это требуется больше времени, однако точность гораздо выше. Не рекомендуется совмещать эти типы передачи статусов (чередовать их) при запросе только изменившихся статусов, т.к. в этом случае система будет считать, что статусы у отправлений меняются.

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

=== Примеры ответов ===

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

<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<statusreq count="23">
<order orderno="111111" 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>
<zipcode>125480</zipcode>
<town code="23432">Санкт-Петербург</town>
<address>Петровка 38 офис 35</address>
<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>
</receiver>
<weight>5.1</weight>
<return_weight>5.1</return_weight>
<quantity>2</quantity>
<paytype>CASH</paytype>
<service>2</service>
<return_service>2</service>
<type>3</type>
<return_type>3</return_type>
<waittime>12</waittime>
<price>387.5</price>
<print_check>YES</print_check>
<inshprice>387.5</inshprice>
<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">
<>..</> (price details are not yet supported)
..
</deliveryprice>
<receiverpays>NO</receiverpays>
<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>
<customstatecode>2<customstatecode>
<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">Мяч</item>
<item code="34456" extcode="abc124" quantity="2" mass="2" retprice="100" VATrate="10" barcode="4645625213138" article="2" returns="0">Обруч</item>
<item code="34421" extcode="abc125" quantity="3" mass="0.3" retprice="50" VATrate="18" barcode="2345625213126" article="3" returns="0">Погремушка желтая</item>
</items>
<packages>
<package code="33123" strbarcode="4625333555001" mass="0" message="">Место 1</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''':
:* '''''ordercode''''' - внутренний код заказа в системе, применяется для некоторых внутренних операций.
:* '''''givencode''''' - внутренний код заказа в системе, применяется для некоторых внутренних операций.
:* '''''returns''''' - количество данного товара, от которого отказался получатель. Не нулевое только в случае частичного отказа.

* атрибут '''''code''''' контейнера '''item''' - внутренний код строки заказа в системе, применяется для некоторых внутренних операций.
* '''''coords''''' в контейнере '''receiver''' - координаты получателя.
* '''currcoords''' - текущие координаты заказа. Атрибуты:
:* '''''lat''''' - широта
:* '''''lon''''' - долгота
:* '''''accuracy''''' - точность в метрах
:* '''''RequestDateTime''''' - дата/время последнего обновления координат.

* '''waittime ''' - Время ожидания курьера.
* '''deliveryprice''' - стоимость доставки в валюте расчетов с клиентом.
* '''status''' - статус доставки (список статусов см. ниже). Атрибуты (заполняются начиная с версии системы 2008.0.0.670):
:* '''''eventstore''''' - филиал, к которому относится текущий статус
:* '''''eventtime''''' - время изменения статуса (время зависит от местонахождения филиала)
:* '''''createtimegmt''''' - время фактического изменения статуса (GMT)
:* '''''message''''' - наименование филиала-получателя, при передаче между филиалами
:* '''''title''''' - русское наименование статуса

* '''statushistory''' - история статусов доставки. Содержит список контейнеров '''status'''. Заполняется только для тарифа "Премиум" начиная с версии системы 2008.0.0.670.
* '''customstatecode''' - код внутреннего статуса курьерской службы. Значения уточняйте в курьерской службе. Назначаются курьерской службой в разделе "Справочники" - "Статусы" - "15 Статусы корреспонденции". Справочник не передается через API клиенту по причине возможного наличия в нем внутренних технологических статусов курьерской службы.
* '''clientstatecode''' - код статуса клиента. Используется, если клиент предлагает свои коды статусов доставки/причин недоставки.
* '''deliveredto''' - данные о вручении, либо причина недоставки.
* '''delivereddate''' - дата вручения.
* '''deliveredtime''' - время вручения. В случае недоставки может быть пустым.
* '''outstrbarcode''' - код у подрядчика (код заказа во внешней системе). Используется в интеграциях с внешними системами.

*'''packages''' - Контейнер для описания мест. Необязательный контейнер. Атрибуты:
:* '''''package''''' - Название места.
:* '''''code''''' - Внутренний код строки.
:* '''''strbarcode''''' - Штрих-код места.
:* '''''mass''''' - Масса места в килограммах.
:* '''''message''''' - Строка сообщения.

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

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

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

# Атрибуты контейнера '''status''' заполняются для версий системы '''2008.0.0.670''' и новее.
# Контейнер '''statushistory''' заполняется для тарифа "[[Личный_кабинет#.D0.9F.D0.BE.D0.B4.D0.BA.D0.BB.D1.8E.D1.87.D0.B5.D0.BD.D0.B8.D0.B5|Премиум]]" и версий системы '''2008.0.0.670''' и новее.
</div>
<br />

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

Для получения только изменившихся статусов отправьте запрос
<source lang="xml">
<?xml version="1.0" encoding="UTF-8" ?>
<statusreq>
<auth extra="8" login="login" pass="pass"></auth>
<changes>ONLY_LAST</changes>
<quickstatus>NO</quickstatus>
</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>
</commitlaststatus>
</source>

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

*'''auth''' - Авторизация. Обязательный элемент.
*'''client''' - Признак клиента или агента. Необязательный элемент.
:* CLIENT - Признак клиента, значение по умолчанию
:* AGENT - Признак агента. В ответ отдается информация по заказам, переданным агенту на доставку

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

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

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

# При данном способе передачи (<changes>ONLY_LAST</changes>) система просматривает заказы, оформленные за последние 3 месяца. Если заказ сделан ранее - изменение статуса по нему не попадет в результат выполнения данного запроса.
# Система всегда выдает текущий статус. Т.е. Вы можете одним запросом получить статус "NEW", а следующим - "COMPLETE". В промежутке между запросами отправление могло пройти через несколько промежуточных статусов.
# Система никогда не гарантирует последовательность прохождения заказом набора статусов. Т.е. Вы можете получить статус "COMPLETE", а следующим запросом - "NEW" - такое может произойти, например, если оператор ошибочно отметил заказ выполненным, а затем исправил ошибку.
</div>
<br />

== Получение вложений к накладной ==

'''Пример запроса:'''
<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.

== Трекинг заказа по номеру ==

Запрос трекинга по номеру предназначен для выдачи минимальной обезличенной информации о конкретном заказе не авторизованному пользователю. Наша система имеет для этого интерфейс по адресу "home.courierexe.ru/{код экстра}/tracking". Вы можете либо сделать ссылку на такую страницу на своем сайте, либо разместить ее 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="1234">
<sender>
<town code="1">Москва город</town>
<date></date>
</sender>
<receiver>
<town code="1">Москва город</town>
<date>2015-04-18</date>
</receiver>
<weight>0</weight>
<quantity>1</quantity>
<currcoords lat="" lon="" accuracy="" RequestDateTime="" />
<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>
</order>
</tracking>
</source>

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

== Изменение статуса агентом ==

Запрос изменения статуса заказа позволяет установить окончательный статус заказа - "Доставлен" или "Не доставлен (Возврат/Отмена)".

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

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

'''Пример запроса изменения статуса:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8" ?>
<setorderinfo>
<auth extra="8" login="login" pass="pass" />
<order ordercode="123456" date="2018-03-01" time="10:00" message="Клиент отказался от покупки"/>
<order ordercode="234567" date="2018-03-01" time="10:00" message="">
<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''''' - Внутренний код заказа.
:* '''''date''''' - Дата изменения статуса.
:* '''''time''''' - Время изменения статуса.
:* '''''message''''' - текст сообщения.

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

== Получение накладной в формате pdf ==

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

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

'''waybill''' - Корневой контейнер. Обязательный элемент.
*'''auth''' - Авторизация. Обязательный элемент.
*'''orderno''' - Номер/код заказа. Обязательный элемент.
*'''form''' - Формат накладной. Не обязательный элемент. Принимает значения:
:* 1 - Подробная накладная (по-умолчанию)
:* 2 - Наклейки (Zebra)

'''Пример ответа:'''
<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" ?>
<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>

== Справочник городов ==

'''Пример запроса справочника городов:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<townlist>
<codesearch>
<zipcode>110000</zipcode>
<kladrcode>0100000100800</kladrcode>
<fiascode>bd21979d-46f8-49d0-9105-e8d65172a983</fiascode>
<code>123</code>
</codesearch>
<conditions>
<city>Краснодарский край</city>
<namecontains>новгород</namecontains>
<namestarts>Моск</namestarts>
<name>Москва</name>
<fullname>Москва город</fullname>
<country>1</country>
</conditions>
<limit>
<limitfrom>30</limitfrom>
<limitcount>10</limitcount>
<countall>YES</countall>
</limit>
</townlist>
</source>

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

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

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

'''Пример ответа:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<townlist count="3" page="1" totalcount="3" totalpages="1">
<town>
<code>26379</code>
<city>
<code>23</code>
<name>Краснодарский край</name>
</city>
<name>Сочи город</name>
<shortname>Сочи</shortname> (not yet supported)
<typename>город</typename> (not yet supported)
</town>
<town>
<code>40331</code>
<city>
<code>32</code>
<name>Брянская область</name>
</city>
<name>Сочилов хутор</name>
<shortname>Сочилов</shortname>
<typename>хутор</typename>
</town>
<town>
<code>114016</code>
<city>
<code>60</code>
<name>Псковская область</name>
</city>
<name>Сочихино деревня</name>
<shortname>Сочихино</shortname>
<typename>деревня</typename>
</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>1</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>
<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>
</conditions>
<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 - Все. ''Это поле может быть недоступным в некоторых установках.''

*'''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>
<CountInPallet>30</CountInPallet>
<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''' - Высота в сантиметрах.
*'''CountInPallet''' - Количество штук в паллете.
*'''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>
</itemmovements>
</source>

*'''code''' - внутренний код товара в справочнике номенклатуры.

'''Пример ответа движения номенклатуры:'''
<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''' - номер документа
:* '''date''' - дата документа
:* '''message''' - комментарий

== Справочник пунктов самовывоза ==

'''Пример запроса пунктов самовывоза:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8" ?>
<pvzlist>
<auth extra="8" login="login" pass="pass"></auth>
<town>Нижний Тагил</town>
</pvzlist>
</source>

*'''town''' - Город получателя.

'''Пример ответа справочника пунктов самовывоза:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8" ?>
<pvzlist count="2">
<pvz>
<code>126</code>
<clientcode>3</clientcode>
<name>Нижний Тагил</name>
<address>622036, г. Нижний Тагил, ул. Циолковского, д. 17</address>
<phone>+73435417709, +73435254989</phone>
<comment>Жилое 5-ти этажное здание, торцом к дороге, второе здание от перекрестка Пархоменко-Циолковского.</comment>
</pvz>
<pvz>
<code>245</code>
<clientcode>NTG1</clientcode>
<name>На Красноармейской</name>
<address>КРАСНОАРМЕЙСКАЯ, д.79</address>
<phone>+7(3435)379-044</phone>
<comment>Время работы: пн.-пт. 9-18, сб. 10-14</comment>
</pvz>
</pvzlist>
</source>

*'''code''' - Код ПВЗ в системе. Используется в запросе [[API#Оформление заказа|оформления заказов]]
*'''clientcode''' - Код ПВЗ используемый компанией-подрядчиком.
*'''name''' - Наименование ПВЗ.
*'''address''' - Адрес ПВЗ.
*'''phone''' - Телефоны ПВЗ.
*'''comment''' - Дополнительная информация.

== Справочник Видов срочности ==

'''Пример запроса Видов срочности:'''
<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" ?>
<calculator>
<auth extra="8" login="login" pass="pass" />
<calc townfrom="Москва" townto="3800000300000" l="10" w="20" h="30" mass="3.7" service="1" />
</calculator>
</source>

Параметры:
*'''townfrom''' - Город-отправитель
*'''townto''' - Город-получатель
*'''l''' - Длина в см (не обязательный параметр)
*'''w''' - Ширина в см (не обязательный параметр)
*'''h''' - Высота в см (не обязательный параметр)
*'''mass''' - Масса в килограммах
*'''service''' - Режим доставки - число, указывающее на запись в справочнике [[#Справочник Видов срочности|видов срочности]]. Если этот параметр опустить, система выдаст расчет для всех доступных видов срочности, передав много контейнеров <calc> в ответе.

В авторизации можно опустить параметры 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>1163</price>
<maxdeliverydays>3</maxdeliverydays>
</calc>
</calculator>
</source>

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

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

== Список актов передачи денег ==

'''Пример запроса списка актов передачи денег:'''
<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>
<price>637.00</price>
<rur>13430.00</rur>
<pricekur>570.00</pricekur>
<priceag>67.00</priceag>
<payno>42423</payno>
<paytype>1</paytype>
<paytypename>Безнал</paytypename>
</sma>
</smalist>
</source>

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

== Детализация актов передачи денег ==

'''Пример запроса детализации актов передачи денег:'''
<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>
<status>Доставлено</status>
</specialsma>
</smadetail>
</source>

*'''code''' - Код записи.
*'''ordercode''' - Код заказа.
*'''orderno''' - Шифр заказа.
*'''orderdate''' - Дата заказа.
*'''delivereddate''' - Дата доставки.
*'''company''' - Получатель.
*'''price''' - Стоимость услуг.
*'''rur''' - Сумма заказа.
*'''inshprice''' - Стоимость заказа.
*'''pricekur''' - Стоимость курьерской доставки.
*'''priceag''' - Агентское вознаграждение.
*'''pricecalc''' - Сумма для передачи агенту.
*'''paytype''' - Тип оплаты: 1 - безнал, 2 - наличными курьером, 3 - наличными в офисе, 4 - перевод на карту.
*'''paytypename''' - Строковое представление типа оплаты
*'''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</nowiki>

API

2018-11-19T12:55:21Z

Boyko: /* Расчет стоимости доставки */

<div style="font-size: 24px; 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>

В системе "Курьерская служба 2008" имеется возможность интеграции средствами XML API, по протоколу HTTP POST.

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

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

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

== Готовые интеграции ==

Для интеграции с популярными CMS можно скачать модули интеграции

{| class="wikitable" align="center" style="width: 80%; margin: auto; color: black; boreder: 1px solid #999999;" cellpadding="10" cellspacing="0"
!style="width: 35%;"|Система управления контентом (CMS)
!style="width: 15%;"|Версия модуля
!style="width: 15%;"|Ссылка
!style="width: 35%;"|Примечание
|-
|[[Файл:bitrix.png|center|x44px]]
|style="text-align: center;"|1.5.9 от 12.03.2018
|style="text-align: center;"|[http://courierexe.ru/download/api/bitrix.zip Скачать Unicode]<br>[http://courierexe.ru/download/api/bitrix_ansi.zip Скачать ANSI]
|Поддерживает версии 14.5 и выше
|-
|[[Файл:prestashop.png|center|x44px]]
|style="text-align: center;"|1.4.5 от 10.10.2018
|style="text-align: center;"|[http://courierexe.ru/download/api/prestashop.zip Скачать]
|Поддерживает версии 1.5.2.0 и выше (2.x в том числе!)
|-
|[[Файл:opencart.png|center|x44px]] [[Файл:ocstore.png|center|x30px]]
|style="text-align: center;"|1.7.5 от 10.08.2018
|style="text-align: center;"|[http://courierexe.ru/download/api/opencart.zip Скачать]
|Поддерживает версии с 1.5.5.1 по 2.2.<br>
[https://opencartforum.com/files/file/2906-avtomatizaciya-otpravki-i-otslezhivanie-dostavok-courierexe-dlya-opencart-15x/ Альтернативный модуль сторонних разработчиков]
|-
|[[Файл:webasyst-shopscript.png|center|x44px]]
|style="text-align: center;"|1.3.5 от 14.03.2018
|style="text-align: center;"|[http://www.webasyst.ru/store/plugin/shop/measoftcourier/ Установить]
|
|-
|[[Файл:insales.png|center|x44px]]
|style="text-align: center;"|1.2.1 от 06.09.2017
|style="text-align: center;"|[http://www.insales.ru/collection/all/product/kurierskaya-sluzhba-2008 Установить]
|[[Интеграция_с_другими_системами#Insales|Настраивается]] в ЛК пользователя в системе
|-
|[[Файл:Leadvertex.png|center|x44px]]
|style="text-align: center;"|1.0 от 15.11.2016
|style="text-align: center;"|[[Файл:Leadvertex-howto.png|center|x44px]]
|[http://blog.leadvertex.ru/news/2110-integraciya-s-kurerkami-na-platforme-measoft/ Настраивается] в ЛК пользователя в системе [https://Leadvertex.ru Leadvertex]
|-
|[[Файл:Retailcrm.png|center|x44px]]
|style="text-align: center;"|1.0 от 11.01.2018
|style="text-align: center;"|[https://www.retailcrm.ru/ RetailCRM]
|[[Интеграция_с_другими_системами#RetailCRM|Настраивается]] в ЛК пользователя в системе
|-
|[[Файл:1C.jpg|center|x44px]]
|style="text-align: center;"|1.4 от 17.11.2017
|style="text-align: center;"|-
|[https://infostart.ru/public/692790/ Альтернативный модуль сторонних разработчиков]
|-
|[[Файл:Joomla2.jpg|center|x44px]]
|style="text-align: center;"|1.0.0 от 12.11.2018
|style="text-align: center;"|[http://courierexe.ru/download/api/com_measoft.zip Скачать]
|Внимание! Модуль новый, поэтому возможна некорректная передача данных.
|-
|AMO CRM
|style="text-align: center;"|-
|style="text-align: center;"|-
|Ожидается в ближайшее время в магазине Amo
|-
|Мой склад
|style="text-align: center;"|-
|style="text-align: center;"|-
|Ожидается в ближайшее время в магазине Мой Склад
|-
|}

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

== Тестовый аккаунт ==

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

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

== Рабочий аккаунт для подключения ==

Для подключения к площадке Вашего клиента необходимо иметь три параметра:

1. '''Параметр extra''' (Цифровой код, уникальный идентификатор компании. Запросите этот параметр у компании, с которой Вы интегрируетесь). Посмотреть этот код можно в интерфейсе программы КС2008 через основное меню '''"Справочники - Дополнительные возможности"'''. Цифровое значение будет указано во второй гиперссылке (на скриншоте ниже отмечено "звездочкой"):

[[Файл:extra1.png|750px]]

2. '''Логин''' - параметр учетной записи для ЛК клиента и API, указывается в карточке клиента на вкладке '''"Прочее"''' в поле '''"Имя пользователя"'''. Возможно, что в программе КС2008 понадобится создать новую карточку клиента (на скриншоте ниже).

3. '''Пароль''' - параметр учетной записи для ЛК клиента и API, указывается в карточке клиента на вкладке '''"Прочее"''' в поле '''"Пароль"''' (на скриншоте ниже).

[[Файл:33_client.png|500px]]

== Общие понятия ==

На стороне курьерской службы имеется веб-сервис по адресу: https://home.courierexe.ru/api/. Тестовые авторизационные данные: логин: test пароль: testm, параметр 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; < на &lt; > на &gt; " на &quot;

== Ограничения ==
С целью защиты от нецелевого использования сервисов, с 29.05.2017 ведено ограничение на запросы - 1500 запросов с одного IP-адреса за 20 минут. В случае превышения IP-адрес блокируется, разблокировка возможна путем обращения в техническую поддержку, с последующим обсуждением ваших алгоритмов и их коррекцией.

Для проверки статусов заказов лучше всего использовать запросы [[#Передача только изменившихся статусов|"statusreq" с параметром changes=ONLY_LAST]]. Не нужно пытаться "бомбить" наше API запросами с номерами всех ваших заказов, особенно - запросами "tracking", они предназначены не для этого (смотрите описание).

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

<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>Чип & Дейл</person>
<phone>123-45-67</phone>
<zipcode>125480</zipcode>
<town>Санкт-Петербург</town>
<address>Петровка 38 офис 35</address>
<date>2014-03-22</date>
<time_min>09:00</time_min>
<time_max>14:00</time_max>
</receiver>
<return>NO</return>
<weight>5.1</weight>
<return_weight>5.1</return_weight>
<quantity>2</quantity>
<paytype>CASH</paytype>
<service>2</service>
<return_service>1</return_service>
<type>3</type>
<return_type>3</return_type>
<price>387.5</price>
<deliveryprice>150</deliveryprice>
<discount>0</discount>
<inshprice>387.5</inshprice>
<enclosure>Детские игрушки</enclosure>
<instruction>Проверить при покупателе, подписать акт</instruction>
<pvz>124</pvz>
<department>Отдел</department>
<pickup>NO</pickup>
<acceptpartially>NO</acceptpartially>
<items>
<item extcode="abc123" quantity="1" mass="0.2" retprice="37.5" VATrate="0" barcode="2345625213125" article="1" volume="3">Мяч</item>
<item extcode="abc124" quantity="2" mass="2" retprice="100" VATrate="10" barcode="4645625213138" article="2" length="10" width="20" height="30">Обруч</item>
<item extcode="abc125" quantity="3" mass="0.3" retprice="50" barcode="2345625213126" article="3">Погремушка желтая</item>
</items>
</order>
</neworder>
</source>

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

*'''neworder''' - Корневой контейнер, обязательный элемент.

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

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

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

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

*'''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>Город получателя в формате "Москва город"</town>
<address>Адрес получателя</address>
<date>Дата доставки в формате "YYYY-MM-DD"</date>
<time_min>Желаемое время доставки в формате "HH:MM"</time_min>
<time_max>Желаемое время доставки в формате "HH:MM"</time_max>
</receiver>
</source>

*'''company''' - Компания-получатель.
*'''person''' - Контактное лицо. ''Должно быть заполнено хотя бы одно из полей - company или person!''
*'''phone''' - Телефон. Можно указывать несколько телефонов, E-mail в этом поле.
*'''town''' - Город.

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

*'''paytype''' - Тип оплаты заказа получателем. Принимает значения:
:* CASH - Наличными при получении (по-умолчанию)
:* CARD - Картой при получении
:* NO - Без оплаты. Поле Price будет проигнорировано. (Этот тип оплаты передается, если заказ уже оплачен и не требует инкассации, API добавит в систему товары по нулевой цене. Если необходимо передать общую сумму заказа - можно это сделать в поле <inshprice>, указав объявленную ценность)
:* OTHER - Прочее (Предусмотрен для того, чтобы оплата поступала непосредственно в курьерскую службу посредством прочих типов оплаты - таких как: вебмани, яденьги, картой на сайте, прочие платежные системы и т.д.)
:* OPTION - На выбор получателя. Этот тип оплаты нельзя передавать с заказом. Он выставляется автоматически в зависимости от настройки клиента.

*'''zipcode''' - Почтовый индекс.
*'''weight''' - Общий вес заказа в килограммах.
*'''return_weight''' - Общий вес возврата заказа в килограммах.
*'''quantity''' - Количество мест.
*'''service''' - Режим доставки (тип услуги) передается код из справочника "Виды срочности".
*'''return_service''' - Режим возврата (тип услуги) передается код из справочника "Виды срочности".
*'''type''' - Тип корреспонденции (отправления) передается код из справочника "Типы корреспонденции".
*'''return_type''' - Тип возвратной корреспонденции (отправления) передается код из справочника "Типы корреспонденции".
*'''price''' - Сумма заказа. В случае наличия контейнера items значение данного параметра будет проигнорировано, и рассчитано автоматически.
*'''deliveryprice''' - Сумма доставки. В случае наличия контейнера items, в него будет добавлено вложение "Доставка".
*'''discount''' - Скидка на заказ. В результате сумма заказа будет уменьшена на размер скидки.
*'''return''' - Признак необходимости возврата.
*'''return_service''' - Режим возврата (тип услуги) передается код из справочника "Виды срочности".
*'''enclosure''' - Вложение.
*'''inshprice''' - Объявленная ценность.
*'''instruction''' - Поручение - Примечание.
*'''pvz''' - Код пункта самовывоза по [[#Справочник пунктов самовывоза|справочнику]]
*'''department''' - Подразделение, в котором оформляется заказ.
*'''pickup''' - Признак оформления забора YES/NO. Если стоит YES, то весь заказ считается заданием на забор груза, а не на доставку! Применяется для вызова курьера к отправителю для забора других отправлений.
*'''acceptpartially''' - Признак возможности частичного выкупа товаров отправления YES/NO.

*'''items''' - Контейнер для описания вложенных товаров. Необязательный контейнер. Атрибуты:
:* '''''item''''' - Название товара.
:* '''''quantity''''' - Количество единиц товара.
:* '''''mass''''' - Масса единицы товара в килограммах.
:* '''''volume''''' - Объемный вес единицы товара в килограммах. При указании объемного веса значение подставляется вместо массы
:* '''''length''''' - Длина единицы товара.
:* '''''width''''' - Ширина единицы товара.
:* '''''height''''' - Высота единицы товара.
:* '''''retprice''''' - Цена единицы товара.
:* '''''VATrate''''' - Ставка НДС - целое число процентов. Если значение не указано, подставляется значение "18".
:* '''''barcode''''' - Штрих-код товара. [[Файл:Article.png|thumb|100px|right]]
:* '''''article''''' - Артикул товара. ''Внимание!'' Указание артикула используется только тогда, когда товар хранится на ответственном хранении в службе доставки, и необходима комплектация. В этом случае система пытается привязать товар к [[API#Справочник номенклатуры|справочнику номенклатуры]]. Если товар в справочнике не найден - система выдаст соответствующую ошибку. Если по артикулу найдено несколько товаров - система выберет один из них случайным образом, что может привести к ошибочной комплектации! Если товар НЕ на ответственном хранении - артикул указывать НЕ нужно. Позиция попадет в систему просто текстом.
:* '''''extcode''''' - Внешний код строки. Используется для идентификации строк заказов при получении статусов. Необязательное поле. ПОКА НЕ ПОДДЕРЖИВАЕТСЯ.

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

=== Примеры ответов ===

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

<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<neworder>
<createorder orderno="AB23541" error="0" errormsg="success"></createorder>
<createorder orderno="55_6542" error="0" errormsg="success"></createorder>
<createorder orderno="AB23542" error="0" errormsg="success"></createorder>
</neworder>
</source>

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

<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<neworder>
<createorder orderno="AB23541" error="17" errormsg="Such number exists"></createorder>
<createorder orderno="AB23542" error="13" errormsg="empty company"></createorder>
<createorder orderno="AB23543" error="14" errormsg="empty person"></createorder>
</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>

=== Коды ошибок при оформлении заказа ===

0 - Ошибок нет.

1 - Ошибка авторизации. (отсутствуют теги <auth login="" pass=""></auth>, неверный логин или пароль).

2 - Отправлен пустой запрос (отсутствует контейнер <neworder></neworder> в XML документе).

3 - Некорректно указана сумма заказа.

4 - Некорректный общий вес заказа.

5 - Не найден город получатель.

6 - Не найден город отправитель.

7 - Не заполнен адрес получателя.

8 - Не заполнен телефон получателя.

9 - Не заполнено контактное имя получателя.

10 - Не заполнено название компании получателя.

11 - Некорректная сумма объявленной ценности.

12 - Артикул не найден.

13 - Не заполнено название компании отправителя.

14 - Не заполнено контактное имя отправителя.

15 - Не заполнен телефон отправителя.

16 - Не заполнен адрес отправителя.

17 - Заказ с таким номером уже существует.

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

=== Пример запроса статуса заказа ===

<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>
<ordercode>34234</ordercode>
<givencode>234534</givencode>
<datefrom>2016-07-21</datefrom>
<dateto>2016-07-21</dateto>
<target>Автозавод</target>
<done>ONLY_NOT_DONE</done>
<changes>ONLY_LAST</changes>
<quickstatus>NO</quickstatus>
</statusreq>
</source>

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

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

*'''changes''' - может принимать значение только ONLY_LAST. Если указан этот параметр, все остальные, кроме quickstatus, игнорируются. Описание данного режима приведено здесь: [[#Передача только изменившихся статусов|Передача только изменившихся статусов]]

*'''quickstatus''' - Указывает "глубину" передаваемых статусов: "YES" (по-умолчанию) - передаются статусы начиная с информации, поступившей от курьера. Такие статусы являются быстрыми (как правило, проставляются курьером сразу после доставки) но не всегда точными. Значение NO запрещает передачу статуса со слов курьера, и выдает только статусы, введенные оператором, как правило вручную. На это требуется больше времени, однако точность гораздо выше. Не рекомендуется совмещать эти типы передачи статусов (чередовать их) при запросе только изменившихся статусов, т.к. в этом случае система будет считать, что статусы у отправлений меняются.

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

=== Примеры ответов ===

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

<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<statusreq count="23">
<order orderno="111111" 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>
<zipcode>125480</zipcode>
<town code="23432">Санкт-Петербург</town>
<address>Петровка 38 офис 35</address>
<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>
</receiver>
<weight>5.1</weight>
<return_weight>5.1</return_weight>
<quantity>2</quantity>
<paytype>CASH</paytype>
<service>2</service>
<return_service>2</service>
<type>3</type>
<return_type>3</return_type>
<waittime>12</waittime>
<price>387.5</price>
<print_check>YES</print_check>
<inshprice>387.5</inshprice>
<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">
<>..</> (price details are not yet supported)
..
</deliveryprice>
<receiverpays>NO</receiverpays>
<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>
<customstatecode>2<customstatecode>
<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">Мяч</item>
<item code="34456" extcode="abc124" quantity="2" mass="2" retprice="100" VATrate="10" barcode="4645625213138" article="2" returns="0">Обруч</item>
<item code="34421" extcode="abc125" quantity="3" mass="0.3" retprice="50" VATrate="18" barcode="2345625213126" article="3" returns="0">Погремушка желтая</item>
</items>
<packages>
<package code="33123" strbarcode="4625333555001" mass="0" message="">Место 1</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''':
:* '''''ordercode''''' - внутренний код заказа в системе, применяется для некоторых внутренних операций.
:* '''''givencode''''' - внутренний код заказа в системе, применяется для некоторых внутренних операций.
:* '''''returns''''' - количество данного товара, от которого отказался получатель. Не нулевое только в случае частичного отказа.

* атрибут '''''code''''' контейнера '''item''' - внутренний код строки заказа в системе, применяется для некоторых внутренних операций.
* '''''coords''''' в контейнере '''receiver''' - координаты получателя.
* '''currcoords''' - текущие координаты заказа. Атрибуты:
:* '''''lat''''' - широта
:* '''''lon''''' - долгота
:* '''''accuracy''''' - точность в метрах
:* '''''RequestDateTime''''' - дата/время последнего обновления координат.

* '''waittime ''' - Время ожидания курьера.
* '''deliveryprice''' - стоимость доставки в валюте расчетов с клиентом.
* '''status''' - статус доставки (список статусов см. ниже). Атрибуты (заполняются начиная с версии системы 2008.0.0.670):
:* '''''eventstore''''' - филиал, к которому относится текущий статус
:* '''''eventtime''''' - время изменения статуса (время зависит от местонахождения филиала)
:* '''''createtimegmt''''' - время фактического изменения статуса (GMT)
:* '''''message''''' - наименование филиала-получателя, при передаче между филиалами
:* '''''title''''' - русское наименование статуса

* '''statushistory''' - история статусов доставки. Содержит список контейнеров '''status'''. Заполняется только для тарифа "Премиум" начиная с версии системы 2008.0.0.670.
* '''customstatecode''' - код внутреннего статуса курьерской службы. Значения уточняйте в курьерской службе. Назначаются курьерской службой в разделе "Справочники" - "Статусы" - "15 Статусы корреспонденции". Справочник не передается через API клиенту по причине возможного наличия в нем внутренних технологических статусов курьерской службы.
* '''clientstatecode''' - код статуса клиента. Используется, если клиент предлагает свои коды статусов доставки/причин недоставки.
* '''deliveredto''' - данные о вручении, либо причина недоставки.
* '''delivereddate''' - дата вручения.
* '''deliveredtime''' - время вручения. В случае недоставки может быть пустым.
* '''outstrbarcode''' - код у подрядчика (код заказа во внешней системе). Используется в интеграциях с внешними системами.

*'''packages''' - Контейнер для описания мест. Необязательный контейнер. Атрибуты:
:* '''''package''''' - Название места.
:* '''''code''''' - Внутренний код строки.
:* '''''strbarcode''''' - Штрих-код места.
:* '''''mass''''' - Масса места в килограммах.
:* '''''message''''' - Строка сообщения.

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

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

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

# Атрибуты контейнера '''status''' заполняются для версий системы '''2008.0.0.670''' и новее.
# Контейнер '''statushistory''' заполняется для тарифа "[[Личный_кабинет#.D0.9F.D0.BE.D0.B4.D0.BA.D0.BB.D1.8E.D1.87.D0.B5.D0.BD.D0.B8.D0.B5|Премиум]]" и версий системы '''2008.0.0.670''' и новее.
</div>
<br />

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

Для получения только изменившихся статусов отправьте запрос
<source lang="xml">
<?xml version="1.0" encoding="UTF-8" ?>
<statusreq>
<auth extra="8" login="login" pass="pass"></auth>
<changes>ONLY_LAST</changes>
<quickstatus>NO</quickstatus>
</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>
</commitlaststatus>
</source>

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

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

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

# При данном способе передачи (<changes>ONLY_LAST</changes>) система просматривает заказы, оформленные за последние 3 месяца. Если заказ сделан ранее - изменение статуса по нему не попадет в результат выполнения данного запроса.
# Система всегда выдает текущий статус. Т.е. Вы можете одним запросом получить статус "NEW", а следующим - "COMPLETE". В промежутке между запросами отправление могло пройти через несколько промежуточных статусов.
# Система никогда не гарантирует последовательность прохождения заказом набора статусов. Т.е. Вы можете получить статус "COMPLETE", а следующим запросом - "NEW" - такое может произойти, например, если оператор ошибочно отметил заказ выполненным, а затем исправил ошибку.
</div>
<br />

== Получение вложений к накладной ==

'''Пример запроса:'''
<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.

== Трекинг заказа по номеру ==

Запрос трекинга по номеру предназначен для выдачи минимальной обезличенной информации о конкретном заказе не авторизованному пользователю. Наша система имеет для этого интерфейс по адресу "home.courierexe.ru/{код экстра}/tracking". Вы можете либо сделать ссылку на такую страницу на своем сайте, либо разместить ее 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="1234">
<sender>
<town code="1">Москва город</town>
<date></date>
</sender>
<receiver>
<town code="1">Москва город</town>
<date>2015-04-18</date>
</receiver>
<weight>0</weight>
<quantity>1</quantity>
<currcoords lat="" lon="" accuracy="" RequestDateTime="" />
<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>
</order>
</tracking>
</source>

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

== Изменение статуса агентом ==

Запрос изменения статуса заказа позволяет установить окончательный статус заказа - "Доставлен" или "Не доставлен (Возврат/Отмена)".

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

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

'''Пример запроса изменения статуса:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8" ?>
<setorderinfo>
<auth extra="8" login="login" pass="pass" />
<order ordercode="123456" date="2018-03-01" time="10:00" message="Клиент отказался от покупки"/>
<order ordercode="234567" date="2018-03-01" time="10:00" message="">
<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''''' - Внутренний код заказа.
:* '''''date''''' - Дата изменения статуса.
:* '''''time''''' - Время изменения статуса.
:* '''''message''''' - текст сообщения.

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

== Получение накладной в формате pdf ==

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

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

'''waybill''' - Корневой контейнер. Обязательный элемент.
*'''auth''' - Авторизация. Обязательный элемент.
*'''orderno''' - Номер/код заказа. Обязательный элемент.
*'''form''' - Формат накладной. Не обязательный элемент. Принимает значения:
:* 1 - Подробная накладная (по-умолчанию)
:* 2 - Наклейки (Zebra)

'''Пример ответа:'''
<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" ?>
<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>

== Справочник городов ==

'''Пример запроса справочника городов:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<townlist>
<codesearch>
<zipcode>110000</zipcode>
<kladrcode>0100000100800</kladrcode>
<fiascode>bd21979d-46f8-49d0-9105-e8d65172a983</fiascode>
<code>123</code>
</codesearch>
<conditions>
<city>Краснодарский край</city>
<namecontains>новгород</namecontains>
<namestarts>Моск</namestarts>
<name>Москва</name>
<fullname>Москва город</fullname>
<country>1</country>
</conditions>
<limit>
<limitfrom>30</limitfrom>
<limitcount>10</limitcount>
<countall>YES</countall>
</limit>
</townlist>
</source>

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

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

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

'''Пример ответа:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<townlist count="3" page="1" totalcount="3" totalpages="1">
<town>
<code>26379</code>
<city>
<code>23</code>
<name>Краснодарский край</name>
</city>
<name>Сочи город</name>
<shortname>Сочи</shortname> (not yet supported)
<typename>город</typename> (not yet supported)
</town>
<town>
<code>40331</code>
<city>
<code>32</code>
<name>Брянская область</name>
</city>
<name>Сочилов хутор</name>
<shortname>Сочилов</shortname>
<typename>хутор</typename>
</town>
<town>
<code>114016</code>
<city>
<code>60</code>
<name>Псковская область</name>
</city>
<name>Сочихино деревня</name>
<shortname>Сочихино</shortname>
<typename>деревня</typename>
</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>1</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>
<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>
</conditions>
<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 - Все. ''Это поле может быть недоступным в некоторых установках.''

*'''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>
<CountInPallet>30</CountInPallet>
<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''' - Высота в сантиметрах.
*'''CountInPallet''' - Количество штук в паллете.
*'''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>
</itemmovements>
</source>

*'''code''' - внутренний код товара в справочнике номенклатуры.

'''Пример ответа движения номенклатуры:'''
<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''' - номер документа
:* '''date''' - дата документа
:* '''message''' - комментарий

== Справочник пунктов самовывоза ==

'''Пример запроса пунктов самовывоза:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8" ?>
<pvzlist>
<auth extra="8" login="login" pass="pass"></auth>
<town>Нижний Тагил</town>
</pvzlist>
</source>

*'''town''' - Город получателя.

'''Пример ответа справочника пунктов самовывоза:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8" ?>
<pvzlist count="2">
<pvz>
<code>126</code>
<clientcode>3</clientcode>
<name>Нижний Тагил</name>
<address>622036, г. Нижний Тагил, ул. Циолковского, д. 17</address>
<phone>+73435417709, +73435254989</phone>
<comment>Жилое 5-ти этажное здание, торцом к дороге, второе здание от перекрестка Пархоменко-Циолковского.</comment>
</pvz>
<pvz>
<code>245</code>
<clientcode>NTG1</clientcode>
<name>На Красноармейской</name>
<address>КРАСНОАРМЕЙСКАЯ, д.79</address>
<phone>+7(3435)379-044</phone>
<comment>Время работы: пн.-пт. 9-18, сб. 10-14</comment>
</pvz>
</pvzlist>
</source>

*'''code''' - Код ПВЗ в системе. Используется в запросе [[API#Оформление заказа|оформления заказов]]
*'''clientcode''' - Код ПВЗ используемый компанией-подрядчиком.
*'''name''' - Наименование ПВЗ.
*'''address''' - Адрес ПВЗ.
*'''phone''' - Телефоны ПВЗ.
*'''comment''' - Дополнительная информация.

== Справочник Видов срочности ==

'''Пример запроса Видов срочности:'''
<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" ?>
<calculator>
<auth extra="8" login="login" pass="pass" />
<calc townfrom="Москва" townto="3800000300000" l="10" w="20" h="30" mass="3.7" service="1" />
</calculator>
</source>

Параметры:
*'''townfrom''' - Город-отправитель
*'''townto''' - Город-получатель
*'''l''' - Длина в мм (не обязательный параметр)
*'''w''' - Ширина в мм (не обязательный параметр)
*'''h''' - Высота в мм (не обязательный параметр)
*'''mass''' - Масса в килограммах
*'''service''' - Режим доставки - число, указывающее на запись в справочнике [[#Справочник Видов срочности|видов срочности]]. Если этот параметр опустить, система выдаст расчет для всех доступных видов срочности, передав много контейнеров <calc> в ответе.

В авторизации можно опустить параметры 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>1163</price>
<maxdeliverydays>3</maxdeliverydays>
</calc>
</calculator>
</source>

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

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

== Список актов передачи денег ==

'''Пример запроса списка актов передачи денег:'''
<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>
<price>637.00</price>
<rur>13430.00</rur>
<pricekur>570.00</pricekur>
<priceag>67.00</priceag>
<payno>42423</payno>
<paytype>1</paytype>
<paytypename>Безнал</paytypename>
</sma>
</smalist>
</source>

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

== Детализация актов передачи денег ==

'''Пример запроса детализации актов передачи денег:'''
<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>
<status>Доставлено</status>
</specialsma>
</smadetail>
</source>

*'''code''' - Код записи.
*'''ordercode''' - Код заказа.
*'''orderno''' - Шифр заказа.
*'''orderdate''' - Дата заказа.
*'''delivereddate''' - Дата доставки.
*'''company''' - Получатель.
*'''price''' - Стоимость услуг.
*'''rur''' - Сумма заказа.
*'''inshprice''' - Стоимость заказа.
*'''pricekur''' - Стоимость курьерской доставки.
*'''priceag''' - Агентское вознаграждение.
*'''pricecalc''' - Сумма для передачи агенту.
*'''paytype''' - Тип оплаты: 1 - безнал, 2 - наличными курьером, 3 - наличными в офисе, 4 - перевод на карту.
*'''paytypename''' - Строковое представление типа оплаты
*'''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</nowiki>

API

2018-11-19T12:30:49Z

Boyko: /* Расчет стоимости доставки */

<div style="font-size: 24px; 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>

В системе "Курьерская служба 2008" имеется возможность интеграции средствами XML API, по протоколу HTTP POST.

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

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

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

== Готовые интеграции ==

Для интеграции с популярными CMS можно скачать модули интеграции

{| class="wikitable" align="center" style="width: 80%; margin: auto; color: black; boreder: 1px solid #999999;" cellpadding="10" cellspacing="0"
!style="width: 35%;"|Система управления контентом (CMS)
!style="width: 15%;"|Версия модуля
!style="width: 15%;"|Ссылка
!style="width: 35%;"|Примечание
|-
|[[Файл:bitrix.png|center|x44px]]
|style="text-align: center;"|1.5.9 от 12.03.2018
|style="text-align: center;"|[http://courierexe.ru/download/api/bitrix.zip Скачать Unicode]<br>[http://courierexe.ru/download/api/bitrix_ansi.zip Скачать ANSI]
|Поддерживает версии 14.5 и выше
|-
|[[Файл:prestashop.png|center|x44px]]
|style="text-align: center;"|1.4.5 от 10.10.2018
|style="text-align: center;"|[http://courierexe.ru/download/api/prestashop.zip Скачать]
|Поддерживает версии 1.5.2.0 и выше (2.x в том числе!)
|-
|[[Файл:opencart.png|center|x44px]] [[Файл:ocstore.png|center|x30px]]
|style="text-align: center;"|1.7.5 от 10.08.2018
|style="text-align: center;"|[http://courierexe.ru/download/api/opencart.zip Скачать]
|Поддерживает версии с 1.5.5.1 по 2.2.<br>
[https://opencartforum.com/files/file/2906-avtomatizaciya-otpravki-i-otslezhivanie-dostavok-courierexe-dlya-opencart-15x/ Альтернативный модуль сторонних разработчиков]
|-
|[[Файл:webasyst-shopscript.png|center|x44px]]
|style="text-align: center;"|1.3.5 от 14.03.2018
|style="text-align: center;"|[http://www.webasyst.ru/store/plugin/shop/measoftcourier/ Установить]
|
|-
|[[Файл:insales.png|center|x44px]]
|style="text-align: center;"|1.2.1 от 06.09.2017
|style="text-align: center;"|[http://www.insales.ru/collection/all/product/kurierskaya-sluzhba-2008 Установить]
|[[Интеграция_с_другими_системами#Insales|Настраивается]] в ЛК пользователя в системе
|-
|[[Файл:Leadvertex.png|center|x44px]]
|style="text-align: center;"|1.0 от 15.11.2016
|style="text-align: center;"|[[Файл:Leadvertex-howto.png|center|x44px]]
|[http://blog.leadvertex.ru/news/2110-integraciya-s-kurerkami-na-platforme-measoft/ Настраивается] в ЛК пользователя в системе [https://Leadvertex.ru Leadvertex]
|-
|[[Файл:Retailcrm.png|center|x44px]]
|style="text-align: center;"|1.0 от 11.01.2018
|style="text-align: center;"|[https://www.retailcrm.ru/ RetailCRM]
|[[Интеграция_с_другими_системами#RetailCRM|Настраивается]] в ЛК пользователя в системе
|-
|[[Файл:1C.jpg|center|x44px]]
|style="text-align: center;"|1.4 от 17.11.2017
|style="text-align: center;"|-
|[https://infostart.ru/public/692790/ Альтернативный модуль сторонних разработчиков]
|-
|[[Файл:Joomla2.jpg|center|x44px]]
|style="text-align: center;"|1.0.0 от 12.11.2018
|style="text-align: center;"|[http://courierexe.ru/download/api/com_measoft.zip Скачать]
|Внимание! Модуль новый, поэтому возможна некорректная передача данных.
|-
|AMO CRM
|style="text-align: center;"|-
|style="text-align: center;"|-
|Ожидается в ближайшее время в магазине Amo
|-
|Мой склад
|style="text-align: center;"|-
|style="text-align: center;"|-
|Ожидается в ближайшее время в магазине Мой Склад
|-
|}

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

== Тестовый аккаунт ==

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

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

== Рабочий аккаунт для подключения ==

Для подключения к площадке Вашего клиента необходимо иметь три параметра:

1. '''Параметр extra''' (Цифровой код, уникальный идентификатор компании. Запросите этот параметр у компании, с которой Вы интегрируетесь). Посмотреть этот код можно в интерфейсе программы КС2008 через основное меню '''"Справочники - Дополнительные возможности"'''. Цифровое значение будет указано во второй гиперссылке (на скриншоте ниже отмечено "звездочкой"):

[[Файл:extra1.png|750px]]

2. '''Логин''' - параметр учетной записи для ЛК клиента и API, указывается в карточке клиента на вкладке '''"Прочее"''' в поле '''"Имя пользователя"'''. Возможно, что в программе КС2008 понадобится создать новую карточку клиента (на скриншоте ниже).

3. '''Пароль''' - параметр учетной записи для ЛК клиента и API, указывается в карточке клиента на вкладке '''"Прочее"''' в поле '''"Пароль"''' (на скриншоте ниже).

[[Файл:33_client.png|500px]]

== Общие понятия ==

На стороне курьерской службы имеется веб-сервис по адресу: https://home.courierexe.ru/api/. Тестовые авторизационные данные: логин: test пароль: testm, параметр 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; < на &lt; > на &gt; " на &quot;

== Ограничения ==
С целью защиты от нецелевого использования сервисов, с 29.05.2017 ведено ограничение на запросы - 1500 запросов с одного IP-адреса за 20 минут. В случае превышения IP-адрес блокируется, разблокировка возможна путем обращения в техническую поддержку, с последующим обсуждением ваших алгоритмов и их коррекцией.

Для проверки статусов заказов лучше всего использовать запросы [[#Передача только изменившихся статусов|"statusreq" с параметром changes=ONLY_LAST]]. Не нужно пытаться "бомбить" наше API запросами с номерами всех ваших заказов, особенно - запросами "tracking", они предназначены не для этого (смотрите описание).

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

<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>Чип & Дейл</person>
<phone>123-45-67</phone>
<zipcode>125480</zipcode>
<town>Санкт-Петербург</town>
<address>Петровка 38 офис 35</address>
<date>2014-03-22</date>
<time_min>09:00</time_min>
<time_max>14:00</time_max>
</receiver>
<return>NO</return>
<weight>5.1</weight>
<return_weight>5.1</return_weight>
<quantity>2</quantity>
<paytype>CASH</paytype>
<service>2</service>
<return_service>1</return_service>
<type>3</type>
<return_type>3</return_type>
<price>387.5</price>
<deliveryprice>150</deliveryprice>
<discount>0</discount>
<inshprice>387.5</inshprice>
<enclosure>Детские игрушки</enclosure>
<instruction>Проверить при покупателе, подписать акт</instruction>
<pvz>124</pvz>
<department>Отдел</department>
<pickup>NO</pickup>
<acceptpartially>NO</acceptpartially>
<items>
<item extcode="abc123" quantity="1" mass="0.2" retprice="37.5" VATrate="0" barcode="2345625213125" article="1" volume="3">Мяч</item>
<item extcode="abc124" quantity="2" mass="2" retprice="100" VATrate="10" barcode="4645625213138" article="2" length="10" width="20" height="30">Обруч</item>
<item extcode="abc125" quantity="3" mass="0.3" retprice="50" barcode="2345625213126" article="3">Погремушка желтая</item>
</items>
</order>
</neworder>
</source>

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

*'''neworder''' - Корневой контейнер, обязательный элемент.

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

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

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

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

*'''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>Город получателя в формате "Москва город"</town>
<address>Адрес получателя</address>
<date>Дата доставки в формате "YYYY-MM-DD"</date>
<time_min>Желаемое время доставки в формате "HH:MM"</time_min>
<time_max>Желаемое время доставки в формате "HH:MM"</time_max>
</receiver>
</source>

*'''company''' - Компания-получатель.
*'''person''' - Контактное лицо. ''Должно быть заполнено хотя бы одно из полей - company или person!''
*'''phone''' - Телефон. Можно указывать несколько телефонов, E-mail в этом поле.
*'''town''' - Город.

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

*'''paytype''' - Тип оплаты заказа получателем. Принимает значения:
:* CASH - Наличными при получении (по-умолчанию)
:* CARD - Картой при получении
:* NO - Без оплаты. Поле Price будет проигнорировано. (Этот тип оплаты передается, если заказ уже оплачен и не требует инкассации, API добавит в систему товары по нулевой цене. Если необходимо передать общую сумму заказа - можно это сделать в поле <inshprice>, указав объявленную ценность)
:* OTHER - Прочее (Предусмотрен для того, чтобы оплата поступала непосредственно в курьерскую службу посредством прочих типов оплаты - таких как: вебмани, яденьги, картой на сайте, прочие платежные системы и т.д.)
:* OPTION - На выбор получателя. Этот тип оплаты нельзя передавать с заказом. Он выставляется автоматически в зависимости от настройки клиента.

*'''zipcode''' - Почтовый индекс.
*'''weight''' - Общий вес заказа в килограммах.
*'''return_weight''' - Общий вес возврата заказа в килограммах.
*'''quantity''' - Количество мест.
*'''service''' - Режим доставки (тип услуги) передается код из справочника "Виды срочности".
*'''return_service''' - Режим возврата (тип услуги) передается код из справочника "Виды срочности".
*'''type''' - Тип корреспонденции (отправления) передается код из справочника "Типы корреспонденции".
*'''return_type''' - Тип возвратной корреспонденции (отправления) передается код из справочника "Типы корреспонденции".
*'''price''' - Сумма заказа. В случае наличия контейнера items значение данного параметра будет проигнорировано, и рассчитано автоматически.
*'''deliveryprice''' - Сумма доставки. В случае наличия контейнера items, в него будет добавлено вложение "Доставка".
*'''discount''' - Скидка на заказ. В результате сумма заказа будет уменьшена на размер скидки.
*'''return''' - Признак необходимости возврата.
*'''return_service''' - Режим возврата (тип услуги) передается код из справочника "Виды срочности".
*'''enclosure''' - Вложение.
*'''inshprice''' - Объявленная ценность.
*'''instruction''' - Поручение - Примечание.
*'''pvz''' - Код пункта самовывоза по [[#Справочник пунктов самовывоза|справочнику]]
*'''department''' - Подразделение, в котором оформляется заказ.
*'''pickup''' - Признак оформления забора YES/NO. Если стоит YES, то весь заказ считается заданием на забор груза, а не на доставку! Применяется для вызова курьера к отправителю для забора других отправлений.
*'''acceptpartially''' - Признак возможности частичного выкупа товаров отправления YES/NO.

*'''items''' - Контейнер для описания вложенных товаров. Необязательный контейнер. Атрибуты:
:* '''''item''''' - Название товара.
:* '''''quantity''''' - Количество единиц товара.
:* '''''mass''''' - Масса единицы товара в килограммах.
:* '''''volume''''' - Объемный вес единицы товара в килограммах. При указании объемного веса значение подставляется вместо массы
:* '''''length''''' - Длина единицы товара.
:* '''''width''''' - Ширина единицы товара.
:* '''''height''''' - Высота единицы товара.
:* '''''retprice''''' - Цена единицы товара.
:* '''''VATrate''''' - Ставка НДС - целое число процентов. Если значение не указано, подставляется значение "18".
:* '''''barcode''''' - Штрих-код товара. [[Файл:Article.png|thumb|100px|right]]
:* '''''article''''' - Артикул товара. ''Внимание!'' Указание артикула используется только тогда, когда товар хранится на ответственном хранении в службе доставки, и необходима комплектация. В этом случае система пытается привязать товар к [[API#Справочник номенклатуры|справочнику номенклатуры]]. Если товар в справочнике не найден - система выдаст соответствующую ошибку. Если по артикулу найдено несколько товаров - система выберет один из них случайным образом, что может привести к ошибочной комплектации! Если товар НЕ на ответственном хранении - артикул указывать НЕ нужно. Позиция попадет в систему просто текстом.
:* '''''extcode''''' - Внешний код строки. Используется для идентификации строк заказов при получении статусов. Необязательное поле. ПОКА НЕ ПОДДЕРЖИВАЕТСЯ.

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

=== Примеры ответов ===

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

<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<neworder>
<createorder orderno="AB23541" error="0" errormsg="success"></createorder>
<createorder orderno="55_6542" error="0" errormsg="success"></createorder>
<createorder orderno="AB23542" error="0" errormsg="success"></createorder>
</neworder>
</source>

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

<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<neworder>
<createorder orderno="AB23541" error="17" errormsg="Such number exists"></createorder>
<createorder orderno="AB23542" error="13" errormsg="empty company"></createorder>
<createorder orderno="AB23543" error="14" errormsg="empty person"></createorder>
</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>

=== Коды ошибок при оформлении заказа ===

0 - Ошибок нет.

1 - Ошибка авторизации. (отсутствуют теги <auth login="" pass=""></auth>, неверный логин или пароль).

2 - Отправлен пустой запрос (отсутствует контейнер <neworder></neworder> в XML документе).

3 - Некорректно указана сумма заказа.

4 - Некорректный общий вес заказа.

5 - Не найден город получатель.

6 - Не найден город отправитель.

7 - Не заполнен адрес получателя.

8 - Не заполнен телефон получателя.

9 - Не заполнено контактное имя получателя.

10 - Не заполнено название компании получателя.

11 - Некорректная сумма объявленной ценности.

12 - Артикул не найден.

13 - Не заполнено название компании отправителя.

14 - Не заполнено контактное имя отправителя.

15 - Не заполнен телефон отправителя.

16 - Не заполнен адрес отправителя.

17 - Заказ с таким номером уже существует.

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

=== Пример запроса статуса заказа ===

<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>
<ordercode>34234</ordercode>
<givencode>234534</givencode>
<datefrom>2016-07-21</datefrom>
<dateto>2016-07-21</dateto>
<target>Автозавод</target>
<done>ONLY_NOT_DONE</done>
<changes>ONLY_LAST</changes>
<quickstatus>NO</quickstatus>
</statusreq>
</source>

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

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

*'''changes''' - может принимать значение только ONLY_LAST. Если указан этот параметр, все остальные, кроме quickstatus, игнорируются. Описание данного режима приведено здесь: [[#Передача только изменившихся статусов|Передача только изменившихся статусов]]

*'''quickstatus''' - Указывает "глубину" передаваемых статусов: "YES" (по-умолчанию) - передаются статусы начиная с информации, поступившей от курьера. Такие статусы являются быстрыми (как правило, проставляются курьером сразу после доставки) но не всегда точными. Значение NO запрещает передачу статуса со слов курьера, и выдает только статусы, введенные оператором, как правило вручную. На это требуется больше времени, однако точность гораздо выше. Не рекомендуется совмещать эти типы передачи статусов (чередовать их) при запросе только изменившихся статусов, т.к. в этом случае система будет считать, что статусы у отправлений меняются.

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

=== Примеры ответов ===

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

<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<statusreq count="23">
<order orderno="111111" 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>
<zipcode>125480</zipcode>
<town code="23432">Санкт-Петербург</town>
<address>Петровка 38 офис 35</address>
<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>
</receiver>
<weight>5.1</weight>
<return_weight>5.1</return_weight>
<quantity>2</quantity>
<paytype>CASH</paytype>
<service>2</service>
<return_service>2</service>
<type>3</type>
<return_type>3</return_type>
<waittime>12</waittime>
<price>387.5</price>
<print_check>YES</print_check>
<inshprice>387.5</inshprice>
<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">
<>..</> (price details are not yet supported)
..
</deliveryprice>
<receiverpays>NO</receiverpays>
<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>
<customstatecode>2<customstatecode>
<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">Мяч</item>
<item code="34456" extcode="abc124" quantity="2" mass="2" retprice="100" VATrate="10" barcode="4645625213138" article="2" returns="0">Обруч</item>
<item code="34421" extcode="abc125" quantity="3" mass="0.3" retprice="50" VATrate="18" barcode="2345625213126" article="3" returns="0">Погремушка желтая</item>
</items>
<packages>
<package code="33123" strbarcode="4625333555001" mass="0" message="">Место 1</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''':
:* '''''ordercode''''' - внутренний код заказа в системе, применяется для некоторых внутренних операций.
:* '''''givencode''''' - внутренний код заказа в системе, применяется для некоторых внутренних операций.
:* '''''returns''''' - количество данного товара, от которого отказался получатель. Не нулевое только в случае частичного отказа.

* атрибут '''''code''''' контейнера '''item''' - внутренний код строки заказа в системе, применяется для некоторых внутренних операций.
* '''''coords''''' в контейнере '''receiver''' - координаты получателя.
* '''currcoords''' - текущие координаты заказа. Атрибуты:
:* '''''lat''''' - широта
:* '''''lon''''' - долгота
:* '''''accuracy''''' - точность в метрах
:* '''''RequestDateTime''''' - дата/время последнего обновления координат.

* '''waittime ''' - Время ожидания курьера.
* '''deliveryprice''' - стоимость доставки в валюте расчетов с клиентом.
* '''status''' - статус доставки (список статусов см. ниже). Атрибуты (заполняются начиная с версии системы 2008.0.0.670):
:* '''''eventstore''''' - филиал, к которому относится текущий статус
:* '''''eventtime''''' - время изменения статуса (время зависит от местонахождения филиала)
:* '''''createtimegmt''''' - время фактического изменения статуса (GMT)
:* '''''message''''' - наименование филиала-получателя, при передаче между филиалами
:* '''''title''''' - русское наименование статуса

* '''statushistory''' - история статусов доставки. Содержит список контейнеров '''status'''. Заполняется только для тарифа "Премиум" начиная с версии системы 2008.0.0.670.
* '''customstatecode''' - код внутреннего статуса курьерской службы. Значения уточняйте в курьерской службе. Назначаются курьерской службой в разделе "Справочники" - "Статусы" - "15 Статусы корреспонденции". Справочник не передается через API клиенту по причине возможного наличия в нем внутренних технологических статусов курьерской службы.
* '''clientstatecode''' - код статуса клиента. Используется, если клиент предлагает свои коды статусов доставки/причин недоставки.
* '''deliveredto''' - данные о вручении, либо причина недоставки.
* '''delivereddate''' - дата вручения.
* '''deliveredtime''' - время вручения. В случае недоставки может быть пустым.
* '''outstrbarcode''' - код у подрядчика (код заказа во внешней системе). Используется в интеграциях с внешними системами.

*'''packages''' - Контейнер для описания мест. Необязательный контейнер. Атрибуты:
:* '''''package''''' - Название места.
:* '''''code''''' - Внутренний код строки.
:* '''''strbarcode''''' - Штрих-код места.
:* '''''mass''''' - Масса места в килограммах.
:* '''''message''''' - Строка сообщения.

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

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

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

# Атрибуты контейнера '''status''' заполняются для версий системы '''2008.0.0.670''' и новее.
# Контейнер '''statushistory''' заполняется для тарифа "[[Личный_кабинет#.D0.9F.D0.BE.D0.B4.D0.BA.D0.BB.D1.8E.D1.87.D0.B5.D0.BD.D0.B8.D0.B5|Премиум]]" и версий системы '''2008.0.0.670''' и новее.
</div>
<br />

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

Для получения только изменившихся статусов отправьте запрос
<source lang="xml">
<?xml version="1.0" encoding="UTF-8" ?>
<statusreq>
<auth extra="8" login="login" pass="pass"></auth>
<changes>ONLY_LAST</changes>
<quickstatus>NO</quickstatus>
</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>
</commitlaststatus>
</source>

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

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

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

# При данном способе передачи (<changes>ONLY_LAST</changes>) система просматривает заказы, оформленные за последние 3 месяца. Если заказ сделан ранее - изменение статуса по нему не попадет в результат выполнения данного запроса.
# Система всегда выдает текущий статус. Т.е. Вы можете одним запросом получить статус "NEW", а следующим - "COMPLETE". В промежутке между запросами отправление могло пройти через несколько промежуточных статусов.
# Система никогда не гарантирует последовательность прохождения заказом набора статусов. Т.е. Вы можете получить статус "COMPLETE", а следующим запросом - "NEW" - такое может произойти, например, если оператор ошибочно отметил заказ выполненным, а затем исправил ошибку.
</div>
<br />

== Получение вложений к накладной ==

'''Пример запроса:'''
<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.

== Трекинг заказа по номеру ==

Запрос трекинга по номеру предназначен для выдачи минимальной обезличенной информации о конкретном заказе не авторизованному пользователю. Наша система имеет для этого интерфейс по адресу "home.courierexe.ru/{код экстра}/tracking". Вы можете либо сделать ссылку на такую страницу на своем сайте, либо разместить ее 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="1234">
<sender>
<town code="1">Москва город</town>
<date></date>
</sender>
<receiver>
<town code="1">Москва город</town>
<date>2015-04-18</date>
</receiver>
<weight>0</weight>
<quantity>1</quantity>
<currcoords lat="" lon="" accuracy="" RequestDateTime="" />
<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>
</order>
</tracking>
</source>

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

== Изменение статуса агентом ==

Запрос изменения статуса заказа позволяет установить окончательный статус заказа - "Доставлен" или "Не доставлен (Возврат/Отмена)".

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

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

'''Пример запроса изменения статуса:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8" ?>
<setorderinfo>
<auth extra="8" login="login" pass="pass" />
<order ordercode="123456" date="2018-03-01" time="10:00" message="Клиент отказался от покупки"/>
<order ordercode="234567" date="2018-03-01" time="10:00" message="">
<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''''' - Внутренний код заказа.
:* '''''date''''' - Дата изменения статуса.
:* '''''time''''' - Время изменения статуса.
:* '''''message''''' - текст сообщения.

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

== Получение накладной в формате pdf ==

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

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

'''waybill''' - Корневой контейнер. Обязательный элемент.
*'''auth''' - Авторизация. Обязательный элемент.
*'''orderno''' - Номер/код заказа. Обязательный элемент.
*'''form''' - Формат накладной. Не обязательный элемент. Принимает значения:
:* 1 - Подробная накладная (по-умолчанию)
:* 2 - Наклейки (Zebra)

'''Пример ответа:'''
<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" ?>
<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>

== Справочник городов ==

'''Пример запроса справочника городов:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<townlist>
<codesearch>
<zipcode>110000</zipcode>
<kladrcode>0100000100800</kladrcode>
<fiascode>bd21979d-46f8-49d0-9105-e8d65172a983</fiascode>
<code>123</code>
</codesearch>
<conditions>
<city>Краснодарский край</city>
<namecontains>новгород</namecontains>
<namestarts>Моск</namestarts>
<name>Москва</name>
<fullname>Москва город</fullname>
<country>1</country>
</conditions>
<limit>
<limitfrom>30</limitfrom>
<limitcount>10</limitcount>
<countall>YES</countall>
</limit>
</townlist>
</source>

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

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

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

'''Пример ответа:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<townlist count="3" page="1" totalcount="3" totalpages="1">
<town>
<code>26379</code>
<city>
<code>23</code>
<name>Краснодарский край</name>
</city>
<name>Сочи город</name>
<shortname>Сочи</shortname> (not yet supported)
<typename>город</typename> (not yet supported)
</town>
<town>
<code>40331</code>
<city>
<code>32</code>
<name>Брянская область</name>
</city>
<name>Сочилов хутор</name>
<shortname>Сочилов</shortname>
<typename>хутор</typename>
</town>
<town>
<code>114016</code>
<city>
<code>60</code>
<name>Псковская область</name>
</city>
<name>Сочихино деревня</name>
<shortname>Сочихино</shortname>
<typename>деревня</typename>
</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>1</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>
<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>
</conditions>
<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 - Все. ''Это поле может быть недоступным в некоторых установках.''

*'''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>
<CountInPallet>30</CountInPallet>
<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''' - Высота в сантиметрах.
*'''CountInPallet''' - Количество штук в паллете.
*'''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>
</itemmovements>
</source>

*'''code''' - внутренний код товара в справочнике номенклатуры.

'''Пример ответа движения номенклатуры:'''
<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''' - номер документа
:* '''date''' - дата документа
:* '''message''' - комментарий

== Справочник пунктов самовывоза ==

'''Пример запроса пунктов самовывоза:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8" ?>
<pvzlist>
<auth extra="8" login="login" pass="pass"></auth>
<town>Нижний Тагил</town>
</pvzlist>
</source>

*'''town''' - Город получателя.

'''Пример ответа справочника пунктов самовывоза:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8" ?>
<pvzlist count="2">
<pvz>
<code>126</code>
<clientcode>3</clientcode>
<name>Нижний Тагил</name>
<address>622036, г. Нижний Тагил, ул. Циолковского, д. 17</address>
<phone>+73435417709, +73435254989</phone>
<comment>Жилое 5-ти этажное здание, торцом к дороге, второе здание от перекрестка Пархоменко-Циолковского.</comment>
</pvz>
<pvz>
<code>245</code>
<clientcode>NTG1</clientcode>
<name>На Красноармейской</name>
<address>КРАСНОАРМЕЙСКАЯ, д.79</address>
<phone>+7(3435)379-044</phone>
<comment>Время работы: пн.-пт. 9-18, сб. 10-14</comment>
</pvz>
</pvzlist>
</source>

*'''code''' - Код ПВЗ в системе. Используется в запросе [[API#Оформление заказа|оформления заказов]]
*'''clientcode''' - Код ПВЗ используемый компанией-подрядчиком.
*'''name''' - Наименование ПВЗ.
*'''address''' - Адрес ПВЗ.
*'''phone''' - Телефоны ПВЗ.
*'''comment''' - Дополнительная информация.

== Справочник Видов срочности ==

'''Пример запроса Видов срочности:'''
<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" ?>
<calculator>
<auth extra="8" login="login" pass="pass" />
<calc townfrom="Москва" townto="3800000300000" l="10" w="20" h="30" mass="3.7" service="1" />
</calculator>
</source>

Параметры:
*'''townfrom''' - Город-отправитель
*'''townto''' - Город-получатель
*'''l''' - Длинна в мм (не обязательный параметр)
*'''w''' - Ширина в мм (не обязательный параметр)
*'''h''' - Высота в мм (не обязательный параметр)
*'''mass''' - Масса в килограммах
*'''service''' - Режим доставки - число, указывающее на запись в справочнике [[#Справочник Видов срочности|видов срочности]]. Если этот параметр опустить, система выдаст расчет для всех доступных видов срочности, передав много контейнеров <calc> в ответе.

В авторизации можно опустить параметры 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>1163</price>
<maxdeliverydays>3</maxdeliverydays>
</calc>
</calculator>
</source>

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

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

== Список актов передачи денег ==

'''Пример запроса списка актов передачи денег:'''
<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>
<price>637.00</price>
<rur>13430.00</rur>
<pricekur>570.00</pricekur>
<priceag>67.00</priceag>
<payno>42423</payno>
<paytype>1</paytype>
<paytypename>Безнал</paytypename>
</sma>
</smalist>
</source>

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

== Детализация актов передачи денег ==

'''Пример запроса детализации актов передачи денег:'''
<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>
<status>Доставлено</status>
</specialsma>
</smadetail>
</source>

*'''code''' - Код записи.
*'''ordercode''' - Код заказа.
*'''orderno''' - Шифр заказа.
*'''orderdate''' - Дата заказа.
*'''delivereddate''' - Дата доставки.
*'''company''' - Получатель.
*'''price''' - Стоимость услуг.
*'''rur''' - Сумма заказа.
*'''inshprice''' - Стоимость заказа.
*'''pricekur''' - Стоимость курьерской доставки.
*'''priceag''' - Агентское вознаграждение.
*'''pricecalc''' - Сумма для передачи агенту.
*'''paytype''' - Тип оплаты: 1 - безнал, 2 - наличными курьером, 3 - наличными в офисе, 4 - перевод на карту.
*'''paytypename''' - Строковое представление типа оплаты
*'''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</nowiki>

API

2018-11-15T14:38:55Z

Boyko: /* Получение накладной в формате pdf */

<div style="font-size: 24px; 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>

В системе "Курьерская служба 2008" имеется возможность интеграции средствами XML API, по протоколу HTTP POST.

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

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

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

== Готовые интеграции ==

Для интеграции с популярными CMS можно скачать модули интеграции

{| class="wikitable" align="center" style="width: 80%; margin: auto; color: black; boreder: 1px solid #999999;" cellpadding="10" cellspacing="0"
!style="width: 35%;"|Система управления контентом (CMS)
!style="width: 15%;"|Версия модуля
!style="width: 15%;"|Ссылка
!style="width: 35%;"|Примечание
|-
|[[Файл:bitrix.png|center|x44px]]
|style="text-align: center;"|1.5.9 от 12.03.2018
|style="text-align: center;"|[http://courierexe.ru/download/api/bitrix.zip Скачать Unicode]<br>[http://courierexe.ru/download/api/bitrix_ansi.zip Скачать ANSI]
|Поддерживает версии 14.5 и выше
|-
|[[Файл:prestashop.png|center|x44px]]
|style="text-align: center;"|1.4.5 от 10.10.2018
|style="text-align: center;"|[http://courierexe.ru/download/api/prestashop.zip Скачать]
|Поддерживает версии 1.5.2.0 и выше (2.x в том числе!)
|-
|[[Файл:opencart.png|center|x44px]] [[Файл:ocstore.png|center|x30px]]
|style="text-align: center;"|1.7.5 от 10.08.2018
|style="text-align: center;"|[http://courierexe.ru/download/api/opencart.zip Скачать]
|Поддерживает версии с 1.5.5.1 по 2.2.<br>
[https://opencartforum.com/files/file/2906-avtomatizaciya-otpravki-i-otslezhivanie-dostavok-courierexe-dlya-opencart-15x/ Альтернативный модуль сторонних разработчиков]
|-
|[[Файл:webasyst-shopscript.png|center|x44px]]
|style="text-align: center;"|1.3.5 от 14.03.2018
|style="text-align: center;"|[http://www.webasyst.ru/store/plugin/shop/measoftcourier/ Установить]
|
|-
|[[Файл:insales.png|center|x44px]]
|style="text-align: center;"|1.2.1 от 06.09.2017
|style="text-align: center;"|[http://www.insales.ru/collection/all/product/kurierskaya-sluzhba-2008 Установить]
|[[Интеграция_с_другими_системами#Insales|Настраивается]] в ЛК пользователя в системе
|-
|[[Файл:Leadvertex.png|center|x44px]]
|style="text-align: center;"|1.0 от 15.11.2016
|style="text-align: center;"|[[Файл:Leadvertex-howto.png|center|x44px]]
|[http://blog.leadvertex.ru/news/2110-integraciya-s-kurerkami-na-platforme-measoft/ Настраивается] в ЛК пользователя в системе [https://Leadvertex.ru Leadvertex]
|-
|[[Файл:Retailcrm.png|center|x44px]]
|style="text-align: center;"|1.0 от 11.01.2018
|style="text-align: center;"|[https://www.retailcrm.ru/ RetailCRM]
|[[Интеграция_с_другими_системами#RetailCRM|Настраивается]] в ЛК пользователя в системе
|-
|[[Файл:1C.jpg|center|x44px]]
|style="text-align: center;"|1.4 от 17.11.2017
|style="text-align: center;"|-
|[https://infostart.ru/public/692790/ Альтернативный модуль сторонних разработчиков]
|-
|AMO CRM
|style="text-align: center;"|-
|style="text-align: center;"|-
|Ожидается в ближайшее время в магазине Amo
|-
|[[Файл:Joomla.png|center|x40px]]
|style="text-align: center;"|1.0.0 от 12.11.2018
|style="text-align: center;"|[http://courierexe.ru/download/api/com_measoft.zip Скачать]
|Внимание! Модуль новый, поэтому возможна некорректная передача данных.
|-
|Мой склад
|style="text-align: center;"|-
|style="text-align: center;"|-
|Ожидается в ближайшее время в магазине Мой Склад
|-
|}

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

== Тестовый аккаунт ==

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

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

== Рабочий аккаунт для подключения ==

Для подключения к площадке Вашего клиента необходимо иметь три параметра:

1. '''Параметр extra''' (Цифровой код, уникальный идентификатор компании. Запросите этот параметр у компании, с которой Вы интегрируетесь). Посмотреть этот код можно в интерфейсе программы КС2008 через основное меню '''"Справочники - Дополнительные возможности"'''. Цифровое значение будет указано во второй гиперссылке (на скриншоте ниже отмечено "звездочкой"):

[[Файл:extra1.png|750px]]

2. '''Логин''' - параметр учетной записи для ЛК клиента и API, указывается в карточке клиента на вкладке '''"Прочее"''' в поле '''"Имя пользователя"'''. Возможно, что в программе КС2008 понадобится создать новую карточку клиента (на скриншоте ниже).

3. '''Пароль''' - параметр учетной записи для ЛК клиента и API, указывается в карточке клиента на вкладке '''"Прочее"''' в поле '''"Пароль"''' (на скриншоте ниже).

[[Файл:33_client.png|500px]]

== Общие понятия ==

На стороне курьерской службы имеется веб-сервис по адресу: https://home.courierexe.ru/api/. Тестовые авторизационные данные: логин: test пароль: testm, параметр 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; < на &lt; > на &gt; " на &quot;

== Ограничения ==
С целью защиты от нецелевого использования сервисов, с 29.05.2017 ведено ограничение на запросы - 1500 запросов с одного IP-адреса за 20 минут. В случае превышения IP-адрес блокируется, разблокировка возможна путем обращения в техническую поддержку, с последующим обсуждением ваших алгоритмов и их коррекцией.

Для проверки статусов заказов лучше всего использовать запросы [[#Передача только изменившихся статусов|"statusreq" с параметром changes=ONLY_LAST]]. Не нужно пытаться "бомбить" наше API запросами с номерами всех ваших заказов, особенно - запросами "tracking", они предназначены не для этого (смотрите описание).

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

<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>Чип & Дейл</person>
<phone>123-45-67</phone>
<zipcode>125480</zipcode>
<town>Санкт-Петербург</town>
<address>Петровка 38 офис 35</address>
<date>2014-03-22</date>
<time_min>09:00</time_min>
<time_max>14:00</time_max>
</receiver>
<return>NO</return>
<return_service>1</return_service>
<weight>5.1</weight>
<return_weight>5.1</return_weight>
<quantity>2</quantity>
<paytype>CASH</paytype>
<service>2</service>
<type>3</type>
<return_type>3</return_type>
<price>387.5</price>
<deliveryprice>150</deliveryprice>
<discount>0</discount>
<inshprice>387.5</inshprice>
<enclosure>Детские игрушки</enclosure>
<instruction>Проверить при покупателе, подписать акт</instruction>
<pvz>124</pvz>
<department>Отдел</department>
<pickup>NO</pickup>
<acceptpartially>NO</acceptpartially>
<items>
<item extcode="abc123" quantity="1" mass="0.2" retprice="37.5" VATrate="0" barcode="2345625213125" article="1" volume="3">Мяч</item>
<item extcode="abc124" quantity="2" mass="2" retprice="100" VATrate="10" barcode="4645625213138" article="2" length="10" width="20" height="30">Обруч</item>
<item extcode="abc125" quantity="3" mass="0.3" retprice="50" barcode="2345625213126" article="3">Погремушка желтая</item>
</items>
</order>
</neworder>
</source>

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

*'''neworder''' - Корневой контейнер, обязательный элемент.

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

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

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

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

*'''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>Город получателя в формате "Москва город"</town>
<address>Адрес получателя</address>
<date>Дата доставки в формате "YYYY-MM-DD"</date>
<time_min>Желаемое время доставки в формате "HH:MM"</time_min>
<time_max>Желаемое время доставки в формате "HH:MM"</time_max>
</receiver>
</source>

*'''company''' - Компания-получатель.
*'''person''' - Контактное лицо. ''Должно быть заполнено хотя бы одно из полей - company или person!''
*'''phone''' - Телефон. Можно указывать несколько телефонов, E-mail в этом поле.
*'''town''' - Город.

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

*'''paytype''' - Тип оплаты заказа получателем. Принимает значения:
:* CASH - Наличными при получении (по-умолчанию)
:* CARD - Картой при получении
:* NO - Без оплаты. Поле Price будет проигнорировано. (Этот тип оплаты передается, если заказ уже оплачен и не требует инкассации, API добавит в систему товары по нулевой цене. Если необходимо передать общую сумму заказа - можно это сделать в поле <inshprice>, указав объявленную ценность)
:* OTHER - Прочее (Предусмотрен для того, чтобы оплата поступала непосредственно в курьерскую службу посредством прочих типов оплаты - таких как: вебмани, яденьги, картой на сайте, прочие платежные системы и т.д.)
:* OPTION - На выбор получателя. Этот тип оплаты нельзя передавать с заказом. Он выставляется автоматически в зависимости от настройки клиента.

*'''zipcode''' - Почтовый индекс.
*'''weight''' - Общий вес заказа в килограммах.
*'''return_weight''' - Общий вес возврата заказа в килограммах.
*'''quantity''' - Количество мест.
*'''service''' - Режим доставки (тип услуги) передается код из справочника "Виды срочности".
*'''type''' - Тип корреспонденции (отправления) передается код из справочника "Типы корреспонденции".
*'''return_type''' - Тип возвратной корреспонденции (отправления) передается код из справочника "Типы корреспонденции".
*'''price''' - Сумма заказа. В случае наличия контейнера items значение данного параметра будет проигнорировано, и рассчитано автоматически.
*'''deliveryprice''' - Сумма доставки. В случае наличия контейнера items, в него будет добавлено вложение "Доставка".
*'''discount''' - Скидка на заказ. В результате сумма заказа будет уменьшена на размер скидки.
*'''return''' - Признак необходимости возврата.
*'''return_service''' - Режим возврата (тип услуги) передается код из справочника "Виды срочности".
*'''enclosure''' - Вложение.
*'''inshprice''' - Объявленная ценность.
*'''instruction''' - Поручение - Примечание.
*'''pvz''' - Код пункта самовывоза по [[#Справочник пунктов самовывоза|справочнику]]
*'''department''' - Подразделение, в котором оформляется заказ.
*'''pickup''' - Признак оформления забора YES/NO. Если стоит YES, то весь заказ считается заданием на забор груза, а не на доставку! Применяется для вызова курьера к отправителю для забора других отправлений.
*'''acceptpartially''' - Признак возможности частичного выкупа товаров отправления YES/NO.

*'''items''' - Контейнер для описания вложенных товаров. Необязательный контейнер. Атрибуты:
:* '''''item''''' - Название товара.
:* '''''quantity''''' - Количество единиц товара.
:* '''''mass''''' - Масса единицы товара в килограммах.
:* '''''volume''''' - Объемный вес единицы товара в килограммах. При указании объемного веса значение подставляется вместо массы
:* '''''length''''' - Длина единицы товара.
:* '''''width''''' - Ширина единицы товара.
:* '''''height''''' - Высота единицы товара.
:* '''''retprice''''' - Цена единицы товара.
:* '''''VATrate''''' - Ставка НДС - целое число процентов. Если значение не указано, подставляется значение "18".
:* '''''barcode''''' - Штрих-код товара. [[Файл:Article.png|thumb|100px|right]]
:* '''''article''''' - Артикул товара. ''Внимание!'' Указание артикула используется только тогда, когда товар хранится на ответственном хранении в службе доставки, и необходима комплектация. В этом случае система пытается привязать товар к [[API#Справочник номенклатуры|справочнику номенклатуры]]. Если товар в справочнике не найден - система выдаст соответствующую ошибку. Если по артикулу найдено несколько товаров - система выберет один из них случайным образом, что может привести к ошибочной комплектации! Если товар НЕ на ответственном хранении - артикул указывать НЕ нужно. Позиция попадет в систему просто текстом.
:* '''''extcode''''' - Внешний код строки. Используется для идентификации строк заказов при получении статусов. Необязательное поле. ПОКА НЕ ПОДДЕРЖИВАЕТСЯ.

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

=== Примеры ответов ===

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

<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<neworder>
<createorder orderno="AB23541" error="0" errormsg="success"></createorder>
<createorder orderno="55_6542" error="0" errormsg="success"></createorder>
<createorder orderno="AB23542" error="0" errormsg="success"></createorder>
</neworder>
</source>

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

<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<neworder>
<createorder orderno="AB23541" error="17" errormsg="Such number exists"></createorder>
<createorder orderno="AB23542" error="13" errormsg="empty company"></createorder>
<createorder orderno="AB23543" error="14" errormsg="empty person"></createorder>
</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>

=== Коды ошибок при оформлении заказа ===

0 - Ошибок нет.

1 - Ошибка авторизации. (отсутствуют теги <auth login="" pass=""></auth>, неверный логин или пароль).

2 - Отправлен пустой запрос (отсутствует контейнер <neworder></neworder> в XML документе).

3 - Некорректно указана сумма заказа.

4 - Некорректный общий вес заказа.

5 - Не найден город получатель.

6 - Не найден город отправитель.

7 - Не заполнен адрес получателя.

8 - Не заполнен телефон получателя.

9 - Не заполнено контактное имя получателя.

10 - Не заполнено название компании получателя.

11 - Некорректная сумма объявленной ценности.

12 - Артикул не найден.

13 - Не заполнено название компании отправителя.

14 - Не заполнено контактное имя отправителя.

15 - Не заполнен телефон отправителя.

16 - Не заполнен адрес отправителя.

17 - Заказ с таким номером уже существует.

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

=== Пример запроса статуса заказа ===

<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>
<ordercode>34234</ordercode>
<givencode>234534</givencode>
<datefrom>2016-07-21</datefrom>
<dateto>2016-07-21</dateto>
<target>Автозавод</target>
<done>ONLY_NOT_DONE</done>
<changes>ONLY_LAST</changes>
<quickstatus>NO</quickstatus>
</statusreq>
</source>

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

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

*'''changes''' - может принимать значение только ONLY_LAST. Если указан этот параметр, все остальные, кроме quickstatus, игнорируются. Описание данного режима приведено здесь: [[#Передача только изменившихся статусов|Передача только изменившихся статусов]]

*'''quickstatus''' - Указывает "глубину" передаваемых статусов: "YES" (по-умолчанию) - передаются статусы начиная с информации, поступившей от курьера. Такие статусы являются быстрыми (как правило, проставляются курьером сразу после доставки) но не всегда точными. Значение NO запрещает передачу статуса со слов курьера, и выдает только статусы, введенные оператором, как правило вручную. На это требуется больше времени, однако точность гораздо выше. Не рекомендуется совмещать эти типы передачи статусов (чередовать их) при запросе только изменившихся статусов, т.к. в этом случае система будет считать, что статусы у отправлений меняются.

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

=== Примеры ответов ===

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

<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<statusreq count="23">
<order orderno="111111" 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>
<zipcode>125480</zipcode>
<town code="23432">Санкт-Петербург</town>
<address>Петровка 38 офис 35</address>
<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>
</receiver>
<weight>5.1</weight>
<return_weight>5.1</return_weight>
<quantity>2</quantity>
<paytype>CASH</paytype>
<service>2</service>
<type>3</type>
<return_type>3</return_type>
<waittime>12</waittime>
<price>387.5</price>
<print_check>YES</print_check>
<inshprice>387.5</inshprice>
<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">
<>..</> (price details are not yet supported)
..
</deliveryprice>
<receiverpays>NO</receiverpays>
<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>
<customstatecode>2<customstatecode>
<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">Мяч</item>
<item code="34456" extcode="abc124" quantity="2" mass="2" retprice="100" VATrate="10" barcode="4645625213138" article="2" returns="0">Обруч</item>
<item code="34421" extcode="abc125" quantity="3" mass="0.3" retprice="50" VATrate="18" barcode="2345625213126" article="3" returns="0">Погремушка желтая</item>
</items>
<packages>
<package code="33123" strbarcode="4625333555001" mass="0" message="">Место 1</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''':
:* '''''ordercode''''' - внутренний код заказа в системе, применяется для некоторых внутренних операций.
:* '''''givencode''''' - внутренний код заказа в системе, применяется для некоторых внутренних операций.
:* '''''returns''''' - количество данного товара, от которого отказался получатель. Не нулевое только в случае частичного отказа.

* атрибут '''''code''''' контейнера '''item''' - внутренний код строки заказа в системе, применяется для некоторых внутренних операций.
* '''''coords''''' в контейнере '''receiver''' - координаты получателя.
* '''currcoords''' - текущие координаты заказа. Атрибуты:
:* '''''lat''''' - широта
:* '''''lon''''' - долгота
:* '''''accuracy''''' - точность в метрах
:* '''''RequestDateTime''''' - дата/время последнего обновления координат.

* '''waittime ''' - Время ожидания курьера.
* '''deliveryprice''' - стоимость доставки в валюте расчетов с клиентом.
* '''status''' - статус доставки (список статусов см. ниже). Атрибуты (заполняются начиная с версии системы 2008.0.0.670):
:* '''''eventstore''''' - филиал, к которому относится текущий статус
:* '''''eventtime''''' - время изменения статуса (время зависит от местонахождения филиала)
:* '''''createtimegmt''''' - время фактического изменения статуса (GMT)
:* '''''message''''' - наименование филиала-получателя, при передаче между филиалами
:* '''''title''''' - русское наименование статуса

* '''statushistory''' - история статусов доставки. Содержит список контейнеров '''status'''. Заполняется только для тарифа "Премиум" начиная с версии системы 2008.0.0.670.
* '''customstatecode''' - код внутреннего статуса курьерской службы. Значения уточняйте в курьерской службе. Назначаются курьерской службой в разделе "Справочники" - "Статусы" - "15 Статусы корреспонденции". Справочник не передается через API клиенту по причине возможного наличия в нем внутренних технологических статусов курьерской службы.
* '''clientstatecode''' - код статуса клиента. Используется, если клиент предлагает свои коды статусов доставки/причин недоставки.
* '''deliveredto''' - данные о вручении, либо причина недоставки.
* '''delivereddate''' - дата вручения.
* '''deliveredtime''' - время вручения. В случае недоставки может быть пустым.
* '''outstrbarcode''' - код у подрядчика (код заказа во внешней системе). Используется в интеграциях с внешними системами.

*'''packages''' - Контейнер для описания мест. Необязательный контейнер. Атрибуты:
:* '''''package''''' - Название места.
:* '''''code''''' - Внутренний код строки.
:* '''''strbarcode''''' - Штрих-код места.
:* '''''mass''''' - Масса места в килограммах.
:* '''''message''''' - Строка сообщения.

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

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

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

# Атрибуты контейнера '''status''' заполняются для версий системы '''2008.0.0.670''' и новее.
# Контейнер '''statushistory''' заполняется для тарифа "[[Личный_кабинет#.D0.9F.D0.BE.D0.B4.D0.BA.D0.BB.D1.8E.D1.87.D0.B5.D0.BD.D0.B8.D0.B5|Премиум]]" и версий системы '''2008.0.0.670''' и новее.
</div>
<br />

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

Для получения только изменившихся статусов отправьте запрос
<source lang="xml">
<?xml version="1.0" encoding="UTF-8" ?>
<statusreq>
<auth extra="8" login="login" pass="pass"></auth>
<changes>ONLY_LAST</changes>
<quickstatus>NO</quickstatus>
</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>
</commitlaststatus>
</source>

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

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

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

# При данном способе передачи (<changes>ONLY_LAST</changes>) система просматривает заказы, оформленные за последние 3 месяца. Если заказ сделан ранее - изменение статуса по нему не попадет в результат выполнения данного запроса.
# Система всегда выдает текущий статус. Т.е. Вы можете одним запросом получить статус "NEW", а следующим - "COMPLETE". В промежутке между запросами отправление могло пройти через несколько промежуточных статусов.
# Система никогда не гарантирует последовательность прохождения заказом набора статусов. Т.е. Вы можете получить статус "COMPLETE", а следующим запросом - "NEW" - такое может произойти, например, если оператор ошибочно отметил заказ выполненным, а затем исправил ошибку.
</div>
<br />

== Получение вложений к накладной ==

'''Пример запроса:'''
<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.

== Трекинг заказа по номеру ==

Запрос трекинга по номеру предназначен для выдачи минимальной обезличенной информации о конкретном заказе не авторизованному пользователю. Наша система имеет для этого интерфейс по адресу "home.courierexe.ru/{код экстра}/tracking". Вы можете либо сделать ссылку на такую страницу на своем сайте, либо разместить ее 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="1234">
<sender>
<town code="1">Москва город</town>
<date></date>
</sender>
<receiver>
<town code="1">Москва город</town>
<date>2015-04-18</date>
</receiver>
<weight>0</weight>
<quantity>1</quantity>
<currcoords lat="" lon="" accuracy="" RequestDateTime="" />
<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>
</order>
</tracking>
</source>

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

== Изменение статуса агентом ==

Запрос изменения статуса заказа позволяет установить окончательный статус заказа - "Доставлен" или "Не доставлен (Возврат/Отмена)".

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

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

'''Пример запроса изменения статуса:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8" ?>
<setorderinfo>
<auth extra="8" login="login" pass="pass" />
<order ordercode="123456" date="2018-03-01" time="10:00" message="Клиент отказался от покупки"/>
<order ordercode="234567" date="2018-03-01" time="10:00" message="">
<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''''' - Внутренний код заказа.
:* '''''date''''' - Дата изменения статуса.
:* '''''time''''' - Время изменения статуса.
:* '''''message''''' - текст сообщения.

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

== Получение накладной в формате pdf ==

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

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

'''waybill''' - Корневой контейнер. Обязательный элемент.
*'''auth''' - Авторизация. Обязательный элемент.
*'''orderno''' - Номер/код заказа. Обязательный элемент.
*'''form''' - Формат накладной. Не обязательный элемент. Принимает значения:
:* 1 - Подробная накладная (по-умолчанию)
:* 2 - Наклейки (Zebra)

'''Пример ответа:'''
<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" ?>
<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>

== Справочник городов ==

'''Пример запроса справочника городов:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<townlist>
<codesearch>
<zipcode>110000</zipcode>
<kladrcode>0100000100800</kladrcode>
<fiascode>bd21979d-46f8-49d0-9105-e8d65172a983</fiascode>
<code>123</code>
</codesearch>
<conditions>
<city>Краснодарский край</city>
<namecontains>новгород</namecontains>
<namestarts>Моск</namestarts>
<name>Москва</name>
<fullname>Москва город</fullname>
<country>1</country>
</conditions>
<limit>
<limitfrom>30</limitfrom>
<limitcount>10</limitcount>
<countall>YES</countall>
</limit>
</townlist>
</source>

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

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

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

'''Пример ответа:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<townlist count="3" page="1" totalcount="3" totalpages="1">
<town>
<code>26379</code>
<city>
<code>23</code>
<name>Краснодарский край</name>
</city>
<name>Сочи город</name>
<shortname>Сочи</shortname> (not yet supported)
<typename>город</typename> (not yet supported)
</town>
<town>
<code>40331</code>
<city>
<code>32</code>
<name>Брянская область</name>
</city>
<name>Сочилов хутор</name>
<shortname>Сочилов</shortname>
<typename>хутор</typename>
</town>
<town>
<code>114016</code>
<city>
<code>60</code>
<name>Псковская область</name>
</city>
<name>Сочихино деревня</name>
<shortname>Сочихино</shortname>
<typename>деревня</typename>
</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>1</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>
<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>
</conditions>
<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 - Все. ''Это поле может быть недоступным в некоторых установках.''

*'''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>
<CountInPallet>30</CountInPallet>
<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''' - Высота в сантиметрах.
*'''CountInPallet''' - Количество штук в паллете.
*'''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>
</itemmovements>
</source>

*'''code''' - внутренний код товара в справочнике номенклатуры.

'''Пример ответа движения номенклатуры:'''
<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''' - номер документа
:* '''date''' - дата документа
:* '''message''' - комментарий

== Справочник пунктов самовывоза ==

'''Пример запроса пунктов самовывоза:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8" ?>
<pvzlist>
<auth extra="8" login="login" pass="pass"></auth>
<town>Нижний Тагил</town>
</pvzlist>
</source>

*'''town''' - Город получателя.

'''Пример ответа справочника пунктов самовывоза:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8" ?>
<pvzlist count="2">
<pvz>
<code>126</code>
<clientcode>3</clientcode>
<name>Нижний Тагил</name>
<address>622036, г. Нижний Тагил, ул. Циолковского, д. 17</address>
<phone>+73435417709, +73435254989</phone>
<comment>Жилое 5-ти этажное здание, торцом к дороге, второе здание от перекрестка Пархоменко-Циолковского.</comment>
</pvz>
<pvz>
<code>245</code>
<clientcode>NTG1</clientcode>
<name>На Красноармейской</name>
<address>КРАСНОАРМЕЙСКАЯ, д.79</address>
<phone>+7(3435)379-044</phone>
<comment>Время работы: пн.-пт. 9-18, сб. 10-14</comment>
</pvz>
</pvzlist>
</source>

*'''code''' - Код ПВЗ в системе. Используется в запросе [[API#Оформление заказа|оформления заказов]]
*'''clientcode''' - Код ПВЗ используемый компанией-подрядчиком.
*'''name''' - Наименование ПВЗ.
*'''address''' - Адрес ПВЗ.
*'''phone''' - Телефоны ПВЗ.
*'''comment''' - Дополнительная информация.

== Справочник Видов срочности ==

'''Пример запроса Видов срочности:'''
<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" ?>
<calculator>
<auth extra="8" login="login" pass="pass" />
<calc townfrom="Москва" townto="3800000300000" mass="3.7" service="1" />
</calculator>
</source>

Параметры:
*'''townfrom''' - Город-отправитель
*'''townto''' - Город-получатель
*'''mass''' - Масса в килограммах
*'''service''' - Режим доставки - число, указывающее на запись в справочнике [[#Справочник Видов срочности|видов срочности]]. Если этот параметр опустить, система выдаст расчет для всех доступных видов срочности, передав много контейнеров <calc> в ответе.

В авторизации можно опустить параметры login и pass, тогда расчет будет производиться по стандартному тарифу курьерской службы, без учета возможных отличий для конкретного клиента.<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>1163</price>
<maxdeliverydays>3</maxdeliverydays>
</calc>
</calculator>
</source>

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

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

== Список актов передачи денег ==

'''Пример запроса списка актов передачи денег:'''
<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>
<price>637.00</price>
<rur>13430.00</rur>
<pricekur>570.00</pricekur>
<priceag>67.00</priceag>
<payno>42423</payno>
<paytype>1</paytype>
<paytypename>Безнал</paytypename>
</sma>
</smalist>
</source>

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

== Детализация актов передачи денег ==

'''Пример запроса детализации актов передачи денег:'''
<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>
<status>Доставлено</status>
</specialsma>
</smadetail>
</source>

*'''code''' - Код записи.
*'''ordercode''' - Код заказа.
*'''orderno''' - Шифр заказа.
*'''orderdate''' - Дата заказа.
*'''delivereddate''' - Дата доставки.
*'''company''' - Получатель.
*'''price''' - Стоимость услуг.
*'''rur''' - Сумма заказа.
*'''inshprice''' - Стоимость заказа.
*'''pricekur''' - Стоимость курьерской доставки.
*'''priceag''' - Агентское вознаграждение.
*'''pricecalc''' - Сумма для передачи агенту.
*'''paytype''' - Тип оплаты: 1 - безнал, 2 - наличными курьером, 3 - наличными в офисе, 4 - перевод на карту.
*'''paytypename''' - Строковое представление типа оплаты
*'''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</nowiki>

API

2018-11-15T14:37:56Z

Boyko: /* Получение накладной в формате pdf */

<div style="font-size: 24px; 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>

В системе "Курьерская служба 2008" имеется возможность интеграции средствами XML API, по протоколу HTTP POST.

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

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

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

== Готовые интеграции ==

Для интеграции с популярными CMS можно скачать модули интеграции

{| class="wikitable" align="center" style="width: 80%; margin: auto; color: black; boreder: 1px solid #999999;" cellpadding="10" cellspacing="0"
!style="width: 35%;"|Система управления контентом (CMS)
!style="width: 15%;"|Версия модуля
!style="width: 15%;"|Ссылка
!style="width: 35%;"|Примечание
|-
|[[Файл:bitrix.png|center|x44px]]
|style="text-align: center;"|1.5.9 от 12.03.2018
|style="text-align: center;"|[http://courierexe.ru/download/api/bitrix.zip Скачать Unicode]<br>[http://courierexe.ru/download/api/bitrix_ansi.zip Скачать ANSI]
|Поддерживает версии 14.5 и выше
|-
|[[Файл:prestashop.png|center|x44px]]
|style="text-align: center;"|1.4.5 от 10.10.2018
|style="text-align: center;"|[http://courierexe.ru/download/api/prestashop.zip Скачать]
|Поддерживает версии 1.5.2.0 и выше (2.x в том числе!)
|-
|[[Файл:opencart.png|center|x44px]] [[Файл:ocstore.png|center|x30px]]
|style="text-align: center;"|1.7.5 от 10.08.2018
|style="text-align: center;"|[http://courierexe.ru/download/api/opencart.zip Скачать]
|Поддерживает версии с 1.5.5.1 по 2.2.<br>
[https://opencartforum.com/files/file/2906-avtomatizaciya-otpravki-i-otslezhivanie-dostavok-courierexe-dlya-opencart-15x/ Альтернативный модуль сторонних разработчиков]
|-
|[[Файл:webasyst-shopscript.png|center|x44px]]
|style="text-align: center;"|1.3.5 от 14.03.2018
|style="text-align: center;"|[http://www.webasyst.ru/store/plugin/shop/measoftcourier/ Установить]
|
|-
|[[Файл:insales.png|center|x44px]]
|style="text-align: center;"|1.2.1 от 06.09.2017
|style="text-align: center;"|[http://www.insales.ru/collection/all/product/kurierskaya-sluzhba-2008 Установить]
|[[Интеграция_с_другими_системами#Insales|Настраивается]] в ЛК пользователя в системе
|-
|[[Файл:Leadvertex.png|center|x44px]]
|style="text-align: center;"|1.0 от 15.11.2016
|style="text-align: center;"|[[Файл:Leadvertex-howto.png|center|x44px]]
|[http://blog.leadvertex.ru/news/2110-integraciya-s-kurerkami-na-platforme-measoft/ Настраивается] в ЛК пользователя в системе [https://Leadvertex.ru Leadvertex]
|-
|[[Файл:Retailcrm.png|center|x44px]]
|style="text-align: center;"|1.0 от 11.01.2018
|style="text-align: center;"|[https://www.retailcrm.ru/ RetailCRM]
|[[Интеграция_с_другими_системами#RetailCRM|Настраивается]] в ЛК пользователя в системе
|-
|[[Файл:1C.jpg|center|x44px]]
|style="text-align: center;"|1.4 от 17.11.2017
|style="text-align: center;"|-
|[https://infostart.ru/public/692790/ Альтернативный модуль сторонних разработчиков]
|-
|AMO CRM
|style="text-align: center;"|-
|style="text-align: center;"|-
|Ожидается в ближайшее время в магазине Amo
|-
|[[Файл:Joomla.png|center|x40px]]
|style="text-align: center;"|1.0.0 от 12.11.2018
|style="text-align: center;"|[http://courierexe.ru/download/api/com_measoft.zip Скачать]
|Внимание! Модуль новый, поэтому возможна некорректная передача данных.
|-
|Мой склад
|style="text-align: center;"|-
|style="text-align: center;"|-
|Ожидается в ближайшее время в магазине Мой Склад
|-
|}

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

== Тестовый аккаунт ==

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

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

== Рабочий аккаунт для подключения ==

Для подключения к площадке Вашего клиента необходимо иметь три параметра:

1. '''Параметр extra''' (Цифровой код, уникальный идентификатор компании. Запросите этот параметр у компании, с которой Вы интегрируетесь). Посмотреть этот код можно в интерфейсе программы КС2008 через основное меню '''"Справочники - Дополнительные возможности"'''. Цифровое значение будет указано во второй гиперссылке (на скриншоте ниже отмечено "звездочкой"):

[[Файл:extra1.png|750px]]

2. '''Логин''' - параметр учетной записи для ЛК клиента и API, указывается в карточке клиента на вкладке '''"Прочее"''' в поле '''"Имя пользователя"'''. Возможно, что в программе КС2008 понадобится создать новую карточку клиента (на скриншоте ниже).

3. '''Пароль''' - параметр учетной записи для ЛК клиента и API, указывается в карточке клиента на вкладке '''"Прочее"''' в поле '''"Пароль"''' (на скриншоте ниже).

[[Файл:33_client.png|500px]]

== Общие понятия ==

На стороне курьерской службы имеется веб-сервис по адресу: https://home.courierexe.ru/api/. Тестовые авторизационные данные: логин: test пароль: testm, параметр 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; < на &lt; > на &gt; " на &quot;

== Ограничения ==
С целью защиты от нецелевого использования сервисов, с 29.05.2017 ведено ограничение на запросы - 1500 запросов с одного IP-адреса за 20 минут. В случае превышения IP-адрес блокируется, разблокировка возможна путем обращения в техническую поддержку, с последующим обсуждением ваших алгоритмов и их коррекцией.

Для проверки статусов заказов лучше всего использовать запросы [[#Передача только изменившихся статусов|"statusreq" с параметром changes=ONLY_LAST]]. Не нужно пытаться "бомбить" наше API запросами с номерами всех ваших заказов, особенно - запросами "tracking", они предназначены не для этого (смотрите описание).

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

<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>Чип & Дейл</person>
<phone>123-45-67</phone>
<zipcode>125480</zipcode>
<town>Санкт-Петербург</town>
<address>Петровка 38 офис 35</address>
<date>2014-03-22</date>
<time_min>09:00</time_min>
<time_max>14:00</time_max>
</receiver>
<return>NO</return>
<return_service>1</return_service>
<weight>5.1</weight>
<return_weight>5.1</return_weight>
<quantity>2</quantity>
<paytype>CASH</paytype>
<service>2</service>
<type>3</type>
<return_type>3</return_type>
<price>387.5</price>
<deliveryprice>150</deliveryprice>
<discount>0</discount>
<inshprice>387.5</inshprice>
<enclosure>Детские игрушки</enclosure>
<instruction>Проверить при покупателе, подписать акт</instruction>
<pvz>124</pvz>
<department>Отдел</department>
<pickup>NO</pickup>
<acceptpartially>NO</acceptpartially>
<items>
<item extcode="abc123" quantity="1" mass="0.2" retprice="37.5" VATrate="0" barcode="2345625213125" article="1" volume="3">Мяч</item>
<item extcode="abc124" quantity="2" mass="2" retprice="100" VATrate="10" barcode="4645625213138" article="2" length="10" width="20" height="30">Обруч</item>
<item extcode="abc125" quantity="3" mass="0.3" retprice="50" barcode="2345625213126" article="3">Погремушка желтая</item>
</items>
</order>
</neworder>
</source>

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

*'''neworder''' - Корневой контейнер, обязательный элемент.

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

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

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

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

*'''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>Город получателя в формате "Москва город"</town>
<address>Адрес получателя</address>
<date>Дата доставки в формате "YYYY-MM-DD"</date>
<time_min>Желаемое время доставки в формате "HH:MM"</time_min>
<time_max>Желаемое время доставки в формате "HH:MM"</time_max>
</receiver>
</source>

*'''company''' - Компания-получатель.
*'''person''' - Контактное лицо. ''Должно быть заполнено хотя бы одно из полей - company или person!''
*'''phone''' - Телефон. Можно указывать несколько телефонов, E-mail в этом поле.
*'''town''' - Город.

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

*'''paytype''' - Тип оплаты заказа получателем. Принимает значения:
:* CASH - Наличными при получении (по-умолчанию)
:* CARD - Картой при получении
:* NO - Без оплаты. Поле Price будет проигнорировано. (Этот тип оплаты передается, если заказ уже оплачен и не требует инкассации, API добавит в систему товары по нулевой цене. Если необходимо передать общую сумму заказа - можно это сделать в поле <inshprice>, указав объявленную ценность)
:* OTHER - Прочее (Предусмотрен для того, чтобы оплата поступала непосредственно в курьерскую службу посредством прочих типов оплаты - таких как: вебмани, яденьги, картой на сайте, прочие платежные системы и т.д.)
:* OPTION - На выбор получателя. Этот тип оплаты нельзя передавать с заказом. Он выставляется автоматически в зависимости от настройки клиента.

*'''zipcode''' - Почтовый индекс.
*'''weight''' - Общий вес заказа в килограммах.
*'''return_weight''' - Общий вес возврата заказа в килограммах.
*'''quantity''' - Количество мест.
*'''service''' - Режим доставки (тип услуги) передается код из справочника "Виды срочности".
*'''type''' - Тип корреспонденции (отправления) передается код из справочника "Типы корреспонденции".
*'''return_type''' - Тип возвратной корреспонденции (отправления) передается код из справочника "Типы корреспонденции".
*'''price''' - Сумма заказа. В случае наличия контейнера items значение данного параметра будет проигнорировано, и рассчитано автоматически.
*'''deliveryprice''' - Сумма доставки. В случае наличия контейнера items, в него будет добавлено вложение "Доставка".
*'''discount''' - Скидка на заказ. В результате сумма заказа будет уменьшена на размер скидки.
*'''return''' - Признак необходимости возврата.
*'''return_service''' - Режим возврата (тип услуги) передается код из справочника "Виды срочности".
*'''enclosure''' - Вложение.
*'''inshprice''' - Объявленная ценность.
*'''instruction''' - Поручение - Примечание.
*'''pvz''' - Код пункта самовывоза по [[#Справочник пунктов самовывоза|справочнику]]
*'''department''' - Подразделение, в котором оформляется заказ.
*'''pickup''' - Признак оформления забора YES/NO. Если стоит YES, то весь заказ считается заданием на забор груза, а не на доставку! Применяется для вызова курьера к отправителю для забора других отправлений.
*'''acceptpartially''' - Признак возможности частичного выкупа товаров отправления YES/NO.

*'''items''' - Контейнер для описания вложенных товаров. Необязательный контейнер. Атрибуты:
:* '''''item''''' - Название товара.
:* '''''quantity''''' - Количество единиц товара.
:* '''''mass''''' - Масса единицы товара в килограммах.
:* '''''volume''''' - Объемный вес единицы товара в килограммах. При указании объемного веса значение подставляется вместо массы
:* '''''length''''' - Длина единицы товара.
:* '''''width''''' - Ширина единицы товара.
:* '''''height''''' - Высота единицы товара.
:* '''''retprice''''' - Цена единицы товара.
:* '''''VATrate''''' - Ставка НДС - целое число процентов. Если значение не указано, подставляется значение "18".
:* '''''barcode''''' - Штрих-код товара. [[Файл:Article.png|thumb|100px|right]]
:* '''''article''''' - Артикул товара. ''Внимание!'' Указание артикула используется только тогда, когда товар хранится на ответственном хранении в службе доставки, и необходима комплектация. В этом случае система пытается привязать товар к [[API#Справочник номенклатуры|справочнику номенклатуры]]. Если товар в справочнике не найден - система выдаст соответствующую ошибку. Если по артикулу найдено несколько товаров - система выберет один из них случайным образом, что может привести к ошибочной комплектации! Если товар НЕ на ответственном хранении - артикул указывать НЕ нужно. Позиция попадет в систему просто текстом.
:* '''''extcode''''' - Внешний код строки. Используется для идентификации строк заказов при получении статусов. Необязательное поле. ПОКА НЕ ПОДДЕРЖИВАЕТСЯ.

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

=== Примеры ответов ===

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

<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<neworder>
<createorder orderno="AB23541" error="0" errormsg="success"></createorder>
<createorder orderno="55_6542" error="0" errormsg="success"></createorder>
<createorder orderno="AB23542" error="0" errormsg="success"></createorder>
</neworder>
</source>

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

<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<neworder>
<createorder orderno="AB23541" error="17" errormsg="Such number exists"></createorder>
<createorder orderno="AB23542" error="13" errormsg="empty company"></createorder>
<createorder orderno="AB23543" error="14" errormsg="empty person"></createorder>
</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>

=== Коды ошибок при оформлении заказа ===

0 - Ошибок нет.

1 - Ошибка авторизации. (отсутствуют теги <auth login="" pass=""></auth>, неверный логин или пароль).

2 - Отправлен пустой запрос (отсутствует контейнер <neworder></neworder> в XML документе).

3 - Некорректно указана сумма заказа.

4 - Некорректный общий вес заказа.

5 - Не найден город получатель.

6 - Не найден город отправитель.

7 - Не заполнен адрес получателя.

8 - Не заполнен телефон получателя.

9 - Не заполнено контактное имя получателя.

10 - Не заполнено название компании получателя.

11 - Некорректная сумма объявленной ценности.

12 - Артикул не найден.

13 - Не заполнено название компании отправителя.

14 - Не заполнено контактное имя отправителя.

15 - Не заполнен телефон отправителя.

16 - Не заполнен адрес отправителя.

17 - Заказ с таким номером уже существует.

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

=== Пример запроса статуса заказа ===

<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>
<ordercode>34234</ordercode>
<givencode>234534</givencode>
<datefrom>2016-07-21</datefrom>
<dateto>2016-07-21</dateto>
<target>Автозавод</target>
<done>ONLY_NOT_DONE</done>
<changes>ONLY_LAST</changes>
<quickstatus>NO</quickstatus>
</statusreq>
</source>

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

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

*'''changes''' - может принимать значение только ONLY_LAST. Если указан этот параметр, все остальные, кроме quickstatus, игнорируются. Описание данного режима приведено здесь: [[#Передача только изменившихся статусов|Передача только изменившихся статусов]]

*'''quickstatus''' - Указывает "глубину" передаваемых статусов: "YES" (по-умолчанию) - передаются статусы начиная с информации, поступившей от курьера. Такие статусы являются быстрыми (как правило, проставляются курьером сразу после доставки) но не всегда точными. Значение NO запрещает передачу статуса со слов курьера, и выдает только статусы, введенные оператором, как правило вручную. На это требуется больше времени, однако точность гораздо выше. Не рекомендуется совмещать эти типы передачи статусов (чередовать их) при запросе только изменившихся статусов, т.к. в этом случае система будет считать, что статусы у отправлений меняются.

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

=== Примеры ответов ===

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

<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<statusreq count="23">
<order orderno="111111" 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>
<zipcode>125480</zipcode>
<town code="23432">Санкт-Петербург</town>
<address>Петровка 38 офис 35</address>
<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>
</receiver>
<weight>5.1</weight>
<return_weight>5.1</return_weight>
<quantity>2</quantity>
<paytype>CASH</paytype>
<service>2</service>
<type>3</type>
<return_type>3</return_type>
<waittime>12</waittime>
<price>387.5</price>
<print_check>YES</print_check>
<inshprice>387.5</inshprice>
<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">
<>..</> (price details are not yet supported)
..
</deliveryprice>
<receiverpays>NO</receiverpays>
<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>
<customstatecode>2<customstatecode>
<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">Мяч</item>
<item code="34456" extcode="abc124" quantity="2" mass="2" retprice="100" VATrate="10" barcode="4645625213138" article="2" returns="0">Обруч</item>
<item code="34421" extcode="abc125" quantity="3" mass="0.3" retprice="50" VATrate="18" barcode="2345625213126" article="3" returns="0">Погремушка желтая</item>
</items>
<packages>
<package code="33123" strbarcode="4625333555001" mass="0" message="">Место 1</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''':
:* '''''ordercode''''' - внутренний код заказа в системе, применяется для некоторых внутренних операций.
:* '''''givencode''''' - внутренний код заказа в системе, применяется для некоторых внутренних операций.
:* '''''returns''''' - количество данного товара, от которого отказался получатель. Не нулевое только в случае частичного отказа.

* атрибут '''''code''''' контейнера '''item''' - внутренний код строки заказа в системе, применяется для некоторых внутренних операций.
* '''''coords''''' в контейнере '''receiver''' - координаты получателя.
* '''currcoords''' - текущие координаты заказа. Атрибуты:
:* '''''lat''''' - широта
:* '''''lon''''' - долгота
:* '''''accuracy''''' - точность в метрах
:* '''''RequestDateTime''''' - дата/время последнего обновления координат.

* '''waittime ''' - Время ожидания курьера.
* '''deliveryprice''' - стоимость доставки в валюте расчетов с клиентом.
* '''status''' - статус доставки (список статусов см. ниже). Атрибуты (заполняются начиная с версии системы 2008.0.0.670):
:* '''''eventstore''''' - филиал, к которому относится текущий статус
:* '''''eventtime''''' - время изменения статуса (время зависит от местонахождения филиала)
:* '''''createtimegmt''''' - время фактического изменения статуса (GMT)
:* '''''message''''' - наименование филиала-получателя, при передаче между филиалами
:* '''''title''''' - русское наименование статуса

* '''statushistory''' - история статусов доставки. Содержит список контейнеров '''status'''. Заполняется только для тарифа "Премиум" начиная с версии системы 2008.0.0.670.
* '''customstatecode''' - код внутреннего статуса курьерской службы. Значения уточняйте в курьерской службе. Назначаются курьерской службой в разделе "Справочники" - "Статусы" - "15 Статусы корреспонденции". Справочник не передается через API клиенту по причине возможного наличия в нем внутренних технологических статусов курьерской службы.
* '''clientstatecode''' - код статуса клиента. Используется, если клиент предлагает свои коды статусов доставки/причин недоставки.
* '''deliveredto''' - данные о вручении, либо причина недоставки.
* '''delivereddate''' - дата вручения.
* '''deliveredtime''' - время вручения. В случае недоставки может быть пустым.
* '''outstrbarcode''' - код у подрядчика (код заказа во внешней системе). Используется в интеграциях с внешними системами.

*'''packages''' - Контейнер для описания мест. Необязательный контейнер. Атрибуты:
:* '''''package''''' - Название места.
:* '''''code''''' - Внутренний код строки.
:* '''''strbarcode''''' - Штрих-код места.
:* '''''mass''''' - Масса места в килограммах.
:* '''''message''''' - Строка сообщения.

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

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

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

# Атрибуты контейнера '''status''' заполняются для версий системы '''2008.0.0.670''' и новее.
# Контейнер '''statushistory''' заполняется для тарифа "[[Личный_кабинет#.D0.9F.D0.BE.D0.B4.D0.BA.D0.BB.D1.8E.D1.87.D0.B5.D0.BD.D0.B8.D0.B5|Премиум]]" и версий системы '''2008.0.0.670''' и новее.
</div>
<br />

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

Для получения только изменившихся статусов отправьте запрос
<source lang="xml">
<?xml version="1.0" encoding="UTF-8" ?>
<statusreq>
<auth extra="8" login="login" pass="pass"></auth>
<changes>ONLY_LAST</changes>
<quickstatus>NO</quickstatus>
</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>
</commitlaststatus>
</source>

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

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

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

# При данном способе передачи (<changes>ONLY_LAST</changes>) система просматривает заказы, оформленные за последние 3 месяца. Если заказ сделан ранее - изменение статуса по нему не попадет в результат выполнения данного запроса.
# Система всегда выдает текущий статус. Т.е. Вы можете одним запросом получить статус "NEW", а следующим - "COMPLETE". В промежутке между запросами отправление могло пройти через несколько промежуточных статусов.
# Система никогда не гарантирует последовательность прохождения заказом набора статусов. Т.е. Вы можете получить статус "COMPLETE", а следующим запросом - "NEW" - такое может произойти, например, если оператор ошибочно отметил заказ выполненным, а затем исправил ошибку.
</div>
<br />

== Получение вложений к накладной ==

'''Пример запроса:'''
<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.

== Трекинг заказа по номеру ==

Запрос трекинга по номеру предназначен для выдачи минимальной обезличенной информации о конкретном заказе не авторизованному пользователю. Наша система имеет для этого интерфейс по адресу "home.courierexe.ru/{код экстра}/tracking". Вы можете либо сделать ссылку на такую страницу на своем сайте, либо разместить ее 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="1234">
<sender>
<town code="1">Москва город</town>
<date></date>
</sender>
<receiver>
<town code="1">Москва город</town>
<date>2015-04-18</date>
</receiver>
<weight>0</weight>
<quantity>1</quantity>
<currcoords lat="" lon="" accuracy="" RequestDateTime="" />
<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>
</order>
</tracking>
</source>

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

== Изменение статуса агентом ==

Запрос изменения статуса заказа позволяет установить окончательный статус заказа - "Доставлен" или "Не доставлен (Возврат/Отмена)".

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

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

'''Пример запроса изменения статуса:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8" ?>
<setorderinfo>
<auth extra="8" login="login" pass="pass" />
<order ordercode="123456" date="2018-03-01" time="10:00" message="Клиент отказался от покупки"/>
<order ordercode="234567" date="2018-03-01" time="10:00" message="">
<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''''' - Внутренний код заказа.
:* '''''date''''' - Дата изменения статуса.
:* '''''time''''' - Время изменения статуса.
:* '''''message''''' - текст сообщения.

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

== Получение накладной в формате pdf ==

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

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

'''waybill''' - Корневой контейнер. Обязательный элемент.
*'''auth''' - Авторизация. Обязательный элемент.
*'''orderno''' - Номер/код заказа. Обязательный элемент.
*'''form''' - Формат накладной. Опциональное поле. Принимает значения:
:* 1 - Подробная накладная (по-умолчанию)
:* 2 - Наклейки (Zebra)

'''Пример ответа:'''
<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" ?>
<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>

== Справочник городов ==

'''Пример запроса справочника городов:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<townlist>
<codesearch>
<zipcode>110000</zipcode>
<kladrcode>0100000100800</kladrcode>
<fiascode>bd21979d-46f8-49d0-9105-e8d65172a983</fiascode>
<code>123</code>
</codesearch>
<conditions>
<city>Краснодарский край</city>
<namecontains>новгород</namecontains>
<namestarts>Моск</namestarts>
<name>Москва</name>
<fullname>Москва город</fullname>
<country>1</country>
</conditions>
<limit>
<limitfrom>30</limitfrom>
<limitcount>10</limitcount>
<countall>YES</countall>
</limit>
</townlist>
</source>

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

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

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

'''Пример ответа:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<townlist count="3" page="1" totalcount="3" totalpages="1">
<town>
<code>26379</code>
<city>
<code>23</code>
<name>Краснодарский край</name>
</city>
<name>Сочи город</name>
<shortname>Сочи</shortname> (not yet supported)
<typename>город</typename> (not yet supported)
</town>
<town>
<code>40331</code>
<city>
<code>32</code>
<name>Брянская область</name>
</city>
<name>Сочилов хутор</name>
<shortname>Сочилов</shortname>
<typename>хутор</typename>
</town>
<town>
<code>114016</code>
<city>
<code>60</code>
<name>Псковская область</name>
</city>
<name>Сочихино деревня</name>
<shortname>Сочихино</shortname>
<typename>деревня</typename>
</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>1</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>
<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>
</conditions>
<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 - Все. ''Это поле может быть недоступным в некоторых установках.''

*'''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>
<CountInPallet>30</CountInPallet>
<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''' - Высота в сантиметрах.
*'''CountInPallet''' - Количество штук в паллете.
*'''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>
</itemmovements>
</source>

*'''code''' - внутренний код товара в справочнике номенклатуры.

'''Пример ответа движения номенклатуры:'''
<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''' - номер документа
:* '''date''' - дата документа
:* '''message''' - комментарий

== Справочник пунктов самовывоза ==

'''Пример запроса пунктов самовывоза:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8" ?>
<pvzlist>
<auth extra="8" login="login" pass="pass"></auth>
<town>Нижний Тагил</town>
</pvzlist>
</source>

*'''town''' - Город получателя.

'''Пример ответа справочника пунктов самовывоза:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8" ?>
<pvzlist count="2">
<pvz>
<code>126</code>
<clientcode>3</clientcode>
<name>Нижний Тагил</name>
<address>622036, г. Нижний Тагил, ул. Циолковского, д. 17</address>
<phone>+73435417709, +73435254989</phone>
<comment>Жилое 5-ти этажное здание, торцом к дороге, второе здание от перекрестка Пархоменко-Циолковского.</comment>
</pvz>
<pvz>
<code>245</code>
<clientcode>NTG1</clientcode>
<name>На Красноармейской</name>
<address>КРАСНОАРМЕЙСКАЯ, д.79</address>
<phone>+7(3435)379-044</phone>
<comment>Время работы: пн.-пт. 9-18, сб. 10-14</comment>
</pvz>
</pvzlist>
</source>

*'''code''' - Код ПВЗ в системе. Используется в запросе [[API#Оформление заказа|оформления заказов]]
*'''clientcode''' - Код ПВЗ используемый компанией-подрядчиком.
*'''name''' - Наименование ПВЗ.
*'''address''' - Адрес ПВЗ.
*'''phone''' - Телефоны ПВЗ.
*'''comment''' - Дополнительная информация.

== Справочник Видов срочности ==

'''Пример запроса Видов срочности:'''
<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" ?>
<calculator>
<auth extra="8" login="login" pass="pass" />
<calc townfrom="Москва" townto="3800000300000" mass="3.7" service="1" />
</calculator>
</source>

Параметры:
*'''townfrom''' - Город-отправитель
*'''townto''' - Город-получатель
*'''mass''' - Масса в килограммах
*'''service''' - Режим доставки - число, указывающее на запись в справочнике [[#Справочник Видов срочности|видов срочности]]. Если этот параметр опустить, система выдаст расчет для всех доступных видов срочности, передав много контейнеров <calc> в ответе.

В авторизации можно опустить параметры login и pass, тогда расчет будет производиться по стандартному тарифу курьерской службы, без учета возможных отличий для конкретного клиента.<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>1163</price>
<maxdeliverydays>3</maxdeliverydays>
</calc>
</calculator>
</source>

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

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

== Список актов передачи денег ==

'''Пример запроса списка актов передачи денег:'''
<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>
<price>637.00</price>
<rur>13430.00</rur>
<pricekur>570.00</pricekur>
<priceag>67.00</priceag>
<payno>42423</payno>
<paytype>1</paytype>
<paytypename>Безнал</paytypename>
</sma>
</smalist>
</source>

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

== Детализация актов передачи денег ==

'''Пример запроса детализации актов передачи денег:'''
<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>
<status>Доставлено</status>
</specialsma>
</smadetail>
</source>

*'''code''' - Код записи.
*'''ordercode''' - Код заказа.
*'''orderno''' - Шифр заказа.
*'''orderdate''' - Дата заказа.
*'''delivereddate''' - Дата доставки.
*'''company''' - Получатель.
*'''price''' - Стоимость услуг.
*'''rur''' - Сумма заказа.
*'''inshprice''' - Стоимость заказа.
*'''pricekur''' - Стоимость курьерской доставки.
*'''priceag''' - Агентское вознаграждение.
*'''pricecalc''' - Сумма для передачи агенту.
*'''paytype''' - Тип оплаты: 1 - безнал, 2 - наличными курьером, 3 - наличными в офисе, 4 - перевод на карту.
*'''paytypename''' - Строковое представление типа оплаты
*'''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</nowiki>

API

2018-11-15T14:30:24Z

Boyko: /* Получение вложений к накладной */

<div style="font-size: 24px; 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>

В системе "Курьерская служба 2008" имеется возможность интеграции средствами XML API, по протоколу HTTP POST.

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

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

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

== Готовые интеграции ==

Для интеграции с популярными CMS можно скачать модули интеграции

{| class="wikitable" align="center" style="width: 80%; margin: auto; color: black; boreder: 1px solid #999999;" cellpadding="10" cellspacing="0"
!style="width: 35%;"|Система управления контентом (CMS)
!style="width: 15%;"|Версия модуля
!style="width: 15%;"|Ссылка
!style="width: 35%;"|Примечание
|-
|[[Файл:bitrix.png|center|x44px]]
|style="text-align: center;"|1.5.9 от 12.03.2018
|style="text-align: center;"|[http://courierexe.ru/download/api/bitrix.zip Скачать Unicode]<br>[http://courierexe.ru/download/api/bitrix_ansi.zip Скачать ANSI]
|Поддерживает версии 14.5 и выше
|-
|[[Файл:prestashop.png|center|x44px]]
|style="text-align: center;"|1.4.5 от 10.10.2018
|style="text-align: center;"|[http://courierexe.ru/download/api/prestashop.zip Скачать]
|Поддерживает версии 1.5.2.0 и выше (2.x в том числе!)
|-
|[[Файл:opencart.png|center|x44px]] [[Файл:ocstore.png|center|x30px]]
|style="text-align: center;"|1.7.5 от 10.08.2018
|style="text-align: center;"|[http://courierexe.ru/download/api/opencart.zip Скачать]
|Поддерживает версии с 1.5.5.1 по 2.2.<br>
[https://opencartforum.com/files/file/2906-avtomatizaciya-otpravki-i-otslezhivanie-dostavok-courierexe-dlya-opencart-15x/ Альтернативный модуль сторонних разработчиков]
|-
|[[Файл:webasyst-shopscript.png|center|x44px]]
|style="text-align: center;"|1.3.5 от 14.03.2018
|style="text-align: center;"|[http://www.webasyst.ru/store/plugin/shop/measoftcourier/ Установить]
|
|-
|[[Файл:insales.png|center|x44px]]
|style="text-align: center;"|1.2.1 от 06.09.2017
|style="text-align: center;"|[http://www.insales.ru/collection/all/product/kurierskaya-sluzhba-2008 Установить]
|[[Интеграция_с_другими_системами#Insales|Настраивается]] в ЛК пользователя в системе
|-
|[[Файл:Leadvertex.png|center|x44px]]
|style="text-align: center;"|1.0 от 15.11.2016
|style="text-align: center;"|[[Файл:Leadvertex-howto.png|center|x44px]]
|[http://blog.leadvertex.ru/news/2110-integraciya-s-kurerkami-na-platforme-measoft/ Настраивается] в ЛК пользователя в системе [https://Leadvertex.ru Leadvertex]
|-
|[[Файл:Retailcrm.png|center|x44px]]
|style="text-align: center;"|1.0 от 11.01.2018
|style="text-align: center;"|[https://www.retailcrm.ru/ RetailCRM]
|[[Интеграция_с_другими_системами#RetailCRM|Настраивается]] в ЛК пользователя в системе
|-
|[[Файл:1C.jpg|center|x44px]]
|style="text-align: center;"|1.4 от 17.11.2017
|style="text-align: center;"|-
|[https://infostart.ru/public/692790/ Альтернативный модуль сторонних разработчиков]
|-
|AMO CRM
|style="text-align: center;"|-
|style="text-align: center;"|-
|Ожидается в ближайшее время в магазине Amo
|-
|[[Файл:Joomla.png|center|x40px]]
|style="text-align: center;"|1.0.0 от 12.11.2018
|style="text-align: center;"|[http://courierexe.ru/download/api/com_measoft.zip Скачать]
|Внимание! Модуль новый, поэтому возможна некорректная передача данных.
|-
|Мой склад
|style="text-align: center;"|-
|style="text-align: center;"|-
|Ожидается в ближайшее время в магазине Мой Склад
|-
|}

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

== Тестовый аккаунт ==

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

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

== Рабочий аккаунт для подключения ==

Для подключения к площадке Вашего клиента необходимо иметь три параметра:

1. '''Параметр extra''' (Цифровой код, уникальный идентификатор компании. Запросите этот параметр у компании, с которой Вы интегрируетесь). Посмотреть этот код можно в интерфейсе программы КС2008 через основное меню '''"Справочники - Дополнительные возможности"'''. Цифровое значение будет указано во второй гиперссылке (на скриншоте ниже отмечено "звездочкой"):

[[Файл:extra1.png|750px]]

2. '''Логин''' - параметр учетной записи для ЛК клиента и API, указывается в карточке клиента на вкладке '''"Прочее"''' в поле '''"Имя пользователя"'''. Возможно, что в программе КС2008 понадобится создать новую карточку клиента (на скриншоте ниже).

3. '''Пароль''' - параметр учетной записи для ЛК клиента и API, указывается в карточке клиента на вкладке '''"Прочее"''' в поле '''"Пароль"''' (на скриншоте ниже).

[[Файл:33_client.png|500px]]

== Общие понятия ==

На стороне курьерской службы имеется веб-сервис по адресу: https://home.courierexe.ru/api/. Тестовые авторизационные данные: логин: test пароль: testm, параметр 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; < на &lt; > на &gt; " на &quot;

== Ограничения ==
С целью защиты от нецелевого использования сервисов, с 29.05.2017 ведено ограничение на запросы - 1500 запросов с одного IP-адреса за 20 минут. В случае превышения IP-адрес блокируется, разблокировка возможна путем обращения в техническую поддержку, с последующим обсуждением ваших алгоритмов и их коррекцией.

Для проверки статусов заказов лучше всего использовать запросы [[#Передача только изменившихся статусов|"statusreq" с параметром changes=ONLY_LAST]]. Не нужно пытаться "бомбить" наше API запросами с номерами всех ваших заказов, особенно - запросами "tracking", они предназначены не для этого (смотрите описание).

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

<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>Чип & Дейл</person>
<phone>123-45-67</phone>
<zipcode>125480</zipcode>
<town>Санкт-Петербург</town>
<address>Петровка 38 офис 35</address>
<date>2014-03-22</date>
<time_min>09:00</time_min>
<time_max>14:00</time_max>
</receiver>
<return>NO</return>
<return_service>1</return_service>
<weight>5.1</weight>
<return_weight>5.1</return_weight>
<quantity>2</quantity>
<paytype>CASH</paytype>
<service>2</service>
<type>3</type>
<return_type>3</return_type>
<price>387.5</price>
<deliveryprice>150</deliveryprice>
<discount>0</discount>
<inshprice>387.5</inshprice>
<enclosure>Детские игрушки</enclosure>
<instruction>Проверить при покупателе, подписать акт</instruction>
<pvz>124</pvz>
<department>Отдел</department>
<pickup>NO</pickup>
<acceptpartially>NO</acceptpartially>
<items>
<item extcode="abc123" quantity="1" mass="0.2" retprice="37.5" VATrate="0" barcode="2345625213125" article="1" volume="3">Мяч</item>
<item extcode="abc124" quantity="2" mass="2" retprice="100" VATrate="10" barcode="4645625213138" article="2" length="10" width="20" height="30">Обруч</item>
<item extcode="abc125" quantity="3" mass="0.3" retprice="50" barcode="2345625213126" article="3">Погремушка желтая</item>
</items>
</order>
</neworder>
</source>

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

*'''neworder''' - Корневой контейнер, обязательный элемент.

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

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

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

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

*'''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>Город получателя в формате "Москва город"</town>
<address>Адрес получателя</address>
<date>Дата доставки в формате "YYYY-MM-DD"</date>
<time_min>Желаемое время доставки в формате "HH:MM"</time_min>
<time_max>Желаемое время доставки в формате "HH:MM"</time_max>
</receiver>
</source>

*'''company''' - Компания-получатель.
*'''person''' - Контактное лицо. ''Должно быть заполнено хотя бы одно из полей - company или person!''
*'''phone''' - Телефон. Можно указывать несколько телефонов, E-mail в этом поле.
*'''town''' - Город.

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

*'''paytype''' - Тип оплаты заказа получателем. Принимает значения:
:* CASH - Наличными при получении (по-умолчанию)
:* CARD - Картой при получении
:* NO - Без оплаты. Поле Price будет проигнорировано. (Этот тип оплаты передается, если заказ уже оплачен и не требует инкассации, API добавит в систему товары по нулевой цене. Если необходимо передать общую сумму заказа - можно это сделать в поле <inshprice>, указав объявленную ценность)
:* OTHER - Прочее (Предусмотрен для того, чтобы оплата поступала непосредственно в курьерскую службу посредством прочих типов оплаты - таких как: вебмани, яденьги, картой на сайте, прочие платежные системы и т.д.)
:* OPTION - На выбор получателя. Этот тип оплаты нельзя передавать с заказом. Он выставляется автоматически в зависимости от настройки клиента.

*'''zipcode''' - Почтовый индекс.
*'''weight''' - Общий вес заказа в килограммах.
*'''return_weight''' - Общий вес возврата заказа в килограммах.
*'''quantity''' - Количество мест.
*'''service''' - Режим доставки (тип услуги) передается код из справочника "Виды срочности".
*'''type''' - Тип корреспонденции (отправления) передается код из справочника "Типы корреспонденции".
*'''return_type''' - Тип возвратной корреспонденции (отправления) передается код из справочника "Типы корреспонденции".
*'''price''' - Сумма заказа. В случае наличия контейнера items значение данного параметра будет проигнорировано, и рассчитано автоматически.
*'''deliveryprice''' - Сумма доставки. В случае наличия контейнера items, в него будет добавлено вложение "Доставка".
*'''discount''' - Скидка на заказ. В результате сумма заказа будет уменьшена на размер скидки.
*'''return''' - Признак необходимости возврата.
*'''return_service''' - Режим возврата (тип услуги) передается код из справочника "Виды срочности".
*'''enclosure''' - Вложение.
*'''inshprice''' - Объявленная ценность.
*'''instruction''' - Поручение - Примечание.
*'''pvz''' - Код пункта самовывоза по [[#Справочник пунктов самовывоза|справочнику]]
*'''department''' - Подразделение, в котором оформляется заказ.
*'''pickup''' - Признак оформления забора YES/NO. Если стоит YES, то весь заказ считается заданием на забор груза, а не на доставку! Применяется для вызова курьера к отправителю для забора других отправлений.
*'''acceptpartially''' - Признак возможности частичного выкупа товаров отправления YES/NO.

*'''items''' - Контейнер для описания вложенных товаров. Необязательный контейнер. Атрибуты:
:* '''''item''''' - Название товара.
:* '''''quantity''''' - Количество единиц товара.
:* '''''mass''''' - Масса единицы товара в килограммах.
:* '''''volume''''' - Объемный вес единицы товара в килограммах. При указании объемного веса значение подставляется вместо массы
:* '''''length''''' - Длина единицы товара.
:* '''''width''''' - Ширина единицы товара.
:* '''''height''''' - Высота единицы товара.
:* '''''retprice''''' - Цена единицы товара.
:* '''''VATrate''''' - Ставка НДС - целое число процентов. Если значение не указано, подставляется значение "18".
:* '''''barcode''''' - Штрих-код товара. [[Файл:Article.png|thumb|100px|right]]
:* '''''article''''' - Артикул товара. ''Внимание!'' Указание артикула используется только тогда, когда товар хранится на ответственном хранении в службе доставки, и необходима комплектация. В этом случае система пытается привязать товар к [[API#Справочник номенклатуры|справочнику номенклатуры]]. Если товар в справочнике не найден - система выдаст соответствующую ошибку. Если по артикулу найдено несколько товаров - система выберет один из них случайным образом, что может привести к ошибочной комплектации! Если товар НЕ на ответственном хранении - артикул указывать НЕ нужно. Позиция попадет в систему просто текстом.
:* '''''extcode''''' - Внешний код строки. Используется для идентификации строк заказов при получении статусов. Необязательное поле. ПОКА НЕ ПОДДЕРЖИВАЕТСЯ.

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

=== Примеры ответов ===

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

<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<neworder>
<createorder orderno="AB23541" error="0" errormsg="success"></createorder>
<createorder orderno="55_6542" error="0" errormsg="success"></createorder>
<createorder orderno="AB23542" error="0" errormsg="success"></createorder>
</neworder>
</source>

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

<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<neworder>
<createorder orderno="AB23541" error="17" errormsg="Such number exists"></createorder>
<createorder orderno="AB23542" error="13" errormsg="empty company"></createorder>
<createorder orderno="AB23543" error="14" errormsg="empty person"></createorder>
</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>

=== Коды ошибок при оформлении заказа ===

0 - Ошибок нет.

1 - Ошибка авторизации. (отсутствуют теги <auth login="" pass=""></auth>, неверный логин или пароль).

2 - Отправлен пустой запрос (отсутствует контейнер <neworder></neworder> в XML документе).

3 - Некорректно указана сумма заказа.

4 - Некорректный общий вес заказа.

5 - Не найден город получатель.

6 - Не найден город отправитель.

7 - Не заполнен адрес получателя.

8 - Не заполнен телефон получателя.

9 - Не заполнено контактное имя получателя.

10 - Не заполнено название компании получателя.

11 - Некорректная сумма объявленной ценности.

12 - Артикул не найден.

13 - Не заполнено название компании отправителя.

14 - Не заполнено контактное имя отправителя.

15 - Не заполнен телефон отправителя.

16 - Не заполнен адрес отправителя.

17 - Заказ с таким номером уже существует.

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

=== Пример запроса статуса заказа ===

<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>
<ordercode>34234</ordercode>
<givencode>234534</givencode>
<datefrom>2016-07-21</datefrom>
<dateto>2016-07-21</dateto>
<target>Автозавод</target>
<done>ONLY_NOT_DONE</done>
<changes>ONLY_LAST</changes>
<quickstatus>NO</quickstatus>
</statusreq>
</source>

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

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

*'''changes''' - может принимать значение только ONLY_LAST. Если указан этот параметр, все остальные, кроме quickstatus, игнорируются. Описание данного режима приведено здесь: [[#Передача только изменившихся статусов|Передача только изменившихся статусов]]

*'''quickstatus''' - Указывает "глубину" передаваемых статусов: "YES" (по-умолчанию) - передаются статусы начиная с информации, поступившей от курьера. Такие статусы являются быстрыми (как правило, проставляются курьером сразу после доставки) но не всегда точными. Значение NO запрещает передачу статуса со слов курьера, и выдает только статусы, введенные оператором, как правило вручную. На это требуется больше времени, однако точность гораздо выше. Не рекомендуется совмещать эти типы передачи статусов (чередовать их) при запросе только изменившихся статусов, т.к. в этом случае система будет считать, что статусы у отправлений меняются.

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

=== Примеры ответов ===

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

<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<statusreq count="23">
<order orderno="111111" 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>
<zipcode>125480</zipcode>
<town code="23432">Санкт-Петербург</town>
<address>Петровка 38 офис 35</address>
<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>
</receiver>
<weight>5.1</weight>
<return_weight>5.1</return_weight>
<quantity>2</quantity>
<paytype>CASH</paytype>
<service>2</service>
<type>3</type>
<return_type>3</return_type>
<waittime>12</waittime>
<price>387.5</price>
<print_check>YES</print_check>
<inshprice>387.5</inshprice>
<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">
<>..</> (price details are not yet supported)
..
</deliveryprice>
<receiverpays>NO</receiverpays>
<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>
<customstatecode>2<customstatecode>
<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">Мяч</item>
<item code="34456" extcode="abc124" quantity="2" mass="2" retprice="100" VATrate="10" barcode="4645625213138" article="2" returns="0">Обруч</item>
<item code="34421" extcode="abc125" quantity="3" mass="0.3" retprice="50" VATrate="18" barcode="2345625213126" article="3" returns="0">Погремушка желтая</item>
</items>
<packages>
<package code="33123" strbarcode="4625333555001" mass="0" message="">Место 1</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''':
:* '''''ordercode''''' - внутренний код заказа в системе, применяется для некоторых внутренних операций.
:* '''''givencode''''' - внутренний код заказа в системе, применяется для некоторых внутренних операций.
:* '''''returns''''' - количество данного товара, от которого отказался получатель. Не нулевое только в случае частичного отказа.

* атрибут '''''code''''' контейнера '''item''' - внутренний код строки заказа в системе, применяется для некоторых внутренних операций.
* '''''coords''''' в контейнере '''receiver''' - координаты получателя.
* '''currcoords''' - текущие координаты заказа. Атрибуты:
:* '''''lat''''' - широта
:* '''''lon''''' - долгота
:* '''''accuracy''''' - точность в метрах
:* '''''RequestDateTime''''' - дата/время последнего обновления координат.

* '''waittime ''' - Время ожидания курьера.
* '''deliveryprice''' - стоимость доставки в валюте расчетов с клиентом.
* '''status''' - статус доставки (список статусов см. ниже). Атрибуты (заполняются начиная с версии системы 2008.0.0.670):
:* '''''eventstore''''' - филиал, к которому относится текущий статус
:* '''''eventtime''''' - время изменения статуса (время зависит от местонахождения филиала)
:* '''''createtimegmt''''' - время фактического изменения статуса (GMT)
:* '''''message''''' - наименование филиала-получателя, при передаче между филиалами
:* '''''title''''' - русское наименование статуса

* '''statushistory''' - история статусов доставки. Содержит список контейнеров '''status'''. Заполняется только для тарифа "Премиум" начиная с версии системы 2008.0.0.670.
* '''customstatecode''' - код внутреннего статуса курьерской службы. Значения уточняйте в курьерской службе. Назначаются курьерской службой в разделе "Справочники" - "Статусы" - "15 Статусы корреспонденции". Справочник не передается через API клиенту по причине возможного наличия в нем внутренних технологических статусов курьерской службы.
* '''clientstatecode''' - код статуса клиента. Используется, если клиент предлагает свои коды статусов доставки/причин недоставки.
* '''deliveredto''' - данные о вручении, либо причина недоставки.
* '''delivereddate''' - дата вручения.
* '''deliveredtime''' - время вручения. В случае недоставки может быть пустым.
* '''outstrbarcode''' - код у подрядчика (код заказа во внешней системе). Используется в интеграциях с внешними системами.

*'''packages''' - Контейнер для описания мест. Необязательный контейнер. Атрибуты:
:* '''''package''''' - Название места.
:* '''''code''''' - Внутренний код строки.
:* '''''strbarcode''''' - Штрих-код места.
:* '''''mass''''' - Масса места в килограммах.
:* '''''message''''' - Строка сообщения.

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

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

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

# Атрибуты контейнера '''status''' заполняются для версий системы '''2008.0.0.670''' и новее.
# Контейнер '''statushistory''' заполняется для тарифа "[[Личный_кабинет#.D0.9F.D0.BE.D0.B4.D0.BA.D0.BB.D1.8E.D1.87.D0.B5.D0.BD.D0.B8.D0.B5|Премиум]]" и версий системы '''2008.0.0.670''' и новее.
</div>
<br />

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

Для получения только изменившихся статусов отправьте запрос
<source lang="xml">
<?xml version="1.0" encoding="UTF-8" ?>
<statusreq>
<auth extra="8" login="login" pass="pass"></auth>
<changes>ONLY_LAST</changes>
<quickstatus>NO</quickstatus>
</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>
</commitlaststatus>
</source>

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

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

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

# При данном способе передачи (<changes>ONLY_LAST</changes>) система просматривает заказы, оформленные за последние 3 месяца. Если заказ сделан ранее - изменение статуса по нему не попадет в результат выполнения данного запроса.
# Система всегда выдает текущий статус. Т.е. Вы можете одним запросом получить статус "NEW", а следующим - "COMPLETE". В промежутке между запросами отправление могло пройти через несколько промежуточных статусов.
# Система никогда не гарантирует последовательность прохождения заказом набора статусов. Т.е. Вы можете получить статус "COMPLETE", а следующим запросом - "NEW" - такое может произойти, например, если оператор ошибочно отметил заказ выполненным, а затем исправил ошибку.
</div>
<br />

== Получение вложений к накладной ==

'''Пример запроса:'''
<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.

== Трекинг заказа по номеру ==

Запрос трекинга по номеру предназначен для выдачи минимальной обезличенной информации о конкретном заказе не авторизованному пользователю. Наша система имеет для этого интерфейс по адресу "home.courierexe.ru/{код экстра}/tracking". Вы можете либо сделать ссылку на такую страницу на своем сайте, либо разместить ее 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="1234">
<sender>
<town code="1">Москва город</town>
<date></date>
</sender>
<receiver>
<town code="1">Москва город</town>
<date>2015-04-18</date>
</receiver>
<weight>0</weight>
<quantity>1</quantity>
<currcoords lat="" lon="" accuracy="" RequestDateTime="" />
<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>
</order>
</tracking>
</source>

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

== Изменение статуса агентом ==

Запрос изменения статуса заказа позволяет установить окончательный статус заказа - "Доставлен" или "Не доставлен (Возврат/Отмена)".

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

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

'''Пример запроса изменения статуса:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8" ?>
<setorderinfo>
<auth extra="8" login="login" pass="pass" />
<order ordercode="123456" date="2018-03-01" time="10:00" message="Клиент отказался от покупки"/>
<order ordercode="234567" date="2018-03-01" time="10:00" message="">
<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''''' - Внутренний код заказа.
:* '''''date''''' - Дата изменения статуса.
:* '''''time''''' - Время изменения статуса.
:* '''''message''''' - текст сообщения.

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

== Получение накладной в формате pdf ==

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

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

'''waybill''' - Корневой контейнер. Обязательный элемент.
*'''auth''' - Авторизация. Обязательный элемент.
*'''orderno''' - Номер/код заказа. Обязательный элемент.
*'''form''' - Формат накладной. Опциональное поле. Принимает значения:
:* 1 - Подробная накладная (по-умолчанию)
:* 2 - Наклейки (Zebra)

'''Пример ответа:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<waybill>
<content></content>
</waybill>
</source>

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

== Отмена заказа ==

Запрос отмены предназначен для отмены тех заказов, по которым не было произведено изменений - статуса доставки, статуса корреспонденции, времени доставки - то есть заказов, которые ещё не находятся в работе.

При отмене заказа поле "Инфо о доставке" получает значение "Отменено заказчиком", а поле "Дата доставки" - текущую дату.

'''Пример запроса отмены заказа:'''
<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>

== Справочник городов ==

'''Пример запроса справочника городов:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<townlist>
<codesearch>
<zipcode>110000</zipcode>
<kladrcode>0100000100800</kladrcode>
<fiascode>bd21979d-46f8-49d0-9105-e8d65172a983</fiascode>
<code>123</code>
</codesearch>
<conditions>
<city>Краснодарский край</city>
<namecontains>новгород</namecontains>
<namestarts>Моск</namestarts>
<name>Москва</name>
<fullname>Москва город</fullname>
<country>1</country>
</conditions>
<limit>
<limitfrom>30</limitfrom>
<limitcount>10</limitcount>
<countall>YES</countall>
</limit>
</townlist>
</source>

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

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

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

'''Пример ответа:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<townlist count="3" page="1" totalcount="3" totalpages="1">
<town>
<code>26379</code>
<city>
<code>23</code>
<name>Краснодарский край</name>
</city>
<name>Сочи город</name>
<shortname>Сочи</shortname> (not yet supported)
<typename>город</typename> (not yet supported)
</town>
<town>
<code>40331</code>
<city>
<code>32</code>
<name>Брянская область</name>
</city>
<name>Сочилов хутор</name>
<shortname>Сочилов</shortname>
<typename>хутор</typename>
</town>
<town>
<code>114016</code>
<city>
<code>60</code>
<name>Псковская область</name>
</city>
<name>Сочихино деревня</name>
<shortname>Сочихино</shortname>
<typename>деревня</typename>
</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>1</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>
<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>
</conditions>
<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 - Все. ''Это поле может быть недоступным в некоторых установках.''

*'''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>
<CountInPallet>30</CountInPallet>
<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''' - Высота в сантиметрах.
*'''CountInPallet''' - Количество штук в паллете.
*'''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>
</itemmovements>
</source>

*'''code''' - внутренний код товара в справочнике номенклатуры.

'''Пример ответа движения номенклатуры:'''
<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''' - номер документа
:* '''date''' - дата документа
:* '''message''' - комментарий

== Справочник пунктов самовывоза ==

'''Пример запроса пунктов самовывоза:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8" ?>
<pvzlist>
<auth extra="8" login="login" pass="pass"></auth>
<town>Нижний Тагил</town>
</pvzlist>
</source>

*'''town''' - Город получателя.

'''Пример ответа справочника пунктов самовывоза:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8" ?>
<pvzlist count="2">
<pvz>
<code>126</code>
<clientcode>3</clientcode>
<name>Нижний Тагил</name>
<address>622036, г. Нижний Тагил, ул. Циолковского, д. 17</address>
<phone>+73435417709, +73435254989</phone>
<comment>Жилое 5-ти этажное здание, торцом к дороге, второе здание от перекрестка Пархоменко-Циолковского.</comment>
</pvz>
<pvz>
<code>245</code>
<clientcode>NTG1</clientcode>
<name>На Красноармейской</name>
<address>КРАСНОАРМЕЙСКАЯ, д.79</address>
<phone>+7(3435)379-044</phone>
<comment>Время работы: пн.-пт. 9-18, сб. 10-14</comment>
</pvz>
</pvzlist>
</source>

*'''code''' - Код ПВЗ в системе. Используется в запросе [[API#Оформление заказа|оформления заказов]]
*'''clientcode''' - Код ПВЗ используемый компанией-подрядчиком.
*'''name''' - Наименование ПВЗ.
*'''address''' - Адрес ПВЗ.
*'''phone''' - Телефоны ПВЗ.
*'''comment''' - Дополнительная информация.

== Справочник Видов срочности ==

'''Пример запроса Видов срочности:'''
<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" ?>
<calculator>
<auth extra="8" login="login" pass="pass" />
<calc townfrom="Москва" townto="3800000300000" mass="3.7" service="1" />
</calculator>
</source>

Параметры:
*'''townfrom''' - Город-отправитель
*'''townto''' - Город-получатель
*'''mass''' - Масса в килограммах
*'''service''' - Режим доставки - число, указывающее на запись в справочнике [[#Справочник Видов срочности|видов срочности]]. Если этот параметр опустить, система выдаст расчет для всех доступных видов срочности, передав много контейнеров <calc> в ответе.

В авторизации можно опустить параметры login и pass, тогда расчет будет производиться по стандартному тарифу курьерской службы, без учета возможных отличий для конкретного клиента.<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>1163</price>
<maxdeliverydays>3</maxdeliverydays>
</calc>
</calculator>
</source>

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

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

== Список актов передачи денег ==

'''Пример запроса списка актов передачи денег:'''
<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>
<price>637.00</price>
<rur>13430.00</rur>
<pricekur>570.00</pricekur>
<priceag>67.00</priceag>
<payno>42423</payno>
<paytype>1</paytype>
<paytypename>Безнал</paytypename>
</sma>
</smalist>
</source>

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

== Детализация актов передачи денег ==

'''Пример запроса детализации актов передачи денег:'''
<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>
<status>Доставлено</status>
</specialsma>
</smadetail>
</source>

*'''code''' - Код записи.
*'''ordercode''' - Код заказа.
*'''orderno''' - Шифр заказа.
*'''orderdate''' - Дата заказа.
*'''delivereddate''' - Дата доставки.
*'''company''' - Получатель.
*'''price''' - Стоимость услуг.
*'''rur''' - Сумма заказа.
*'''inshprice''' - Стоимость заказа.
*'''pricekur''' - Стоимость курьерской доставки.
*'''priceag''' - Агентское вознаграждение.
*'''pricecalc''' - Сумма для передачи агенту.
*'''paytype''' - Тип оплаты: 1 - безнал, 2 - наличными курьером, 3 - наличными в офисе, 4 - перевод на карту.
*'''paytypename''' - Строковое представление типа оплаты
*'''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</nowiki>

API

2018-11-15T14:22:46Z

Boyko: /* Получение вложений к накладной */

<div style="font-size: 24px; 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>

В системе "Курьерская служба 2008" имеется возможность интеграции средствами XML API, по протоколу HTTP POST.

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

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

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

== Готовые интеграции ==

Для интеграции с популярными CMS можно скачать модули интеграции

{| class="wikitable" align="center" style="width: 80%; margin: auto; color: black; boreder: 1px solid #999999;" cellpadding="10" cellspacing="0"
!style="width: 35%;"|Система управления контентом (CMS)
!style="width: 15%;"|Версия модуля
!style="width: 15%;"|Ссылка
!style="width: 35%;"|Примечание
|-
|[[Файл:bitrix.png|center|x44px]]
|style="text-align: center;"|1.5.9 от 12.03.2018
|style="text-align: center;"|[http://courierexe.ru/download/api/bitrix.zip Скачать Unicode]<br>[http://courierexe.ru/download/api/bitrix_ansi.zip Скачать ANSI]
|Поддерживает версии 14.5 и выше
|-
|[[Файл:prestashop.png|center|x44px]]
|style="text-align: center;"|1.4.5 от 10.10.2018
|style="text-align: center;"|[http://courierexe.ru/download/api/prestashop.zip Скачать]
|Поддерживает версии 1.5.2.0 и выше (2.x в том числе!)
|-
|[[Файл:opencart.png|center|x44px]] [[Файл:ocstore.png|center|x30px]]
|style="text-align: center;"|1.7.5 от 10.08.2018
|style="text-align: center;"|[http://courierexe.ru/download/api/opencart.zip Скачать]
|Поддерживает версии с 1.5.5.1 по 2.2.<br>
[https://opencartforum.com/files/file/2906-avtomatizaciya-otpravki-i-otslezhivanie-dostavok-courierexe-dlya-opencart-15x/ Альтернативный модуль сторонних разработчиков]
|-
|[[Файл:webasyst-shopscript.png|center|x44px]]
|style="text-align: center;"|1.3.5 от 14.03.2018
|style="text-align: center;"|[http://www.webasyst.ru/store/plugin/shop/measoftcourier/ Установить]
|
|-
|[[Файл:insales.png|center|x44px]]
|style="text-align: center;"|1.2.1 от 06.09.2017
|style="text-align: center;"|[http://www.insales.ru/collection/all/product/kurierskaya-sluzhba-2008 Установить]
|[[Интеграция_с_другими_системами#Insales|Настраивается]] в ЛК пользователя в системе
|-
|[[Файл:Leadvertex.png|center|x44px]]
|style="text-align: center;"|1.0 от 15.11.2016
|style="text-align: center;"|[[Файл:Leadvertex-howto.png|center|x44px]]
|[http://blog.leadvertex.ru/news/2110-integraciya-s-kurerkami-na-platforme-measoft/ Настраивается] в ЛК пользователя в системе [https://Leadvertex.ru Leadvertex]
|-
|[[Файл:Retailcrm.png|center|x44px]]
|style="text-align: center;"|1.0 от 11.01.2018
|style="text-align: center;"|[https://www.retailcrm.ru/ RetailCRM]
|[[Интеграция_с_другими_системами#RetailCRM|Настраивается]] в ЛК пользователя в системе
|-
|[[Файл:1C.jpg|center|x44px]]
|style="text-align: center;"|1.4 от 17.11.2017
|style="text-align: center;"|-
|[https://infostart.ru/public/692790/ Альтернативный модуль сторонних разработчиков]
|-
|AMO CRM
|style="text-align: center;"|-
|style="text-align: center;"|-
|Ожидается в ближайшее время в магазине Amo
|-
|[[Файл:Joomla.png|center|x40px]]
|style="text-align: center;"|1.0.0 от 12.11.2018
|style="text-align: center;"|[http://courierexe.ru/download/api/com_measoft.zip Скачать]
|Внимание! Модуль новый, поэтому возможна некорректная передача данных.
|-
|Мой склад
|style="text-align: center;"|-
|style="text-align: center;"|-
|Ожидается в ближайшее время в магазине Мой Склад
|-
|}

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

== Тестовый аккаунт ==

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

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

== Рабочий аккаунт для подключения ==

Для подключения к площадке Вашего клиента необходимо иметь три параметра:

1. '''Параметр extra''' (Цифровой код, уникальный идентификатор компании. Запросите этот параметр у компании, с которой Вы интегрируетесь). Посмотреть этот код можно в интерфейсе программы КС2008 через основное меню '''"Справочники - Дополнительные возможности"'''. Цифровое значение будет указано во второй гиперссылке (на скриншоте ниже отмечено "звездочкой"):

[[Файл:extra1.png|750px]]

2. '''Логин''' - параметр учетной записи для ЛК клиента и API, указывается в карточке клиента на вкладке '''"Прочее"''' в поле '''"Имя пользователя"'''. Возможно, что в программе КС2008 понадобится создать новую карточку клиента (на скриншоте ниже).

3. '''Пароль''' - параметр учетной записи для ЛК клиента и API, указывается в карточке клиента на вкладке '''"Прочее"''' в поле '''"Пароль"''' (на скриншоте ниже).

[[Файл:33_client.png|500px]]

== Общие понятия ==

На стороне курьерской службы имеется веб-сервис по адресу: https://home.courierexe.ru/api/. Тестовые авторизационные данные: логин: test пароль: testm, параметр 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; < на &lt; > на &gt; " на &quot;

== Ограничения ==
С целью защиты от нецелевого использования сервисов, с 29.05.2017 ведено ограничение на запросы - 1500 запросов с одного IP-адреса за 20 минут. В случае превышения IP-адрес блокируется, разблокировка возможна путем обращения в техническую поддержку, с последующим обсуждением ваших алгоритмов и их коррекцией.

Для проверки статусов заказов лучше всего использовать запросы [[#Передача только изменившихся статусов|"statusreq" с параметром changes=ONLY_LAST]]. Не нужно пытаться "бомбить" наше API запросами с номерами всех ваших заказов, особенно - запросами "tracking", они предназначены не для этого (смотрите описание).

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

<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>Чип & Дейл</person>
<phone>123-45-67</phone>
<zipcode>125480</zipcode>
<town>Санкт-Петербург</town>
<address>Петровка 38 офис 35</address>
<date>2014-03-22</date>
<time_min>09:00</time_min>
<time_max>14:00</time_max>
</receiver>
<return>NO</return>
<return_service>1</return_service>
<weight>5.1</weight>
<return_weight>5.1</return_weight>
<quantity>2</quantity>
<paytype>CASH</paytype>
<service>2</service>
<type>3</type>
<return_type>3</return_type>
<price>387.5</price>
<deliveryprice>150</deliveryprice>
<discount>0</discount>
<inshprice>387.5</inshprice>
<enclosure>Детские игрушки</enclosure>
<instruction>Проверить при покупателе, подписать акт</instruction>
<pvz>124</pvz>
<department>Отдел</department>
<pickup>NO</pickup>
<acceptpartially>NO</acceptpartially>
<items>
<item extcode="abc123" quantity="1" mass="0.2" retprice="37.5" VATrate="0" barcode="2345625213125" article="1" volume="3">Мяч</item>
<item extcode="abc124" quantity="2" mass="2" retprice="100" VATrate="10" barcode="4645625213138" article="2" length="10" width="20" height="30">Обруч</item>
<item extcode="abc125" quantity="3" mass="0.3" retprice="50" barcode="2345625213126" article="3">Погремушка желтая</item>
</items>
</order>
</neworder>
</source>

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

*'''neworder''' - Корневой контейнер, обязательный элемент.

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

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

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

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

*'''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>Город получателя в формате "Москва город"</town>
<address>Адрес получателя</address>
<date>Дата доставки в формате "YYYY-MM-DD"</date>
<time_min>Желаемое время доставки в формате "HH:MM"</time_min>
<time_max>Желаемое время доставки в формате "HH:MM"</time_max>
</receiver>
</source>

*'''company''' - Компания-получатель.
*'''person''' - Контактное лицо. ''Должно быть заполнено хотя бы одно из полей - company или person!''
*'''phone''' - Телефон. Можно указывать несколько телефонов, E-mail в этом поле.
*'''town''' - Город.

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

*'''paytype''' - Тип оплаты заказа получателем. Принимает значения:
:* CASH - Наличными при получении (по-умолчанию)
:* CARD - Картой при получении
:* NO - Без оплаты. Поле Price будет проигнорировано. (Этот тип оплаты передается, если заказ уже оплачен и не требует инкассации, API добавит в систему товары по нулевой цене. Если необходимо передать общую сумму заказа - можно это сделать в поле <inshprice>, указав объявленную ценность)
:* OTHER - Прочее (Предусмотрен для того, чтобы оплата поступала непосредственно в курьерскую службу посредством прочих типов оплаты - таких как: вебмани, яденьги, картой на сайте, прочие платежные системы и т.д.)
:* OPTION - На выбор получателя. Этот тип оплаты нельзя передавать с заказом. Он выставляется автоматически в зависимости от настройки клиента.

*'''zipcode''' - Почтовый индекс.
*'''weight''' - Общий вес заказа в килограммах.
*'''return_weight''' - Общий вес возврата заказа в килограммах.
*'''quantity''' - Количество мест.
*'''service''' - Режим доставки (тип услуги) передается код из справочника "Виды срочности".
*'''type''' - Тип корреспонденции (отправления) передается код из справочника "Типы корреспонденции".
*'''return_type''' - Тип возвратной корреспонденции (отправления) передается код из справочника "Типы корреспонденции".
*'''price''' - Сумма заказа. В случае наличия контейнера items значение данного параметра будет проигнорировано, и рассчитано автоматически.
*'''deliveryprice''' - Сумма доставки. В случае наличия контейнера items, в него будет добавлено вложение "Доставка".
*'''discount''' - Скидка на заказ. В результате сумма заказа будет уменьшена на размер скидки.
*'''return''' - Признак необходимости возврата.
*'''return_service''' - Режим возврата (тип услуги) передается код из справочника "Виды срочности".
*'''enclosure''' - Вложение.
*'''inshprice''' - Объявленная ценность.
*'''instruction''' - Поручение - Примечание.
*'''pvz''' - Код пункта самовывоза по [[#Справочник пунктов самовывоза|справочнику]]
*'''department''' - Подразделение, в котором оформляется заказ.
*'''pickup''' - Признак оформления забора YES/NO. Если стоит YES, то весь заказ считается заданием на забор груза, а не на доставку! Применяется для вызова курьера к отправителю для забора других отправлений.
*'''acceptpartially''' - Признак возможности частичного выкупа товаров отправления YES/NO.

*'''items''' - Контейнер для описания вложенных товаров. Необязательный контейнер. Атрибуты:
:* '''''item''''' - Название товара.
:* '''''quantity''''' - Количество единиц товара.
:* '''''mass''''' - Масса единицы товара в килограммах.
:* '''''volume''''' - Объемный вес единицы товара в килограммах. При указании объемного веса значение подставляется вместо массы
:* '''''length''''' - Длина единицы товара.
:* '''''width''''' - Ширина единицы товара.
:* '''''height''''' - Высота единицы товара.
:* '''''retprice''''' - Цена единицы товара.
:* '''''VATrate''''' - Ставка НДС - целое число процентов. Если значение не указано, подставляется значение "18".
:* '''''barcode''''' - Штрих-код товара. [[Файл:Article.png|thumb|100px|right]]
:* '''''article''''' - Артикул товара. ''Внимание!'' Указание артикула используется только тогда, когда товар хранится на ответственном хранении в службе доставки, и необходима комплектация. В этом случае система пытается привязать товар к [[API#Справочник номенклатуры|справочнику номенклатуры]]. Если товар в справочнике не найден - система выдаст соответствующую ошибку. Если по артикулу найдено несколько товаров - система выберет один из них случайным образом, что может привести к ошибочной комплектации! Если товар НЕ на ответственном хранении - артикул указывать НЕ нужно. Позиция попадет в систему просто текстом.
:* '''''extcode''''' - Внешний код строки. Используется для идентификации строк заказов при получении статусов. Необязательное поле. ПОКА НЕ ПОДДЕРЖИВАЕТСЯ.

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

=== Примеры ответов ===

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

<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<neworder>
<createorder orderno="AB23541" error="0" errormsg="success"></createorder>
<createorder orderno="55_6542" error="0" errormsg="success"></createorder>
<createorder orderno="AB23542" error="0" errormsg="success"></createorder>
</neworder>
</source>

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

<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<neworder>
<createorder orderno="AB23541" error="17" errormsg="Such number exists"></createorder>
<createorder orderno="AB23542" error="13" errormsg="empty company"></createorder>
<createorder orderno="AB23543" error="14" errormsg="empty person"></createorder>
</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>

=== Коды ошибок при оформлении заказа ===

0 - Ошибок нет.

1 - Ошибка авторизации. (отсутствуют теги <auth login="" pass=""></auth>, неверный логин или пароль).

2 - Отправлен пустой запрос (отсутствует контейнер <neworder></neworder> в XML документе).

3 - Некорректно указана сумма заказа.

4 - Некорректный общий вес заказа.

5 - Не найден город получатель.

6 - Не найден город отправитель.

7 - Не заполнен адрес получателя.

8 - Не заполнен телефон получателя.

9 - Не заполнено контактное имя получателя.

10 - Не заполнено название компании получателя.

11 - Некорректная сумма объявленной ценности.

12 - Артикул не найден.

13 - Не заполнено название компании отправителя.

14 - Не заполнено контактное имя отправителя.

15 - Не заполнен телефон отправителя.

16 - Не заполнен адрес отправителя.

17 - Заказ с таким номером уже существует.

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

=== Пример запроса статуса заказа ===

<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>
<ordercode>34234</ordercode>
<givencode>234534</givencode>
<datefrom>2016-07-21</datefrom>
<dateto>2016-07-21</dateto>
<target>Автозавод</target>
<done>ONLY_NOT_DONE</done>
<changes>ONLY_LAST</changes>
<quickstatus>NO</quickstatus>
</statusreq>
</source>

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

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

*'''changes''' - может принимать значение только ONLY_LAST. Если указан этот параметр, все остальные, кроме quickstatus, игнорируются. Описание данного режима приведено здесь: [[#Передача только изменившихся статусов|Передача только изменившихся статусов]]

*'''quickstatus''' - Указывает "глубину" передаваемых статусов: "YES" (по-умолчанию) - передаются статусы начиная с информации, поступившей от курьера. Такие статусы являются быстрыми (как правило, проставляются курьером сразу после доставки) но не всегда точными. Значение NO запрещает передачу статуса со слов курьера, и выдает только статусы, введенные оператором, как правило вручную. На это требуется больше времени, однако точность гораздо выше. Не рекомендуется совмещать эти типы передачи статусов (чередовать их) при запросе только изменившихся статусов, т.к. в этом случае система будет считать, что статусы у отправлений меняются.

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

=== Примеры ответов ===

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

<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<statusreq count="23">
<order orderno="111111" 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>
<zipcode>125480</zipcode>
<town code="23432">Санкт-Петербург</town>
<address>Петровка 38 офис 35</address>
<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>
</receiver>
<weight>5.1</weight>
<return_weight>5.1</return_weight>
<quantity>2</quantity>
<paytype>CASH</paytype>
<service>2</service>
<type>3</type>
<return_type>3</return_type>
<waittime>12</waittime>
<price>387.5</price>
<print_check>YES</print_check>
<inshprice>387.5</inshprice>
<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">
<>..</> (price details are not yet supported)
..
</deliveryprice>
<receiverpays>NO</receiverpays>
<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>
<customstatecode>2<customstatecode>
<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">Мяч</item>
<item code="34456" extcode="abc124" quantity="2" mass="2" retprice="100" VATrate="10" barcode="4645625213138" article="2" returns="0">Обруч</item>
<item code="34421" extcode="abc125" quantity="3" mass="0.3" retprice="50" VATrate="18" barcode="2345625213126" article="3" returns="0">Погремушка желтая</item>
</items>
<packages>
<package code="33123" strbarcode="4625333555001" mass="0" message="">Место 1</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''':
:* '''''ordercode''''' - внутренний код заказа в системе, применяется для некоторых внутренних операций.
:* '''''givencode''''' - внутренний код заказа в системе, применяется для некоторых внутренних операций.
:* '''''returns''''' - количество данного товара, от которого отказался получатель. Не нулевое только в случае частичного отказа.

* атрибут '''''code''''' контейнера '''item''' - внутренний код строки заказа в системе, применяется для некоторых внутренних операций.
* '''''coords''''' в контейнере '''receiver''' - координаты получателя.
* '''currcoords''' - текущие координаты заказа. Атрибуты:
:* '''''lat''''' - широта
:* '''''lon''''' - долгота
:* '''''accuracy''''' - точность в метрах
:* '''''RequestDateTime''''' - дата/время последнего обновления координат.

* '''waittime ''' - Время ожидания курьера.
* '''deliveryprice''' - стоимость доставки в валюте расчетов с клиентом.
* '''status''' - статус доставки (список статусов см. ниже). Атрибуты (заполняются начиная с версии системы 2008.0.0.670):
:* '''''eventstore''''' - филиал, к которому относится текущий статус
:* '''''eventtime''''' - время изменения статуса (время зависит от местонахождения филиала)
:* '''''createtimegmt''''' - время фактического изменения статуса (GMT)
:* '''''message''''' - наименование филиала-получателя, при передаче между филиалами
:* '''''title''''' - русское наименование статуса

* '''statushistory''' - история статусов доставки. Содержит список контейнеров '''status'''. Заполняется только для тарифа "Премиум" начиная с версии системы 2008.0.0.670.
* '''customstatecode''' - код внутреннего статуса курьерской службы. Значения уточняйте в курьерской службе. Назначаются курьерской службой в разделе "Справочники" - "Статусы" - "15 Статусы корреспонденции". Справочник не передается через API клиенту по причине возможного наличия в нем внутренних технологических статусов курьерской службы.
* '''clientstatecode''' - код статуса клиента. Используется, если клиент предлагает свои коды статусов доставки/причин недоставки.
* '''deliveredto''' - данные о вручении, либо причина недоставки.
* '''delivereddate''' - дата вручения.
* '''deliveredtime''' - время вручения. В случае недоставки может быть пустым.
* '''outstrbarcode''' - код у подрядчика (код заказа во внешней системе). Используется в интеграциях с внешними системами.

*'''packages''' - Контейнер для описания мест. Необязательный контейнер. Атрибуты:
:* '''''package''''' - Название места.
:* '''''code''''' - Внутренний код строки.
:* '''''strbarcode''''' - Штрих-код места.
:* '''''mass''''' - Масса места в килограммах.
:* '''''message''''' - Строка сообщения.

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

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

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

# Атрибуты контейнера '''status''' заполняются для версий системы '''2008.0.0.670''' и новее.
# Контейнер '''statushistory''' заполняется для тарифа "[[Личный_кабинет#.D0.9F.D0.BE.D0.B4.D0.BA.D0.BB.D1.8E.D1.87.D0.B5.D0.BD.D0.B8.D0.B5|Премиум]]" и версий системы '''2008.0.0.670''' и новее.
</div>
<br />

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

Для получения только изменившихся статусов отправьте запрос
<source lang="xml">
<?xml version="1.0" encoding="UTF-8" ?>
<statusreq>
<auth extra="8" login="login" pass="pass"></auth>
<changes>ONLY_LAST</changes>
<quickstatus>NO</quickstatus>
</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>
</commitlaststatus>
</source>

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

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

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

# При данном способе передачи (<changes>ONLY_LAST</changes>) система просматривает заказы, оформленные за последние 3 месяца. Если заказ сделан ранее - изменение статуса по нему не попадет в результат выполнения данного запроса.
# Система всегда выдает текущий статус. Т.е. Вы можете одним запросом получить статус "NEW", а следующим - "COMPLETE". В промежутке между запросами отправление могло пройти через несколько промежуточных статусов.
# Система никогда не гарантирует последовательность прохождения заказом набора статусов. Т.е. Вы можете получить статус "COMPLETE", а следующим запросом - "NEW" - такое может произойти, например, если оператор ошибочно отметил заказ выполненным, а затем исправил ошибку.
</div>
<br />

== Получение вложений к накладной ==

'''Пример запроса:'''
<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">PA0gI...AvVHlwZSAv=</item>
<item name="photo2.jpg" size="74861">hcnR4cmVm...yDSUlRU9GDQ==</item>
.....
</attachments>
</source>

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

== Трекинг заказа по номеру ==

Запрос трекинга по номеру предназначен для выдачи минимальной обезличенной информации о конкретном заказе не авторизованному пользователю. Наша система имеет для этого интерфейс по адресу "home.courierexe.ru/{код экстра}/tracking". Вы можете либо сделать ссылку на такую страницу на своем сайте, либо разместить ее 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="1234">
<sender>
<town code="1">Москва город</town>
<date></date>
</sender>
<receiver>
<town code="1">Москва город</town>
<date>2015-04-18</date>
</receiver>
<weight>0</weight>
<quantity>1</quantity>
<currcoords lat="" lon="" accuracy="" RequestDateTime="" />
<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>
</order>
</tracking>
</source>

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

== Изменение статуса агентом ==

Запрос изменения статуса заказа позволяет установить окончательный статус заказа - "Доставлен" или "Не доставлен (Возврат/Отмена)".

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

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

'''Пример запроса изменения статуса:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8" ?>
<setorderinfo>
<auth extra="8" login="login" pass="pass" />
<order ordercode="123456" date="2018-03-01" time="10:00" message="Клиент отказался от покупки"/>
<order ordercode="234567" date="2018-03-01" time="10:00" message="">
<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''''' - Внутренний код заказа.
:* '''''date''''' - Дата изменения статуса.
:* '''''time''''' - Время изменения статуса.
:* '''''message''''' - текст сообщения.

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

== Получение накладной в формате pdf ==

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

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

'''waybill''' - Корневой контейнер. Обязательный элемент.
*'''auth''' - Авторизация. Обязательный элемент.
*'''orderno''' - Номер/код заказа. Обязательный элемент.
*'''form''' - Формат накладной. Опциональное поле. Принимает значения:
:* 1 - Подробная накладная (по-умолчанию)
:* 2 - Наклейки (Zebra)

'''Пример ответа:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<waybill>
<content></content>
</waybill>
</source>

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

== Отмена заказа ==

Запрос отмены предназначен для отмены тех заказов, по которым не было произведено изменений - статуса доставки, статуса корреспонденции, времени доставки - то есть заказов, которые ещё не находятся в работе.

При отмене заказа поле "Инфо о доставке" получает значение "Отменено заказчиком", а поле "Дата доставки" - текущую дату.

'''Пример запроса отмены заказа:'''
<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>

== Справочник городов ==

'''Пример запроса справочника городов:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<townlist>
<codesearch>
<zipcode>110000</zipcode>
<kladrcode>0100000100800</kladrcode>
<fiascode>bd21979d-46f8-49d0-9105-e8d65172a983</fiascode>
<code>123</code>
</codesearch>
<conditions>
<city>Краснодарский край</city>
<namecontains>новгород</namecontains>
<namestarts>Моск</namestarts>
<name>Москва</name>
<fullname>Москва город</fullname>
<country>1</country>
</conditions>
<limit>
<limitfrom>30</limitfrom>
<limitcount>10</limitcount>
<countall>YES</countall>
</limit>
</townlist>
</source>

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

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

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

'''Пример ответа:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<townlist count="3" page="1" totalcount="3" totalpages="1">
<town>
<code>26379</code>
<city>
<code>23</code>
<name>Краснодарский край</name>
</city>
<name>Сочи город</name>
<shortname>Сочи</shortname> (not yet supported)
<typename>город</typename> (not yet supported)
</town>
<town>
<code>40331</code>
<city>
<code>32</code>
<name>Брянская область</name>
</city>
<name>Сочилов хутор</name>
<shortname>Сочилов</shortname>
<typename>хутор</typename>
</town>
<town>
<code>114016</code>
<city>
<code>60</code>
<name>Псковская область</name>
</city>
<name>Сочихино деревня</name>
<shortname>Сочихино</shortname>
<typename>деревня</typename>
</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>1</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>
<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>
</conditions>
<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 - Все. ''Это поле может быть недоступным в некоторых установках.''

*'''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>
<CountInPallet>30</CountInPallet>
<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''' - Высота в сантиметрах.
*'''CountInPallet''' - Количество штук в паллете.
*'''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>
</itemmovements>
</source>

*'''code''' - внутренний код товара в справочнике номенклатуры.

'''Пример ответа движения номенклатуры:'''
<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''' - номер документа
:* '''date''' - дата документа
:* '''message''' - комментарий

== Справочник пунктов самовывоза ==

'''Пример запроса пунктов самовывоза:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8" ?>
<pvzlist>
<auth extra="8" login="login" pass="pass"></auth>
<town>Нижний Тагил</town>
</pvzlist>
</source>

*'''town''' - Город получателя.

'''Пример ответа справочника пунктов самовывоза:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8" ?>
<pvzlist count="2">
<pvz>
<code>126</code>
<clientcode>3</clientcode>
<name>Нижний Тагил</name>
<address>622036, г. Нижний Тагил, ул. Циолковского, д. 17</address>
<phone>+73435417709, +73435254989</phone>
<comment>Жилое 5-ти этажное здание, торцом к дороге, второе здание от перекрестка Пархоменко-Циолковского.</comment>
</pvz>
<pvz>
<code>245</code>
<clientcode>NTG1</clientcode>
<name>На Красноармейской</name>
<address>КРАСНОАРМЕЙСКАЯ, д.79</address>
<phone>+7(3435)379-044</phone>
<comment>Время работы: пн.-пт. 9-18, сб. 10-14</comment>
</pvz>
</pvzlist>
</source>

*'''code''' - Код ПВЗ в системе. Используется в запросе [[API#Оформление заказа|оформления заказов]]
*'''clientcode''' - Код ПВЗ используемый компанией-подрядчиком.
*'''name''' - Наименование ПВЗ.
*'''address''' - Адрес ПВЗ.
*'''phone''' - Телефоны ПВЗ.
*'''comment''' - Дополнительная информация.

== Справочник Видов срочности ==

'''Пример запроса Видов срочности:'''
<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" ?>
<calculator>
<auth extra="8" login="login" pass="pass" />
<calc townfrom="Москва" townto="3800000300000" mass="3.7" service="1" />
</calculator>
</source>

Параметры:
*'''townfrom''' - Город-отправитель
*'''townto''' - Город-получатель
*'''mass''' - Масса в килограммах
*'''service''' - Режим доставки - число, указывающее на запись в справочнике [[#Справочник Видов срочности|видов срочности]]. Если этот параметр опустить, система выдаст расчет для всех доступных видов срочности, передав много контейнеров <calc> в ответе.

В авторизации можно опустить параметры login и pass, тогда расчет будет производиться по стандартному тарифу курьерской службы, без учета возможных отличий для конкретного клиента.<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>1163</price>
<maxdeliverydays>3</maxdeliverydays>
</calc>
</calculator>
</source>

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

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

== Список актов передачи денег ==

'''Пример запроса списка актов передачи денег:'''
<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>
<price>637.00</price>
<rur>13430.00</rur>
<pricekur>570.00</pricekur>
<priceag>67.00</priceag>
<payno>42423</payno>
<paytype>1</paytype>
<paytypename>Безнал</paytypename>
</sma>
</smalist>
</source>

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

== Детализация актов передачи денег ==

'''Пример запроса детализации актов передачи денег:'''
<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>
<status>Доставлено</status>
</specialsma>
</smadetail>
</source>

*'''code''' - Код записи.
*'''ordercode''' - Код заказа.
*'''orderno''' - Шифр заказа.
*'''orderdate''' - Дата заказа.
*'''delivereddate''' - Дата доставки.
*'''company''' - Получатель.
*'''price''' - Стоимость услуг.
*'''rur''' - Сумма заказа.
*'''inshprice''' - Стоимость заказа.
*'''pricekur''' - Стоимость курьерской доставки.
*'''priceag''' - Агентское вознаграждение.
*'''pricecalc''' - Сумма для передачи агенту.
*'''paytype''' - Тип оплаты: 1 - безнал, 2 - наличными курьером, 3 - наличными в офисе, 4 - перевод на карту.
*'''paytypename''' - Строковое представление типа оплаты
*'''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</nowiki>