Изменения

<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 курьерскими службами], работающими под управлением системы [https://curie.ru/ MeaSoft "Курьерская служба 2008"]. Если Вы являетесь '''агрегатором''', передающим данные от клиентов, возможно, Вам придется последовательно подключаться под разными пользователями, если курьерская служба должна вести раздельный учет взаиморасчетов по клиентам. Если Вы являетесь '''подрядчиком''' - Вы можете забирать заказы, используя значение client=AGENT в запросе [[#Пример запроса статуса заказа|statusreq]], и передавать статусы заказов используя метод [[#Изменение статуса агентом|setorderinfo]]. Так же для интеграций с подрядчиками у нас есть специальная платформа, но добавлять подрядчиков в нее можно только на нашей стороне. Присылайте нам коммерческое предложение, описание Вашего сервиса, и мы с радостью его рассмотрим.

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

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

{| 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 от 13.12.2018|style="text-align: center;"|[httphttps://marketplace.1c-bitrix.ru/solutions/measoft.courier/ Установить] <!-- [httphttps://courierexe.ru/download/api/bitrixmeasoft.zip Скачать Unicode]<br>[http://courierexe.ru/download/api/bitrix_ansicourier.zip Скачать ANSI] -->|Поддерживает версии 1420.5 .0 и выше. Подробнее см. [[1C-Битрикс|описание]].

|[[Файл:prestashop.png|center|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 в том числе!)Подробнее см. [[PrestaShop|описание]].

|[[Файл:OpencartOCStore.png|center|x44pxx60px]]|style="text-align: center;"|[https://courierexe.ru/download/api/opencart.zip Скачать для версии 1.75.5 от 10.08.20181]<br>2.0.0 от 01.12.2018<br>3.1.1 от 28.02.2019|style="text-align: center;"|[httphttps://courierexe.ru/download/api/opencartmeasoft_oc2.ocmod.zip Скачатьдля версии 2.0]<br><br>[httphttps://courierexe.ru/download/api/opencart_2measoft_oc2.3.ocmod.zip Скачатьдля версии 2.3]<br><br>[httphttps://courierexe.ru/download/api/opencart_3measoft_oc3.ocmod.zip Скачатьдля версии 3.0]|Поддерживает версии с 1.5.5.1.<br>Версия 2.0.0 поддерживает Скачивайте модули для своей версии с 2OpenCart.0<br>Подробнее см. [https://opencartforum[OpenCart|описание]].com/files/file/2906-avtomatizaciya-otpravki-i-otslezhivanie-dostavok-courierexe-dlya-opencart-15x/ Альтернативный модуль сторонних разработчиков]

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

<!--|[[Файл: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://www.insales.ru/collection/all/product/kurierskaya-sluzhba[Личный кабинет клиента|ЛК пользователя]]|[[InSales|Инструкция по настройке]]|-2008 Установить]|[http[Файл://wikiiiko.courierexe.ru/index.php?titlejpg|center|x80px]]|style=Интеграция_с_другими_системами#Insales "text-align: center;"|Настраивается] в [[Личный кабинет клиента|ЛК пользователя в системе]]|[[Iiko|Инструкция по настройке]]

|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

|[http://wiki.courierexe.ru/index.php?title=Интеграция_с_другими_системами#[RetailCRM |Настраивается]] в ЛК пользователя в системе

|[https://infostart.ru/public/692790/ Альтернативный модуль сторонних разработчиков(1 версия)] [https://infostart.ru/public/1531484/ Альтернативный модуль сторонних разработчиков (2 версия)]

|[[Файл:Joomla2.jpg|center|x44pxx60px]]|style="text-align: center;"|1.0.0 от 12.11.2018|style="text-align: center;"|[httphttps://courierexe.ru/download/api/com_measoft.zip Скачать]|Работает только с компонентом Virtuemart. Внимание! Модуль новый, поэтому возможна некорректная передача данных. Проверяйте, если что - сообщайте, исправим!Инструкция в архиве

|style="text-align: center;"|-|style="text-align: center;"|[https://www.amocrm.ru/extensions/courier2008 Установитьmeasoft Описание на сайте amoCRM]|Внимание! Модуль новый, поэтому возможна некорректная передача данныхПодробное описание настроек читайте [[amoCRM|тут]].|-|rowspan="2"|[[Файл:MoySclad. Проверяйте, если что jpg|center|x30px]]|style="height:50px; text- сообщайте, исправим!align: center;"||[[МойСклад|Инструкция]]

|[[Файл:MoySclad.jpg|center|x44px]]|style="text-alignheight: center50px;"|-|style="text-align: center;"|[https://home.courierexeitmdev.ru/moyskladms/shipping/step1 ПодключениеСкачать модуль сторонних разработчиков] [[|Интеграция МойСклад с другими системами#Мой Склад|Инструкция]]|Ожидается в ближайшее время в магазине Мой Складкурьерскими службами от сторонних разработчиков

|style="text-align: center;"|WordPress от 5 версии[https://courierexe.ru/wordpress/wordpress.php Скачать]|[[Wordpress|Инструкция]]|-WooCommerce от 3|[[Файл:Cscart.9 версииpng|center|x60px]]|style="text-align: center;"|[httphttps://courierexemarketplace.cs-cart.rucom/download/api/KC2008_delivery_1584704798measoft-en.zip Скачатьhtml Установить] |Поддерживает версии 4.10 и выше.<br>[[Интеграция с другими системами#WordpressCS-Cart|Инструкция]]|Внимание! Модуль новый, поэтому возможна некорректная передача данных-|[[Файл:webhooks. Проверяйте, если что jpg|center|x100px]]|style="text-align: center;"|Читайте описание [[Webhook|на этой странице]]|Передача информации о статусах и заказах в вашу систему|-|[[Файл:Logo_tilda_black.png|center|x100px]]|style="text- сообщайте, исправим!align: center;"|Читайте описание [[Tilda|на этой странице]]|Работает только на платных тарифах

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

'''Обратите внимание!''' В модулях систем '''PrestaShop''', '''OpenCart''', '''OCStore''', '''Webasyst''', '''InSales''' и '''Joomla''' для отправки заказа == Тестовый аккаунт ==Для отладки зайдите в курьерскую службу необходимо зайти в карточку заказа, в которой должна отображаться форма (смтестовый личный кабинет по адресу [https://home.courierexe.ru/8 https://home. изображение)courierexe. Форма позволяет отправить заказru/8], а если заказ отправлен - проверить его статуслогин: login пароль: pass.

Для отображения списка пунктов выдачи есть '''готовый JavaScript модуль''': упрощения интеграции можно скачать [https://home.courierexe.ru/jsdownload/api/measoft_mapphp_sample.js Инструкция по использованию - внутриzip пример обращения к сервису на PHP].

<source lang=xml><auth extra= Тестовый аккаунт "8" login="login" pass="pass"></auth></source>

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

Для упрощения интеграции можно скачать Запросите эти данные у курьерской службы, к которой вы подключаетесь. Курьерская служба передает временный пароль, его нужно сменить после первого входа в [[http://courierexe.ru/download/api/php_sample.zip пример обращения к сервису на PHPЛичный кабинет клиента|ЛК клиента]].

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

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

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

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

3Тестовые авторизационные данные: логин: login пароль: pass, параметр extra: 8. '''Пароль''' - параметр учетной записи Обратите внимание, что тестовая площадка для ЛК клиента и APIвсех одна. Не нужно передавать в нее заказы с конфиденциальными данными, указывается в карточке клиента на вкладке '''"Прочее"''' в поле '''"Пароль"''' (на скриншоте ниже)их смогут увидеть другие участники.

[[Файл:33_clientДля использования интеграции в «боевом» режиме, запросите '''логин''', '''пароль''', и параметр '''extra''' у той компании, с которой интегрируетесь.png|500px]]

На стороне курьерской службы имеется веб-Клиент отправляет запросы к сервису методом HTTP POST, сервис по адресу: https://homeобрабатывает запросы и возвращает результат выполнения.courierexe.ru/api/. <rspoiler text="Еще есть порт 8443.">Некоторые маршрутизаторы, используемые провайдерами, РНК Все запросы и прочее, ответы передаются в попытке глубокого анализа, могут повреждать трафик на стандартный порт 443формате XML. Сделано по тикету 10964.</rspoiler> Тестовые авторизационные данные: логин: test пароль: testm, параметр extra: Кодировка — UTF-8. Обратите внимание, что тестовая площадка для всех однаРазделитель целой и дробной частей чисел — используется символ точки. Не нужно передавать Даты представляются в нее заказы с конфиденциальными даннымивиде YYYY-MM-DD, их смогут увидеть другие участники.Для использования интеграции в "боевом" режиме, запросите '''логин''', '''пароль''', и параметр '''extra''' у той компании, с которой интегрируетесь.Вы можете отправлять тестовые запросы к нашему сервису в личном кабинете на закладке "Автоматизация". В личном кабинете так же можно видеть историю отправленных Вами запросоввремя — HH:MM.

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

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

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

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

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

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

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

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

<package strbarcode="ORD0000001" mass="1" message="" quantity="3"></package>

<deliveryset above_price="100" return_price="1000" VATrate="10">

*Обязательными на уровне системы являются только 3 поля: receiver->company или receiver->person, receiver->address и receiver->phone. Так же в настройках системы сама курьерская служба может назначить какие-то дополнительные поля обязательными, тогда, если вы их не укажете, получите сообщение об ошибке.<spoiler text="Пример минимально возможного заказа"><source lang="xml"><?xml version="1.0" encoding="UTF-8"?><neworder> <auth extra="8" login="login" pass="pass" /> <order> <receiver> <company>МВД</company> <phone>(495)123-45-67</phone> <address>Петровка, 38</address> </receiver> </order></neworder></source></spoiler> '''neworderОписание полей''' - Корневой контейнер, обязательный элемент.

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

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

:* '''order''orderno' — Контейнер для описания одного заказа, обязательный элемент. В одном контейнере '''neworder''' может быть много контейнеров '''order' - Номер заказа. Если присваивается клиентом - указывается здесь. Если не присваивается - можно оставить пустым, система сгенерирует свой номер, и вернет его в ответе. Система проверяет наличие '' для создания нескольких заказов с указанным номером в пределах текущего календарного года, и в случае их существования - заказ создан не будет, а в ответе вернется ошибка 17 "Such number exists". Если не указан штрих-код (поле barcode), и значение поля подходит для использования его в качестве штрих-кода, данное значение будет скопировано в поле "Штрих-код". Это накладывает ограничения в частности, на длину указанного поля (25 знаков, чтобы работали стандартные печатные формы)одним запросом.

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

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

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

*'''company''' -  — Компания-получатель.*'''person''' -  — Контактное лицо. ''Должно быть заполнено хотя бы одно из полей - полей — company или person!''*'''phone''' -  — Телефон. Можно указывать несколько телефонов, E-mail в этом поле.*'''town''' -  — Город.* '''pvz''' — Код пункта самовывоза по справочнику. Кроме того, ПВЗ можно указать в строке '''''address''''' в виде::* код ПВЗ в нашей системе:* код ПВЗ в системе подрядчика:* наименование ПВЗ в виде строки "ПВЗ " + «Наименование ПВЗ».  При указании ПВЗ в поле адреса необходимо проверять значение поля город получателя (он должен соответствовать данным ПВЗ) либо не передавать его вообще.

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

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

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

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

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

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

*'''packages''' - Контейнер для описания мест. Необязательный контейнер. Атрибуты::* '''''package''''' - Название места.:* '''''code''''' - Внутренний код строки.:* '''''strbarcode''''' - Штрих-код места.:* '''''mass''''' - Масса места в килограммах.:* '''''message''''' - Строка сообщения.:* '''''length''''' - Длина единицы товара.:* '''''width''''' - Ширина единицы товара.:* '''''height''''' - Высота единицы товара.Тэг 1262 – идентификатор ФОИВ = "020" (константа ФОИВ МИНЗДРАВа)

* '''deliveryset''' - настройка [[Дифференциальная стоимость доставки | дифференциальной стоимости доставки]]. Атрибуты::* '''''above_price''''' Тэг 1263 - стоимость в случае полного выкупа заказа (действует как дата нормативного акта федерального органа исполнительной власти = "сумма от14.12.2018" последней границы, указанной в теге below_sum(константа):* '''''return_price''''' - стоимость в случае возврата заказа

* '''below''' - граница стоимости настроек:* '''''below_sum''''' - граница стоимости выкупаемого заказа:* '''''price''''' Тэг 1264 - стоимость выкупаемого заказа до соответствующей границыномер нормативного акта федерального органа исполнительной власти = "1556"(константа)

*'''costcode''' :: Тэг 1212 - Кост-код сотрудника.Признак предмета расчета

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

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

<source lang="xmljson"><?xml version="1.0item_industry_props":{"tag1262":" encoding=020"UTF-8,"?><neworder> <createorder orderno=tag1263"AB23541:" error=14.12.2018"0," errormsg=tag1264"success:"></createorder> <createorder orderno=1556"55_6542," error=tag1265"0:" errormsgtm=mdlp&sid=00000000XXXXXX"},"successtag1212"></createorder> <createorder orderno=: "AB235421" error="0ValidationMask" errormsg=: "success(A-Z0-9){6,8}"></createorder></neworder>

Для клиентов из '''Узбекистана''' необходимо указывать код ИКПУ и код упаковки в следующем формате:<source lang="xmljson"><?xml version="1.0ikpu" encoding=:"UTF-8123123123"?><neworder> <createorder orderno=,"AB23541packageCode" error=:"17123456" errormsg="Such number exists"></createorder> <createorder orderno="AB23542" error="13" errormsg="empty company"></createorder> <createorder orderno="AB23543" error="14" errormsg="empty person"></createorder></neworder>

* '''Пример ответа при ошибке синтаксисаpackages''' — Контейнер для описания мест. Необязательный контейнер. Атрибуты::* '''''package''''' — Название места.:* '''''code''''' — Внутренний код строки.:* '''''strbarcode''''' — Штрихкод места.:* '''''mass''''' — Масса места в килограммах.:* '''''message''''' — Строка сообщения.:* '''''length''''' — Длина товарного места (в сантиметрах).:* '''''width''''' — Ширина товарного места (в сантиметрах).:* '''''height''''' — Высота товарного места (в сантиметрах).:* '''''quantity''''' — Количество мест с данным набором параметров. Действует ограничение на общее количество мест в заказе. Общее количество мест в заказе не может быть больше 1000.

<source lang="xml"><?xml version="1* '''deliveryset''' — настройка [[Дифференцированная стоимость доставки|дифференцированной стоимости доставки]].0" encoding="UTF-8"?>Атрибуты:<request>:* '''''above_price''''' — стоимость в случае полного выкупа заказа (действует как «сумма от» последней границы, указанной в теге below_sum) <error>column:1 line* '''''return_price''''' — стоимость в случае возврата заказа:11 message:expected * '''''VATrate''''>'</error></request></source> — Ставка НДС — целое число процентов.

=== Коды ошибок при оформлении * '''below''' — граница стоимости настроек:* '''''below_sum''''' — граница стоимости выкупаемого заказа ===:* '''''price''''' — стоимость выкупаемого заказа до соответствующей границы

0 - Ошибок нет* '''advprices''' — Контейнер для описания дополнительных услуг. Необязательный элемент. <span style="color: red;>Для обработки в API включите дополнительные услуги в настройках полей [[Личный кабинет курьерской службы#Настройка личного кабинета клиента|заказов и заборов]]</span>:* '''''code''''' — код услуги.:* '''''value''''' — значение услуги. Если тип услуги bool, то в значении передаем true.

1 - Ошибка авторизации* '''extrafields''' — Контейнер для описания расширенных полей. Необязательный элемент. Может содержать несколько элементов extrafield* '''extrafield''' — Контейнер для описания расширенного поля.:* '''''name''''' — наименование переменной. (отсутствуют теги <auth login="" pass=Может содержать только латинские буквы, цифры и знак подчеркивания "_"></auth>, неверный логин или пароль)но начинаться может только с буквы. Максимальная длина - 20 символов.:* '''''value''''' — значение переменной. Максимальная длина - 250 символов.

2 - Отправлен пустой запрос (отсутствует контейнер <neworder><* '''overall_volume''' — Общий объем, м3. Виртуальное поле. Необязательное. Из этого поля рассчитывается длина/neworder> высота/ширина места. Расчет срабатывает только если в XML документе)каждом месте есть нулевые значения длины или высоты или ширины.

3 - Некорректно указана сумма заказа* '''userid''' — Идентификатор пользователя, строковый или числовой тип. Виртуальное поле. Необязательное. Данное поле используется совместно с настройками «Цена доставки для получателя», определяя приоритет правила. Можно использовать в различных CMS/CRM системах, настраивая цены для определенного покупателя.

4 - Некорректный общий вес заказа* '''groupid''' — Идентификатор группы пользователя, строковый или числовой тип. Виртуальное поле. Необязательное. Данное поле используется совместно с настройками «Цена доставки для получателя», определяя приоритет правила. Можно использовать в различных CMS/CRM системах, настраивая цены для определенной группы покупателей.

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

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

8 - Не заполнен телефон получателя=== Примеры ответов ===При успешном выполнении запроса, создании заказа, возвращается сумма заказа в атрибуте orderprice, а также ошибка 0. При не успешном — номер ошибки и текст ее на английском языке в атрибуте errormsg, для некоторых ошибок выводится перевод на русский в атрибуте errormsgru.В атрибут orderno помещается номер заказа, в атрибут barcode — штрихкод заказа.

10 <source lang="xml"><?xml version="1.0" encoding="UTF- Не заполнено название компании получателя.8"?><neworder> <createorder orderno="AB23541" barcode="67567#114" error="0" errormsg="Success" errormsgru="Успешно" orderprice="5000" /> <createorder orderno="AB23542" barcode="67567#115" error="0" errormsg="Success" errormsgru="Успешно" orderprice="6000" /> <createorder orderno="AB23543" barcode="67567#116" error="0" errormsg="Success" errormsgru="Успешно" orderprice="0" /></neworder> </source>

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

14 <source lang="xml"><?xml version="1.0" encoding="utf- Не заполнено контактное имя отправителя.8"?><request><error error="1" errormsg="authorization error"></error></request>15 - Не заполнен телефон отправителя.</source>

17 <source lang="xml"><?xml version="1.0" encoding="UTF- Заказ с таким номером уже существует.8"?><request> <error>column:1 line:11 message:expected '>'</error></request></source>

== Запрос статуса заказов = Коды и описание ошибок ==={|class=wikitable!Код ошибки=== Пример запроса статуса заказа ===!Английское описание!Русское описание<source lang="xml">|-<?xml version="1.|0" encoding="UTF||Success||Успешно|-8" ?><statusreq>|1||Wrong XML||Некорректный файл XML.|- <auth extra="8" login="login" pass="pass"></auth>|2||Lat is empty||Укажите широту. <client>CLIENT</client>|- <orderno>1234</orderno>|3||Specify a valid «Price» field value.||Укажите корректное значение поля «Сумма». <orderno2>5678</orderno2>|- <ordercode>34234</ordercode>|4||Specify a valid «Weight» field value.||Укажите корректное значение поля «Вес».|- <givencode>234534<|5||Recepient city/givencode>town not found.||Город назначения не найден. <datefrom>2016-07|-21</datefrom> <dateto>2016-07-21<|6||Sender city/dateto>town not found.||Город отправления не найден. <target>Автозавод</target>|- <done>ONLY_NOT_DONE</done>|7||Specify the «Recipient address» field value.||Укажите значение поля «Адрес получателя». <changes>ONLY_LAST</changes>|-|8||Specify the «Recipient phone» field value.||Укажите значение поля «Телефон получателя».</statusreq>|-</source>|9||Specify the «Recipient name» field value.||Укажите значение поля «ФИО получателя».|-=== Описание полей запроса статуса ===|10||Specify a valid «Quantity» field value.||Укажите корректное значение поля «Количество». '''statusreq''' |- Корневой контейнер. Обязательный элемент.*'''auth''' - Авторизация|11||Specify a valid «Declared value» field value. Обязательный элемент||Укажите корректное значение поля «Объявленная ценность».*'''client''' |- Признак клиента или агента|12||Supplier SKU ID not found. Необязательный элемент||Артикул не найден.:* CLIENT |- Признак клиента, значение по умолчанию:* AGENT - Признак агента|17||Order number already exists in the database. В ответ отдается информация по заказам, переданным агенту на доставку*'''orderno''' - Номер ||Такой номер заказа. Необязательный элементуже есть в базе.*'''ordercode''' - Внутренний |-|18||Order code already exists in the database.||Такой код заказа. Необязательный элементуже есть в базе.*'''orderno2''' |- Номер заказа из срочных. Необязательный элемент.*'''datefrom''' |19||The delivery date format is not valid. Specify a date in YYYY-MM- Дата заказа "с"DD format. Необязательный элемент||Укажите значение поля «Дата доставки» в формате гггг-мм-дд.*'''dateto''' |- Дата заказа "по"|20||Specify a valid «Delivery mode» field value. Необязательный элемент||Укажите корректное значение поля «Режим доставки».*'''target''' |- Строка поиска. Позволяет указать текст, который содержится в названии компании или адресе получателя|21||Specify a valid «Return trip mode» field value.||Укажите корректное значение поля «Режим возврата».*'''done''' |- Может принимать значения: :* ONLY_DONE - Только доставленные (имеются в виду успешные статусы, например, '''Доставлен''' или '''Частично доставлен''')|22||Specify a valid «Delivery type» field value.||Укажите корректное значение поля «Тип доставки».:* ONLY_NOT_DONE |- Только не доставленные (заказы, которые не являются доставленными, например, '''Не доставлен''' или '''Утерян'''):* ONLY_NEW |23||Specify a valid «Return shipment type» field value.||Укажите корректное значение поля «Тип возврата».|- Только новые:* ONLY_DELIVERY - Только заказы в обработке - заказы, находящиеся в любом статусе, кроме конечных: Доставлено, Не доставлено, Отменён и т|30||Specify the «Order number» field value.д||Укажите значение поля «Номер заказа».:* ''Пусто'' |- все корреспонденции *'''changes''' - может принимать |31||Specify the «Barcode» field value.||Укажите значение только ONLY_LASTполя «Штрихкод». Если указан этот параметр, все остальные игнорируются. Описание данного режима приведено здесь: [[#Передача только изменившихся статусов|Передача только изменившихся статусов]]-|32||Specify the «Sender company» field value.||Укажите значение поля «Компания-отправитель».|-<div style="color: #a94442; background|33||Specify the «Sender name» field value.||Укажите значение поля «ФИО отправителя».|-color: #f2dede; border: 1px solid #ebccd1; padding: 3px 10px 10px;">'''Обратите внимание!'''|34||Specify the «Sender phone» field value.||Укажите значение поля «Телефон отправителя».|-# Периода запроса статусов (контейнеры '''datefrom''' и '''dateto''') ограничивается двумя месяцами &mdash; два месяца до даты '''"по"'''|35||Specify the «Sender city/town» field value.||Укажите значение поля «Город отправителя».# Если не указаны обе даты &mdash; '''dateto''' принимается равной текущей дате|-|36||Specify the «Sender address» field value.# Если не указана дата '''dateto''' &mdash; она принимается равной '''datefrom''' плюс 2 месяца||Укажите значение поля «Адрес отправителя».# Если не указана дата '''datefrom''' &mdash; она принимается равной '''dateto''' минус 2 месяца|-|37||Specify the «Pickup date» field value.||Укажите значение поля «Дата забора».</div>|-<br />|38||Specify the «Pickup time from» field value.||Укажите значение поля «Время забора с».|-=== Примеры ответов === |39||Specify the «Pickup time to» field value.||Укажите значение поля «Время забора до».|-'''Пример успешного ответа'''|40||Specify the «Recipient company» field value.||Укажите значение поля «Компания-получатель».|-<source lang="xml"><?xml version="1|41||Specify the «Recipient name» field value.||Укажите значение поля «ФИО получателя».0" encoding="UTF|-8"?><statusreq count="23">|42||Specify the «Recipient phone» field value.||Укажите значение поля «Телефон получателя». <order orderno="111111" awb="qwerty" orderno2="123123" ordercode="34534234" givencode="2345334">|- <barcode>111111<|43||Specify the «Recipient city/barcode> <sender> <company>МВД</company> <person>Иванов Иtown» field value.И||Укажите значение поля «Город получателя».</person> <phone>123-45|-67</phone> <contacts>|44||Specify the «Recipient address» field value.||Укажите значение поля «Адрес получателя». <phone>+74951234567</phone>|- </contacts>|45||Specify the «Delivery date» field value.||Укажите значение поля «Дата доставки». <town code="23432">Санкт|-Петербург</town> <address>Петровка 38 офис 35</address>|46||Specify the «Delivery time from» field value.||Укажите значение поля «Время доставки с». <date>2014-03|-22</date> <time_min>09:00</time_min> <time_max>14:00</time_max> </sender> <receiver> <company>МВД</company> <person>Иванов И|47||Specify the «Delivery time to» field value.И||Укажите значение поля «Время доставки до».</person> <phone>123|-45-67 - Иван (916)234|48||Specify the «Recipient postcode» field value.45||Укажите значение поля «Индекс получателя».21 Петр,mvd@mail.ru</phone> <contacts>|- <phone>+74951234567</phone>|49||Specify the «Weight» field value.||Укажите значение поля «Вес». <phone>+79162344521</phone>|- <email>mvd@mail|50||Specify the «Payment type» field value.||Укажите значение поля «Тип оплаты».ru</email> </contacts>|- <inn>1112223335</inn> <zipcode>125480</zipcode>|51||Specify the «Quantity» field value.||Укажите значение поля «Количество». <town code="153361" regioncode="78" regionname="Санкт|-Петербург город">Санкт-Петербург город</town> <address>Петровка 38 офис 35</address>|52||Specify the «Amount» field value.||Укажите значение поля «Сумма». <pvz>|- <code>126</code>|53||Specify the «Declared value» field value.||Укажите значение поля «Объявленная стоимость». <clientcode>QWERTY</clientcode>|- </pvz> <date>2014|54||Specify the «Description» field value.||Укажите значение поля «Описание».|-03-22</date> <time_min>09:00</time_min> <time_max>14:00</time_max> <coords lat="|55||Specify the «Instruction» field value.680327" lon="37||Укажите значение поля «Поручение».604456"></coords> </receiver>|- <weight>5|56||Specify the «Delivery mode» field value.||Укажите значение поля «Режим доставки».1</weight> <return_weight>5.1</return_weight>|- <quantity>2</quantity>|57||Specify the «Shipment type» field value.||Укажите значение поля «Тип отправления». <paytype>CASH</paytype>|- <service>2</service> <return_service>2</service>|58||Specify whether return trip is required.||Укажите значение поля «Необходимость возврата». <type>3</type>|- <return_type>3</return_type>|59||Specify the «Return trip mode» field value.||Укажите значение поля «Режим возврата» <waittime>12</waittime>|- <price>387|60||Specify the «Return shipment type» field value.||Укажите значение поля «Тип возврата».5</price> <print_check>YES</print_check>|- <inshprice>387|61||Specify barcode.||Укажите штрихкод.5</inshprice> <enclosure>Детские игрушки</enclosure>|- <instruction>Проверить при покупателе, подписать акт</instruction> <currcoords lat="55|62||Specify item weight.680327" lon="37||Укажите массу единицы товара.604456" accuracy="50" RequestDateTime="2014|-04|63||Specify item quantity.||Укажите количество товара.|-21 18:07:45"></currcoords> <courier>|64||Specify item price.||Укажите цену единицы товара. <code>26</code>|- <|65||Specify item name>Иванов Владимир Петрович</name>.||Укажите название товара. <phone>+79161234567</phone>|- </courier>|66||Wrong XLS file||Некорректный файл XLS. <deliveryprice total="158|-|67||Order barcode already exists in the database.6" delivery="100||Такой штрихкод заказа уже есть в базе.00" return="58.6"> <advprice code="1" price="150">База</advprice>|- <advprice code="2" price="0">% от объявленной стоимости</advprice>|68||Select the «Payment by recipient» field value.||Укажите значение поля «Оплата получателем».|- <advprice code="3" price="8|69||Specify department.||Укажите отдел.6">Топливный сбор</advprice> <advprice |-|70||Specify service partner code="4" price="0">Округление</advprice>.||Укажите значение поля «Код подрядчика». </deliveryprice>|- <receiverpays>NO</receiverpays>|71||Date cannot be earlier than tomorrow.||Дата не может быть раньше чем завтра. <status eventstore="филиал в Санкт|-Петербурге" eventtime="2016-06-02 17:22:00" createtimegmt="2016|72||Date cannot be later than 15 days from now.||Дата не может быть позже чем через 15 дней.|-06-03 16:14:44" message="" title="Доставлен">COMPLETE</status> <statushistory>|73||Date cannot be earlier than today.||Дата не может быть раньше чем сегодня. <status eventstore="Офис в Москве" eventtime="2016|-05-30 10:20:00" createtimegmt="2016|74||Date cannot be later than {0} days from now.||Дата не может быть позже, чем через {0} дней.|-06|75||Specify a valid «Item weight» field value.||Укажите корректное значение поля «Масса единицы товара».|-03 16:14:44" message="" title="Новый">NEW</status> <status eventstore="Офис в Москве" eventtime="2016|76||Specify a valid «Quantity» field value.||Укажите корректное значение поля «Количество товара».|-06-01 17:38:00" createtimegmt="2016|77||Specify a valid «Item price» field value.||Укажите корректное значение поля «Цена единицы товара».|-06|78||Specify a valid «Delivery time from» field value.||Укажите корректное значение поля «Время доставки с».|-03 16:14:44" message="филиал в Санкт|79||Specify a valid «Delivery time to» field value.||Укажите корректное значение поля «Время доставки до».|-Петербурге" title="Планируется отправка">DEPARTURING</status> <status eventstore="Офис в Москве" eventtime="2016|80||Specify a valid «Pickup time from» field value.||Укажите корректное значение поля «Время забора с».|-06|81||Specify a valid «Pickup time to» field value.||Укажите корректное значение поля «Время забора до».|-01 19:53:00" createtimegmt="2016|82||Specify a valid «Pickup point» field value.||Укажите корректное значение поля «ПВЗ».|-06-03 16:14:44" message="филиал |83||Duplicate number in the registry.||Дублирование номера в Санктреестре.|-Петербурге" title="Отправлено со склада">DEPARTURE</status> <status eventstore="филиал в Санкт|84||Duplicate barcode in the registry.||Дублирование штрихкода в реестре.|-Петербурге" eventtime="2016-06|85||Specify a valid «Weight at return trip» field value.||Укажите корректное значение поля «Вес возврата».|-02 07:41:00" createtimegmt="2016-06-03 16:14:44" message="" title="Получен складом">ACCEPTED</status> <status eventstore="филиал в Санкт|86||Specify the «Weight at return trip» field value.||Укажите значение поля «Вес возврата».|-Петербурге" eventtime="2016|87||Order weight exceeds the allowed maximum for the pickup point.||Вес превышает допустимое значение для этого ПВЗ.|-06|88||Pickup date cannot be earlier than today.||Дата забора не может быть раньше чем сегодня.|-02 09:17:00" createtimegmt="2016-06-03 16:14:44" message="" title="Выдан курьеру на доставку">DELIVERY</status> <status eventstore="филиал в Санкт|89||Specify a later delivery date.||Укажите более позднюю дату доставки.|-Петербурге" eventtime="2016-06|90||Inappropriate «Weight» or «Pay type» field value for the selected city or town. Please review and correct the values.||Значение поля «Масса» или «Тип оплаты» для выбранного города указано некорректно или отсутствует. Проверьте значения и исправьте.|-02 17:22:00" createtimegmt="2016-06-03 16:14:44" message="" title="Доставлен (предварительно)">COURIERDELIVERED</status> <status eventstore="филиал в Санкт|91||{deliverytype} {deliverydate} is {holidaytype}. Select another date.||{deliverytype} {deliverydate} является {holidaytype}. Выберите другую дату.|-Петербурге" eventtime="2016|92||{deliverytype} {deliverydate} is {holidaytype}. Select another date.||{deliverytype} {deliverydate} является {holidaytype}. Выберите другую дату.|-06|93||Add items.||Добавьте товары.|-02 17:22:00" createtimegmt="2016|95||The selected pickup point only allows paid orders.||Выбранный ПВЗ выдает только предоплаченные заказы.|-06-03 16:14:44" message="" title="Доставлен">COMPLETE</status> </statushistory> <customstatecode>2<customstatecode>|96||Order barcode exceeds the allowed maximum (25) symbols.||Длина штрихкода заказа превышает максимально допустимую (25 символов). <clientstatecode></clientstatecode>|- <costcode>cc12345</costcode> <receipt fdNum="124555" fnSn="9289000100295555" kktNum="0001611984048555" inn="7722756555" fdValue="2899551555" summ="387|97||The pickup date format is not valid. Specify a date in YYYY-MM-DD format.5" ofdUrl="gate||Укажите значение поля «Дата забора» в формате гггг-мм-дд.ofd.ru">https://ofd|-|98||Specify the cost code.ru/rec/7722756555/0001611984048555/9289000100295555/124555/2899551555</receipt> <deliveredto>Иванова, секр||Укажите значение поля «Кост-код».</deliveredto> <delivereddate>2016-06|-02</delivereddate> <deliveredtime>17:22</deliveredtime>|99||The item is not in stock.||Товар отсутствует на складе. <outstrbarcode>EXT123456</outstrbarcode>|- <items> <|100||Set the quantity of the item code="34533" extcode="abc123" quantity="marked with Chestny ZNAK to one.||Укажите количество товара, маркированного кодом «Честный ЗНАК», равным единице.|-|101||Quantity of item Delivery cannot be greater than 1||Количество вложений типа «Доставка» не может быть более 1" mass="0.2" retprice="37|-|102||А database error occurred. Please try later again.||Ошибка базы данных. Попробуйте позже.5" VATrate="0" barcode="2345625213125" article="1" returns="0" origincountry="040" GTD="" excise="0|-|103||Order not found.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>|104||Cannot edit order in the current status.||Невозможно изменить заказ в текущем статусе.|-|105||Discount cannot be greater than the order amount. Specify a smaller value.||Размер скидки не может превышать сумму заказа. Укажите меньшее значение скидки.|- <item |106||Specify the correct additional service code="34421" extcode="abc125" quantity="3" mass="0.3" retprice="50" VATrate="18" barcode="2345625213126" article="3" returns="0" governmentCode="">Погремушка желтая</item>||Укажите корректный код дополнительной услуги.|-|107||Specify the correct additional service name.||Укажите корректное значение поля [advprice][value]. </items>|-|108||Specify the «Additional services» field value.||Укажите значение поля «Дополнительные услуги». <packages>|- <package code="33331" strbarcode="ORD0000001" mass="1" message="" got="YES"></package>|110||Specify the correct TIN.||Укажите корректный ИНН.|- <package code="33332" strbarcode="ORD0000002" mass="2|111||Specify the correct IIN (KZ).||Укажите корректный ИИН (КЗ).5" message="" got="NO"></package> </packages>|- </order></statusreq> |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/source>town by postcode not found.||Город получателя по его индексу не найден.|-|126||Incorrect items prepayment and pickup.||Заказ не может содержать только вложения «Предоплата» и «Забор».|-|127||Package limit exceeded||Превышен лимит количества мест|-|128||Quantity of item Prepayment cannot be greater than 1||Количество вложений типа «Предоплата» не может быть больше 1.|-|129||Sum of cod must be equal sum of items||Объявленная стоимость должна быть равна сумме вложений.|-|130||Specify a valid respstore code.||Укажите код ответственного филиала.|-|131||Cannot edit, order has not been synchronized.||Невозможно изменить заказ пока он не синхронизирован.|-|132||Specify a valid "Recipient city/town" field value.||Укажите город получателя|-|133||Specify a valid "weight" for the town.||Укажите корректный вес для города|-|134||Specify a valid "paytype" for the town.||Укажите тип оплаты для города|-|135||Specify the correct SKU ID/code for item.||Укажите артикул/код вложения|-|136||Specify warehouse goods in the order.||Укажите вложения в заказе|-|137||The order's date of creation is more than 60 days ago.||Заказ создан более 60 дней назад|-|138||Specify a valid "Package dimension" field value.||Укажите корректные габариты места|-|139||Wrong type of XML query||Ошибка запроса|-|140||Duplicate item code in the order.||Дублирование кода вложения в заказе|-|141||Duplicate additional service in the order.||Дублирование кода дополнительной услуги в заказе|-|144||Incorrect extrafields.||Некорректные расширенные поля.|-|}

<source lang="xml"><?xml version="1.0" encodingЗапрос статуса заказов ="utf-8"?><statusreq count="0"></statusreq> </source> '''Пример ответа при ошибке авторизации'''

<?xml version="1.0" encoding="utfUTF-8"?><requeststatusreq> <error errorauth extra="18" login=" errormsglogin" pass="authorization errorpass"></errorauth> <client>CLIENT</client> <orderno>1234</orderno> <orderno2>5678</orderno2> <ordercode>34234</ordercode> <givencode>234534</givencode> <uid>af11c7c6-6645-4a20-9604-be911a75722d</uid> <datefrom>2016-07-21</datefrom> <dateto>2016-07-21</dateto> <target>Автозавод</target> <done>ONLY_NOT_DONE</done> <changes>ONLY_LAST</changes> <conditions> <namecontains/> <namestarts/> </conditions> <limit>500</limit></requeststatusreq>

'''Пример ответа при ошибке синтаксиса''' <source lang="xml"><?xml version="1.0" encoding="UTF-8"?><request> <error>column:1 line:11 message:expected '>'</error></request></source> === Описание полей ответа статусов запроса статуса ===Все поля ответа соответствуют структуре order при создании заказа, с некоторыми добавлениями: * Атрибуты контейнера '''orderstatusreq''': — Корневой контейнер. Обязательный элемент.:* '''auth''awb''''' - Номер накладной в системе курьерской службы — Авторизация. Обязательный элемент.:* '''client''orderno2''''' - Номер накладной в подсистеме срочной доставки курьерской службы — Признак клиента или агента. Необязательный элемент.:* '''''ordercode''''' - внутренний код заказа в системеCLIENT — Признак клиента, применяется для некоторых внутренних операций.значение по умолчанию:* '''''givencode''''' - внутренний код заказа в системеAGENT — Признак агента. В ответ отдается информация по заказам, применяется для некоторых внутренних операций.переданным агенту на доставку* атрибут '''''code''orderno''' контейнера '''item''' - внутренний код строки  — Идентификатор заказа в системе, применяется для некоторых внутренних операцийу клиента (шифр). Необязательный элемент.:* '''ordercode''returns''''' - количество данного товара, от которого отказался получатель — Внутренний код заказа. Не нулевое только в случае частичного отказаНеобязательный элемент. * атрибут '''orderno2''got''''' контейнера '''package''' - признак принятого места YES / NO — Номер заказа из срочных. Необязательный элемент.:* '''''returns''uid''' - количество данного товара — Уникальный идентификатор, от которого отказался получательесли он был добавлен при создании заказа. Не нулевое только в случае частичного отказаНеобязательный элемент. * '''''coords''''' Запрос информации по uid возможен в контейнере '''receiver''' - координаты получателя.течении суток после создания заказа* '''currcoordsdatefrom''' - текущие координаты  — Дата заказа«с». Атрибуты::* '''''lat''''' - широта:* '''''lon''''' - долгота:* '''''accuracy''''' - точность в метрах:* '''''RequestDateTime''''' - дата/время последнего обновления координатНеобязательный элемент. * '''courierdateto''' - Данные курьера, которому выдан заказ — Дата заказа «по». Если заказ не выдан, то выводятся данные запланированного курьераНеобязательный элемент.* '''waittime target''' - Время ожидания курьера — Строка поиска.* '''deliveryprice''' - Стоимость услуг Позволяет указать текст, который содержится в валюте расчетов с клиентомназвании компании или адресе получателя. Атрибуты::* '''''total''done''' - общая стоимость услуг — Может принимать значения:* '''''delivery''''' - стоимость доставки:* ONLY_DONE — Только доставленные (имеются в виду успешные статусы, например, '''Доставлен''return'или '''' - стоимость возвратаТэг '''deliverypriceЧастично доставлен''' включает список дополнительных услуг (только для тарифа "Премиум")::* ONLY_NOT_DONE — Только не доставленные (заказы, которые не являются доставленными, например, '''''advprice''''' - наименование дополнительной услуги:* Не доставлен'''или ''code'Утерян'''' - код дополнительной услуги:* '''''price''''' - стоимость дополнительной услуги * '''status''' - статус доставки (список статусов см. ниже). Атрибуты (заполняются начиная с версии системы 2008.0.0.670)::* '''''eventstore''''' - филиал, к которому относится текущий статусONLY_NEW — Только новые:* '''''eventtime''''' - время события по часовому поясу места его наступления.:* '''''createtimegmt''''' - время по GMT создания записи о смене статуса ONLY_DELIVERY — Только заказы в БД. Используется для сортировки записейобработке — заказы, чтобы соблюсти хронологическую последовательность. <spoiler text="Подробнее">Большинство событий фиксируются находящиеся в полях eventtime и createtimegmt на основании одного действия, тогда они отличаются только сдвигом от GMT. Однаколюбом статусе, если курьер доставил отправление 10.10.2010 в 20кроме конечных:00Доставлено, по какой-то причине не внес это в мобильное приложение, на следующий день сдал накладную, и в 9 утра оператор внесла, что он доставил вчера в 20:00. Тогда в createtimegmt будет сегодня 6 утра (для Москвы)Не доставлено, а в eventtime - вчера в 20:00Отменён и т. При этом оператор по каким-то причинам может внести время вручения раньше, чем какое-то предыдущее событие, т.о д. нарушится последовательность времени в eventtime, но при сортировке по createtimegmt все-равно все будет правильно.</spoiler>:* ''Пусто'''message''''' - наименование филиала-получателя, при передаче между филиалами:* '''''title''''' - русское наименование статуса — все корреспонденции * '''statushistorychanges''' - история статусов доставки — может принимать значение только ONLY_LAST. Содержит список контейнеров '''status'''Если указан этот параметр, все остальные игнорируются. Заполняется Описание данного режима приведено здесь: [[#Передача только изменившихся статусов|Передача только для тарифа "Премиум" начиная с версии системы 2008.0.0.670.изменившихся статусов]] * '''customstatecodeconditions''' - код внутреннего статуса курьерской службы. Значения уточняйте в курьерской службе. Назначаются курьерской службой в разделе "Справочники" - "Статусы" - "15 Статусы корреспонденции". Справочник не передается через API клиенту  — Задает условия фильтрации по причине возможного наличия в нем внутренних технологических статусов курьерской службы«orderno».* '''clientstatecode''' - код статуса клиента. Используется, если клиент предлагает свои коды статусов доставки/причин недоставкиВсе вложенные элементы одновременно накладывают условие «И».Минимум 5 символов!:* '''deliveredtonamecontains''' - данные о вручении — Поиск по номеру заказа(шифр), либо причина недоставкикоторый содержит «orderno».:* '''delivereddatenamestarts''' - дата вручения.* '''deliveredtime''' - время вручения. В случае недоставки может быть пустым.* '''outstrbarcode''' - код у подрядчика  — Поиск по номеру заказа(код заказа во внешней системешифр). Используется в интеграциях , который начинается с внешними системами«orderno».

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

 # Атрибуты контейнера Периода запроса статусов (контейнеры '''datefrom''' и '''dateto'''status) ограничивается двумя месяцами — два месяца до даты ''' заполняются для версий системы «по»'''2008.0# Если не указаны обе даты — '''dateto''' принимается равной текущей дате.0.670# Если не указана дата '''dateto''' — она принимается равной '''datefrom''' и новееплюс 2 месяца.# Контейнер Если не указана дата '''statushistorydatefrom''' заполняется для тарифа "[[Личный_кабинет#.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.670dateto''' и новееминус 2 месяца.# Контейнер Поиск по '''deliverypriceconditions''' заполняется работает только для тарифа "[[Личный_кабинет#.D0.9F.D0.BE.D0.B4.D0.BA.D0.BB.D1.8E.D1.87.D0.B5.D0.BD.D0.B8.D0.B5|Премиум]]".«Номер заказа(шифр)» и только от 4 символов

<br />

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

<?xml version="1.0" encoding="UTF-8" ?><statusreqcount="23"> <auth extraorder orderno="8111111" awb="qwerty" orderno2="123123" loginordercode="login34534234" passgivencode="pass2345334"> <barcode>111111</authbarcode> <sender> <company>МВД</company> <person>Иванов И.И.</person> <phone>123-45-67</phone> <contacts> <phone>+74951234567<changes/phone>ONLY_LAST </changescontacts> <town code="23432">Санкт-Петербург</statusreqtown> <address>Петровка 38 офис 35</sourceaddress> <date>2014-03-22</date>Система выдает все заказы, в которых, с момента последнего запроса в этом режиме, изменилось хотя бы одно из полей <time_min>09:00</time_min> orderno <time_max>14:00</time_max> status </sender> delivereddate <receiver> deliveredtime <company>МВД</company> deliveredto <person>Иванов И.И.</person> receiver <phone>123-45-67 -Иван (916)234.45.21 Петр,mvd@mail.ru</phone> <contacts> <phone>+74951234567</phone> <phone>+79162344521</phone>date receiver- <email>mvd@mail.ru</email>address price </contacts> <inn>1112223335</inn>После успешной обработки ответа необходимо отметить полученные статусы успешно полученными, отправив запрос <zipcode>125480</zipcode> <source langtown code="xml153361"><?xml versionregioncode="1.078" encodingregionname="UTFСанкт-8Петербург город" ?>Санкт-Петербург город</town> <address>Петровка 38 офис 35</address> <area>Район 1</area> <pvz> <code>126</code> <clientcode>QWERTY</clientcode> <commitlaststatus/pvz> <date>2014-03-22</date> <time_min>09:00</time_min> <time_max>14:00</time_max> <auth extracoords lat="855.680327" loginlon="login37.604456" pass></coords> <deliveryPIN>1234</deliveryPIN> </receiver> <price>387.5</price> <inshprice>387.5</inshprice> <paytype code="pass1">CASH</authpaytype> <clientweight>CLIENT5.1</clientweight> <quantity>2</commitlaststatusquantity> <service>2</sourceservice> <type>3</type>'''Описание полей запроса''' <return>NO</return> <return_service>2</service>*'''auth''' - Авторизация. Обязательный элемент <return_type>3</return_type> <return_weight>5.1</return_weight> <return_message>Доставлено в целости</return_message>*'''client''' <return_date>2026-01- Признак клиента или агента. Необязательный элемент.19</return_date> <return_time>13:18:* CLIENT - Признак клиента00</return_time> <pickup>NO</pickup> <print_check>YES</print_check> <waittime>12</waittime> <enclosure>Детские игрушки</enclosure> <instruction>Проверить при покупателе, значение по умолчаниюподписать акт</instruction> <currcoords lat="55.680327" lon="37.604456" accuracy="50" RequestDateTime="2014-04-21 18:* AGENT - Признак агента. В ответ отдается информация по заказам, переданным агенту на доставку07:45"></currcoords> <courier> <code>26</code> <name>Иванов Владимир Петрович</name> <phone>+79161234567</phone>В случае успеха Вы получите ответ </courier> <source langdeliveryprice total="158.6" delivery="xml100.00" return="58.6"> <?xml versionadvprice code="1." price="150">База</advprice> <advprice code="2" price="0" encoding>% от объявленной стоимости</advprice> <advprice code="3" price="UTF-8.6" ?>Топливный сбор</advprice> <commitlaststatus erroradvprice code="4" price="0">OKОкругление</commitlaststatusadvprice> </sourcedeliveryprice> <receiverpays>NO</receiverpays>Данный способ передачи статусов гарантирует полную корректную передачу статусов, даже в случае, если в нашей системе статус изменился в промежутке времени между запросом статусов и подтверждением их получения. Если система не получила подтверждение успешной передачи статуса, она будет считать информацию не переданной, и выдаст ее при повторном запросе. <acceptpartially>NO</acceptpartially> <div stylestatus eventstore="colorфилиал в Санкт-Петербурге" eventtime="2016-06-02 17:22: #a94442; background00" createtimegmt="2016-06-color03 16: #f2dede; border14: 1px solid #ebccd1; padding: 3px 10px 10px;44" message="" title="Доставлен" eventtown="Санкт-Петербург город" color="16777215">COMPLETE</status>'''Обратите внимание!''' <statushistory> <status eventstore="Офис в Москве" eventtime="2016-05-30 10:20:00" createtimegmt="2016-06-03 16:14:44"# При данном способе передачи (<changes message="" title="Новый" eventtown="Москва город" country="RU">ONLY_LASTNEW</changesstatus>) система просматривает заказы, оформленные за последние 3 месяца. Если заказ сделан ранее <status eventstore="Офис в Москве" eventtime="2016-06- изменение статуса по нему не попадет в результат выполнения данного запроса.# Система всегда выдает текущий статус. Т.е. Вы можете одним запросом получить статус 01 17:38:00"NEWcreatetimegmt=", а следующим 2016-06- 03 16:14:44"COMPLETE message=". В промежутке между запросами отправление могло пройти через несколько промежуточных статусов. Если нужна гарантия получения всех промежуточных статусов, нужно анализировать блок statushistory (может не заполняться филиал в следствии ограничений версии или тарифа конкретной службы доставки).Санкт-Петербурге" title="Планируется отправка" eventtown="Москва город" country="RU">DEPARTURING</status># Система никогда не гарантирует последовательность прохождения заказом набора статусов. Т.е. Вы можете получить статус <status eventstore="Офис в Москве"COMPLETEeventtime=", а следующим запросом 2016-06- 01 19:53:00"NEWcreatetimegmt=" 2016- такое может произойти, например, если оператор ошибочно отметил заказ выполненным, а затем исправил ошибку.06-03 16:14:44" message="филиал в Санкт-Петербурге" title="Отправлено со склада" eventtown="Москва город" country="RU">DEPARTURE</divstatus> <status eventstore="филиал в Санкт-Петербурге" eventtime="2016-06-02 07:41:00" createtimegmt="2016-06-03 16:14:44" message="" title="Получен складом" eventtown="Санкт-Петербург город" country="RU">ACCEPTED<br /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"<source lang message="xml"><?xml versiontitle="1.0Доставлен (предварительно)" encodingeventtown="UTFСанкт-8Петербург город" country="RU" ?>COURIERDELIVERED<attachments/status> <auth extrastatus eventstore="филиал в Санкт-Петербурге" eventtime="2016-06-02 17:22:00" createtimegmt="2016-06-03 16:14:44" message="8" logintitle="Доставлен" eventtown="loginСанкт-Петербург город" passcountry="passRU" >COMPLETE</status> </statushistory> <customstatecode>2<customstatecode> <ordernoclientstatecode>1234567</ordernoclientstatecode> <deliveredto>Иванова, секр.</attachmentsdeliveredto> <delivereddate>2016-06-02</sourcedelivereddate> '''Описание полей <deliveredtime>17:'''22</deliveredtime> <department>Отдел</department>'''attachments''' - Корневой контейнер. Обязательный элемент. <costcode>cc12345</costcode>*'''auth''' - Авторизация. Обязательный элемент. <outstrbarcode>EXT123456</outstrbarcode>*'''orderno''' - Номер <respstore>14</код заказа. Обязательный элемент.respstore> <partner>Офис на Ленина</partner> '''Пример ответа <arrival>2016-05-02 23:'''21</arrival> <source langreceipt fdNum="xml124555" fnSn="9289000100295555" kktNum="0001611984048555" inn="7722756555" fdValue="2899551555" summ="387.5" ofdUrl="gate.ofd.ru">https://ofd.ru/rec/7722756555/0001611984048555/9289000100295555/124555/2899551555</receipt> <items> <?xml versionitem code="34533" extcode="abc123" quantity="1" mass="0.2" retprice="37.5" VATrate="0" encodingbarcode="UTF-82345625213125" article="1" returns="0" origincountry="040" GTD="" excise="0.00" governmentCode="11223311" govType="1" suppcompany="Поставщик" suppINN="1112223334" suppphone="79161234567"?>Мяч<attachments/item> <item namecode="34456" extcode="abc124" quantity="2" mass="2" retprice="100" VATrate="10" barcode="4645625213138" article="2" returns="0" governmentCode="doc1.docx" sizegovType="356541">JVBERi0xLjMN JUBQREYwMTIzNDU2Nzg5IDI NMyAwIG9iag08PA0vVHlwZSA U3VidHlwZSAvSW1hZ2UNL1d pZHRoIDE4MDgNL0hlaWdodCA ggNCAwIFINL0JpdHNQZXJDb 21wb25lbnQgMQ0vRGVjb2RlU ENL0NvbHVtbnMgMTgwOA0+P g0vSW1hZ2VNYXNrIHRydWUNL XhEZWNvZGUNPj4Nc3RyZWFt DQОбруч</item> <item namecode="34421" extcode="abc125" quantity="3" mass="photo20.jpg3" retprice="50" VATrate="18" barcode="2345625213126" itemcode="44123" article="3" returns="0" sizegovernmentCode="74861" govType="1">VBERi0xLjMN JUBQREYwMTIzNDU2Nzg5IDI NMyAwIG9iag08PA0vVHlwZSA vWE9iamVjdA0vU3VidHlwZS AvSW1hZ2UNL1dpZHRoIDEzNj gNL0hlaWdodCAxMzMzDS9MZ W5ndGggNCAwIFINL0JpdHNQZ XJDb21wb25lbnQgMQ0vRGVj b2RlUGFybXMgPDwNL0sgLTEN L0NvbHVtbnMgMTM2OA0+Pg0 vSWПогремушка желтая</item> </attachmentsitems> </sourcepackages> В тегах item возвращаются бинарные данные (файлы), закодированные в base64.  <package code="33331" strbarcode= Трекинг заказа по номеру "ORD0000001" mass="1" message= Запрос трекинга по номеру предназначен для выдачи минимальной обезличенной информации о конкретном заказе не авторизованному пользователю. Наша система имеет для этого интерфейс по адресу "home.courierexe.ru/{код экстра}/tracking". Вы можете либо сделать ссылку на такую страницу на своем сайте, либо разместить ее iframe'ом у себя, либо сделать свою и пользоваться нашим API. Этот интерфейс создан специально для выдачи информации живому пользователю сайта. Для получения статусов заказов в свою информационную систему нужно использовать запрос got="statusreqYES", желательно с параметром changes=ONLY_LAST! '''Пример запроса:'''></package> <source langpackage code="33332" strbarcode="xmlORD0000002"><?xml versionmass="12.05" message="" encodinggot="UTF-8NO"?></package> </packages> <extrafields> <extrafield> <name>courier_car<tracking/name> <value>ВАЗ 2106, бежевый<extra/value>8 </extraextrafield> <orderno/extrafields>1234 </ordernoorder></trackingstatusreq>

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

<?xml version="1.0" encoding="UTFutf-8"?><tracking> <order orderno="1234"> <sender> <town code="1" country="RU">Москва город</town> <date></date> </sender> <receiver> <town codestatusreq count="1" country="RU">Москва город</town> <date>2015-04-18</date> </receiver> <AWB>BarCode</AWB> <weight>0</weight> <quantity>1</quantity> <currcoords lat="" lon="" accuracy="" RequestDateTime="" /> <status eventstore="филиал в Санкт-Петербурге" eventtime="2016-06-02 17:22:00" createtimegmt="2016-06-03 16:14:44" message="" title="Доставлен" country="RU">COMPLETE</status> <statushistory> <status eventstore="Офис в Москве" eventtime="2016-05-30 10:20:00" createtimegmt="2016-06-03 16:14:44" message="" title="Новый" country="RU">NEW</status> <status eventstore="Офис в Москве" eventtime="2016-06-01 17:38:00" createtimegmt="2016-06-03 16:14:44" message="филиал в Санкт-Петербурге" title="Планируется отправка" country="RU">DEPARTURING</status> <status eventstore="Офис в Москве" eventtime="2016-06-01 19:53:00" createtimegmt="2016-06-03 16:14:44" message="филиал в Санкт-Петербурге" title="Отправлено со склада" country="RU">DEPARTURE</status> <status eventstore="филиал в Санкт-Петербурге" eventtime="2016-06-02 07:41:00" createtimegmt="2016-06-03 16:14:44" message="" title="Получен складом" country="RU">ACCEPTED</status> <status eventstore="филиал в Санкт-Петербурге" eventtime="2016-06-02 09:17:00" createtimegmt="2016-06-03 16:14:44" message="" title="Выдан курьеру на доставку" country="RU">DELIVERY</status> <status eventstore="филиал в Санкт-Петербурге" eventtime="2016-06-02 17:22:00" createtimegmt="2016-06-03 16:14:44" message="" title="Доставлен (предварительно)" country="RU">COURIERDELIVERED</status> <status eventstore="филиал в Санкт-Петербурге" eventtime="2016-06-02 17:22:00" createtimegmt="2016-06-03 16:14:44" message="" title="Доставлен" country="RU">COMPLETE</status> </statushistory> </order></trackingstatusreq>

'''Получение информации в формате 17 TRACKПример ответа при ошибке синтаксиса'''

<tracking17request> <extraerror>8</extra> <ordernocolumn:1 line:11 message:expected '>1234'</ordernoerror></tracking17request>

=== Описание полей ответа статусов ===Все поля ответа соответствуют структуре order при создании заказа, с некоторыми добавлениями: * Атрибуты контейнера '''order'''Пример ответа::* '''''awb''''' — Номер накладной в системе курьерской службы.<pre>{:* '''''orderno2''''' — Номер накладной в подсистеме срочной доставки курьерской службы.:* '''''ordercode''''' — внутренний код заказа в системе, применяется для некоторых внутренних операций. "number":"ExtNumber"* '''''givencode''''' — внутренний код заказа в системе,применяется для некоторых внутренних операций. *'''paytype''' - Тип оплаты заказа получателем. Принимает значения::: CASH - Наличными при получении (по-умолчанию):: CARD - Картой при получении "oriNumber":"1234": NO - Без оплаты.:: OTHER - Прочее (Предусмотрен для того, чтобы оплата поступала непосредственно в курьерскую службу посредством прочих типов оплаты - таких как: вебмани, яденьги, картой на сайте,прочие платежные системы и т.д.) "oriCountry"* Атрибуты контейнера '''paytype''':** '''''code''''' - (integer) внутренний код типа оплаты заказа в системном справочнике "RUТипы оплаты корреспонденции". Не обязательный элемент.  * атрибут '''''code''''' контейнера '''item''' — внутренний код строки заказа в системе,применяется для некоторых внутренних операций. "destCountry":"RU"* '''''returns''''' — количество данного товара,от которого отказался получатель. Не нулевое только в случае частичного отказа. * атрибут '''''got''''' контейнера '''package''' — признак принятого места YES / NO. "status":"Complete"* '''''returns''''' — количество данного товара,от которого отказался получатель. Не нулевое только в случае частичного отказа. * '''''area''''' в контейнере '''receiver''' — район/метро получателя.* '''''coords''''' в контейнере '''receiver''' — координаты получателя.* '''''deliveryPIN''''' в контейнере '''receiver''' — Пин-код. "events"* '''pickup''' — признак оформления забора, возможные значения:['''YES''', '''NO'''. Если указано '''YES''', то весь заказ считается заданием на забор груза, а не на доставку. {* '''currcoords''' — текущие координаты заказа. Атрибуты: "time":"2016-06-02 17* '''''lat''''' — широта:22* '''''lon''''' — долгота:00",* '''''accuracy''''' — точность в метрах "location":"RU"* '''''RequestDateTime''''' — дата/время последнего обновления координат. * '''courier''' — Данные курьера, которому выдан заказ. Если заказ не выдан,то выводятся данные запланированного курьера.* '''waittime ''' — Время ожидания курьера. "content"* '''deliveryprice''' — Стоимость услуг в валюте расчетов с клиентом. Атрибуты:"Complete" },:* '''''total''''' — общая стоимость услуг {:* '''''delivery''''' — стоимость доставки «Туда» "time":"2016* '''''return''''' — стоимость доставки «Обратно» (если order-06-02 17>return=YES)Тэг '''deliveryprice''' включает список дополнительных услуг (только для тарифа «Премиум»)::22* '''''advprice''''' — наименование дополнительной услуги:00",* '''''code''''' — код дополнительной услуги "location":"RU",* '''''price''''' — стоимость дополнительной услуги  "content"* '''status''' — статус доставки (список статусов см. ниже). Атрибуты (заполняются начиная с версии системы 2008.0.0.670):"Courierdelivered" }:* '''''eventstore''''' — филиал,к которому относится текущий статус {:* '''''eventtime''''' — время события по часовому поясу места его наступления. :* '''''createtimegmt''''' — время по GMT создания записи о смене статуса в БД. Используется для сортировки записей, чтобы соблюсти хронологическую последовательность. <spoiler text="timeПодробнее">Большинство событий фиксируются в полях eventtime и createtimegmt на основании одного действия, тогда они отличаются только сдвигом от GMT. Однако, если курьер доставил отправление 10.10.2010 в 20:"201600, по какой-06-02 09то причине не внес это в мобильное приложение, на следующий день сдал накладную, и в 9 утра оператор внесла, что он доставил вчера в 20:1700. Тогда в createtimegmt будет сегодня 6 утра (для Москвы), а в eventtime — вчера в 20:00". При этом оператор по каким-то причинам может внести время вручения раньше, чем какое-то предыдущее событие, т.о. нарушится последовательность времени в eventtime,но при сортировке по createtimegmt все-равно все будет правильно.</spoiler> "location":"RU"* '''''message''''' — наименование филиала-получателя,при передаче между филиалами "content":"Delivery"* '''''title''''' — русское наименование статуса * '''statushistory''' — история статусов доставки. Содержит список контейнеров '''status'''. Заполняется только для тарифа «Премиум» начиная с версии системы 2008.0.0.670.* '''customstatecode''' — код внутреннего статуса курьерской службы. Значения уточняйте в курьерской службе. Назначаются курьерской службой в разделе «Справочники» — «Статусы» — «15 Статусы корреспонденции». Справочник не передается через API клиенту по причине возможного наличия в нем внутренних технологических статусов курьерской службы. }* '''clientstatecode''' — код статуса клиента. Используется,если клиент предлагает свои коды статусов доставки/причин недоставки. {* '''deliveredto''' — данные из поля «Инфо. о доставке» (может быть информация о доставке, причина недоставки и т. п.).* '''delivereddate''' — дата вручения. "time"* '''deliveredtime''' — время вручения. В случае недоставки может быть пустым.* '''arrival''' — плановая дата прибытия в формате гггг-мм-дд чч: мм:"2016сс. Заполняется только при использовании автоматических систем планирования (Максоптра, Яндекс доставка), во всех остальных случаях - пустое.* '''outstrbarcode''' — код у подрядчика (код заказа во внешней системе). Используется в интеграциях с внешними системами.* '''partner''' — текущий филиал/подрядчик.* '''return_message''' — информация о возврате* '''return_date''' -06дата возврата* '''return_time''' -02 07время возврата* '''department''' — Подразделение, в котором оформляется заказ. Контейнер '''status''' может принимать следующие значения::41AWAITING_SYNC — Ожидает синхронизации. Данные заказа пока не появились в службе доставки.:00"'''NEW''' — Успешно создан,передан в службу доставки.: NEWPICKUP — Создан забор.: PICKUP — Забран у отправителя.: WMSASSEMBLED — Скомплектован на складе фулфилмента.: WMSDISASSEMBLED — Разукомплектован на склад фулфилмента.: '''ACCEPTED''' — Получен складом.: CUSTOMSPROCESS — Производится таможенный контроль.: CUSTOMSFINISHED — Таможенный контроль произведен.: CONFIRM — Согласована доставка. "location":"RU",UNCONFIRM — Не удалось согласовать доставку. "content":"Accepted"DEPARTURING — Планируется отправка со склада на другой склад. },: DEPARTURE — Отправлено со склада на другой склад. {: INVENTORY — Инвентаризация. Убедились в наличии отправления на складе. "time":"2016-06-01 19PICKUPREADY — Готов к выдаче в ПВЗ.:53'''DELIVERY''' — Выдан курьеру на доставку.:00"COURIERDELIVERED — Доставлен (предварительно, ожидает подтверждения менеджером,чтобы перейти в статус COMPLETE). "location":"RU"COURIERPARTIALLY — Частично доставлен (предварительно, ожидает подтверждения менеджером,чтобы перейти в статус PARTIALLY). "content":"Departure"COURIERCANCELED — Отказ (предварительно, после этого ожидается COURIERRETURN). }: COURIERRETURN — Возвращено курьером. Курьер не смог доставить до получателя и вернул заказ обратно на склад. Это промежуточный статус,после которого менеджер выясняет, нужно ли повторно доставлять (статусы DATECHANGE/DELIVERY) или это окончательная недоставка (CANCELED).: DATECHANGE — Перенос даты доставки. { "time":"2016-06-01 17'''COMPLETE''' — Доставлен.:38'''PARTIALLY''' — Доставлен частично.:00"'''CANCELED''' — Не доставлен (Возврат/Отмена). После этого статуса отправление должны вернуть заказчику,будут статусы RETURNING и RETURNED : RETURNING — Планируется возврат заказчику (после CANCELED).: RETURNED — Возвращен заказчику.: LOST — Утрачен/утерян.  "location":"RU",PARTLYRETURNING — Планируется возврат остатков. "content":"Departuring"PARTLYRETURNED — Остаток возвращен. },: TRANSACCEPTED — Прибыл на склад перевозчика. {: PICKUPTRANS — Забран у перевозчика. "time":"2016WITHDRAWN_FROM_PICKUP_POINT -05Изъят.: CUSTOMSDELAY -30 10Задержка отправления таможенным органом.:20DEPARTUREDELAY - Задержка отправления перевозчиком.:00",STORETAKE - Принят в работу на складе. '''Примечание.''' В будущем возможно дополнение используемого набора статусов.  "location<div style="color: #a94442; background-color: #f2dede; border: 1px solid #ebccd1; padding:3px 10px 10px;"RU",> "content":"New"'''Обратите внимание!''' } # Контейнер '''statushistory''' и '''deliveryprice''' заполняется для тарифов [[Личный кабинет курьерской службы#Функции личного кабинета|Премиум и Максимум]].# Контейнер '''packages''' не возвращает более 1000 элементов.# Система никогда не гарантирует последовательность прохождения заказом набора статусов. То есть Вы можете получить статус «COMPLETE», а следующим запросом — «NEW» — такое может произойти, например, если оператор ошибочно отметил заказ выполненным, а затем исправил ошибку.}</prediv><br> === Передача только изменившихся статусов ===В нашем API предусмотрено удобное средство получения статусов всех заказов, без необходимости «бомбить» сервер запросами статусов по каждому заказу. Работает это так: раз, например, в 10 минут, вы посылаете запрос «покажите все изменившиеся статусы». Пример запроса ниже. Система вам отдает ВСЕ заказы, статусы (или некоторые другие поля, см. ниже) которых изменились с момента последнего запроса. Вы разбираете полученный документ, по каждому заказу сохраняете его актуальный статус в своей системе, и если все хорошо, у вас все получилось, ваша система неожиданно не упала от наплыва информации, посылаете нам запрос подтверждения получения статусов (commitlaststatus). Мы у себя отмечаем, что эти статусы вами получены и их не надо передавать повторно. Таким образом, сколько бы заказов у вас ни было, статусы по ним всем почти в реальном времени вы можете получать всего двумя запросами.

Функция ищет последний заказ по номеру среди заказов всех клиентов. Выдает неперсонализированную информацию о текущем состоянии заказа.Для получения только изменившихся статусов отправьте запрос:<br /source lang="xml">Описание контейнеров ответа аналогично описанию [[API#.D0.97.D0.B0.D0.BF.D1.80.D0.BE.D1.81_.D1.81.D1.82.D0.B0.D1.82.D1.83.D1.81.D0.B0_.D0.B7.D0.B0.D0.BA.D0.B0.D0.B7.D0.BE.D0.B2|Запроса статусов заказов]]<?xml version="1.0" encoding="UTF-8" ?><statusreq> <auth extra="8" login= Изменение статуса агентом ="login" pass="pass"></auth> <changes>ONLY_LAST</changes> <streamid>1234</streamid></statusreq></source>

Запрос изменения статуса заказа позволяет установить окончательный статус заказа Система выдает все заказы, в которых с момента последнего запроса в этом режиме изменилось хотя бы одно из полей: orderno status delivereddate deliveredtime deliveredto receiver- "Доставлен" или "Не доставлен (Возврат/Отмена)".>date receiver->address price

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

'''Пример запроса изменения статусаВ случае успеха вы получите ответ:'''

<setorderinfo> <auth extra="8" login="login" pass="pass" /> <order ordercode="123456"> <message>Получил Иванов</message> </order> <order ordercode="234567"> <status>PICKUPREADY</status> <eventtime>2016-05-30 10:20:00</eventtime> <message>Клиент отказался от покупки</message> <paytype>CASH</paytype> <items> <item code="34533" quantity="1" reasoncommitlaststatus error="0" /> OK<item code="34456" quantity="0" reason="0" /commitlaststatus> <item code="34421" quantity="2" reason="0" /source> </items> <image filename="filename1Такой способ передачи статусов гарантирует полную корректную передачу статусов, даже если в нашей системе статус изменился между запросом статусов и подтверждением их получения. Если система не получила подтверждение передачи статуса, она будет считать информацию непереданной и выдаст ее при повторном запросе.jpg"> /9j/4AAQSkZJRgA BAQAAAQABAAD/2wBDAA0JCg sKCA0LCgsODg0PEyAVExISEy ccHhcgLikxMC4pLSwzOko+M zZGNywtQFdBRkxOUlNSMj5aY VpQYEpRUk//2wBDAQ4ODhMR EyYVFSZPNS01T09PT09PT09P T09PT09PT09PT09PT09PT09 PT09PT09PT09PT09PT09PT09 PT09PT0//wAARCAYACAADAS IA</image> </order></setorderinfo></source>

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

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

<?xml version="1.0" encoding="UTF-8"?><setorderinfostatusreq> <order ordercodeauth extra="1234568" errorlogin="0login" errormsgpass="OK" errormsgru="Успешноpass" ></auth> <changes>ONLY_LAST</changes> <order ordercode="234567" error="59" errormsg="value [date_put] is already set" errormsgru="Значение [Дата доставки] уже указано" limit>5</limit></setorderinfostatusreq>

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

<waybillcommitlaststatus> <auth extra="8" login="login" pass="pass" ></auth> <ordersacs> <ac>11111</ac> <ac>22222<order orderno="1234567" ordercode="33331" /ac> <ac>33333<order orderno="1234568" ordercode="33332" /ac> <ac>44444</ordersac> <ac>55555<form/ac>1 </formacs></waybillcommitlaststatus>

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

'''Пример ответазапроса:'''

<waybilltracking> <contentextra>EODIcaI8KSBlwQ 4MnEOR7Px8U8EBAyGICBnwpw IZhQgz0ZxuPs8EBM8</GcbjzB AwhBl8hwQYIO00GmEwg1CeEG extra> mqYTChNU0wqf8l8nz4zgc+K fCno+zwU5GjOZmzXGcbEQYIM 4zkegRE40zWzONyoNNMIOIa cWnp6aDCGEGE9NQmoQd2mg00 79U4f3hPTwnfp6Sdrafeqpa JDpFw/1aYT077VNNNdO00G3q mqqvp9p2E7T0/wiFemv8uG6 OM<orderno>1234</contentorderno></waybilltracking>

 В тэге content возвращаются бинарные данные (файл pdf), закодированные в base64.  '''Обратите внимание''', что печатные формы для заборов не формируются. == Отмена заказа == Запрос отмены предназначен для отмены тех заказов, по которым не было произведено изменений - статуса доставки, статуса корреспонденции, времени доставки - то есть заказов, которые ещё не находятся в работе.Возможность отмены заказа есть только у курьерских служб с тарифом "Премиум" и по-умолчанию она выключена, ее нужно отдельно включить: [[Личный кабинет курьерской службы#Дополнительные настройки]]. При отмене заказа поле "Инфо о доставке" получает значение "Отменено заказчиком", поле "Дата доставки" - текущую дату, а "Вручил курьер" - системную запись "ОТМЕНА".  '''Пример запроса отмены заказаответа:'''

<?xml version="1.0" encoding="UTF-8" ?><cancelordertracking> <auth extraorder orderno="8111111" loginordercode="login" pass="pass12345" > <barcode>111111</barcode> <AWB>111111</AWB> <order ordernosender> <town code="1" ordercodecountry="123456RU" >Москва город</town> <order ordernodate>2014-03-22</date> <time_min>09:00</time_min> <time_max>14:00</time_max> </sender> <receiver> <town code="123aaa1" ordercodecountry="RU" >Москва город</town> <zipcode>125480</cancelorderzipcode> <date>2014-03-22</sourcedate> <time_min>09:00</time_min> '''Описание полей запроса статуса <time_max>14:'''00</time_max> </receiver>'''cancelorder''' - Корневой контейнер <price>387. Обязательный элемент5</price> <inshprice>387.5</inshprice>*'''auth''' - Авторизация. Обязательный элемент <paytype>CASH</paytype> <weight>5.1</weight> <quantity>2</quantity> <service>2</service> <type>3</type> <return>NO</return>*'''order''' - Контейнер отменяемого заказа. Обязательный элемент. Запрос может содержать более одного контейнера '''order'''. Атрибуты: <return_service>2</return_service>:* '''''orderno''''' - Шифр заказа. <return_date></return_date>:* '''''ordercode''''' - Внутренний код заказа. <return_time></return_time>Обратите внимание, что должен быть указан хотя бы один из атрибутов ''orderno'' или ''ordercode''! <return_message></return_message> <waittime>12</waittime> <enclosure>Детские игрушки</enclosure>'''Пример ответа:''' <instruction>Проверить при покупателе, подписать акт</instruction> <source langdeliveryprice total="xml158.6"><?xml versiondelivery="1100.000" encodingreturn="UTF-858.6" ?/> <courier> <code>26</code> <name>Иванов Владимир Петрович</name> <phone>+79161234567</phone> <cancelorder/courier> <order ordernocurrcoords lat="123test55.680327" ordercodelon="12345637.604456" erroraccuracy="050" errormsgRequestDateTime="OK" errormsgru="Успешно2014-04-21 18:07:45" /> <order ordernostatus eventstore="123aaaфилиал в Санкт-Петербурге" ordercodeeventtime="2016-06-02 17:22:00" errorcreatetimegmt="522016-06-03 16:14:44" errormsgmessage="order not found" errormsgrutitle="Заказ не найденДоставлен" />COMPLETE</cancelorderstatus> </sourcestatushistory>  <status eventstore="Офис в Москве" eventtime= Справочник городов "2016-05-30 10:20:00" createtimegmt="2016-06-03 16:14:44" message= '''Пример запроса справочника городов:'''<source lang"" title="xmlНовый">NEW</status> <?xml versionstatus eventstore="Офис в Москве" eventtime="1.02016-06-01 17:38:00" createtimegmt="2016-06-03 16:14:44" encodingmessage="UTFфилиал в Санкт-8Петербурге" title="Планируется отправка"?>DEPARTURING<townlist/status> <auth extrastatus eventstore="Офис в Москве" eventtime="2016-06-01 19:53:00" createtimegmt="82016-06-03 16:14:44" message="филиал в Санкт-Петербурге" title="Отправлено со склада" /> DEPARTURE<codesearch/status> <zipcodestatus eventstore="филиал в Санкт-Петербурге" eventtime="2016-06-02 07:41:00" createtimegmt="2016-06-03 16:14:44" message="" title="Получен складом">110000ACCEPTED</zipcodestatus> <kladrcodestatus eventstore="филиал в Санкт-Петербурге" eventtime="2016-06-02 09:17:00" createtimegmt="2016-06-03 16:14:44" message="" title="Выдан курьеру на доставку">0100000100800DELIVERY</kladrcodestatus> <fiascode>bd21979dstatus eventstore="филиал в Санкт-46f8Петербурге" eventtime="2016-49d006-910502 17:22:00" createtimegmt="2016-e8d65172a98306-03 16:14:44" message="" title="Доставлен (предварительно)">COURIERDELIVERED</fiascodestatus> <codestatus eventstore="филиал в Санкт-Петербурге" eventtime="2016-06-02 17:22:00" createtimegmt="2016-06-03 16:14:44" message="" title="Доставлен">123COMPLETE</codestatus> </codesearchstatushistory> <conditionsdeliveredto>Иванова, секр.</deliveredto> <citydelivereddate>Краснодарский край2016-06-02</citydelivereddate> <namecontainsdeliveredtime>новгород17:22</namecontainsdeliveredtime> <namestartsoutstrbarcode>МоскEXT123456</namestartsoutstrbarcode> <items> <nameitem 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">МоскваМяч</nameitem> <fullnameitem code="34456" extcode="abc124" quantity="2" mass="2" retprice="100" VATrate="10" barcode="4645625213138" article="2" returns="0" governmentCode="">Москва городОбруч</fullnameitem> <countryitem code="34421" extcode="abc125" quantity="3" mass="0.3" retprice="50" VATrate="18" barcode="2345625213126" article="3" returns="0" governmentCode="">1Погремушка желтая</countryitem> </conditionsitems> <limitacquirers> <limitfromacquirer code="2" name="Ibox"/>30 <acquirer code="5" name="Payme"/limitfrom> <limitcount>10 <acquirer code="6" name="Click"/limitcount> <countall>YES </countallacquirers> </limitorder></townlisttracking>

Внутри контейнера townlist все элементы могут как отсутствоватьгде, так и комбинироваться. Поиск не чувствителен к регистру.* '''acquirers''' / '''acquirer''' - эквайринг, доступный для получения ссылки на оплату заказа** '''acquirers''' / '''acquirer''' / ''code'' - внутренний код эквайринга** '''acquirers''' / '''acquirer''' / ''name'' - наименование эквайринга

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

*'''conditionsПример запроса:''' - Задает условия поиска. Все вложенные элементы одновременно накладывают условие <source lang="Иxml".>:* '''city''' - Поиск по всем населенным пунктам региона<?xml version="1.:* '''namecontains''' 0" encoding="UTF- Поиск населенных пунктов, название которых содержит указанный текст.:* '''namestarts''' - Поиск населенных пунктов, название которых начинается с указанного текста.:* '''name''' - Поиск населенных пунктов, название которых соответствует указанному тексту.:* '''fullname''' - Поиск населенных пунктов, название вместе с типом населенного пункта которых соответствует указанному тексту.8"?>:* '''country''' - Поиск только по стране с указанным кодом.<tracking17> <extra>8</extra>*'''limit''' - Ограничивает вывод результата. <orderno>1234</orderno>:* '''limitfrom''' - Задает номер записи результата, начиная с которой выдавать ответ. По-умолчанию - 0.:* '''limitcount'''- Задает количество записей результата, которые нужно вернуть. По-умолчанию - 10000.</tracking17>:* '''countall''' - YES указывает на необходимость подсчета общего количества найденных совпадений. Это может замедлять выполнение запроса. Если отключено - в ответе не указываются totalcount и totalpages.</source>

<source lang=pre>{ "number":"ExtNumber", "oriNumber":"xml1234">,<?xml version= "1.0oriCountry" encoding=:"UTF-8RU"?>,<townlist count= "destCountry":"3RU" page=, "1status" totalcount=:"3Complete" totalpages=, "1events">:[ { <town> "time":"2016-06-02 17:22:00", <code>26379</code> "location":"RU", <city> "town":"Москва", <code>23</code> "store":"Москва Главный", <name>Краснодарский край</name> "content":"Complete" </city> }, <name>Сочи город</name> { <fiascode>79da737a "time":"2016-603b06-4c1902 17:22:00", "location":"RU", "town":"Москва", "store":"Москва Главный", "content":"Courierdelivered" }, { "time":"2016-9b5406-9114c96fb912</fiascode>02 09:17:00", <kladrcode>2300000700000</kladrcode> "location":"RU", <shortname /> (not yet supported) "town":"Москва", <typename /> (not yet supported) "store":"Москва Главный", <coords lat= "43.5855content" lon=:"39.7231Delivery" /> </town> }, { <town> "time":"2016-06-02 07:41:00", <code>40331</code> "location":"RU", <city> "town":"Москва", <code>32</code> "store":"Москва Главный", <name>Брянская область</name> "content":"Accepted" </city> }, <name>Сочилов хутор</name> { <fiascode>c9c96c67 "time":"2016-2cc906-4f10-afde-fd32417ea216</fiascode>01 19:53:00", <kladrcode>3201900011100</kladrcode> "location":"RU", <shortname /> "town":"Горький", <typename /> "store":"Горький Автозавод", <coords lat= "52.6407content" lon=:"33.1724Departure" /> </town> }, { <town> "time":"2016-06-01 17:38:00", <code>114016</code> "location":"RU", <city> "town":"Горький", <code>60</code> "store":"Горький Автозавод", <name>Псковская область</name> "content":"Departuring" </city> }, <name>Сочихино деревня</name> { <fiascode>10df7588 "time":"2016-19c105-49d1-a387-9de1cf3eb26f</fiascode>30 10:20:00", <kladrcode>6001900015400</kladrcode> "location":"RU", <shortname /> "town":"Горький", <typename /> "store":"Горький Автозавод", <coords lat= "56.6003content" lon=:"29.3542New" /> } ]}</townpre> Функция ищет последний заказ по номеру среди заказов всех клиентов. Выдает неперсонализированную информацию о текущем состоянии заказа.</townlistbr></source>Описание контейнеров ответа аналогично описанию [[API#.D0.97.D0.B0.D0.BF.D1.80.D0.BE.D1.81 .D1.81.D1.82.D0.B0.D1.82.D1.83.D1.81.D0.B0 .D0.B7.D0.B0.D0.BA.D0.B0.D0.B7.D0.BE.D0.B2|Запроса статусов заказов]]. === Получение ссылки для оплаты заказа ===

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

'''Пример запроса справочника:'''

<regionlist> <codesearchacqlink> <codeextra>778</codeextra> </codesearchacq> <conditions> <namecontainscode>край2</namecontainscode> <namestarts>Моск</namestartsacq> <fullname>Московская область</fullnameorder> <countrycode>112345</countrycode> </conditionsorder></regionlistacqlink>

<regionlist countacqlink error="20" amount="2000" extid="161083231"> <city> <code>80<https:/code> <country> <code>1</code> <name>Россия<qr.nspk.ru/name> <id>643AD10001A7GLVGA9YDO2I0789SIOPV3?type=02&amp;bank=1000011&amp;sum=2000&amp;cur=RUB&amp;crc=7E9C</idacqlink> <ShortName1>RU</ShortName1source> <ShortName2>RUS</ShortName2> </country>где <name>Агинский Бурятский автономный округ</name>*'''acqlink''' - ссылка на оплату заказа </city>*acqlink.'''amount''' - тип integer сумма платежа в копейках в общем случае, в других случаях в соответствии с типом валюты <city>*acqlink.'''extid''' - идентификатор счета на стороне платежной системы <code>1</code>*acqlink.'''error'' - код ошибки, если отличается от 0, означает невозможность получения ссылки на оплату, в этом случае ссылки на оплату не будет и ответ будет выглядеть так: <countrysource lang="xml"> <code>?xml version="1</code.0" encoding="UTF-8"?> <name>Россия<acqlink error="2" message="Ошибка авторизации: Invalid token" amount="2000" extid=""/name> <id>643</idsource> <ShortName1>RU</ShortName1> <ShortName2>RUS</ShortName2>где*acqlink.'''message''' - текст ошибки возвращаемой эквайрингом Возможные типы ошибок получения ссылки:* '''1''' - не настроен эквайринг, либо не найден заказ* '''2''' - ошибка на стороне эквайринга </country>* '''3''' - запрещающий статус курьера (заказ доставлен, частично доставлен) <name>Адыгея республика</name>* '''4''' - оплата заказа не разрешена </city></regionlist>== Изменение заказа ==</source>Запрос предназначен для изменения заказов.

'''Пример запроса справочника улиц:'''<source langdiv style="xml"><?xml version="1.0" encoding="UTFcolor: #a94442; background-8color: #f2dede; border: 1px solid #ebccd1; padding: 3px 10px 10px;"?><streetlist> <conditions> <town>Москва город</town> // ОБЯЗАТЕЛЬНОЕ ПОЛЕ'''Обратите внимание!''' <namecontains>Хохло</namecontains># Данные запроса изменения указываются '''полностью''', как если бы заказ создавался впервые. <namestarts>Академика Х</namestarts># При отсутствии вложения в запросе изменения данное вложение '''не удаляется''' из заказа, но его количество становится равным 0. <name>Академика Хохлова</name> <fullname>Академика Хохлова ул# При одновременном изменении заказа в API и системе курьерской службы приоритет отдается данным системы курьерской службы. То есть изменения в API приняты не будут.</fullname> </conditions> <limit> <limitfrom>30</limitfrom> <limitcount>10</limitcount> <countall>YES</countall> </limit></streetlist></sourcediv>

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

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

* значение '''Пример ответа:orderno'''данным методом изменить нельзя.<source lang="xml"><?xml version="1* значение '''barcode''' изменяется в случае явного его указания.0" encoding="UTFВ случае отсутствия или пустого значения -8"?>остается прежним.<streetlist count="1" page="1" totalcount="3" totalpages="1">* вместо корневого тэга '''neworder''' указывается '''editorder'''; <street>* тэг курьера '''courier''' можно изменить только при включенной настройке '''Разрешить изменение курьера по АПИ'''; <name>Академика Хохлова ул* для вложений '''item''' указывается внутренний код вложения в атрибуте '''code''', который можно получить при получении статуса заказа.</name> <shortname>Академика Хохлова</shortname> <typename>ул* для мест '''package''' указывается внутренний код вложения в атрибуте '''code''', который можно получить при получении статуса заказа.</typename> </street></streetlist></source>

Необходимо иметь в виду, что: # Заказ нельзя изменить, пока он не синхронизирован с системой (пока предыдущие изменения не переданы в бэк-офис)# Удаление вложений и мест выполняется не моментально, а в процессе синхронизации с бэк-офисом (для записей указываются метки Удалено) == Справочник номенклатуры =Описание полей ответа изменения ===Все поля ответа соответствуют ответу при создании заказа за исключением корневого тэга — вместо '''neworder''' возвращается '''editorder'''. == Отмена заказа ==Запрос предназначен для отмены заказов. Отменять заказы могут курьерские службы с тарифами «Премиум» и «Максимум». Разрешения для отмены заказов и статусы в которых заказы можно отменять описаны в разделе '''Изменение заказов''' При отмене заказа поле «Инфо о доставке» получает значение «Отменено заказчиком», поле «Дата доставки» — текущую дату, а «Вручил курьер» — системную запись «ОТМЕНА». 

'''Пример запроса справочника номенклатурыотмены заказа:'''

<itemlistcancelorder> <auth extra="8" login="login" pass="pass"></auth> <codesearch> <code>order orderno="" ordercode="123456<" /code> <article>FD343 <order orderno="123aaa" ordercode="" /article> <barcode>2345625213125</barcodecancelorder> </codesearch> <conditionssource> <namecontains>телевизор</namecontains> <namestarts>sony</namestarts> <name>Sony KDL-55W905 ЖК-телевизор</name> <quantity>EXISTING_ONLY</quantity> </conditions> <limit> <limitfrom>30</limitfrom> <limitcount>10</limitcount> <countall>YES</countall> </limit></itemlist></source>

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

*'''conditionscancelorder''' - Задает условия поиска — Корневой контейнер. Все вложенные элементы одновременно накладывают условие "И"Обязательный элемент.:* '''namecontainsauth''' - Поиск товаров, название которых содержит указанный текст — Авторизация. Обязательный элемент.:* '''namestartsorder''' — Контейнер отменяемого заказа. Обязательный элемент. Запрос может содержать более одного контейнера '''order''' - Поиск товаров, название которых начинается с указанного текста.Атрибуты::* '''name''orderno'''' - Поиск товаров, название которых соответствует указанному тексту' — Шифр заказа.:* '''quantity''ordercode' - Наличие на складе'''' — Внутренний код заказа. Принимает значения EXISTING_ONLY - Только в наличииОбратите внимание, NOT_EXISTING_ONLY - Только не в наличии, ALL - Все. что должен быть указан хотя бы один из атрибутов ''orderno'' или ''Это поле может быть недоступным в некоторых установках.ordercode''!

<?xml version="1.0" encoding="UTF-8"?><itemlist countcancelorder> <order orderno="3123test" totalcountordercode="3123456" pageerror="10" totalpageserrormsg="1OK"errormsgru="Успешно" /> <item> <code>123456</code> <article>FD343</article> <barcode>2345625213125</barcode> <name>Sony KDL-55W905 ЖК-телевизор</name> <retprice>65000</retprice> <purchprice>50000</purchprice> <weight>5.1</weight> <length>50</length> <width>30</width> <height>40</height> <CountInPallet>30</CountInPallet> <HasSerials>1</HasSerials> <CountryOfOrigin>Малайзия</CountryOfOrigin> (order orderno="123aaa" ordercode="" error="52" errormsg="order not yet supported) <Message>Хороший телевизор<found" errormsgru="Заказ не найден" /Message> <Message2>Снова хороший телевизор</Message2> <quantity>12</quantity> <reserved>3</reserved> <item> ...</itemlistcancelorder></source>

'''Пример запроса движения номенклатуры:'''

<itemmovementsaddattachments> <auth extra="8" login="login" pass="pass"/> <orderno>1234567</orderno> <attachments> <item name="photo1.jpg">JVBERi0xLjMN1wb25lbnQgMQ JUBQREYwMTIzNDU2Nzg5IDI NMyAwIG9iag08PA0vVHlwZSA U3VidHlwZSAvSW1hZ2UNL1d pZHRoIDE4MDgNL0hlaWdodCA ggNCAwIFINL0JpdHNQZXJDb 21wb25lbnQgMQ0vRGVjb2RlU ENL0NvbHVtbnMgMTgwOA0+P g0vSW1hZ2VNYXNrIHRydWUNL XhEZWNvZGUNPj4Nc3RyZWFt DQ</authitem> <item name="photo2.jpg">VBERi0xLjMNAwIG9iag0HRoJ JUBQREYwMTIzNDU2Nzg5IDI NMyAwIG9iag08PA0vVHlwZSA vWE9iamVjdA0vU3VidHlwZS AvSW1hZ2UNL1dpZHRoIDEzNj gNL0hlaWdodCAxMzMzDS9MZ W5ndGggNCAwIFINL0JpdHNQZ XJDb21wb25lbnQgMQ0vRGVj b2RlUGFybXMgPDwNL0sgLTEN L0NvbHVtbnMgMTM2OA0+Pg0 vSW<code/item>4259 </codeattachments></itemmovementsaddattachments>

'''addattachments''' — Корневой контейнер. Обязательный элемент.* '''auth''' — Авторизация. Обязательный элемент.* '''orderno''' — Номер заказа. Обязательный элемент. Может использоваться тэг <ordercode> с указанием внутреннего кода заказа.* '''attachments''' — Обязательный элемент, в котором перечисляются передаваемые данные файлов.** '''item''' — Бинарные данные (файл), закодированные в base64. Обязательный элемент.*** '''name''' — Атрибут элемента '''item''', в котором передается имя файла. Обязательный элемент.  '''Пример ответа движения номенклатуры:'''<source lang="xml"><?xml version="1.0" encoding="UTF-8"?><addattachments> <attachments> <item name="photo1.jpg" error="0" errormsg="OK" errormsgru="Успешно" /> <item name="photo2.jpg" error="0" errormsg="OK" errormsgru="Успешно" /> </attachments></addattachments></source> == Получение вложений к накладной =='''Пример запроса:'''

<itemmovements countattachments> <auth extra="8" login="login" pass="16pass"/> <itemmovement> <codeorderno>1515001234567</codeorderno> <date>2017-05-26</dateattachments> <retprice>0</retpricesource> <quantity>1<'''Описание полей:''' '''attachments''' — Корневой контейнер. Обязательный элемент.* '''auth''' — Авторизация. Обязательный элемент.* '''orderno''' — Номер/quantity>код заказа. Обязательный элемент.   <delivered>0</delivered>'''Пример ответа:''' <itemsource lang="xml"> <code>4259</code?xml version="1.0" encoding="UTF-8"?> <name>Настольная игра Дженга</nameattachments> </itemname="doc1.docx" timestamp="2025-01-01 12:00:00" size="35654">JVBERixLjMN <status> UwLJdLwIDKxTn+AScMjKqor7Xm3sp1yj1k6BzlPdX2Qsiit6yg3g1fCI4YVAgclUOIY5tDra2LvAcIS <code> 5</code> <name>Возврат от покупателя<+8PsL/sXb0+aoper/9kL/name> <4Ov/status>YE9QsHwyg7YZTtKICy0YVIYb4Nt7L1tPUMfaX9NpuTsvFCtBAvYG <store> eJVZoZ2tm6+fZVqAavZpeLizVLtct1a+xvG0+bTSkw3Ac8PhdNfL4smrT2hSgPJLfyaVGyA2ndyW22t <code>1< sFtTP5knktPNumSZ56QsFRPJkaU8ExDxAcMYMDIoBiIoR4/code> <name>офис в Москве<dDjHMbMW/name>EW4fiB1pvWmV2ONWIl1Xdub < Xg1ob0qWX9W4qagsqzGhjRLsEGeJGVXg9oVC+XkJa9esrhGUmC0tuKEla+AplVO/store>OtHwXcW0FWui1z7 <order> 6KHrtobuWV0xa9sCEiSvb91w3ePHOvfcveo5xt9o4ZevHF7ZOeKxV5qmVx2MI44a1L+Mhk5YuGT12xd <ordercode>3374830< Ibsb7r+j9bff/ordercode> <number>123660-0<unQlv0al6HBnoD5G89q4+tkjgDtvwwARmqm2aa2Jgvmth8mrXquTNtl2u467vbF/number>5r <date>2017-05-24< vnMt9uesu21Me1bjeNJGlVfAaCtw+/date> <orderno>14123<jfenJ/orderno>fWjqa7ygExx+L0BcTGroxrKexQXIQ1ImfEW7ZRJZa+O <barcode>0000000670< ip7xJmmNESMxrgu/barcode>dquBbGypjJpFDJVRH1rVPR1Ifl4aFS5IEdDWZFSdyBBWKWhVSVu517ZgzOCFAwp <company>ТОВАР< wwbFph29g4fTaxnvn/company>3X78x+Tt56ZNffArgULt+HByvy7+yz6U6XWMawCi3+6gJXN0S+jf4t+HT34wg <address>Кравченко ул., 1< km7/address>HDp55YTSWMoCMgZsvZkBrXtIv4WA7xgkT4YpYpxjwLvnsWKkGE+pDbxER0UUWlpVFRY4oilTfM4 <delivereddate>2017-05-29</delivereddate> MIzgCPgxjOlZ87ceA7ceRJrgpipFGyugPQ4OTI2S8lWJoqTpHJlJbNOeYM7zTcoVxSNyJXiYWSAMklT <deliveredtime>12:00:00< q/deliveredtime> <deliveredto xd+3fd3/>USq2V1rJ7RyBLHsuDSiLwgaOFc5LUCRGI+QWuBAsIwPlZrgRpSMseJyTzD15PKiIRE7bc </order> Rggk5ijXAPpqISetD4wVm0AD2LHuBZdaxmK3HOKIZoG0QLmiZdVqspXnFIJwVyCKhWiDCI4bzH8Y76w <document> TAnwM67HIqMISOkmJXY8mlYhpiNa7g2oTBkKxo4wgnvETQIUUrlFOn9KdOreDiKQx071rN4N61yRAi1 <code>21991< 7EGRhSOgoeLYv+k41+KZ1SVBXAuDjB+xuxnQmm8wJDcP5IRn+5penzbR/code>ivm7qleHK5o790w8ejXchI <number>318 vOHIPWtWwYhtAO34LdDXqFqWxZEBLNstMCwwITBTWirxk12zuUppp</numberitem> <date>2017-05-26</dateattachments> <message></messagesource> </document> </itemmovements>В тегах item возвращаются бинарные данные (файлы), закодированные в base64. </itemlist>== Изменение статуса агентом ==<Запрос изменения статуса заказа позволяет установить окончательный статус заказа — «Доставлен» или «Не доставлен (Возврат/source>Отмена)».

''' Описание полей ответа '''*'''code''' - внутренний код операции движения*'''date''' - Кроме этого, устанавливается дата операции*'''retprice''' - цена товара*'''quantity''' - количество товара операции*''и время (при необходимости) изменения статуса, а также сообщение в поле 'delivered'Инфо о доставке'' - количество доставленного товара.

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

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

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

<?xml version="1.0" encoding="UTF-8" ?><pvzlistsetorderinfo> <auth extraorder ordercode="8123456" loginerror="login0" passerrormsg="passOK" errormsgru="Успешно"></auth> <code>1234</code> <town>Нижний Тагил</town> <parentcode>6</parentcode> <acceptcash>YES</acceptcash> <acceptcard>YES</acceptcard> <acceptfitting>YES</acceptfitting> <maxweight>30</maxweight> <acceptindividuals>YES</acceptindividuals> <lt>57.924737</lt> <lg>order ordercode="234567" error="59.940019</lg> <rt>57.905682</rt> <rg>59.984669</rg> <json>YES<" errormsg="value [date_put] is already set" errormsgru="Значение [Дата доставки] уже указано" /json></pvzlistsetorderinfo>

*'''auth''' - Атрибут '''extra''' - обязателен, по нему определяется курьерская служба, '''login''' и '''pass''' позволяют авторизоваться под клиентом: == Получение документов для отдельного клиента могут быть ограничения по доступности некоторых ПВЗ, и в этом случае они будут учтены.*'''code''' - Внутренний код.*'''town''' - Город получателя.*'''parentcode''' - Фильтр по родительскому элементу*'''acceptcash''' - Фильтр по приему наличных YES/NO*'''acceptcard''' - Фильтр по приему банковских карт YES/NO*'''acceptfitting''' - Фильтр по наличию примерки YES/NO*'''maxweight''' - Фильтр по максимальному весу, с которым работает ПВЗ*'''acceptindividuals''' - Фильтр по доступности физическим лицам YES/NO*'''lt''' - Широта левого верхнего угла*'''lg''' - Долгота левого верхнего угла*'''rt''' - Широта правого нижнего угла*'''rg''' - Долгота правого нижнего угла*'''json''' - Признак вывода ответа в виде JSON YES/NO печати =='''Пример ответа справочника пунктов самовывозазапроса получения печатных форм:'''

<pvzlist count="2"waybill> <pvz> <code>126<auth extra="8" login="login" pass="pass" /code> <clientcodeclient>3CLIENT</clientcodeclient> <name>Нижний Тагил </nameorders> <parentcode>6<order orderno="1234567" ordercode="33331" /parentcode> <parentname>Интеграция</parentname> <town codeorder orderno="1234568" ordercode="12426733332">Нижний Тагил город</town> <address>622036, г. Нижний Тагил, ул. Циолковского, д. 17 </addressorders> <phoneform>+73435417709, +734352549891</phoneform> <commentstart>Новый пункт доставки5</commentstart> <worktimeintegration>Вс 10:00-16:00, Сб 10:00-16:00, Пн-Пт 10:00-20:0021</worktimeintegration> <traveldescription>Жилое 5-ти этажное здание, торцом к дороге, второе здание от перекрестка Пархоменко-Циолковского</traveldescriptionwaybill> <maxweight>10</maxweightsource> <acceptcash>YES</acceptcash> <acceptcard>YES</acceptcard>'''Описание полей:''' <acceptfitting>YES</acceptfitting> <acceptindividuals>YES</acceptindividuals>'''waybill''' — Корневой контейнер. Обязательный элемент <latitude>57* '''auth''' — Авторизация.93457</latitude>Обязательный элемент <longitude>59* '''client''' — Признак клиента или агента. Необязательный элемент.95131</longitude> </pvz>:* CLIENT — Признак клиента, значение по умолчанию <pvz>:* AGENT — Признак агента. В ответ отдается информация по заказам, переданным агенту на доставку <code>245</code>* '''orders''' — Список заказов для получения печатных форм. Содержит тэги '''order''' с атрибутами: <clientcode>NTG1</clientcode>:* '''''orderno''''' — шифр заказа <name>На Красноармейской</name>:* '''''ordercode''''' — внутренний код заказа. Указывать необходимо один из атрибутов для всех заказов. Приоритет имеет атрибут '''''ordercode''''' <parentcode>6</parentcode> <parentname>Интеграция</parentname> <town code="124267">Нижний Тагил город</town> <address>КРАСНОАРМЕЙСКАЯ, д* '''form''' — Формат накладной. Не обязательный элемент.79</address>Принимает значения: <phone>+7:* 1 — Подробная накладная (3435по-умолчанию)379-044</phone> <comment>Возможность примерки отсутствует</comment>:* 2 — Наклейки Zebra <worktime>Вс 10:00-16* 3 — Наклейки на страницу формата А4:00, Сб 10:00* 4 — Акты приема-16:00, Пн-Пт 10:00-20:00</worktime>передачи <traveldescription>Напротив ТЦ Пирамида</traveldescription>* '''start''' — Имеет смысл только для form = 3. Начальная позиция первой наклейки. Используется для пропуска наклеек на листе для их экономии. <maxweight>20</maxweight> <acceptcash>YES</acceptcash> <acceptcard>YES</acceptcard> <acceptfitting>NO</acceptfitting> <acceptindividuals>YES</acceptindividuals> <latitude>57* '''integration''' - Получение наклеек от подрядчика.93468</latitude> <longitude>60Не обязательный элемент, имеет смысл при наличии кода подрядчика в карточке заказа.55476</longitude>Принимает значение: </pvz>:* 21 - подрядчик GTD</pvzlist></source>

*'''codeПример ответа:''' <source lang="xml"><?xml version="1.0" encoding="UTF- Код ПВЗ в системе8"?><waybill> <integration code="21"> <order code="33331"> <content>JVBERi0xLjYNJeLjz9MNC... Используется в запросе [[API#Оформление заказа|оформления заказов]]</content> </order> <order code="33332">*'''clientcode''' - Код ПВЗ используемый компанией-подрядчиком <content>JVBERi0xLjYNJeLjz9MNC..*'''name''' - Наименование ПВЗ.</content>*'''parentcode''' - Код родительского элемента. </order>*'''parentname''' - Наименование родительского элемента. </integration>*'''town''' - Населенный пункт с кодом из [[#Справочник городов|справочника городов]]. <content>EODIcaI8KSBlwQ 4MnEOR7Px8U8EBAyGICBnwpw *'''address''' - Адрес ПВЗ. IZhQgz0ZxuPs8EBM/GcbjzB AwhBl8hwQYIO00GmEwg1CeEG *'''phone''' - Телефоны ПВЗ. mqYTChNU0wqf8l8nz4zgc+K fCno+zwU5GjOZmzXGcbEQYIM *'''comment''' - Дополнительная информация. 4zkegRE40zWzONyoNNMIOIa cWnp6aDCGEGE9NQmoQd2mg00 *'''worktime''' - Режим работы ПВЗ. 79U4f3hPTwnfp6Sdrafeqpa JDpFw/1aYT077VNNNdO00G3q *'''traveldescription''' - Описание местонахождения ПВЗ или пути к нему. mqqvp9p2E7T0/wiFemv8uG6 OM</content>*'''maxweight''' - Максимальный вес, с которым работает ПВЗ.</waybill>*'''acceptcash''' - Признак приема наличных</source>*'''acceptcard''' - Признак приема банковских карт*'''acceptfitting''' - Наличие примерки*'''latitude''' - ШиротаВ тэге content возвращаются бинарные данные (файл pdf), закодированные в base64.*'''longitude''' - ДолготаПри записи в файл необходимо использовать двоичный формат записи!

Блок integration содержит отдельные наклейки для заказов, предоставленные подрядчиком, так же закодированные в base64.  '''Пример запроса Видов срочности:Обратите внимание'''<source lang="xml"><?xml version="1Лимит количества при единовременном получении печатных форм - 1000 штук.0" encoding="UTFЕсли нужно получить больше -8" ?><services><auth extra="8"/></services></source>делайте это несколькими запросами.

'''Пример ответа справочника Видов срочности:Обратите внимание'''<source lang="xml"><?xml version="1Печатные формы для заборов не формируются.0" encoding="UTF-8" ?><services count="2"> <service> <code>1</code> <name>Эконом</name> </service> <service> <code>2</code> <name>Срочно</name> </service></services></source>

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

<?xml version="1.0" encoding="UTF-8" ?><calculatorwaybill> <auth extra="8" login="login" pass="pass" /error> Текст ошибки<calc townfrom="Москва" townto="3800000300000" l="10" w="20" h="30" mass="3.7" service="1" /error></calculatorwaybill>

Параметры:*'''townfrom''' - Город-отправитель*'''townto''' - Город-получатель*'''l''' - Длина в сантиметрах (не обязательный параметр)*'''w''' - Ширина в сантиметрах (не обязательный параметр)*'''h''' - Высота в сантиметрах (не обязательный параметр)*'''mass''' - Масса в килограммах*'''service''' - Режим доставки - число, указывающее на запись в справочнике [[#== Справочник Видов срочности|видов срочности]]. Если этот параметр опустить, система выдаст расчет для всех доступных видов срочности, передав много контейнеров <calc> в ответе. В авторизации можно опустить параметры login и pass, тогда расчет будет производиться по стандартному тарифу курьерской службы, без учета возможных отличий для конкретного клиента.<br>Объемный вес будет учитываться только при условии указания всех габаритов: длины, ширины и высоты.<br>В полях город-отправитель и город-получатель можно указывать название города (не рекомендуется!), либо код города из нашего справочника, либо 13-ти значный код КЛАДР, либо 36-ти значный код адресной системы ФИАС (AOID). городов =='''Пример ответа стоимости доставкизапроса справочника городов:'''<source lang="xml">

<calculatortownlist> <calcauth extra="8" /> <codesearch> <zipcode>110000</zipcode> <kladrcode>0100000100800</kladrcode> <fiascode>bd21979d-46f8-49d0-9105-e8d65172a983</fiascode> <townfrom code="1">Москва город123</code> </codesearch> <conditions> <city>Краснодарский край</city> <namecontains>новгород</townfromnamecontains> <townto code="56603"namecontainsparts>Иркутск городмолоково моск</towntonamecontainsparts> <massnamestarts>3.7Моск</massnamestarts> <service name="Экспресс">1Москва</name> <fullname>Москва город</servicefullname> <zonecountry>1</country>2 </zoneconditions> <limit> <pricelimitfrom>116330</pricelimitfrom> <mindeliverydayslimitcount>110</mindeliverydayslimitcount> <maxdeliverydayscountall>3YES</maxdeliverydayscountall> </calclimit></calculatortownlist>

Параметры:*'''townfrom''' - Город-отправитель Внутри контейнера townlist все элементы могут как отсутствовать, так, как система его распознала и привязала комбинироваться. Поиск не чувствителен к справочнику. Атрибут '''code''' - код из справочника городов системырегистру. *'''towntoauth''' - Город-получатель так — Авторизация, как система его распознала необязательный элемент. Используется в случае включенного и привязала к справочнику. Атрибут '''code''' - код из справочника городов системынастроенного ограничения по населенным пунктам в конкретной курьерской службе. *'''masscodesearch''' - Масса в килограммах — Поиск по кодам. В случае использования — контейнеры conditions и limit игнорируются.:*'''servicezipcode''' - Режим доставки - число — Поиск по индексу. Обратите внимание на то, указывающее что один почтовый индекс может распространяться на запись в справочнике видов срочности (см описание на этой странице)несколько населенных пунктов. В этом случае система вернет несколько записей.:*'''zonekladrcode'''  — Поиск по 13- номер тарифной зоны, по которой рассчиталась стоимость. В зависимости от зоны выбирается тарифная сетка. Так же к цене могут применяться повышающие или понижающие коэффициенты при доставке не из/в региональный центрти значному коду КЛАДР.:*'''pricefiascode''' - рассчитанная стоимость доставки в валюте прайс-листа курьерской службы. Рекомендуется к использованию в отличие от одноименного атрибута родительского контейнера — Поиск по коду ФИАС (AOGUID).:*'''maxdeliverydayscode''' - максимальный срок доставки  — Поиск по коду в рабочих дняхсистеме.

* '''conditions''Обратите внимание' — Задает условия поиска. Все вложенные элементы одновременно накладывают условие «И».:* '''city''' — Поиск по всем населенным пунктам региона.:* '''namecontainsparts'' В реальном ответе сервера в теге calc присутствует атрибут ' — Поиск населенных пунктов, название которых содержит все указанные слова, с разбиением поисковой фразы через пробел. Например "моск моло" найдет деревню "priceМолоково"в Московской области. Он оставлен для обратной совместимости:* '''namecontains''' — Поиск населенных пунктов, название которых содержит указанный текст.:* '''namestarts''' — Поиск населенных пунктов, название которых начинается с указанного текста.:* '''name''' — Поиск населенных пунктов, название которых соответствует указанному тексту.:* '''fullname''' — Поиск населенных пунктов, не используйте егоназвание вместе с типом населенного пункта которых соответствует указанному тексту. Пользуйтесь вложенным тегом price:* '''country''' — Поиск только по стране с указанным внутренним кодом или текстовым кодом в соответствии [https://ru.wikipedia.org/wiki/ISO_3166-1 стандартом ISO_3166-1], например, «RU», «RUS» для России.

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

<?xml version="1.0" encoding="UTF-8" ?><smalist> <auth extratownlist count="3" page="81" logintotalcount="login3" passtotalpages="pass1" /> <datefromtown> <code>2016-02-1026379</datefromcode> <city> <datetocode>2016-03-1023</datetocode> <name>Краснодарский край</smalistname> </sourcecity> <name>Сочи город</name>'''smalist''' <fiascode>79da737a- Корневой контейнер. Обязательный элемент.*'''auth''' 603b- Авторизация. Обязательный элемент.*'''datefrom''' 4c19- Дата "с". Необязательный элемент.*'''dateto''' 9b54- Дата "по". Необязательный элемент.9114c96fb912</fiascode>Если интервал дат не указан, то возвращаются акты передачи денег за последний месяц. <kladrcode>2300000700000</kladrcode> <shortname /> (not yet supported)'''Пример ответа на запрос списка актов передачи денег:''' <source lang="xml"typename /> (not yet supported) <?xml versioncoords lat="143.05855" encodinglon="UTF-839.7231"?/> <smalist count="1"/town> <smatown> <code>627840331</code> <numbercity> <code>399232</numbercode> <name>Брянская область<actdate/name>2016-02-12 </actdatecity> <datepayname>Сочилов хутор</datepayname> <datetofiascode>2016c9c96c67-2cc9-024f10-12afde-fd32417ea216</datetofiascode> <promiseddatepaykladrcode>3201900011100</promiseddatepaykladrcode> <priceshortname />637.00 <typename /price> <pricecorrcoords lat="52.6407" lon="33.1724" />113.00 </pricecorrtown> <town> <rurcode>13430.00114016</rurcode> <pricekurcity>570.00 <code>60</pricekurcode> <name>Псковская область<priceag/name>67.00 </priceagcity> <paynoname>42423Сочихино деревня</paynoname> <paytypefiascode>110df7588-19c1-49d1-a387-9de1cf3eb26f</paytypefiascode> <paytypenamekladrcode>Безнал6001900015400</paytypenamekladrcode> <signedcopyreceivedshortname />NO <typename /> <coords lat="56.6003" lon="29.3542" /signedcopyreceived> </smatown></smalisttownlist>

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

== Детализация актов передачи денег Справочник регионов == '''Пример запроса детализации актов передачи денегсправочника:'''

<?xml version="1.0" encoding="UTF-8" ?><smadetailregionlist> <codesearch> <code>77</code> <auth extra="8" login="login" pass="pass" /codesearch> <codeconditions> <namecontains>край</namecontains> <namestarts>Моск</namestarts> <fullname>Московская область</fullname> <country>RU</country>6278 </codeconditions></smadetailregionlist>

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

<smadetail regionlist count="2"> <specialsmacity> <code>4249480</code> <ordercodecountry>14424 <code>1</ordercodecode> <ordernoname>11111Россия</ordernoname> <orderdateid>2018-01-01643</orderdateid> <delivereddateShortName1>2018-10-01RU</delivereddateShortName1> <ShortName2>RUS<company/ShortName2>Компания </companycountry> <pricename>314.00Агинский Бурятский автономный округ</pricename> </city> <city> <rurcode>8800.001</rurcode> <inshpricecountry> <code>314.001</inshpricecode> <pricekurname>270.00Россия</pricekurname> <priceagid>44.00643</priceagid> <pricecalcShortName1>8486.00RU</pricecalcShortName1> <paytypeShortName2>2RUS</paytypeShortName2> <paytypename>наличными курьером</paytypenamecountry> <statusname>ДоставленоАдыгея республика</statusname> </specialsmacity></smadetailregionlist>

*'''code''' - Код записи.== Справочник улиц ==*'''ordercodeПример запроса справочника улиц:''' - Код заказа.*'''orderno''' - Шифр заказа.<source lang="xml">*'''orderdate''' <?xml version="1.0" encoding="UTF- Дата заказа.8"?>*'''delivereddate''' - Дата доставки.<streetlist>*'''company''' - Получатель. <conditions> <town>Москва город</town> // ОБЯЗАТЕЛЬНОЕ ПОЛЕ!*'''price''' - Стоимость услуг. <namecontains>Хохло</namecontains>*'''rur''' - Сумма заказа. <namestarts>Академика Х</namestarts>*'''inshprice''' - Стоимость заказа. <name>Академика Хохлова</name>*'''pricekur''' - Стоимость курьерской доставки <fullname>Академика Хохлова ул.</fullname>*' </conditions> <limit> <limitfrom>30</limitfrom> <limitcount>10</limitcount> <countall>YES</countall> </limit></streetlist></source> * ''priceag'conditions''' - Агентское вознаграждение — Задает условия поиска. Все вложенные элементы одновременно накладывают условие «И».:*'''pricecalctown''' - Сумма для передачи агенту — Обязательное поле. Название или код населенного пункта.:*'''paytypenamecontains''' - Тип оплаты: 1 - безнал, 2 - наличными курьером, 3 - наличными в офисе — Поиск улиц, 4 - перевод на картуназвание которых содержит указанный текст.:*'''paytypenamenamestarts''' - Строковое представление типа оплаты — Поиск улиц, название которых начинается с указанного текста.:*'''statusname''' - Статус заказа — Поиск улиц, название которых соответствует указанному тексту.:* '''fullname''' — Поиск улиц, для которых название вместе с типом соответствует указанному тексту.== Генерация коротких ссылок ==* '''limit''' — Ограничивает вывод результата.В некоторых случаях:* '''limitfrom''' — Задает номер записи результата, например, при использовании в СМС, может потребоваться использование коротких ссылок на ЛКначиная с которой выдавать ответ.Для этого, необходимо отправить запрос с полной ссылкой, в ответ на который придёт хэшПо-код для ссылкиумолчанию — 0. :* '''Пример запроса генерации коротких ссылок:limitcount'''- Задает количество записей результата, которые нужно вернуть. По-умолчанию — 10000.:* '''countall''' — YES указывает на необходимость подсчета общего количества найденных совпадений. Это может замедлять выполнение запроса. Если отключено, в ответе не указываются totalcount и totalpages. '''Пример ответа:'''<source lang="xml"><?xml version="1.0" encoding="UTF-8" ?><shortlink> <link shortstreetlist count="01"> https:page="1" totalcount="3" totalpages="1"> <street> <code>124<//home.courierexecode> <name>Академика Хохлова ул.ru/8/site/orders </linkname> <shortname>Академика Хохлова</shortlinkshortname> </sourcetypename>ул.</typename> </street> '''shortlink''' - Корневой контейнер. Обязательный элемент</streetlist></source> В ответе улицы сортируются по алфавиту.*== Справочник номенклатуры =='''linkПример запроса справочника номенклатуры:''' - Полная ссылка, для которой необходимо получить код. Обязательный элемент. Если атрибут '''short''' равен 1, то ответ не будет содержать XML, а только хэш-код. ''<source lang="xml"><?xml version="1.0" encoding="UTF-8" ?><itemlist> <auth extra="8" login="login" pass="pass"></auth> <codesearch> <code>123456</code> <article>FD343</article> <barcode>2345625213125</barcode> </codesearch> <conditions> <namecontains>телевизор</namecontains> <namestarts>sony</namestarts> <name>Sony KDL-55W905 ЖК-телевизор</name> <quantity>EXISTING_ONLY</quantity> <store>2</store> </conditions> <except> <code>123478</code> </except> <limit> <limitfrom>30</limitfrom> <limitcount>10</limitcount> <countall>YES</countall> </limit></itemlist></source> Внутри контейнера itemlist все элементы могут как отсутствовать, так и комбинироваться. Поиск не чувствителен к регистру.* '''codesearch''' — Поиск по кодам. В случае использования — контейнеры conditions и limit игнорируются.:* '''code''' — Поиск по внутреннему коду системы.:* '''article''' — Поиск по артикулу.:* '''barcode''' — Поиск по штрихкоду. * '''conditions''' — Задает условия поиска. Все вложенные элементы одновременно накладывают условие «И».:* '''namecontains''' — Поиск товаров, название которых содержит указанный текст.:* '''namestarts''' — Поиск товаров, название которых начинается с указанного текста.:* '''name''' — Поиск товаров, название которых соответствует указанному тексту.:* '''quantity''' — Наличие на складе. Принимает значения EXISTING_ONLY — Только в наличии, NOT_EXISTING_ONLY — Только не в наличии, ALL — Все. ''Это поле может быть недоступным в некоторых установках.'':* '''store''' — Поиск товаров по определенному складу. * '''except''' — Описание исключений для корректного определения количества зарезервированной номенклатуры.:* '''code''' — Код заказа. * '''limit''' — Ограничивает вывод результата.:* '''limitfrom''' — Задает номер записи результата, начиная с которой выдавать ответ.:* '''limitcount''' — Задает количество записей результата, которые нужно вернуть. '''Пример ответа:'''<source lang="xml"><?xml version="1.0" encoding="UTF-8"?><itemlist count="3" totalcount="3" page="1" totalpages="1"> <item> <code>123456</code> <article>FD343</article> <barcode>2345625213125</barcode> <name>Sony KDL-55W905 ЖК-телевизор</name> <retprice>65000</retprice> <purchprice>50000</purchprice> <weight>5.1</weight> <length>50</length> <width>30</width> <height>40</height> <VATrate>20</VATrate> <CountInPallet>30</CountInPallet> <CountInBox>2</CountInBox> <HasSerials>1</HasSerials> <CountryOfOrigin>Малайзия</CountryOfOrigin> (not yet supported) <Message>Хороший телевизор</Message> <Message2>Снова хороший телевизор</Message2> <quantity>12</quantity> <reserved>3</reserved> <item> ...</itemlist></source> '''Описание полей:'''* '''code''' — Внутренний идентификатор, присвоенный системой.* '''article''' — Артикул, назначенный клиентом (поставщиком).* '''barcode''' — Штрихкод производителя.* '''name''' — Наименование.* '''retprice''' — Розничная цена по-умолчанию. При оформлении заказа цена используется та, которая указана в заказе.* '''purchprice''' — Закупочная цена.* '''weight''' — Масса в килограммах.* '''length''' — Длина в сантиметрах.* '''width''' — Ширина в сантиметрах.* '''height''' — Высота в сантиметрах.* '''VATrate''' — Ставка НДС, целое число процентов.* '''CountInPallet''' — Количество штук в паллете.* '''CountInBox''' — Количество штук в упаковке.* '''HasSerials''' — Требует учета серийных номеров. Принимает значения 1 — да, 0 — нет.* '''CountryOfOrigin''' — Наименование страны происхождения на русском языке.* '''Message''' — Комментарий.* '''Message2''' — Дополнительный комментарий.* '''quantity''' — Количество на складе. Товары, уже собранные в заказы в этом количестве не присутствуют, считаются покинувшими товарный склад. ''Это поле может быть недоступным в некоторых установках.''* '''reserved''' — Количество зарезервированного товара. Может превышать остаток на складе, если покупатели ждут следующей поставки. ''Это поле может быть недоступным в некоторых установках.'' == Движение номенклатуры =='''Пример запроса движения номенклатуры:'''<source lang="xml"><?xml version="1.0" encoding="UTF-8" ?><itemmovements> <auth extra="8" login="login" pass="pass"></auth> <code>4259</code> <datefrom>2020-10-01</datefrom> <dateto>2020-10-02</dateto></itemmovements></source> * '''code''' — внутренний код товара в справочнике номенклатуры.* '''datefrom''' — дата начала периода.* '''dateto''' — дата окончания периода.Может быть указан или код, или период, или код и период одновременно.  '''Пример ответа движения номенклатуры:'''<source lang="xml"><?xml version="1.0" encoding="UTF-8" ?><itemmovements count="16"> <itemmovement> <code>151500</code> <date>2017-05-26</date> <retprice>0</retprice> <quantity>1</quantity> <delivered>0</delivered> <item> <code>4259</code> <name>Настольная игра Дженга</name> </item> <status> <code>5</code> <name>Возврат от покупателя</name> </status> <store> <code>1</code> <name>офис в Москве</name> </store> <order> <ordercode>3374830</ordercode> <number>123660-0</number> <date>2017-05-24</date> <orderno>14123</orderno> <barcode>0000000670</barcode> <company>ТОВАР</company> <address>Кравченко ул., 1</address> <delivereddate>2017-05-29</delivereddate> <deliveredtime>12:00:00</deliveredtime> <deliveredto /> </order> <document> <code>21991</code> <number>318</number> <date>2017-05-26</date> <message></message> </document> <serials> <serial>123456789</serial> </serials> </itemmovements></itemlist></source> ''' Описание полей ответа '''* '''code''' — внутренний код операции движения* '''date''' — дата операции* '''retprice''' — цена товара* '''quantity''' — количество товара операции* '''delivered''' — количество доставленного товара * '''item''' — контейнер товара:* '''code''' — внутренний код товара:* '''name''' — наименование товара * '''status''' — контейнер статуса операции:* '''code''' — код статуса:* '''name''' — наименование * '''store''' — контейнер филиала, к которому относится операция:* '''code''' — код филиала:* '''name''' — наименование филиала * '''order''' — контейнер корреспонденции:* '''ordercode''' — внутренний код заказа:* '''number''' — номер заказа:* '''date''' — дата заказа:* '''orderno''' — шифр:* '''barcode''' — штрихкод:* '''company''' — компания:* '''address''' — адрес:* '''delivereddate''' — дата вручения:* '''deliveredtime''' — время вручения:* '''deliveredto''' — данные о вручении, либо причина недоставки * '''document''' — контейнер документа операции:* '''code''' — внутренний код документа:* '''number''' — номер документа:* '''extnumber''' — внешний номер документа:* '''date''' — дата документа:* '''message''' — комментарий * '''serials''' — контейнер серийных номеров:* '''serial''' — серийный номер единицы номенклатуры, участвующей в движении   == Серийные номера =='''Пример запроса движения номенклатуры с серийным номером:'''<source lang="xml"><?xml version="1.0" encoding="UTF-8" ?><serialmovements> <auth extra="8" login="login" pass="pass"></auth> <serial>123456789</serial></serialmovements></source> * '''serial''' — серийный номер единицы номенклатуры.  '''Пример ответа движения номенклатуры с серийным номером:'''<source lang="xml"><?xml version="1.0" encoding="UTF-8" ?><serialmovements count="16"> <serialmovement> <code>151500</code> <serial>123456789</serial> <date>2017-05-26</date> <delivered>0</delivered> <item> <code>4259</code> <name>Настольная игра Дженга</name> </item> <status> <code>5</code> <name>Возврат от покупателя</name> </status> <order> <ordercode>3374830</ordercode> <number>123660-0</number> <date>2017-05-24</date> <orderno>14123</orderno> <barcode>0000000670</barcode> <company>ТОВАР</company> <address>Кравченко ул., 1</address> <delivereddate>2017-05-29</delivereddate> <deliveredtime>12:00:00</deliveredtime> <deliveredto /> </order> <document> <code>21991</code> <number>318</number> <date>2017-05-26</date> <message></message> </document> </serialmovement></serialmovements></source> ''' Описание полей ответа ''' Описание аналогично описанию полей [[#Движение номенклатуры|движения номенклатуры]]   == Серийные номера по заказу =='''Пример запроса движения серийных номеров заказа:'''<source lang="xml"><?xml version="1.0" encoding="UTF-8" ?><orderserials> <auth extra="8" login="login" pass="pass"></auth> <ordercode>123456789</ordercode> <orderno>123456789</orderno> <barcode>123456789</barcode></orderserials></source> * '''ordercode''' — внутренний код заказа.* '''orderno''' — шифр заказа.* '''barcode''' — штрих-код заказа.Указывать необходимо один из идентификаторов заказа.  '''Пример ответа движения серийных номеров заказа:'''<source lang="xml"><?xml version="1.0" encoding="UTF-8" ?><orderserials> <order> <code>3374830</code> <orderno>14123</orderno> <barcode>0000000670</barcode> <delivereddate>2024-07-20</delivereddate> <deliveredtime>10:04:00</deliveredtime> <assemblydate>2024-07-19 07:05:34</assemblydate> </order> <items> <item> <code>4259</code> <name>Настольная игра Дженга</name> <article>123000</article> <state>Delivered</state> <serials> <serial>123456789</serial> </serials> </item> </items></orderserials></source> ''' Описание полей ответа ''' * '''order''' — блок заказа::* '''code''' — код:* '''orderno''' — шифр:* '''barcode''' — штрих-код:* '''delivereddate''' — дата доставки факт:* '''deliveredtime''' — время доставки факт:* '''assemblydate''' — дата сборки * '''item''' — блок товара::* '''code''' — код:* '''name''' — наименование:* '''article''' — артикул:* '''state''' — статус Доставлено (Delivered) или Возвращено (Returned):* '''serials''' — блок серийных номеров по заказу == Получение справочника тарифов по городам == '''Пример запроса справочника тарифов по городам'''<source lang="xml"><?xml version="1.0" encoding="UTF-8"?><tariffs> <auth extra="8" login="login" pass="pass" /> <townfrom>Москва</townfrom> <service>1</service> <mainonly>1</mainonly> </tariffs></source> * '''auth''' — атрибут '''extra''' обязателен, по нему определяется курьерская служба.* '''townfrom''' — город-отправитель. Если не передан, то городом будет «Москва».* '''service''' — режим доставки. Обязательный элемент.* '''mainonly''' — необязательный элемент. Если передан, то в ответе будут данные только по городам из справочника '''Межгород''' > '''Зоны'''.  Важно понимать, что в ответе отдаются только тарифы, указанные в разделе "Тарифы по зонам" раздела "Межгород" в офисной системе курьерской службы, т.е. считающихся междугородними. Доставка до городов, рассчитываемая по внутригородским тарифам, в ответе НЕ ОТДАЕТСЯ!   '''Пример ответа справочника тарифов по городам'''<source lang="json">{ "townfrom": "0c5b2444-70a0-4932-980c-b4dc0d3f02b5", "service": 1, "tariffs": [ { "towntofias": "0c5b2444-70a0-4932-980c-b4dc0d3f02b5", "towntocode": 1, "towntoname": "Москва город", "townregion": "Город Москва", "distance": 0, "pricedistance": 0, "pricesnew": { "before": [ { "price": 100, "every": 0, "mass": 1 }, { "price": 150, "every": 0, "mass": 5 } ], "after": [ { "price": 0, "every": 1, "mass": 38.01 }, { "price": 15, "every": 1, "mass": 51.01 } ] }, "deliveryPeriodMin": 1, "deliveryPeriodMax": 2 } ]}</source> ''' Описание полей ответа '''* '''townfrom''' — код ФИАС города-отправителя.* '''service''' — режим доставки.* '''tariffs''' — cписок тарифов по городу.:* '''townregion''' — регион города-получателя.:* '''towntofias''' — код ФИАС города-получателя.:* '''towntocode''' — внутренний код города-получателя.:* '''towntoname''' — наименование города-получателя.:* '''distance''' — дистанция в км до города от МКАД, если в запросе townfrom — Москва.:* '''pricedistance''' — сумма за километраж до города от МКАД, если в запросе townfrom — Москва.:* '''pricesnew''' — ваши настройки тарифов из справочника '''Межгород''' > '''Тарифы по зонам'''.::* '''before/after''' — контейнеры ДО/ОТ.:::* '''price''' — цена. Если ответ идет по «before», то в цену также плюсуется сумма pricedistance:::* '''every''' — за каждые.:::* '''mass''' — масса.:* '''prices''' — устаревший элемент, не используется.:* '''deliveryPeriodMin''' — минимальный срок доставки.:* '''deliveryPeriodMax''' — максимальный срок доставки. == Номенклатура приходной накладной =='''Пример запроса номенклатуры приходной накладной:'''<source lang="xml"><?xml version="1.0" encoding="UTF-8" ?><itemdoc> <auth extra="8" login="login" pass="pass"></auth> <code>21991</code></itemdoc></source> * '''code''' — внутренний код документа приходной накладной (см. предыдущий запрос).  '''Пример ответа движения номенклатуры:'''<source lang="xml"><?xml version="1.0" encoding="UTF-8" ?><itemdoc> <code>21991</code> <number>318</number> <date>2017-05-26</date> <message></message> <items> <item code="4259" quantity="1" barcode="200300" article="123555">Настольная игра Дженга</item> </items></itemdoc></source> ''' Описание полей ответа '''* '''code''' — внутренний код приходной накладной* '''number''' — номер документа* '''date''' — дата документа* '''message''' — комментарий * '''item''' — контейнер товара:* '''code''' — внутренний код товара:* '''barcode''' — штрихкод товара:* '''article''' — артикул товара:* '''quantity''' — количество поступившего товара == Справочник филиалов =='''Пример запроса списка филиалов:'''<source lang="xml"><?xml version="1.0" encoding="UTF-8" ?><storelist> <auth extra="8"></auth> <json>YES</json> <client_code>7890</client_code></storelist></source> * '''auth''' — Атрибут '''extra''' — обязателен, по нему определяется курьерская служба* '''json''' — Признак вывода ответа в виде JSON YES/NO* '''client_code''' — Код клиента курьерской службы '''Пример ответа:'''<source lang="xml"><?xml version="1.0" encoding="UTF-8" ?><storelist count="2"> <store> <code>123</code> <name>ABC</name> </store> <store> <code>456</code> <name>Филиал 2</name> </store></storelist></source> * '''code''' — Код филиала.* '''name''' — Наименование филиала. == Справочник пунктов самовывоза ==Для отображения списка пунктов выдачи (ПВЗ) есть '''готовый JavaScript модуль''': https://home.courierexe.ru/js/measoft_map.js Инструкция по использованию — внутри. Посмотреть пример работы можно [https://home.courierexe.ru/pvz_test.html Здесь] Уникальные запросы списка ПВЗ кешируются на стороне личного кабинета и хранятся до 7 часов утра по московскому времени следующего дня. Например, если уникальный запрос с массой 2 кг был отправлен сегодня в 10 часов, то завтра в 7 утра он сбросится. Если сегодня в 18 часов в этом же запросе вы укажете массу 2 кг, в ответе вернется тот же список ПВЗ. Если передадите массу 3 кг, список может быть другим. Обратите внимание, что если в выборке количество ПВЗ больше '''10000''' и не указаны параметры '''code''', '''json''' или '''limitcount''', то будет возвращаться ошибка. В этом случае необходимо использовать блок '''limit'''. '''Пример запроса пунктов самовывоза:'''<source lang="xml"><?xml version="1.0" encoding="UTF-8" ?><pvzlist> <auth extra="8" login="login" pass="pass"></auth> <code>1234</code> <client_code>7890</client_code> <city>Свердловская область</city> <town regioncode="66" country="RU">Нижний Тагил</town> <address>Щёлковское шоссе</address> <house>77</house> <advanced_search>Строка поиска</advanced_search> <parentcode>6</parentcode> <acceptcash>YES</acceptcash> <acceptcard>YES</acceptcard> <acceptfitting>YES</acceptfitting> <maxweight>30</maxweight> <acceptindividuals>YES</acceptindividuals> <respstores>YES</respstores> <lt>57.924737</lt> <lg>59.940019</lg> <rt>57.905682</rt> <rg>59.984669</rg> <json>YES</json> <with_coords>YES</with_coords> <limit> <limitfrom>30</limitfrom> <limitcount>2</limitcount> <countall>YES</countall> </limit></pvzlist></source> * '''auth''' — Атрибут '''extra''' — обязателен, по нему определяется курьерская служба, '''login''' и '''pass''' позволяют авторизоваться под клиентом: для отдельного клиента могут быть ограничения по доступности некоторых ПВЗ, и в этом случае они будут учтены.* '''code''' — Внутренний код, целое число.* '''client_code''' — Код клиента курьерской службы.* '''city''' — Регион получателя. Можно указать код региона или полное наименование региона из [[#Справочник регионов|справочника регионов]].* '''town''' — Город получателя.Для тега города '''town''' можно указать код региона в атрибуте '''''regioncode''''' из [[#Справочник регионов|справочника регионов]]. Поиск будет производиться в указанном регионе. Также можно указать страну получателя в атрибуте '''''country''''' в соответствии с [https://ru.wikipedia.org/wiki/ISO_3166-1 стандартом ISO_3166-1], например, «RU», «RUS» или «643» для России.Для формата запроса JSON фильтрация по городу работает только в связке с фильтром по адресу. * '''address''' — Фильтр по адресу, работает только в связке с фильтром по городу* '''house''' — Фильтр по номеру дома, работает только в связке с фильтрами по адресу и городу* '''advanced_search''' — Фильтр по коду агента, наименованию, телефону или комментарию* '''parentcode''' — Фильтр по родительскому [[#Справочник филиалов|филиалу]]* '''acceptcash''' — Фильтр по приему наличных YES/NO* '''acceptcard''' — Фильтр по приему банковских карт YES/NO* '''acceptfitting''' — Фильтр по наличию примерки YES/NO* '''maxweight''' — Фильтр по максимальному весу, с которым работает ПВЗ* '''acceptindividuals''' — Фильтр по доступности физическим лицам YES/NO* '''respstores''' - Признак вывода ответственных филиалов при значении YES* '''lt''' — Широта левого верхнего угла* '''lg''' — Долгота левого верхнего угла* '''rt''' — Широта правого нижнего угла* '''rg''' — Долгота правого нижнего угла* '''json''' — Признак вывода ответа в виде JSON YES/NO* '''with_coords''' — Признак вывода ПВЗ только с наличием координат YES/NO* '''limit''' — Ограничивает вывод результата.:* '''limitfrom''' — Задает номер записи результата, начиная с которой выдавать ответ. По-умолчанию — 0.:* '''limitcount'''- Задает количество записей результата, которые нужно вернуть. По-умолчанию — 100.:* '''countall''' — YES указывает на необходимость подсчета общего количества найденных совпадений. Это может замедлять выполнение запроса. Если отключено — в ответе не указываeтся totalcount.  '''Пример ответа справочника пунктов самовывоза:'''<source lang="xml"><?xml version="1.0" encoding="UTF-8" ?><pvzlist count="2" totalcount="40465"> <pvz> <code>126</code> <clientcode>3</clientcode> <name>Нижний Тагил</name> <parentcode>6</parentcode> <parentname>Интеграция</parentname> <town code="124267" regioncode="66" regionname="Свердловская область">Нижний Тагил город</town> <address>622036, г. Нижний Тагил, ул. Циолковского, д. 17</address> <phone>+73435417709, +73435254989</phone> <comment>Новый пункт доставки</comment> <worktime>Вс 10:00-16:00, Сб 10:00-16:00, Пн-Пт 10:00-20:00</worktime> <traveldescription>Жилое 5-ти этажное здание, торцом к дороге, второе здание от перекрестка Пархоменко-Циолковского</traveldescription> <maxweight>10</maxweight> <acceptcash>YES</acceptcash> <acceptcard>YES</acceptcard> <acceptfitting>YES</acceptfitting> <acceptindividuals>YES</acceptindividuals> <latitude>57.93457</latitude> <longitude>59.95131</longitude> <uid>40606d00-9c51-11eb-b2c9-cfd6c1111392</uid> </pvz> <pvz> <code>245</code> <clientcode>NTG1</clientcode> <name>На Красноармейской</name> <parentcode>6</parentcode> <parentname>Интеграция</parentname> <town code="124267" regioncode="66" regionname="Свердловская область">Нижний Тагил город</town> <address>КРАСНОАРМЕЙСКАЯ, д.79</address> <phone>+7(3435)379-044</phone> <comment>Возможность примерки отсутствует</comment> <worktime>Вс 10:00-16:00, Сб 10:00-16:00, Пн-Пт 10:00-20:00</worktime> <traveldescription>Напротив ТЦ Пирамида</traveldescription> <maxweight>20</maxweight> <acceptcash>YES</acceptcash> <acceptcard>YES</acceptcard> <acceptfitting>NO</acceptfitting> <acceptindividuals>YES</acceptindividuals> <latitude>57.93468</latitude> <longitude>60.55476</longitude> <uid>41116853-9c51-11eb-b2c9-cfd6c1451392</uid> </pvz></pvzlist></source> * '''code''' — Код ПВЗ в системе. Используется в запросе [[API#Оформление заказа|оформления заказов]]* '''clientcode''' — Код ПВЗ используемый компанией-подрядчиком.* '''name''' — Наименование ПВЗ.* '''parentcode''' — Код родительского элемента.* '''parentname''' — Наименование родительского элемента.* '''town''' — Населенный пункт с кодом из [[#Справочник городов|справочника городов]], а также с кодом и наименованием региона.* '''address''' — Адрес ПВЗ.* '''phone''' — Телефоны ПВЗ.* '''comment''' — Дополнительная информация.* '''worktime''' — Режим работы ПВЗ.* '''traveldescription''' — Описание местонахождения ПВЗ или пути к нему.* '''maxweight''' — Максимальный вес, с которым работает ПВЗ.* '''acceptcash''' — Признак приема наличных* '''acceptcard''' — Признак приема банковских карт* '''acceptfitting''' — Наличие примерки* '''latitude''' — Широта* '''longitude''' — Долгота* '''uid''' — Уникальный идентификатор ПВЗ в системе Measoft. Создается автоматически при получении данных о ПВЗ от агентов.* '''count''' — Количество записей в ответе* '''totalcount''' — Общее количество записей, отвечающее параметрам запроса == Получение фискальных данных заказа =='''Пример запроса получения фискальных данных:'''<source lang="xml"><?xml version="1.0" encoding="UTF-8"?><receiptdata> <auth extra="8" login="login" pass="pass" /> <orders> <order orderno="123456" /> <order orderno="890111C" /> </orders></receiptdata>  </source> '''Пример ответа получения фискальных данных:'''<source lang="xml">  <?xml version="1.0" encoding="UTF-8"?><receipts count="1"> <receipt> <orderno>123456</orderno> <fdDatetime>2020-06-07 12:14:00</fdDatetime> <fdValue>123</fdValue> <fdNum>456</fdNum> <fnSn>789</fnSn> <kktNum>100</kktNum> <inn>222</inn> <ofdUrl>gate.ofd.ru</ofdUrl> <fullUrl>https://check.ofd.ru/123</fullUrl> <price>12345</price> <payType>2</payType> <lines count="1"> <line> <item>1111764</item> <name>Сапоги</name> <extcode>27113415</extcode> <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''' — Сумма чека* '''paytype''' — Тип оплаты чека. Принимает значения::* CASH — Наличными (по-умолчанию):* CARD — Безналичным способом* '''fullUrl''' — URL чека для просмотра онлайн* '''lines''' — Позиции чека:* '''item''' — код товара:* '''name''' — наименование товара:* '''extcode''' — код товара во внешних системах:* '''qty''' — количество товара:* '''price''' — цена товара:* '''governmentCode''' — считанная последовательность, которая в дальнейшем преобразуется по алгоритму тега 1162:* '''vatRate''' — НДС товара:* '''itemType''' — тип товара (товар, доставка и т. д.) == Справочник Виды срочности =='''Пример запроса видов срочности:'''<source lang="xml"><?xml version="1.0" encoding="UTF-8" ?><services><auth extra="8"/></services></source> '''Пример ответа справочника видов срочности:'''<source lang="xml"><?xml version="1.0" encoding="UTF-8" ?><services count="2"> <service> <code>1</code> <name>Эконом</name> </service> <service> <code>2</code> <name>Срочно</name> </service></services></source> == Справочник дополнительных услуг =='''Пример запроса дополнительных услуг:'''<source lang="xml"><?xml version="1.0" encoding="UTF-8"?><advprices> <auth extra="8" login="login" pass="pass" /></advprices></source> '''advprices''' — Корневой контейнер. Обязательный элемент.  '''Пример ответа справочника дополнительных услуг:'''<source lang="xml"><?xml version="1.0" encoding="UTF-8" ?><advprices> <advprice> <code>1</code> <name>Этажей в доме</name> <type>int</type> </advprice> <advprice> <code>2</code> <name>Коэффициент надбавки</name> <type>float</type> </advprice> <advprice> <code>3</code> <name>Расписаться на упаковке</name> <type>bool</type> </advprice></advprices></source> Параметры:* '''code''' — внутренний код услуги* '''name''' — наименование услуги. Если поле «название в ЛК» в настройках услуги не пусто, то возвращает значение поля «название в ЛК».* '''hine''' — подсказка по доп услуге для пользователя* '''type''' — тип услуги. Может иметь значения::* '''bool''' — для услуг вида «чекбокс», «Да»:* '''float''' — для числа с плавающей точкой:* '''int''' — для целого числа == Расчет стоимости доставки =='''Пример запроса стоимости доставки:'''<source lang="xml"><?xml version="1.0" encoding="UTF-8" ?><calculator> <auth extra="8" login="login" pass="pass" /> <order> <pricetype>CUSTOMER</pricetype> <sender> <town>Санкт-Петербург</town> <address>Петровка 38 офис 35</address> <coords lat="55.680327" lon="37.604456"></coords> </sender> <receiver> <zipcode>125480</zipcode> <town regioncode="78" country="RU">Санкт-Петербург</town> <address>Петровка 38 офис 35</address> <pvz>124</pvz> <coords lat="55.680327" lon="37.604456"></coords> </receiver> <weight>5.1</weight> <service>2</service> <paytype>CASH</paytype> <price>387.5</price> <deliveryprice>150</deliveryprice> <inshprice>387.5</inshprice> <packages> <package mass="1" quantity="5"></package> <package mass="2.5" length="10" width="20" height="30"></package> </packages> <userid>user123</userid> <groupid>customer</groupid> </order></calculator></source>  Параметры:Структура данных и заполнение полей аналогичны и совместимы с [[#Оформление заказа]]. Дополнительные поля:* '''pricetype''' — тип требуемой цены. Возможные значения: «CUSTOMER» (по-умолчанию) — [[Личный кабинет клиента#Цена доставки для получателя|цена для конечного получателя]], «CLIENT» — цена курьерской службы для клиента.* '''userid''' — Идентификатор пользователя, строковый или числовой тип. Виртуальное поле. Необязательное. Данное поле используется совместно с настройками «Цена доставки для получателя», определяя приоритет правила. Можно использовать в различных CMS/CRM системах, настраивая цены для определенного покупателя.* '''groupid''' — Идентификатор группы пользователя, строковый или числовой тип. Виртуальное поле. Необязательное. Данное поле используется совместно с настройками «Цена доставки для получателя», определяя приоритет правила. Можно использовать в различных CMS/CRM системах, настраивая цены для определенной группы покупателей. Суммы НП и ОЦ, а также тип оплаты CARD имеют значение при настроенных в тарифе на вкладке Прочее долях (в процентах) от данных сумм. В авторизации можно опустить параметры login и pass, тогда расчет будет производиться по стандартному тарифу курьерской службы, без учета возможных отличий для конкретного клиента.<br>Объемный вес будет учитываться только при условии указания всех габаритов: длины, ширины и высоты.<br>В полях город-отправитель и город-получатель можно указывать название города (не рекомендуется!), либо код города из нашего справочника, либо 13-ти значный код КЛАДР, либо 36-ти значный код адресной системы ФИАС (AOID).  '''Пример ответа стоимости доставки:'''<source lang="xml"><?xml version="1.0" encoding="UTF-8"?><calculator> <calc> <townfrom code="1">Москва город</townfrom> <townto code="56603">Иркутск город</townto> <mass>3.7</mass> <service name="Экспресс">1</service> <zone>2</zone> <price>1113</price> <mindeliverydays>1</mindeliverydays> <maxdeliverydays>3</maxdeliverydays> <mindeliverydate>2020-05-13</mindeliverydate> <intervals> <workdays> <interval>10:00-16:00</interval> <interval>16:00-22:00</interval> </workdays> <holidays> <interval>12:00-16:00</interval> </holidays> </intervals> <deliveryprice> <advprice code="1" price="1000">База</advprice> <advprice code="4" price="100">Процент от суммы руб</advprice> <advprice code="5" price="63">Процент от объявленной стоимости</advprice> <advprice code="6" price="-50">Скидка при доставке</advprice> </deliveryprice> </calc></calculator></source> Параметры:* '''townfrom''' — Город-отправитель так, как система его распознала и привязала к справочнику. Атрибут '''code''' — код из справочника городов системы.* '''townto''' — Город-получатель так, как система его распознала и привязала к справочнику. Атрибут '''code''' — код из справочника городов системы.* '''mass''' — Масса в килограммах* '''service''' — Режим доставки — число, указывающее на запись в справочнике видов срочности (см описание на этой странице).* '''zone''' — номер тарифной зоны, по которой рассчиталась стоимость. В зависимости от зоны выбирается тарифная сетка. Так же к цене могут применяться повышающие или понижающие коэффициенты при доставке не из/в региональный центр.* '''price''' — рассчитанная стоимость доставки в валюте прайс-листа курьерской службы. Рекомендуется к использованию в отличие от одноименного атрибута родительского контейнера.* '''maxdeliverydays''' — максимальный срок доставки в рабочих днях.* '''mindeliverydate''' — минимальная дата доставки в учетом выходных дней.* '''intervals''' — список интервалов доставки для соответствующей зоны и режима срочности.* '''deliveryprice''' — Данные по составляющим ценам доставки '''''Обратите внимание:''''' В реальном ответе сервера в теге calc присутствует атрибут «price». Он оставлен для обратной совместимости, не используйте его. Пользуйтесь вложенным тегом price. === Коды и описание ошибок ==={|class=wikitable!Код ошибки!Английское описание!Русское описание!Примечание|-|15||tarif not found||Тариф не найден||Ошибка получения тарифов: для клиента не указан тариф|-|19||field [town to] cannot be empty||Поле [город получателя] не может быть пустым||Необходимо указать город получателя или ПВЗ|-|20||field [weight] is incorrect||Некорректное значение [масса]||Значение массы некорректное, например, не является числом. Его необходимо исправить|-|21||town from not found||Город отправителя не найден||Системе не удалось найти указанный населенный пункт отправителя|-|22||town to not found||Город получателя не найден||Системе не удалось найти указанный населенный пункт отправителя|-|23||field [weight] cannot be empty||Поле [масса] не может быть пустым||Необходимо указать значение массы отправления, поле [weight]|-|36||subtown not found||Город в регионе не найден||Не настроено направление доставки до города в регионе: не добавлен регион или указанный город отсутствует в списке региона|-|37||zoneprice not found||Тариф зоны не найден||Отсутствуют зоны тарификации или для них не указаны стоимости|-|38||tarif not found - 1||Тариф не найден 1||Результаты расчета отсутствуют: общая ошибка в случае, если других ошибок нет, но результат пустой |-|39||tarif not found - 2||Тариф не найден 2||Ошибка получения тарифов: для клиента не настроен тариф или тарификация от количества заказов|-|82||field [weight] exceeded limit PVZ||Значение [weight] превышает ограничение ПВЗ||Указанное значение массы больше, чем максимально допустимое для указанного ПВЗ|-|83||attribute [paytype] not allowed PVZ||Значение [paytype] не допустимо для ПВЗ||В ПВЗ не допустим указанный тип оплаты|-|} == Получение информации о клиенте =='''Пример запроса получения информации о клиенте:'''<source lang="xml"><?xml version="1.0" encoding="UTF-8" ?><client> <auth extra="8" login="login" pass="pass" /> </client></source> '''client''' — Корневой контейнер. Обязательный элемент.* '''auth''' — Авторизация. Обязательный элемент. '''Пример ответа на запрос получения информации о клиенте:'''<source lang="xml"><?xml version="1.0" encoding="UTF-8" ?><client> <code>1082</code></client></source> * '''code''' — Код клиента == Список актов передачи денег =='''Пример запроса списка актов передачи денег:'''<source lang="xml"><?xml version="1.0" encoding="UTF-8" ?><smalist> <auth extra="8" login="login" pass="pass" /> <datefrom>2016-02-10</datefrom> <dateto>2016-03-10</dateto></smalist></source> '''smalist''' — Корневой контейнер. Обязательный элемент.* '''auth''' — Авторизация. Обязательный элемент.* '''datefrom''' — Дата «с». Необязательный элемент.* '''dateto''' — Дата «по». Необязательный элемент.Если интервал дат не указан, то возвращаются акты передачи денег за последний месяц. '''Пример ответа на запрос списка актов передачи денег:'''<source lang="xml"><?xml version="1.0" encoding="UTF-8"?><smalist count="1"> <sma> <code>6278</code> <number>3992</number> <actdate>2016-02-12</actdate> <datepay></datepay> <dateto>2016-02-12</dateto> <promiseddatepay></promiseddatepay> <price>637.00</price> <pricecorr>113.00</pricecorr> <rur>13430.00</rur> <pricekur>570.00</pricekur> <priceag>67.00</priceag> <payno>42423</payno> <paytype>1</paytype> <paytypename>Безнал</paytypename> <signedcopyreceived>NO</signedcopyreceived> </sma></smalist></source> * '''code''' — Код акта* '''number''' — Номер акта в системе* '''actdate''' — Дата акта* '''datepay''' — Дата оплаты по акту* '''dateto''' — Дата конечного периода для формирования АПД* '''promiseddatepay''' — Плановая дата оплаты* '''price''' — Стоимость услуг* '''pricecorr''' — Сумма корректировки* '''rur''' — Сумма заказа* '''pricekur''' — Стоимость курьерской доставки* '''priceag''' — Агентское вознаграждение* '''payno''' — Номер платежного поручения* '''paytype''' — Тип оплаты: 1 — безнал, 2 — наличными курьером, 3 — наличными в офисе, 4 — перевод на карту* '''paytypename''' — Строковое представление типа оплаты* '''signedcopyreceived''' — Признак факта возврата акта YES/NO == Детализация актов передачи денег =='''Пример запроса детализации актов передачи денег:'''<source lang="xml"><?xml version="1.0" encoding="UTF-8" ?><smadetail> <auth extra="8" login="login" pass="pass" /> <code>6278</code></smadetail></source> '''smadetail''' — Корневой контейнер. Обязательный элемент.* '''auth''' — Авторизация. Обязательный элемент.* '''code''' — Код акта передачи денег (см. запрос списка АПД). Обязательный элемент. '''Пример ответа на запрос детализации актов передачи денег:'''<source lang="xml"><?xml version="1.0" encoding="UTF-8"?><smadetail count="2"> <specialsma> <code>42494</code> <ordercode>14424</ordercode> <orderno>11111</orderno> <orderdate>2018-01-01</orderdate> <delivereddate>2018-10-01</delivereddate> <company>Компания</company> <price>314.00</price> <rur>8800.00</rur> <inshprice>314.00</inshprice> <pricekur>270.00</pricekur> <priceag>44.00</priceag> <pricecalc>8486.00</pricecalc> <paytype>2</paytype> <paytypename>наличными курьером</paytypename> <weight>0.400</weight> <distance>0.0</distance> <status>Доставлено</status> </specialsma></smadetail></source> * '''code''' — Код записи.* '''ordercode''' — Код заказа.* '''orderno''' — Шифр заказа.* '''orderdate''' — Дата заказа.* '''delivereddate''' — Дата доставки.* '''company''' — Получатель.* '''price''' — Стоимость услуг.* '''rur''' — Сумма заказа.* '''inshprice''' — Стоимость заказа.* '''pricekur''' — Стоимость курьерской доставки.* '''priceag''' — Агентское вознаграждение.* '''pricecalc''' — Сумма для передачи агенту.* '''paytype''' — Тип оплаты: 1 — безнал, 2 — наличными курьером, 3 — наличными в офисе, 4 — перевод на карту.* '''paytypename''' — Строковое представление типа оплаты* '''weight''' — Вес заказа.* '''distance''' — Дистанция по заказу* '''status''' — Статус заказа. == Установка статуса согласования заказа ==Для возможности клиентом установки статуса согласования заказа необходимо включить переменную [[Личный кабинет курьерской службы#Заказы|Разрешить менять статус согласования]] '''Пример запроса установки статуса согласования заказа'''<source lang="xml"><?xml version="1.0" encoding="UTF-8"?><setapprovalstatus> <auth extra="8" login="login" pass="pass" /> <order ordercode="1234561"> <confirmstate>1</confirmstate> <message>Сообщение статуса</message> </order> <order ordercode="1234562"> <confirmstate>2</confirmstate> <message>Согласовано</message> </order> <order ordercode="1234563"> <confirmstate>3</confirmstate> <message>Не согласовано</message> </order></setapprovalstatus></source> * '''order''' — Контейнер заказа. Обязателен как минимум один элемент.:* '''ordercode''' — Внутренний код заказа.* '''confirmstate''' — Код статуса заказа. Все статусы с кодами можно получить запросом [[#Получение списка статусов согласования заказа|Получение списка статусов согласования заказа]]* '''message''' — Дополнительный комментарий, который отобразится в поле ''Инфо о доставке''. == Получение списка статусов согласования заказа =='''Пример запроса списка статусов согласования заказа'''<source lang="xml"><?xml version="1.0" encoding="UTF-8"?><approvalstatuses> <auth extra="8" login="login" pass="pass" /></approvalstatuses></source> '''Пример ответа списка статусов согласования заказа'''<source lang="xml"><?xml version="1.0" encoding="UTF-8" ?><approvalstatuses count="6"> <status> <code>1</code> <name>Неизвестно</name> </status> <status> <code>2</code> <name>Согласование запрошено</name> </status> <status> <code>3</code> <name>Доставка полностью согласована</name> </status> <status> <code>4</code> <name>Согласовано с изменением времени</name> </status> <status> <code>5</code> <name>Перенос на другую дату</name> </status> <status> <code>6</code> <name>Отказ</name> </status></approvalstatuses></source> == Генерация коротких ссылок ==В некоторых случаях, например, при использовании в СМС, может потребоваться использование коротких ссылок на ЛК.Для этого, необходимо отправить запрос с полной ссылкой, в ответ на который придёт хэш-код для ссылки. '''Пример запроса генерации коротких ссылок:'''<source lang="xml"><?xml version="1.0" encoding="UTF-8" ?><shortlink> <link short="0"> https://home.courierexe.ru/8/site/orders </link></shortlink></source> '''shortlink''' — Корневой контейнер. Обязательный элемент.* '''link''' — Полная ссылка, для которой необходимо получить код. Обязательный элемент. Если атрибут '''short''' равен 1, то ответ не будет содержать XML, а только хэш-код. '''Пример ответа на запрос генерации коротких ссылок:'''<source lang="xml"><?xml version="1.0" encoding="UTF-8"?><shortlink> <hash>35AF350C</hash></shortlink></source> * '''hash''' — Хэш-код ссылки. Далее, можно использовать ссылку на ЛК: <nowiki>https://home.courierexe.ru/35AF350C или curie.ru/35AF350C</nowiki>  '''Примечание!''' Сервис коротких ссылок работает только для ресурсов компании MeaSoft. == Проверка надежности покупателя ==Проверка надежности работает только для тарифа «Максимум» личного кабинета. <source lang="xml"><?xml version="1.0" encoding="UTF-8" ?><mcheck> <auth extra="8" login="login" pass="pass" /> <phones> <phone>89161147992</phone> </phones></mcheck></source> Ответ: <source lang="xml"><?xml version="1.0" encoding="UTF-8" ?><mcheck> <phones> <phone rate="90">89161147992</phone> </phones></mcheck></source>  == Размещение страниц на своем сайте (iframe) == В некоторых случаях имеет смысл разметить те или иные страницы на своем сайте. Например, чтобы клиенты могли рассчитать стоимость доставки не переходя по внешней ссылке, а там же, на сайте, калькулятор можно разместить прямо на странице такого сайта посредством так называемого фрейма — '''iframe'''. [https://ya.ru/search/?text=iframe Фрейм] — контейнер внутри обычной страницы, который позволяет загружать сторонние страницы. Пример загрузки калькулятора: <source lang="html"><iframe id="frame" src="https://home.courierexe.ru/8/calculator"> Здесь должен отобразиться калькулятор</iframe></source> Для удобства пользователей вашего сайта можно указать язык интерфейса (который переключается непосредственно на сайте) параметром '''lang''': <source lang="html"><iframe id="frame" src="https://home.courierexe.ru/8/calculator?lang=2"> Здесь должен отобразиться калькулятор</iframe></source>  <div style="color: #a94442; background-color: #f2dede; border: 1px solid #ebccd1; padding: 3px 10px 10px;">'''Обратите внимание!'''# При использовании iFrame могут не работать некоторые функции, например, подписка на push-уведомления на странице трекинга или отслеживания.# Если язык не указать, то на страницах калькулятора и трекинга отображается свой переключатель языка. Если язык указан, то переключатель не отображается. Поддерживаемые языки и их коды::'''1''' — русский:'''2''' — английский:'''4''' — узбекский</div> == Оформление манифеста == '''Пример запроса на создание манифеста:'''<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> <sentdate>2024-11-07</sentdate> <places> <place> <number>1</number> <seal>7890AABBB</seal> </place> <place> <number>2</number> <seal>123456ABC</seal> </place> </places> <addresses> <address> <code>12345</code> <place>1</place> </address> <address> <code>67890</code> <place>2</place> </address> </addresses></manifest></source>  '''manifest''' - Корневой контейнер. Обязательный элемент.*'''auth''' - Авторизация. Обязательный элемент.*'''store_from''' - код филиала отправителя. Обязательный элемент.*'''store_to''' - код филиала получателя. Обязательный элемент.*'''trn_code''' - код перевозчика. Обязательный элемент.*'''sentdate''' - дата отправки манифеста. Не обязательный элемент.*'''addresses''' - корневой элемент для списка заказов.*:'''address''' - корневой элемент для заказа.*::'''code''' - наш внутренний номер заказа. Обязательный элемент.*::'''place''' - номер места заказа. Обязательный элемент, если переданы места.*'''places''' - корневой элемент для списка мест.*::'''place''' - корневой элемент для места.*::'''number''' - номер места. Обязательный элемент.*::'''seal''' - номер пломбы. Необязательный элемент.  '''Пример успешного ответа'''<source lang="xml"><?xml version="1.0" encoding="UTF-8"?><manifest> <result>OK</result></manifest></source>  '''Пример ответа на запрос генерации коротких ссылок:с ошибкой'''

<shortlinkmanifest> <hashresult error="Текст ошибки">35AF350CERROR</hashresult></shortlinkmanifest>

*'''hashmanifest''' - Хэш-код ссылкиКорневой контейнер. Обязательный элемент. Далее, можно использовать ссылку на ЛК: <nowiki>https://home.courierexe*'''result ''' - Результат.ru/35AF350C Принимает значения OK или curieERROR.ru/35AF350C</nowiki>  *'''Примечание!error''' Сервис коротких ссылок работает только для ресурсов компании MeaSoft- атрибут с текстом ошибки, если она была.