Изменения

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

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

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

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

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

'''English version is [[API documentationDocumentation|HERE!]]'''

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

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

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

Если вы '''подрядчик''', вы можете забирать заказы, используя значение client=AGENT в запросе [[#Пример запроса статуса заказа|statusreq]], и передавать статусы заказов, используя метод [[#Изменение статуса агентом|setorderinfo]]. Также для интеграций с подрядчиками у Васнас есть специальная платформа, но добавлять подрядчиков в нее можно только на нашей стороне. Присылайте нам коммерческое предложение, описание вашего сервиса, и мы с радостью его рассмотрим. При написании этой документации мы предполагаем, что ее читатель обладает необходимой для понимания квалификацией программиста, владеет XML и средой разработки, в которой он делает интеграцию. Если вы не программист, вам необходимо привлечь к проекту профессионального программиста. Если у вас после прочтения данной документации остались вопросы, Вы можете задайте их задать по почте [mailto:support@courierexe.ru support@courierexe.ru]. Обязательно представьтесь, напишите Ваши ваши контактные данные (телефон, скайп) и название компании, с которой Вы вы хотите интегрироваться.

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

Сообщайте нам свои пожелания по работе наших модулей. Мы учтем их в новых версиях. {| class="wikitable" align="center" style="width: 80%; margin: auto; background-color: black#ffffff; borederborder: 1px solid #999999;" cellpadding="10" cellspacing="0"

|style="text-align: center;"|1.5.9 от 12.03.2018|style="text-align: center;"|[httphttps://courierexemarketplace.1c-bitrix.ru/downloadsolutions/apimeasoft.courier/bitrix.zip Скачать UnicodeУстановить]<br>!--[httphttps://courierexe.ru/download/api/bitrix_ansimeasoft.courier.zip Скачать ANSI]-->|Поддерживает версии 1420.5 .0 и выше. Подробнее см. [[1C-Битрикс|описание]].

|[[Файл:prestashop.png|center|x44pxx60px]]|style="text-align: center;"|1.4.5 от 10.10.2018|style="text-align: center;"|[httphttps://courierexe.ru/download/api/prestashop.zip Скачать]|Поддерживает версии 1.5.2.0 и выше (2.x Инструкция в том числе!)архиве

|[[Файл:opencartOpencartOCStore.png|center|x44px]] [[Файл:ocstore.png|center|x30pxx60px]]|style="text-align: center;"|[https://courierexe.ru/download/api/opencart.zip Скачать для версии 1.75.5 от 10.081]<br>[https://courierexe.ru/download/api/measoft_oc2.ocmod.2018|style="text-alignzip Скачать для версии 2.0]<br>[https: center;"|//courierexe.ru/download/api/measoft_oc2.3.ocmod.zip Скачать для версии 2.3]<br>[httphttps://courierexe.ru/download/api/opencartmeasoft_oc3.ocmod.zip Скачатьдля версии 3.0]|Поддерживает версии с 1.5.5.1 по 2.2<br>Скачивайте модули для своей версии OpenCart.<br>Подробнее см. [[https://opencartforumOpenCart|описание]].com/files/file/2906-avtomatizaciya-otpravki-i-otslezhivanie-dostavok-courierexe-dlya-opencart-15x/ Альтернативный модуль сторонних разработчиков]

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

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

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

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

|[[Интеграция_с_другими_системами#RetailCRM|Настраивается]] в ЛК пользователя в системе

|[https://infostart.ru/public/692790/ Альтернативный модуль сторонних разработчиков(1 версия)] [https://infostart.ru/public/1531484/ Альтернативный модуль сторонних разработчиков (2 версия)]|-|[[Файл:Joomla2.jpg|center|x60px]]|style="text-align: center;"|[https://courierexe.ru/download/api/com_measoft.zip Скачать]|Работает только с компонентом Virtuemart. Инструкция в архиве

|AMO CRM[[Файл:Amocrm.png|center|x44px]]|style="text-align: center;"|[https://www.amocrm.ru/extensions/courier2008 Установить]|Подробнее см. [[amoCRM|описание]].|-|rowspan="2"|[[Файл:MoySclad.jpg|center|x30px]]|style="height:50px; text-align: center;"|[https://home.courierexe.ru/moysklad/step1 Настроить интеграцию с MeaSoft]|[[МойСклад|Инструкция]]|-|style="height:50px; text-align: center;"|[https://itmdev.ru/ms/shipping/ Скачать модуль сторонних разработчиков]|Интеграция МойСклад с курьерскими службами от сторонних разработчиков|-|Ожидается в ближайшее время в магазине Amo[[Файл:wordpress.jpg|center|x80px]]|style="text-align: center;"|[https://courierexe.ru/wordpress/wordpress.php Скачать]|[[Wordpress|Инструкция]]

|Joomla – VirtueMart[[Файл:Cscart.png|style="text-align: center;"|-x60px]]|style="text-align: center;"|[https://marketplace.cs-cart.com/measoft-en.html Установить]|Ожидается в ближайшее времяПоддерживает версии 4.10 и выше.<br>[[CS-Cart|Инструкция]]

|Мой склад[[Файл:webhooks.jpg|style="text-align: center;"|-x100px]]|style="text-align: center;"|-Читайте описание [[Webhook|на этой странице]]|Ожидается в ближайшее время Передача информации о статусах и заказах в магазине Мой Складвашу систему

Данные модули распространяются бесплатно, без каких-либо гарантий со стороны разработчика'''Обратите внимание!''' В модулях систем PrestaShop и Joomla для отправки заказа в курьерскую службу зайдите в карточку заказа. Их наличие не нужно рассматривать как средство полной автоматизации взаимодействия с курьерской службойВ карточке отображается специальная форма отправки заказа, а скорее как помощь разработчикам интернет-магазинов в построении интеграции с курьерскими службами. Однако, мы будем очень признательны, если Вы будете нам сообщать о своих потребностях и/или найденных неточностях в наших модуляхзаказ отправлен, это она позволяет нам учитывать пожелания в новых версияхпроверить его статус:[[Файл:Form.png|400 px|Форма отправки заказа|none]] Для отображения списка пунктов выдачи есть [https://home.courierexe.ru/js/measoft_map.js JavaScript модуль]. Инструкция по использованию — внутри. Посмотреть пример работы можно [https://home.courierexe.ru/pvz_test.html здесь].

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

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

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

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

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

3. '''Пароль''' - параметр учетной записи для ЛК клиента и API, указывается в карточке клиента на вкладке '''<source lang=xml><auth extra="Прочее8"''' в поле '''login="Парольlogin"''' (на скриншоте ниже).pass="pass" clientcode="123"></auth></source>

Описание:* '''extra''' — уникальный идентификатор компании;* '''login''' — логин курьерской службы;* '''pass''' — пароль курьерской службы;* '''clientcode''' — внутренний код клиента (вкладка '''Клиенты''', столбец «Внутренний код»). Вы можете узнать код экстра, логин и пароль курьерской службы в офисном приложении MeaSoft в справочнике '''Дополнительные возможности'''. Подробнее см. раздел «[[Файл:33_client.pngЛичный кабинет курьерской службы#Подключение|500pxПодключение]]».

На стороне курьерской службы имеется веб-сервис по адресу: В силу [https://homeru.courierexewikipedia.ruorg/apiwiki/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. Тестовые авторизационные данные: логин: test пароль: testm, параметр extra: 8D0.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.Для использования интеграции в "боевом" режиме, запросите '''логин''', '''пароль''', и параметр '''extra''' у той компанииB8 особенностей языка XML], с которой интегрируетесь.Вы можете отправлять тестовые запросы к нашему сервису некоторые символы в личном кабинете тексте должны быть заменены: & на &amp;amp; < на &amp;lt; > на закладке &amp;gt; "Автоматизация". В личном кабинете так же можно видеть историю отправленных Вами запросов.на &amp;quot;

Клиент отправляет запросы к сервисуНаше API принципиально работает только по HTTPS, методом HTTP POST, сервис обрабатывает запросы и возвращает результат выполнениятак как передает конфиденциальные данные. Все запросы и ответы передаются в формате XMLВ некоторых системах с этим возникают проблемы.Кодировка - UTF-8. Разделитель целой и дробной частей чисел Если ваша система не может полноценно работать с шифрованием, мы рекомендуем развернуть http- используется символ точки. Даты представляются в виде YYYY-MM-DDсервер у себя локально, время - HH:MM.В силу установить [httpshttp://courierexe.ru.wikipedia.org/wikidownload/api/XML#proxy.D0zip прокси на PHP].A0<spoiler text="Как запустить">Для теста можете запустить его на сервере следующей командой: php -S <IP>:8080 proxy.D0phpгде <IP> — это адрес вашего сервера, а 8080 порт, на котором будут приниматься запросы.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], некоторые символы в тексте должны быть замененыТогда для обмена данными с нашим АПИ необходимо будет использовать адрес <IP>: & на &amp;amp; 8080< на &amp;lt; /spoiler> на &amp;gt; " на &amp;quot;Доступность функций, описанных в этом разделе, зависит от [[Личный кабинет курьерской службы#Функции личного кабинета|тарифа вашего личного кабинета]].

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

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

<townregioncode="78" country="RU">Санкт-Петербург</town>

<returnprice>NO387.5</returnprice> <return_serviceinshprice>1387.5</return_serviceinshprice> <deliveryprice VATrate="20">150</deliveryprice> <discount>120</discount> <paytype>CASH</paytype>

<pricereturn>387.5NO</pricereturn> <deliverypricereturn_service>1501</deliverypricereturn_service> <discountreturn_type>03</discountreturn_type> <inshpricereturn_weight>3875.51</return_weight> <courier>22</courier> <receiverpays>NO</inshpricereceiverpays>

<item extcode="abc123" quantity="1" mass="0.2" retprice="37.5" VATrate="0" barcode="2345625213125" textArticle="1" article="1" volume="3" origincountry="AUT" GTD="321546654" excise="15.20" suppcompany="ООО &quot;Рога и копыта&quot;" suppphone="79161234567" suppINN="1112223334" govType="2" governmentCode="11223311" extraTags="">Мяч</item> <item extcode="abc124" quantity="2" mass="2" retprice="100" inshprice="100" VATrate="10" barcode="4645625213138" article="2" length="10" width="20" height="30" origincountry="004">Обруч</item> <item extcode="abc125" quantity="3" mass="0.3" retprice="50" inshprice="50" barcode="2345625213126" itemcode="44123" article="3" type="1">Погремушка желтая</item>

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

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

*'''orderbarcode''' - Контейнер для описания одного  — Штрихкод заказа. Если клиент штрихкодирует свои отправления и штрихкод отличается от номера заказа, обязательный элементв этом поле указывается штрихкод. В одном контейнере '''neworder''' может быть много контейнеров '''order''' для создания нескольких заказов одним запросомЕсли ШК содержит кириллицу или малое количество символов, то формируется ШК в формате EAN13.

:* '''''orderno''''' - Номер <spoiler text="Заполнение номера заказа. Если присваивается клиентом (шифра) и штрих- указывается здесь. Если не присваивается - можно оставить пустым, система сгенерирует свой номер, кода">Шифр и вернет его в ответе. Система проверяет наличие заказов с указанным номером в пределах текущего календарного года, и в случае их существования штрих- заказ создан не будет, а в ответе вернется ошибка 17 "Such number exists".код заполняются исходя из начальных значений:

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

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

*'''receiver''' -  — Информация о получателе заказа. Обязательный контейнер.

<townregioncode="Код региона">Город получателя в формате "Москва город"</town>

*'''company''' -  — Компания-получатель.*'''person''' -  — Контактное лицо. ''Должно быть заполнено хотя бы одно из полей - полей — company или person!''*'''phone''' -  — Телефон. Можно указывать несколько телефонов, E-mail в этом поле.*'''town'''  — Город.* '''pvz''' — Код пункта самовывоза по справочнику. Кроме того, ПВЗ можно указать в строке '''''address''''' в виде::* код ПВЗ в нашей системе:* код ПВЗ в системе подрядчика:* наименование ПВЗ в виде строки "ПВЗ " + «Наименование ПВЗ» Для тега города '''town''' можно указать код региона в атрибуте '''''regioncode''''' из [[#Справочник регионов|справочника регионов]]. Поиск будет производиться в указанном регионе. Также можно указать страну получателя в атрибуте '''''country''''' в соответствии с [https://ru.wikipedia.org/wiki/ISO_3166-1 стандартом ISO_3166- Город1], например, «RU», «RUS» или «643» для России. Кроме того, поиск города осуществляется с учетом почтового индекса, указанного в теге '''zipcode'''.

:* 36-ти значный код адресной системы <rspoiler text="ФИАС">Федеральная информационная адресная система — система — единый российский государственный адресный реестр</rspoiler> (AOID)

*'''paytypeuserid''' - Тип оплаты заказа получателем — Идентификатор пользователя, строковый или числовой тип. Принимает значения::* CASH - Наличными при получении (по-умолчанию):* CARD - Картой при получении:* NO - Без оплатыВиртуальное поле. Поле Price будет проигнорированоНеобязательное. (Этот тип оплаты передаетсяДанное поле используется совместно с настройками «Цена доставки для получателя», если заказ уже оплачен и не требует инкассации, API добавит в систему товары по нулевой ценеопределяя приоритет правила. Если необходимо передать общую сумму заказа - можно это сделать Можно использовать в поле <inshprice>различных CMS/CRM системах, указав объявленную ценность)настраивая цены для определенного покупателя. :* OTHER - Прочее (Предусмотрен для того'''groupid''' — Идентификатор группы пользователя, чтобы оплата поступала непосредственно в курьерскую службу посредством прочих типов оплаты - таких как: вебмани, яденьги, картой на сайте, прочие платежные системы и тстроковый или числовой тип.дВиртуальное поле.):* OPTION - На выбор получателяНеобязательное. Этот тип оплаты нельзя передавать Данное поле используется совместно с заказомнастройками «Цена доставки для получателя», определяя приоритет правила. Он выставляется автоматически Можно использовать в зависимости от настройки клиентаразличных CMS/CRM системах, настраивая цены для определенной группы покупателей.

*'''zipcode''' <div style="color: #a94442; background- Почтовый индекс.*'''weight''' - Общий вес заказа в килограммах.*'''quantity''' - Количество мест.*'''service''' - Режим доставки (тип услуги) передается код из справочника color: #f2dede; border: 1px solid #ebccd1; padding: 3px 10px 10px;"Виды срочности".>*'''typeОбратите внимание!''' - Тип корреспонденции (отправления) передается код из справочника "Типы корреспонденции".*'''price''' - Сумма заказа. В случае наличия контейнера items значение данного параметра будет проигнорированоПри передаче заказов, и рассчитано автоматически.*'''deliveryprice''' - Сумма у которых плановая дата доставки. В случае наличия контейнера items/забора меньше ближайшей возможной, в него будет добавлено вложение "Доставка".*'''discount''' - Скидка на заказ. В результате сумма заказа будет уменьшена дата автоматически меняется на размер скидки.*'''return''' - Признак необходимости возврата.*'''return_service''' - Режим возврата (тип услуги) передается код из справочника "Виды срочности".*'''enclosure''' - Вложение.*'''inshprice''' - Объявленная ценность.*'''instruction''' - Поручение - Примечаниесамую раннюю возможную.*'''pvz''' - Код пункта самовывоза по [[Личный кабинет курьерской службы#Справочник пунктов самовывозаКак считается минимальная дата возможной доставки|справочникуПодробнее]]*'''department''' - Подразделение, в котором оформляется заказ.*'''pickup''' - Признак оформления забора YES/NO. Если стоит YES, то весь заказ считается заданием на забор груза, а не на доставку! Применяется для вызова курьера к отправителю для забора других отправлений.*'''acceptpartially''' - Признак возможности частичного выкупа товаров отправления YES</NO.div>

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

<createorder orderno="AB23541" barcode="67567#114" error="0" errormsg="successSuccess" errormsgru="Успешно" orderprice="5000"></createorder> <createorder orderno="55_6542AB23542" barcode="67567#115" error="0" errormsg="successSuccess" errormsgru="Успешно" orderprice="6000"></createorder> <createorder orderno="AB23542AB23543" barcode="67567#116" error="0" errormsg="successSuccess" errormsgru="Успешно" orderprice="0"></createorder>

<createorder orderno="AB23541" barcode="67567#114" error="1767" errormsg="Such number Order barcode already existsin the database." errormsgru="Такой штрихкод заказа уже есть в базе."></createorder> <createorder orderno="AB23542" barcode="67567#115" error="1317" errormsg="empty companyOrder number already exists in the database." errormsgru="Такой номер заказа уже есть в базе."></createorder> <createorder orderno="AB23543" barcode="67567#116" error="1467" errormsg="empty personOrder barcode already exists in the database." errormsgru="Такой штрихкод заказа уже есть в базе."></createorder>

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

0 - Ошибок нет. 1 - Ошибка авторизации. (отсутствуют теги <auth login="" pass=""></auth>, неверный логин или пароль).= Передача значений полей в форме создания заказа в Личном Кабинете через GET параметры ===2 - Отправлен пустой запрос (отсутствует контейнер <neworder></neworder> Если вам требуется передавать значения полей в XML документе). 3 - Некорректно указана сумма форме создания заказа. 4 в Личном Кабинете через GET параметры, то вы можете подробно ознакомиться с этим на данной странице - Некорректный общий вес [[Личный_кабинет_клиента#Передача и подстановка значений полей формы создания заказа. 5 - Не найден город получатель. 6 - Не найден город отправитель. 7 - Не заполнен адрес получателя. 8 - Не заполнен телефон получателя. 9 - Не заполнено контактное имя получателя. 10 - Не заполнено название компании получателя. 11 - Некорректная сумма объявленной ценности. 12 - Артикул не найден. 13 - Не заполнено название компании отправителя. 14 - Не заполнено контактное имя отправителя. 15 - Не заполнен телефон отправителя. 16 - Не заполнен адрес отправителя. 17 - Заказ с таким номером уже существует.через GET параметры]]

<quickstatusconditions>NO <namecontains/quickstatus> <namestarts/> </conditions>

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

*'''changesconditions''' - может принимать значение только ONLY_LAST — Задает условия фильтрации по «orderno». Если указан этот параметрВсе вложенные элементы одновременно накладывают условие «И». Минимум 5 символов!:* '''namecontains''' — Поиск по номеру заказа(шифр), все остальные, кроме quickstatusкоторый содержит «orderno».:* '''namestarts''' — Поиск по номеру заказа(шифр), игнорируютсякоторый начинается с «orderno». Описание данного режима приведено здесь: [[#Передача только изменившихся статусов|Передача только изменившихся статусов]]

# Периода запроса статусов (контейнеры '''datefrom''' и '''dateto''') ограничивается двумя месяцами &mdash; месяцами — два месяца до даты '''"по"«по»'''.# Если не указаны обе даты &mdash; даты — '''dateto''' принимается равной текущей дате.# Если не указана дата '''dateto''' &mdash;  — она принимается равной '''datefrom''' плюс 2 месяца.# Если не указана дата '''datefrom''' &mdash;  — она принимается равной '''dateto''' минус 2 месяца.# Поиск по '''conditions''' работает только для «Номер заказа(шифр)» и только от 4 символов

<br /> === Примеры ответов ===

<order orderno="111111" awb="qwerty" orderno2="123123" ordercode="34534234" givencode="2345334">

<town code="23432153361" regioncode="78" regionname="Санкт-Петербург город">Санкт-Петербурггород</town>

<pricetype>3873</type> <return>NO</return> <return_service>2</service> <return_type>3</return_type> <return_weight>5.51</return_weight> <return_message>Доставлено в целости</return_message> <pickup>NO</pricepickup>

<inshpricewaittime>387.512</inshpricewaittime>

<instruction>Проверить при покупателе, подписать акт</instruction>

<deliveryprice total="158.6" delivery="100.00" return="58.6"> <advprice code="1" price="150">..База</advprice> ( <advprice code="2" price details are not yet supported)="0">% от объявленной стоимости</advprice> <advprice code="3" price="8..6">Топливный сбор</advprice> <advprice code="4" price="0">Округление</advprice>

<acceptpartially>NO</acceptpartially> <status eventstore="филиал в Санкт-Петербурге" eventtime="2016-06-02 17:22:00" createtimegmt="2016-06-03 16:14:44" message="" title="Доставлен" eventtown="Санкт-Петербург город" color="16777215">COMPLETE</status>

<status eventstore="Офис в Москве" eventtime="2016-05-30 10:20:00" createtimegmt="2016-06-03 16:14:44" message="" title="Новый" eventtown="Москва город" country="RU">NEW</status> <status eventstore="Офис в Москве" eventtime="2016-06-01 17:38:00" createtimegmt="2016-06-03 16:14:44" message="филиал в Санкт-Петербурге" title="Планируется отправка" eventtown="Москва город" country="RU">DEPARTURING</status> <status eventstore="Офис в Москве" eventtime="2016-06-01 19:53:00" createtimegmt="2016-06-03 16:14:44" message="филиал в Санкт-Петербурге" title="Отправлено со склада" eventtown="Москва город" country="RU">DEPARTURE</status> <status eventstore="филиал в Санкт-Петербурге" eventtime="2016-06-02 07:41:00" createtimegmt="2016-06-03 16:14:44" message="" title="Получен складом" eventtown="Санкт-Петербург город" country="RU">ACCEPTED</status> <status eventstore="филиал в Санкт-Петербурге" eventtime="2016-06-02 09:17:00" createtimegmt="2016-06-03 16:14:44" message="" title="Выдан курьеру на доставку" eventtown="Санкт-Петербург город" country="RU">DELIVERY</status> <status eventstore="филиал в Санкт-Петербурге" eventtime="2016-06-02 17:22:00" createtimegmt="2016-06-03 16:14:44" message="" title="Доставлен (предварительно)" eventtown="Санкт-Петербург город" country="RU">COURIERDELIVERED</status> <status eventstore="филиал в Санкт-Петербурге" eventtime="2016-06-02 17:22:00" createtimegmt="2016-06-03 16:14:44" message="" title="Доставлен" eventtown="Санкт-Петербург город" country="RU">COMPLETE</status>

<item code="34533" extcode="abc123" quantity="1" mass="0.2" retprice="37.5" VATrate="0" barcode="2345625213125" article="1" returns="0" origincountry="040" GTD="" excise="0.00" governmentCode="11223311" suppcompany="Поставщик" suppINN="1112223334" suppphone="79161234567">Мяч</item> <item code="34456" extcode="abc124" quantity="2" mass="2" retprice="100" VATrate="10" barcode="4645625213138" article="2" returns="0" governmentCode="">Обруч</item> <item code="34421" extcode="abc125" quantity="3" mass="0.3" retprice="50" VATrate="18" barcode="2345625213126" itemcode="44123" article="3" returns="0" governmentCode="">Погремушка желтая</item>

<package code="3312333331" strbarcode="4625333555001ORD0000001" mass="01" message="" got="YES"></package> <package code="33332" strbarcode="ORD0000002" mass="2.5" message="" got="NO">Место 1</package>

:* '''''awb''''' — Номер накладной в системе курьерской службы.:* '''''orderno2''''' — Номер накладной в подсистеме срочной доставки курьерской службы.:* '''''ordercode''''' -  — внутренний код заказа в системе, применяется для некоторых внутренних операций.:* '''''givencode''''' — внутренний код заказа в системе, применяется для некоторых внутренних операций. *'''paytype''' - Тип оплаты заказа получателем. Принимает значения::: CASH - Наличными при получении (по-умолчанию):: CARD - Картой при получении:: NO - Без оплаты.:: OTHER - Прочее (Предусмотрен для того, чтобы оплата поступала непосредственно в курьерскую службу посредством прочих типов оплаты - таких как: вебмани, яденьги, картой на сайте, прочие платежные системы и т.д.)* Атрибуты контейнера '''paytype''':** '''''code''''' - (integer) внутренний код типа оплаты заказа в системном справочнике "Типы оплаты корреспонденции". Не обязательный элемент.  * атрибут '''''code''''' контейнера '''item''' — внутренний код строки заказа в системе, применяется для некоторых внутренних операций.:* '''''returns''''' -  — количество данного товара, от которого отказался получатель. Не нулевое только в случае частичного отказа. * атрибут '''''got''''' контейнера '''package''' — признак принятого места YES / NO.:* '''''returns''''' — количество данного товара, от которого отказался получатель. Не нулевое только в случае частичного отказа. * '''''area''''' в контейнере '''receiver''' — район/метро получателя.* '''''coords''''' в контейнере '''receiver''' — координаты получателя.* '''''deliveryPIN''''' в контейнере '''receiver''' — Пин-код.* '''pickup''' — признак оформления забора, возможные значения: '''YES''', '''NO'''. Если указано '''YES''', то весь заказ считается заданием на забор груза, а не на доставку.* '''currcoords''' — текущие координаты заказа. Атрибуты::* '''''lat''''' — широта:* '''''lon''''' — долгота:* '''''accuracy''''' — точность в метрах:* '''''RequestDateTime''''' — дата/время последнего обновления координат. * '''courier''' — Данные курьера, которому выдан заказ. Если заказ не выдан, то выводятся данные запланированного курьера.* '''waittime ''' — Время ожидания курьера.* '''deliveryprice''' — Стоимость услуг в валюте расчетов с клиентом. Атрибуты::* '''''total''''' — общая стоимость услуг:* '''''delivery''''' — стоимость доставки «Туда»:* '''''return''''' — стоимость доставки «Обратно» (если order->return=YES)Тэг '''deliveryprice''' включает список дополнительных услуг (только для тарифа «Премиум»)::* '''''advprice''''' — наименование дополнительной услуги:* '''''code''''' — код дополнительной услуги:* '''''price''''' — стоимость дополнительной услуги

* атрибут '''status''code' — статус доставки (список статусов см. ниже). Атрибуты (заполняются начиная с версии системы 2008.0.0.670)::* '''' контейнера 'eventstore''item''' - внутренний код строки заказа в системе — филиал, применяется для некоторых внутренних операций.к которому относится текущий статус:* '''''coordseventtime''''' в контейнере '''receiver''' - координаты получателя.* '''currcoords''' - текущие координаты заказа — время события по часовому поясу места его наступления. Атрибуты::* '''''latcreatetimegmt'''''  — время по GMT создания записи о смене статуса в БД. Используется для сортировки записей, чтобы соблюсти хронологическую последовательность. <spoiler text="Подробнее">Большинство событий фиксируются в полях eventtime и createtimegmt на основании одного действия, тогда они отличаются только сдвигом от GMT. Однако, если курьер доставил отправление 10.10.2010 в 20:00, по какой- широтато причине не внес это в мобильное приложение, на следующий день сдал накладную, и в 9 утра оператор внесла, что он доставил вчера в 20:00. Тогда в createtimegmt будет сегодня 6 утра (для Москвы), а в eventtime — вчера в 20:* '''''lon''''' 00. При этом оператор по каким-то причинам может внести время вручения раньше, чем какое-то предыдущее событие, т.о. нарушится последовательность времени в eventtime, но при сортировке по createtimegmt все- долготаравно все будет правильно.</spoiler>:* '''''accuracymessage'''''  — наименование филиала- точность в метрахполучателя, при передаче между филиалами:* '''''RequestDateTimetitle''''' - дата/время последнего обновления координат. — русское наименование статуса

* '''deliverypricestatushistory''' - стоимость  — история статусов доставки в валюте расчетов с клиентом.* Содержит список контейнеров '''status''' - статус доставки (список статусов см. ниже). Атрибуты (заполняются Заполняется только для тарифа «Премиум» начиная с версии системы 2008.0.0.670):.:* '''customstatecode''eventstore' — код внутреннего статуса курьерской службы. Значения уточняйте в курьерской службе. Назначаются курьерской службой в разделе «Справочники» — «Статусы» — «15 Статусы корреспонденции». Справочник не передается через API клиенту по причине возможного наличия в нем внутренних технологических статусов курьерской службы.* '''clientstatecode''' - филиал — код статуса клиента. Используется, к которому относится текущий статусесли клиент предлагает свои коды статусов доставки/причин недоставки.:* '''deliveredto''eventtime' — данные из поля «Инфо. о доставке» (может быть информация о доставке, причина недоставки и т. п.).* '''delivereddate''' - время изменения статуса (время зависит от местонахождения филиала) — дата вручения.:* '''deliveredtime'''createtimegmt — время вручения. В случае недоставки может быть пустым.* '''arrival'' ' — плановая дата прибытия в формате гггг- время фактического изменения статуса мм-дд чч: мм: сс. Заполняется только при использовании автоматических систем планирования (GMTМаксоптра, Яндекс доставка), во всех остальных случаях - пустое.:* '''outstrbarcode''message' — код у подрядчика (код заказа во внешней системе). Используется в интеграциях с внешними системами.* '''partner' - наименование филиала-получателя, при передаче между филиалами'' — текущий филиал/подрядчик.:* '''return_message''title' — информация о возврате* '''department' - русское наименование статуса'' — Подразделение, в котором оформляется заказ.

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

*'''packages''' - Контейнер для описания мест. Необязательный контейнер. Атрибуты::* '''''package''''' - Название места.:* '''''code''''' - Внутренний код строки.:* '''''strbarcode''COMPLETE''' - Штрих-код места — Доставлен.:* '''''mass'PARTIALLY'''' - Масса места в килограммах — Доставлен частично.:* '''''message''CANCELED''' - Строка сообщения — Не доставлен (Возврат/Отмена).После этого статуса отправление должны вернуть заказчику, будут статусы RETURNING и RETURNED

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

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

# Атрибуты контейнера Контейнер '''status''' заполняются для версий системы '''2008.0.0.670statushistory''' и новее.# Контейнер '''statushistorydeliveryprice''' заполняется для тарифа "тарифов [[Личный_кабинетЛичный кабинет курьерской службы#.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''' и новееТо есть Вы можете получить статус «COMPLETE», а следующим запросом — «NEW» — такое может произойти, например, если оператор ошибочно отметил заказ выполненным, а затем исправил ошибку.

<br />

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

Для получения только изменившихся статусов отправьте запрос:

<quickstatusstreamid>NO1234</quickstatusstreamid>

Система выдает все заказы, в которых, с момента последнего запроса в этом режиме, изменилось хотя бы одно из полей:

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

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

<commitlaststatus> <error error="0" errormsg=">OK"></error></commitlaststatus>

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

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

<br />

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

<order orderno="1234111111"> <barcode>111111</barcode> <AWB>111111</AWB> <sender> <town code="1" country="RU">Москва город</town> <date>2014-03-22</date> <time_min>09:00</time_min> <time_max>14:00</time_max> </sender> <receiver> <town code="1" country="RU">Москва город</town> <zipcode>125480</zipcode> <date>20152014-0403-1822</date> <time_min>09:00</time_min> <time_max>14:00</time_max> </receiver> <price>387.5</price> <inshprice>387.5</inshprice> <paytype>CASH</paytype> <weight>05.1</weight> <quantity>12</quantity> <service>2</service> <type>3</type> <return>NO</return> <return_service>2</return_service> <return_date></return_date> <return_time></return_time> <return_message></return_message> <waittime>12</waittime> <enclosure>Детские игрушки</enclosure> <instruction>Проверить при покупателе, подписать акт</instruction> <deliveryprice total="158.6" delivery="100.00" return="58.6" /> <courier> <code>26</code> <name>Иванов Владимир Петрович</name> <phone>+79161234567</phone> </courier> <currcoords lat="55.680327" lon="37.604456" accuracy="50" RequestDateTime="2014-04-21 18:07:45" /> <status eventstore="филиал в Санкт-Петербурге" eventtime="2016-06-02 17:22:00" createtimegmt="2016-06-03 16:14:44" message="" title="Доставлен">COMPLETE</status> <statushistory> <status eventstore="Офис в Москве" eventtime="2016-05-30 10:20:00" createtimegmt="2016-06-03 16:14:44" message="" title="Новый">NEW</status> <status eventstore="Офис в Москве" eventtime="2016-06-01 17:38:00" createtimegmt="2016-06-03 16:14:44" message="филиал в Санкт-Петербурге" title="Планируется отправка">DEPARTURING</status> <status eventstore="Офис в Москве" eventtime="2016-06-01 19:53:00" createtimegmt="2016-06-03 16:14:44" message="филиал в Санкт-Петербурге" title="Отправлено со склада">DEPARTURE</status> <status eventstore="филиал в Санкт-Петербурге" eventtime="2016-06-02 07:41:00" createtimegmt="2016-06-03 16:14:44" message="" title="Получен складом">ACCEPTED</status> <status eventstore="филиал в Санкт-Петербурге" eventtime="2016-06-02 09:17:00" createtimegmt="2016-06-03 16:14:44" message="" title="Выдан курьеру на доставку">DELIVERY</status> <status eventstore="филиал в Санкт-Петербурге" eventtime="2016-06-02 17:22:00" createtimegmt="2016-06-03 16:14:44" message="" title="Доставлен (предварительно)">COURIERDELIVERED</status> <status eventstore="филиал в Санкт-Петербурге" eventtime="2016-06-02 17:22:00" createtimegmt="2016-06-03 16:14:44" message="" title="Доставлен">COMPLETE</status> </statushistory> <deliveredto>Иванова, секр.</deliveredto> <delivereddate>2016-06-02</delivereddate> <deliveredtime>17:22</deliveredtime> <outstrbarcode>EXT123456</outstrbarcode> <items> <item code="34533" extcode="abc123" quantity="1" mass="0.2" retprice="37.5" VATrate="0" barcode="2345625213125" article="1" returns="0" origincountry="040" GTD="" excise="0.00" governmentCode="11223311" suppcompany="Поставщик" suppINN="1112223334" suppphone="79161234567">Мяч</item> <item code="34456" extcode="abc124" quantity="2" mass="2" retprice="100" VATrate="10" barcode="4645625213138" article="2" returns="0" governmentCode="">Обруч</item> <item code="34421" extcode="abc125" quantity="3" mass="0.3" retprice="50" VATrate="18" barcode="2345625213126" article="3" returns="0" governmentCode="">Погремушка желтая</item> </items> </order>

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

<order ordercode="123456" date> <message>Получил Иванов</message> <outstrbarcode>7654312</outstrbarcode> </order> <order ordercode="2018234567"> <status>PICKUPREADY</status> <eventtime>2016-0305-01" time="30 10:20:00" </eventtime> <message=">Клиент отказался от покупки</message> <paytype>CASH</paytype> <storeprice>123</storeprice> <items> <item code="34533" quantity="1" reason="0" governmentCode="11223311"/> <order ordercodeitem code="34456" quantity="2345670" datereason="2018-03-010" /> <item code="34421" timequantity="10:002" messagereason="0"/> </items>

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

== Получение накладной в формате pdf документов для печати == '''Пример запроса получения накладнойпечатных форм:'''

<auth extra="extra8" login="login" pass="pass" /> <orders> <order orderno="1234567" ordercode="33331" /> <order orderno="1234568" ordercode="33332" /> </orders> <form>Шифр заказа1</ordernoform> <start>5</start>

<content>EODIcaI8KSBlwQ 4MnEOR7Px8U8EBAyGICBnwpw IZhQgz0ZxuPs8EBM/GcbjzB AwhBl8hwQYIO00GmEwg1CeEG mqYTChNU0wqf8l8nz4zgc+K fCno+zwU5GjOZmzXGcbEQYIM 4zkegRE40zWzONyoNNMIOIa cWnp6aDCGEGE9NQmoQd2mg00 79U4f3hPTwnfp6Sdrafeqpa JDpFw/1aYT077VNNNdO00G3q mqqvp9p2E7T0/wiFemv8uG6 OM</content>

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

При отмене заказа поле "Инфо о доставке" получает значение "Отменено заказчиком"'''Обратите внимание''', а поле "Дата доставки" - текущую датучто печатные формы для заборов не формируются.

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

<?xml version="1.0" encoding="UTF-8" ?><cancelorderwaybill> <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"error>Текст ошибки<?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="Заказ не найден" /></cancelorderwaybill>

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

*'''codesearch''' — Поиск по кодам. В случае использования — контейнеры conditions и limitигнорируются.:* '''zipcode''' — Поиск по индексу. Обратите внимание на то, что один почтовый индекс может распространяться на несколько населенных пунктов. В этом случае система вернет несколько записей.:* ''' kladrcode''' — Поиск по 13- ти значному коду КЛАДР.:* '''fiascode''' — Поиск по коду ФИАС (AOGUID).:* '''code''' — Поиск по коду в системе. * '''conditions''' — Задает условия поиска. Все вложенные элементы одновременно накладывают условие «И».:* '''city''' — Поиск по всем населенным пунктам региона.:* '''namecontainsparts''' — Поиск населенных пунктов, название которых содержит все указанные слова, с разбиением поисковой фразы через пробел. Например "моск моло" найдет деревню "Молоково" в Московской области.:* '''namecontains''' — Поиск населенных пунктов, название которых содержит указанный текст.:* '''namestarts''' — Поиск населенных пунктов, название которых начинается с указанного текста.:* '''name''' — Поиск населенных пунктов, название которых соответствует указанному тексту.:* '''fullname''' — Поиск населенных пунктов, название вместе с типом населенного пункта которых соответствует указанному тексту.:* '''country''' — Поиск только по стране с указанным внутренним кодом или текстовым кодом в соответствии [https://ru.wikipedia.org/wiki/ISO_3166-1 стандартом ISO_3166-1], например, «RU», «RUS» для России. * '''limit''' — Ограничивает вывод результата.:* '''limitfrom''' -  — Задает номер записи результата, начиная с которой выдавать ответ. По-умолчанию - умолчанию — 0.:* '''limitcount'''- Задает количество записей результата, которые нужно вернуть. По-умолчанию - умолчанию — 10000.:* '''countall''' -  — YES указывает на необходимость подсчета общего количества найденных совпадений. Это может замедлять выполнение запроса. Если отключено - отключено — в ответе не указываются totalcount и totalpages.

<code>26379</code> <city> <code>23</code> <name>Краснодарский край</name> </city> <name>Сочи город</name> <shortnamefiascode>79da737a-603b-4c19-9b54-9114c96fb912</fiascode> <kladrcode>Сочи2300000700000</kladrcode> <shortname/> (not yet supported) <typename>город</typename> (not yet supported) <coords lat="43.5855" lon="39.7231" />

<code>40331</code> <city> <code>32</code> <name>Брянская область</name> </city> <name>Сочилов хутор</name> <shortnamefiascode>c9c96c67-2cc9-4f10-afde-fd32417ea216</fiascode> <kladrcode>Сочилов3201900011100</kladrcode> <shortname/> <typename/>хутор <coords lat="52.6407" lon="33.1724" /typename>

<code>114016</code> <city> <code>60</code> <name>Псковская область</name> </city> <name>Сочихино деревня</name> <shortnamefiascode>10df7588-19c1-49d1-a387-9de1cf3eb26f</fiascode> <kladrcode>Сочихино6001900015400</kladrcode> <shortname/> <typename/>деревня <coords lat="56.6003" lon="29.3542" /typename>

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

<country>1RU</country>

</streetlist >

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

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

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

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

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

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

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

*'''code''' -  — внутренний код операции движения*'''date''' -  — дата операции*'''retprice''' -  — цена товара*'''quantity''' -  — количество товара операции*'''delivered''' -  — количество доставленного товара * '''item''' — контейнер товара:* '''code''' — внутренний код товара:* '''name''' — наименование товара * '''status''' — контейнер статуса операции:* '''code''' — код статуса:* '''name''' — наименование * '''store''' — контейнер филиала, к которому относится операция:* '''code''' — код филиала:* '''name''' — наименование филиала * '''order''' — контейнер корреспонденции:* '''ordercode''' — внутренний код заказа:* '''number''' — номер заказа:* '''date''' — дата заказа:* '''orderno''' — шифр:* '''barcode''' — штрихкод:* '''company''' — компания:* '''address''' — адрес:* '''delivereddate''' — дата вручения:* '''deliveredtime''' — время вручения:* '''deliveredto''' — данные о вручении, либо причина недоставки * '''document''' — контейнер документа операции:* '''code''' — внутренний код документа:* '''number''' — номер документа:* '''extnumber''' — внешний номер документа:* '''date''' — дата документа:* '''message''' — комментарий == Получение справочника тарифов по городам == '''Пример запроса справочника тарифов по городам'''<source lang="xml"><?xml version="1.0" encoding="UTF-8"?><tariffs> <auth extra="8" login="login" pass="pass" /> <townfrom>Москва</townfrom> <service>1</service> <mainonly>1</mainonly> </tariffs></source> * '''auth''' — атрибут '''extra''' обязателен, по нему определяется курьерская служба.* '''townfrom''' — город-отправитель. Если не передан, то городом будет «Москва».* '''service''' — режим доставки. Обязательный элемент.* '''mainonly''' — необязательный элемент. Если передан, то в ответе будут данные только по городам из справочника '''Межгород''' > '''Зоны'''.

'''Пример ответа справочника тарифов по городам'''<source lang="json">{ "townfrom": "0c5b2444-70a0-4932-980c-b4dc0d3f02b5", "service": 1, "tariffs": [ { "towntofias": "0c5b2444-70a0-4932-980c-b4dc0d3f02b5", "towntocode": 1, "towntoname": "Москва город", "townregion": "Город Москва", "distance": 0, "pricedistance": 0, "pricesnew": { "before": [ { "price": 100, "every": 0, "mass": 1 }, { "price": 150, "every": 0, "mass": 5 } ], "after": [ { "price": 0, "every": 1, "mass": 38.01 }, { "price": 15, "every": 1, "mass": 51.01 } ] }, "deliveryPeriodMin": 1, "deliveryPeriodMax": 2 } ]}</source> ''' Описание полей ответа '''*'''storetownfrom'''  — код ФИАС города- контейнер филиала, к которому относится операцияотправителя.* '''service''' — режим доставки.* '''tariffs''' — cписок тарифов по городу.:* '''codetownregion'''  — регион города- получателя.:* '''towntofias''' — код филиалаФИАС города-получателя.:* '''nametowntocode'''  — внутренний код города- получателя.:* '''towntoname''' — наименование филиалагорода-получателя.:* '''distance''' — дистанция в км до города от МКАД, если в запросе townfrom — Москва.:* '''pricedistance''' — сумма за километраж до города от МКАД, если в запросе townfrom — Москва.:* '''pricesnew''' — ваши настройки тарифов из справочника '''Межгород''' > '''Тарифы по зонам'''.::* '''before/after''' — контейнеры ДО/ОТ.:::* '''price''' — цена. Если ответ идет по «before», то в цену также плюсуется сумма pricedistance:::* '''every''' — за каждые.:::* '''mass''' — масса.:* '''prices''' — устаревший элемент, не используется.:* '''deliveryPeriodMin''' — минимальный срок доставки.:* '''deliveryPeriodMax''' — максимальный срок доставки. == Номенклатура приходной накладной =='''Пример запроса номенклатуры приходной накладной:'''<source lang="xml"><?xml version="1.0" encoding="UTF-8" ?><itemdoc> <auth extra="8" login="login" pass="pass"></auth> <code>21991</code></itemdoc></source>

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

*'''documentПример ответа движения номенклатуры:''' <source lang="xml"><?xml version="1.0" encoding="UTF-8" ?><itemdoc> <code>21991</code> <number>318</number> <date>2017-05- контейнер документа операции26</date> <message></message> <items> <item code="4259" quantity="1" barcode="200300" article="123555">Настольная игра Дженга</item> </items></itemdoc></source> ''' Описание полей ответа ''':* '''code''' -  — внутренний код документаприходной накладной:* '''number''' -  — номер документа:* '''date''' -  — дата документа* '''message''' — комментарий * '''item''' — контейнер товара:* '''messagecode''' — внутренний код товара:* '''barcode''' — штрихкод товара:* '''article''' — артикул товара:* '''quantity''' — количество поступившего товара == Справочник филиалов =='''Пример запроса списка филиалов:'''<source lang="xml"><?xml version="1.0" encoding="UTF-8" ?><storelist> <auth extra="8"></auth> <json>YES</json> <client_code>7890</client_code></storelist></source> * '''auth''' — Атрибут '''extra''' — обязателен, по нему определяется курьерская служба* '''json''' — Признак вывода ответа в виде JSON YES/NO* '''client_code''' — Код клиента курьерской службы '''Пример ответа:''' <source lang="xml"><?xml version="1.0" encoding="UTF- комментарий8" ?><storelist count="2"> <store> <code>123</code> <name>ABC</name> </store> <store> <code>456</code> <name>Филиал 2</name> </store></storelist></source> * '''code''' — Код филиала.* '''name''' — Наименование филиала.

<code>1234</code> <client_code>7890</client_code> <city>Свердловская область</city> <townregioncode="66" country="RU">Нижний Тагил</town> <address>Щёлковское шоссе</address> <house>77</house> <parentcode>6</parentcode> <acceptcash>YES</acceptcash> <acceptcard>YES</acceptcard> <acceptfitting>YES</acceptfitting> <maxweight>30</maxweight> <acceptindividuals>YES</acceptindividuals> <lt>57.924737</lt> <lg>59.940019</lg> <rt>57.905682</rt> <rg>59.984669</rg> <json>YES</json> <with_coords>YES</with_coords> <limit> <limitfrom>30</limitfrom> <limitcount>2</limitcount> <countall>YES</countall> </limit>

* '''auth''' — Атрибут '''extra''' — обязателен, по нему определяется курьерская служба, '''login''' и '''pass''' позволяют авторизоваться под клиентом: для отдельного клиента могут быть ограничения по доступности некоторых ПВЗ, и в этом случае они будут учтены.* '''code''' — Внутренний код.* '''client_code''' — Код клиента курьерской службы.* '''city''' — Регион получателя. Можно указать код региона или полное наименование региона из [[#Справочник регионов|справочника регионов]].*'''town''' -  — Город получателя.Для тега города '''town''' можно указать код региона в атрибуте '''''regioncode''''' из [[#Справочник регионов|справочника регионов]]. Поиск будет производиться в указанном регионе. Также можно указать страну получателя в атрибуте '''''country''''' в соответствии с [https://ru.wikipedia.org/wiki/ISO_3166-1 стандартом ISO_3166-1], например, «RU», «RUS» или «643» для России.Для формата запроса JSON фильтрация по городу работает только в связке с фильтром по адресу. * '''address''' — Фильтр по адресу, работает только в связке с фильтром по городу* '''house''' — Фильтр по номеру дома, работает только в связке с фильтрами по адресу и городу* '''parentcode''' — Фильтр по родительскому [[#Справочник филиалов|филиалу]]* '''acceptcash''' — Фильтр по приему наличных YES/NO* '''acceptcard''' — Фильтр по приему банковских карт YES/NO* '''acceptfitting''' — Фильтр по наличию примерки YES/NO* '''maxweight''' — Фильтр по максимальному весу, с которым работает ПВЗ* '''acceptindividuals''' — Фильтр по доступности физическим лицам YES/NO* '''lt''' — Широта левого верхнего угла* '''lg''' — Долгота левого верхнего угла* '''rt''' — Широта правого нижнего угла* '''rg''' — Долгота правого нижнего угла* '''json''' — Признак вывода ответа в виде JSON YES/NO* '''with_coords''' — Признак вывода ПВЗ только с наличием координат YES/NO* '''limit''' — Ограничивает вывод результата.:* '''limitfrom''' — Задает номер записи результата, начиная с которой выдавать ответ. По-умолчанию — 0.:* '''limitcount'''- Задает количество записей результата, которые нужно вернуть. По-умолчанию — 100.:* '''countall''' — YES указывает на необходимость подсчета общего количества найденных совпадений. Это может замедлять выполнение запроса. Если отключено — в ответе не указываeтся totalcount.

<pvzlist count="2" totalcount="40465">

<comment>Новый пункт доставки</comment> <worktime>Вс 10:00-16:00, Сб 10:00-16:00, Пн-Пт 10:00-20:00</worktime> <traveldescription>Жилое 5-ти этажное здание, торцом к дороге, второе здание от перекрестка Пархоменко-Циолковского</traveldescription> <maxweight>10</maxweight> <acceptcash>YES</acceptcash> <acceptcard>YES</acceptcard> <acceptfitting>YES</acceptfitting> <acceptindividuals>YES</acceptindividuals> <latitude>57.93457</commentlatitude> <longitude>59.95131</longitude> <uid>40606d00-9c51-11eb-b2c9-cfd6c1111392</uid>

<comment>Время работыВозможность примерки отсутствует</comment> <worktime>Вс 10: пн.00-пт. 916:00, Сб 10:00-1816:00, сбПн-Пт 10:00-20:00</worktime> <traveldescription>Напротив ТЦ Пирамида</traveldescription> <maxweight>20</maxweight> <acceptcash>YES</acceptcash> <acceptcard>YES</acceptcard> <acceptfitting>NO</acceptfitting> <acceptindividuals>YES</acceptindividuals> <latitude>57. 1093468</latitude> <longitude>60.55476</longitude> <uid>41116853-9c51-11eb-b2c9-14cfd6c1451392</commentuid>

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

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

 </source> '''Пример ответа получения фискальных данных:'''<source lang="xml">  <?xml version="1.0" encoding="UTF-8"?><receipts count="1"> <receipt> <orderno>123456</orderno> <fdDatetime>2020-06-07 12:14:00</fdDatetime> <fdValue>123</fdValue> <fdNum>456</fdNum> <fnSn>789</fnSn> <kktNum>100</kktNum> <inn>222</inn> <ofdUrl>gate.ofd.ru</ofdUrl> <fullUrl>https://check.ofd.ru/123</fullUrl> <price>12345</price> <lines count="1"> <line> <item>1111764</item> <name>Сапоги</name> <qty>1</qty> <price>1000</price> <vatRate>20</vatRate> <governmentCode>Z16513LK2</governmentCode> <itemType>1</itemType> </line> </lines> </receipt></receipts></source> Параметры ответа:* '''orderno''' — Номер заказа* '''fdDatetime''' — Дата и время пробития фискального чека* '''fdValue''' — ФПД (фискальный признак документа)* '''fdNum''' — ФИСКАЛЬНЫЙ ДОКУМЕНТ (фискальный номер чека)* '''fnSn''' — ФН (номер фискального накопителя)* '''kktNum''' — РН (регистрационный номер кассы)* '''inn''' — ИНН* '''ofdUrl''' — URL адрес (доменное имя) ОФД* '''price''' — Сумма чека* '''fullUrl''' — URL чека для просмотра онлайн* '''lines''' — Позиции чека:* '''item''' — код товара:* '''name''' — наименование товара:* '''qty''' — количество товара:* '''price''' — цена товара:* '''governmentCode''' — считанная последовательность, которая в дальнейшем преобразуется по алгоритму тега 1162:* '''vatRate''' — НДС товара:* '''itemType''' — тип товара (товар, доставка и т. д.) == Справочник Виды срочности =='''Пример запроса Видов видов срочности:'''

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

<auth extra="8" login="login" pass="pass" /> <order> <pricetype>CUSTOMER</pricetype> <calc townfromsender> <town>Санкт-Петербург</town> <address>Петровка 38 офис 35</address> <coords lat="55.680327" lon="37.604456"></coords> </sender> <receiver> <zipcode>125480</zipcode> <town regioncode="78" country="МоскваRU" townto>Санкт-Петербург</town> <address>Петровка 38 офис 35</address> <pvz>124</pvz> <coords lat="380000030000055.680327" masslon="337.7604456" ></coords> </receiver> <weight>5.1</weight> <service>2</service> <paytype>CASH</paytype> <price>387.5</price> <deliveryprice>150</deliveryprice> <inshprice>387.5</inshprice> <packages> <package mass="1" quantity="5"></package> <package mass="2.5" length="10" width="20" height="30"></package> </packages> <userid>user123</userid> <groupid>customer</groupid> </order>

*'''townfrom''' - Город-отправительСтруктура данных и заполнение полей аналогичны и совместимы с [[#Оформление заказа]]. Дополнительные поля:*'''towntopricetype'''  — тип требуемой цены. Возможные значения: «CUSTOMER» (по- Город-получательумолчанию) — [[Личный кабинет клиента#Цена доставки для получателя|цена для конечного получателя]], «CLIENT» — цена курьерской службы для клиента.*'''massuserid''' - Масса  — Идентификатор пользователя, строковый или числовой тип. Виртуальное поле. Необязательное. Данное поле используется совместно с настройками «Цена доставки для получателя», определяя приоритет правила. Можно использовать в килограммахразличных CMS/CRM системах, настраивая цены для определенного покупателя.*'''servicegroupid''' - Режим  — Идентификатор группы пользователя, строковый или числовой тип. Виртуальное поле. Необязательное. Данное поле используется совместно с настройками «Цена доставки - числодля получателя», указывающее на запись определяя приоритет правила. Можно использовать в справочнике [[#Справочник Видов срочности|видов срочности]]. Если этот параметр опуститьразличных CMS/CRM системах, система выдаст расчет настраивая цены для всех доступных видов срочностиопределенной группы покупателей. Суммы НП и ОЦ, передав много контейнеров <calc> а также тип оплаты CARD имеют значение при настроенных в тарифе на вкладке Прочее долях (в ответепроцентах) от данных сумм.

<price>11631113</price> <mindeliverydays>1</mindeliverydays>

*'''townfrom''' -  — Город-отправитель так, как система его распознала и привязала к справочнику. Атрибут '''code''' -  — код из справочника городов системы.*'''townto''' -  — Город-получатель так, как система его распознала и привязала к справочнику. Атрибут '''code''' -  — код из справочника городов системы.*'''mass''' -  — Масса в килограммах*'''service''' -  — Режим доставки - доставки — число, указывающее на запись в справочнике видов срочности (см описание на этой странице).*'''zone''' -  — номер тарифной зоны, по которой рассчиталась стоимость. В зависимости от зоны выбирается тарифная сетка. Так же к цене могут применяться повышающие или понижающие коэффициенты при доставке не из/в региональный центр.*'''price''' -  — рассчитанная стоимость доставки в валюте прайс-листа курьерской службы. Рекомендуется к использованию в отличие от одноименного атрибута родительского контейнера.*'''maxdeliverydays''' -  — максимальный срок доставки в рабочих днях.* '''mindeliverydate''' — минимальная дата доставки в учетом выходных дней.* '''intervals''' — список интервалов доставки для соответствующей зоны и режима срочности.* '''deliveryprice''' — Данные по составляющим ценам доставки '''''Обратите внимание:''''' В реальном ответе сервера в теге calc присутствует атрибут «price». Он оставлен для обратной совместимости, не используйте его. Пользуйтесь вложенным тегом price. == Получение информации о клиенте =='''Пример запроса получения информации о клиенте:'''<source lang="xml"><?xml version="1.0" encoding="UTF-8" ?><client> <auth extra="8" login="login" pass="pass" /> </client></source> '''client''' — Корневой контейнер. Обязательный элемент.* '''auth''' — Авторизация. Обязательный элемент. '''Пример ответа на запрос получения информации о клиенте:'''<source lang="xml"><?xml version="1.0" encoding="UTF-8" ?><client> <code>1082</code></client></source>

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

'''smalist''' -  — Корневой контейнер. Обязательный элемент.*'''auth''' -  — Авторизация. Обязательный элемент.*'''datefrom''' -  — Дата "с"«с». Необязательный элемент.*'''dateto''' -  — Дата "по"«по». Необязательный элемент.

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

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

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

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

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

<nowiki>https://home.courierexe.ru/35AF350C или curie.ru/35AF350C</nowiki>  '''Примечание!''' Сервис коротких ссылок работает только для ресурсов компании MeaSoft. == Проверка надежности покупателя ==Проверка надежности работает только для тарифа «Максимум» личного кабинета. <source lang="xml"><?xml version="1.0" encoding="UTF-8" ?><mcheck> <auth extra="8" login="login" pass="pass" /> <phones> <phone>89161147992</phone> </phones></mcheck></source> Ответ: <source lang="xml"><?xml version="1.0" encoding="UTF-8" ?><mcheck> <phones> <phone rate="90">89161147992</phone> </phones></mcheck></source>  == Размещение страниц на своем сайте (iframe) == В некоторых случаях имеет смысл разметить те или иные страницы на своем сайте. Например, чтобы клиенты могли рассчитать стоимость доставки не переходя по внешней ссылке, а там же, на сайте, калькулятор можно разместить прямо на странице такого сайта посредством так называемого фрейма — '''iframe'''. [https://ya.ru/search/?text=iframe Фрейм] — контейнер внутри обычной страницы, который позволяет загружать сторонние страницы. Пример загрузки калькулятора: <source lang="html"><iframe id="frame" src="https://home.courierexe.ru/8/calculator"> Здесь должен отобразиться калькулятор</iframe></source> Для удобства пользователей вашего сайта можно указать язык интерфейса (который переключается непосредственно на сайте) параметром '''lang''': <source lang="html"><iframe id="frame" src="https://home.courierexe.ru/8/calculator?lang=2"> Здесь должен отобразиться калькулятор</iframe></source> Обратите внимание! Если язык не указать, то на страницах калькулятора и трекинга отображается свой переключатель языка. Если язык указан, то переключатель не отоборажается. Поддерживаемые языки и их коды::'''1''' — русский:'''2''' — английский:'''4''' — узбекский == Оформление манифеста == '''Пример запроса на создание манифеста:'''<source lang="xml"><?xml version="1.0" encoding="UTF-8" ?><manifest> <auth extra="8" login="login" pass="pass" /> <store_from>1</store_from> <store_to>2</store_to> <trn_code>3</trn_code> <addresses> <address> <code>456</code> </address> </addresses></manifest></source>  '''manifest''' - Корневой контейнер. Обязательный элемент.*'''auth''' - Авторизация. Обязательный элемент.*'''store_from''' - код филиала отправителя. Обязательный элемент.*'''store_to''' - код филиала получателя. Обязательный элемент.*'''trn_code''' - код перевозчика. Обязательный элемент.  '''Пример успешного ответа'''<source lang="xml"><?xml version="1.0" encoding="UTF-8"?><manifest> <result>OK</result></manifest></source>  '''Пример ответа с ошибкой'''<source lang="xml"><?xml version="1.0" encoding="UTF-8"?><manifest> <result error="Текст ошибки">ERROR</result></manifest></source> '''manifest''' - Корневой контейнер. Обязательный элемент.*'''result ''' - Результат. Принимает значения OK или ERROR.*'''error''' - атрибут с текстом ошибки, если она была.