Изменения

<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;"|[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;"|[httphttps://courierexe.ru/download/api/prestashop.zip Скачать]|Поддерживает версии 1.5.2.0 и выше (2.x Инструкция в том числе!)архиве

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

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

<!--|[[Файл:advantshop.png|center|x44px]]

|Компания PROMO разработала этот модуль и настраивает интеграцию КС 2008 MeaSoft с ADVANTSHOP своим клиентам.|- -->|[[Файл:insales.png|center|x80px]]|style="text-align: center;"|Настраивается в [[Личный кабинет клиента|ЛК пользователя]]|[[InSales|Инструкция по настройке]]

|[[Файл:insalesiiko.pngjpg|center|x44pxx80px]]|style="text-align: center;"|Настраивается в [[http://www.insales.ru/collection/all/product/kurierskaya-sluzhba-2008 УстановитьЛичный кабинет клиента|ЛК пользователя]]|[http://wiki.courierexe.ru/index.php?title=Интеграция_с_другими_системами#Insales Настраивается[Iiko|Инструкция по настройке]] в ЛК пользователя в системе

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

|[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;"|[httphttps://courierexe.ru/download/api/com_measoft.zip Скачать]|Работает только с компонентом Virtuemart. Внимание! Модуль новый, поэтому возможна некорректная передача данных. Проверяйте, если что - сообщайте, исправим!Инструкция в архиве

|Внимание! Модуль новый, поэтому возможна некорректная передача данныхПодробнее см. [[amoCRM|описание]]. Проверяйте, если что - сообщайте, исправим!

|rowspan="2"|[[Файл:MoySclad.jpg|center|x44pxx30px]]|style="height:50px; text-align: center;"|[https://home.courierexe.ru/moysklad/step1 ПодключениеНастроить интеграцию с MeaSoft] |[[Интеграция с другими системами#Мой СкладМойСклад|Инструкция]]|-|style="height:50px; text-align: center;"|[https://itmdev.ru/ms/shipping/ Скачать модуль сторонних разработчиков]|Интеграция МойСклад с курьерскими службами от сторонних разработчиков

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

'''Обратите внимание!''' В модулях систем PrestaShop и Joomla для отправки заказа в курьерскую службу зайдите в карточку заказа. В карточке отображается специальная форма отправки заказа, а если заказ отправлен, она позволяет проверить его статус:[[Файл:Form.png|150 400 px|мини|Форма отправки заказа|none]]

'''Обратите внимание!''' В модулях систем '''PrestaShop''', '''OpenCart''', '''OCStore''', '''Webasyst''', '''InSales''' и '''Joomla''' для отправки заказа в курьерскую службу необходимо зайти в карточку заказа, в которой должна отображаться форма (смДля отображения списка пунктов выдачи есть [https://home. изображение)courierexe. Форма позволяет отправить заказ, а если заказ отправлен - проверить его статусru/js/measoft_map.js JavaScript модуль]. Инструкция по использованию — внутри. Посмотреть пример работы можно [https://home.courierexe.ru/pvz_test.html здесь].

Для отображения списка пунктов выдачи есть На вкладке '''готовый JavaScript модульИнтеграция''': https://home> '''Отладка''' вы можете пробовать выполнять запросы к API для отладки, а также видеть историю отправленных запросов.courierexe.ru/js/measoft_map.js Инструкция по использованию - внутри. Посмотреть пример работы можно [https://home.courierexe.ru/pvz_testСозданные заказы появятся в пункте основного меню '''Отслеживание'''.html Здесь]

Данные модули распространяются бесплатно, без каких-либо гарантий со стороны разработчикаДля упрощения интеграции можно скачать [https://courierexe. Их наличие не нужно рассматривать как средство полной автоматизации взаимодействия с курьерской службой, а скорее как помощь разработчикам интернет-магазинов в построении интеграции с курьерскими службамиru/download/api/php_sample. В любом случае нужно понимать, что ответственность за корректность передачи данных лежит zip пример обращения к сервису на интернет-магазине. Однако, мы будем очень признательны, если Вы будете нам сообщать о своих потребностях и/или найденных неточностях в наших модулях, это позволит нам учитывать пожелания в новых версияхPHP].

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

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

Для упрощения интеграции можно скачать [httpОписание параметров://courierexe* '''extra''' — экстра-код, уникальный идентификатор компании, с которой вы интегрируетесь.ru/download/api/php_sample.zip пример обращения к сервису на PHP]* '''login''' — логин клиента;* '''pass''' — пароль клиента;* '''measoftid''' — системная переменная, используемая системой.

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

1. <source lang=xml><auth extra="8" login="login" pass="pass" clientcode="123"></auth></source> Описание:* '''Параметр 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="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>

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

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

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

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

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

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

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

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

* '''deliveryset''' - настройка [[Дифференциальная стоимость доставки | дифференциальной стоимости доставки]]. Атрибуты::* '''''above_price''''' - стоимость в случае полного выкупа заказа (действует как Тэг 1262 – идентификатор ФОИВ = "сумма от020" последней границы, указанной в теге below_sum(константа ФОИВ МИНЗДРАВа):* '''''return_price''''' - стоимость в случае возврата заказа

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

* '''advprices''' - Контейнер для описания дополнительных услуг. Необязательный:* '''''code''''' - код услуги:* '''''value''''' Тэг 1264 - значение услуги. Если тип услуги bool, то в значении передаем trueномер нормативного акта федерального органа исполнительной власти = "1556"(константа)

В случае необходимости указания<source lang="json">"item_industry_props":{"tag1262":"020", помимо товаров, дополнительных услуг (например"tag1263":"14.12.2018", ДОСТАВКА"tag1264":"1556", комплектация"tag1265":"tm=mdlp&sid=00000000XXXXXX"}, подъем на этаж и т.д.) - их нужно указать в том же контейнере items как товары, без артикула."tag1212": "1"</source>

 * '''packages''' — Контейнер для описания мест. Необязательный контейнер. Атрибуты::* '''''package''''' — Название места.:* '''''code''''' — Внутренний код строки.:* '''''strbarcode''''' — Штрихкод места.:* '''''mass''''' — Масса места в килограммах.:* '''''message''''' — Строка сообщения.:* '''''length''''' — Длина товарного места (в сантиметрах).:* '''''width''''' — Ширина товарного места (в сантиметрах).:* '''''height''''' — Высота товарного места (в сантиметрах).:* '''''quantity''''' — Количество мест с данным набором параметров. Действует ограничение на общее количество мест в заказе. Общее количество мест в заказе не может быть больше 1000. * '''deliveryset''' — настройка [[Дифференцированная стоимость доставки|дифференцированной стоимости доставки]]. Атрибуты::* '''''above_price''''' — стоимость в случае полного выкупа заказа (действует как «сумма от» последней границы, указанной в теге below_sum):* '''''return_price''''' — стоимость в случае возврата заказа:* '''''VATrate''''' — Ставка НДС — целое число процентов. * '''below''' — граница стоимости настроек:* '''''below_sum''''' — граница стоимости выкупаемого заказа:* '''''price''''' — стоимость выкупаемого заказа до соответствующей границы * '''advprices''' — Контейнер для описания дополнительных услуг. Необязательный элемент. <span style="color: red;>Для обработки в API включите дополнительные услуги в настройках полей [[Личный кабинет курьерской службы#Настройка личного кабинета клиента|заказов и заборов]]</span>:* '''''code''''' — код услуги.:* '''''value''''' — значение услуги. Если тип услуги bool, то в значении передаем true. * '''overall_volume''' — Общий объем, м3. Виртуальное поле. Необязательное. Из этого поля рассчитывается длина/высота/ширина места. Расчет срабатывает только если в каждом месте есть нулевые значения длины или высоты или ширины. * '''userid''' — Идентификатор пользователя, строковый или числовой тип. Виртуальное поле. Необязательное. Данное поле используется совместно с настройками «Цена доставки для получателя», определяя приоритет правила. Можно использовать в различных CMS/CRM системах, настраивая цены для определенного покупателя. * '''groupid''' — Идентификатор группы пользователя, строковый или числовой тип. Виртуальное поле. Необязательное. Данное поле используется совместно с настройками «Цена доставки для получателя», определяя приоритет правила. Можно использовать в различных CMS/CRM системах, настраивая цены для определенной группы покупателей. <div style="color: #a94442; background-color: #f2dede; border: 1px solid #ebccd1; padding: 3px 10px 10px;">'''Обратите внимание!'''При передаче заказов, у которых плановая дата доставки/забора меньше ближайшей возможной, дата автоматически меняется на самую раннюю возможную. [[Личный кабинет курьерской службы#Как считается минимальная дата возможной доставки|Подробнее]]</div>  В случае необходимости указания, помимо товаров, дополнительных услуг (например, ДОСТАВКА, комплектация, подъем на этаж и т. д.) — их нужно указать в том же контейнере items как товары, без артикула. === Примеры ответов ===При успешном выполнении запроса, создании заказа, возвращается сумма заказа в атрибуте orderprice, а также ошибка 0. При не успешном - успешном — номер ошибки и текст ее на английском языке в атрибуте errormsg, для некоторых ошибок выводится перевод на русский в атрибуте errormsgru.В атрибут orderno помещается номер заказа, в атрибут barcode — штрихкод заказа.

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

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

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

'''Пример ответа если нет == Запрос статуса заказов'''==

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

=== Описание полей запроса статуса ==='''Пример ответа statusreq''' — Корневой контейнер. Обязательный элемент.* '''auth''' — Авторизация. Обязательный элемент.* '''client''' — Признак клиента или агента. Необязательный элемент.:* CLIENT — Признак клиента, значение по умолчанию:* AGENT — Признак агента. В ответ отдается информация по заказам, переданным агенту на доставку* '''orderno''' — Идентификатор заказа у клиента (шифр). Необязательный элемент.* '''ordercode''' — Внутренний код заказа. Необязательный элемент.* '''orderno2''' — Номер заказа из срочных. Необязательный элемент. * '''uid''' — Уникальный идентификатор, если он был добавлен при ошибке авторизациисоздании заказа. Необязательный элемент. Запрос информации по uid возможен в течении суток после создания заказа* '''datefrom''' — Дата заказа «с». Необязательный элемент.* '''dateto''' — Дата заказа «по». Необязательный элемент.* '''target''' — Строка поиска. Позволяет указать текст, который содержится в названии компании или адресе получателя.* '''done''' — Может принимать значения::* ONLY_DONE — Только доставленные (имеются в виду успешные статусы, например, '''Доставлен''' или '''Частично доставлен'''):* ONLY_NOT_DONE — Только не доставленные (заказы, которые не являются доставленными, например, '''Не доставлен''' или '''Утерян'''):* ONLY_NEW — Только новые:* ONLY_DELIVERY — Только заказы в обработке — заказы, находящиеся в любом статусе, кроме конечных: Доставлено, Не доставлено, Отменён и т. д.:* ''Пусто'' — все корреспонденции * '''changes''' — может принимать значение только ONLY_LAST. Если указан этот параметр, все остальные игнорируются. Описание данного режима приведено здесь: [[#Передача только изменившихся статусов|Передача только изменившихся статусов]] * '''conditions''' — Задает условия фильтрации по «orderno». Все вложенные элементы одновременно накладывают условие «И». Минимум 5 символов!:* '''namecontains''' — Поиск по номеру заказа(шифр), который содержит «orderno».:* '''namestarts''' — Поиск по номеру заказа(шифр), который начинается с «orderno».

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

<requeststatusreq count="23"> <order orderno="111111" awb="qwerty" orderno2="123123" ordercode="34534234" givencode="2345334"> <barcode>111111</barcode> <errorsender> <company>column:1 line:11 message:expected 'МВД</company> <person>'Иванов И.И.</errorperson> <phone>123-45-67</requestphone> <contacts> <phone>+74951234567</sourcephone> </contacts> <town code=== Описание полей ответа статусов ==="23432">Санкт-Петербург</town>Все поля ответа соответствуют структуре order при создании заказа, с некоторыми добавлениями: <address>Петровка 38 офис 35</address> <date>2014-03-22</date>* Атрибуты контейнера '''order''' <time_min>09:00</time_min> <time_max>14:* '''''awb''''' - Номер накладной в системе курьерской службы00</time_max> </sender> <receiver> <company>МВД</company> <person>Иванов И.И.</person>:* '''''orderno2''''' <phone>123-45-67 - Номер накладной в подсистеме срочной доставки курьерской службыИван (916)234.45.:* '''''ordercode''''' - внутренний код заказа в системе21 Петр, применяется для некоторых внутренних операцийmvd@mail.ru</phone>:* '''''givencode''''' - внутренний код заказа в системе, применяется для некоторых внутренних операций <contacts> <phone>+74951234567</phone> <phone>+79162344521</phone> <email>mvd@mail.ru</email> </contacts> <inn>1112223335</inn> <zipcode>125480</zipcode>* атрибут ''''' <town code''''' контейнера '''item''' ="153361" regioncode="78" regionname="Санкт-Петербург город">Санкт- внутренний код строки заказа в системе, применяется для некоторых внутренних операций.Петербург город</town> <address>Петровка 38 офис 35</address> <area>Район 1</area> <pvz> <code>126</code>:* '''''returns''''' - количество данного товара, от которого отказался получатель. Не нулевое только в случае частичного отказа. <clientcode>QWERTY</clientcode> </pvz>* атрибут '''''got''''' контейнера '''package''' <date>2014-03- признак принятого места YES 22</date> <time_min>09:00</ NO.time_min> <time_max>14:* '''''returns''''' - количество данного товара, от которого отказался получатель00</time_max> <coords lat="55. Не нулевое только в случае частичного отказа680327" lon="37.604456"></coords> <deliveryPIN>1234</deliveryPIN>* '''''coords''''' в контейнере ''' </receiver''' - координаты получателя> <price>387.5</price> <inshprice>387.5</inshprice> <paytype code="1">CASH</paytype>* '''currcoords''' - текущие координаты заказа <weight>5. Атрибуты:1</weight> <quantity>2</quantity> <service>2</service> <type>3</type> <return>NO</return> <return_service>2</service>:* '''''lat''''' - широта <return_type>3</return_type>:* '''''lon''''' - долгота <return_weight>5.1</return_weight>:* '''''accuracy''''' - точность <return_message>Доставлено в метрахцелости</return_message> <pickup>NO</pickup> <print_check>YES</print_check>:* '''''RequestDateTime''''' - дата <waittime>12</время последнего обновления координат.waittime> <enclosure>Детские игрушки</enclosure>* '''courier''' - Данные курьера <instruction>Проверить при покупателе, которому выдан заказподписать акт</instruction> <currcoords lat="55. Если заказ не выдан, то выводятся данные запланированного курьера680327" lon="37.* '''waittime ''' 604456" accuracy="50" RequestDateTime="2014- Время ожидания курьера.* '''deliveryprice''' 04- Стоимость услуг в валюте расчетов с клиентом. Атрибуты21 18:07:45"></currcoords> <courier> <code>26</code>:* ''''' <name>Иванов Владимир Петрович</name> <phone>+79161234567</phone> </courier> <deliveryprice total''''' - общая стоимость услуг:* '''''="158.6" delivery''''' - стоимость доставки ="Туда100.00":* '''''return''''' - стоимость доставки ="Обратно58.6" (если order->return <advprice code="1" price=YES)"150">База</advprice>Тэг '''deliveryprice''' включает список дополнительных услуг (только для тарифа <advprice code="2" price="Премиум0"):>% от объявленной стоимости</advprice>:* ''''' <advprice code="3" price="8.6">Топливный сбор</advprice''''' - наименование дополнительной услуги>:* ''''' <advprice code''''' - код дополнительной услуги="4" price="0">Округление</advprice> </deliveryprice>:* '''''price''''' - стоимость дополнительной услуги <receiverpays>NO</receiverpays> <acceptpartially>NO</acceptpartially>* ''' <status''' eventstore="филиал в Санкт-Петербурге" eventtime="2016-06- статус доставки (список статусов см. ниже). Атрибуты (заполняются начиная с версии системы 2008.0.0.670)02 17:22:* '''''eventstore''''' 00" createtimegmt="2016-06- филиал, к которому относится текущий статус03 16:* '''''eventtime''''' - время события по часовому поясу места его наступления.14:* '''''createtimegmt''''' 44" message="" title="Доставлен" eventtown="Санкт- время по GMT создания записи о смене статуса в БД. Используется для сортировки записей, чтобы соблюсти хронологическую последовательность. <spoiler textПетербург город" color="Подробнее16777215">Большинство событий фиксируются COMPLETE</status> <statushistory> <status eventstore="Офис в полях Москве" eventtime и createtimegmt на основании одного действия, тогда они отличаются только сдвигом от GMT. Однако, если курьер доставил отправление 10.="2016-05-30 10.2010 в 20:00, по какой-то причине не внес это в мобильное приложение, на следующий день сдал накладную, и в 9 утра оператор внесла, что он доставил вчера в 20:00. Тогда в " createtimegmt будет сегодня 6 утра (для Москвы), а в eventtime - вчера в 20:00. При этом оператор по каким="2016-то причинам может внести время вручения раньше, чем какое-то предыдущее событие, т.о. нарушится последовательность времени в eventtime, но при сортировке по createtimegmt все06-равно все будет правильно.</spoiler>03 16:* '''''message''''' - наименование филиала-получателя, при передаче между филиалами14:* '''''title''''' - русское наименование статуса44" * '''statushistory''' - история статусов доставки. Содержит список контейнеров '''status'''. Заполняется только для тарифа message="Премиум" начиная с версии системы 2008.0.0.670.* '''customstatecode''' - код внутреннего статуса курьерской службы. Значения уточняйте в курьерской службе. Назначаются курьерской службой в разделе title="СправочникиНовый" - eventtown="СтатусыМосква город" - country="15 Статусы корреспонденцииRU". Справочник не передается через API клиенту по причине возможного наличия в нем внутренних технологических статусов курьерской службы.* '''clientstatecode''' - код статуса клиента. Используется, если клиент предлагает свои коды статусов доставки>NEW</причин недоставки.status>* '''deliveredto''' - данные о вручении, либо причина недоставки.* '''delivereddate''' <status eventstore="Офис в Москве" eventtime="2016- дата вручения.* '''deliveredtime''' 06- время вручения. В случае недоставки может быть пустым.* '''outstrbarcode''' - код у подрядчика (код заказа во внешней системе). Используется в интеграциях с внешними системами.  Значения контейнеров '''status''' могут принимать следующие значения01 17:38: AWAITING_SYNC 00" createtimegmt="2016- Ожидает синхронизации. Данные заказа пока не появились в бэкофисе: NEW 06- Новый03 16: PICKUP - Забран у отправителя14: ACCEPTED - Получен складом44": INVENTORY - Инвентаризация: DEPARTURING message="филиал в Санкт- Петербурге" title="Планируется отправка" eventtown="Москва город" country="RU">DEPARTURING</status>: DEPARTURE <status eventstore="Офис в Москве" eventtime="2016-06- Отправлено со склада01 19: DELIVERY - Выдан курьеру на доставку53: COURIERDELIVERED 00" createtimegmt="2016- Доставлен (предварительно): COMPLETE 06- Доставлен03 16: PARTIALLY - Доставлен частично14: COURIERRETURN - Возвращено курьером. Курьер не смог доставить до получателя, и вернул заказ обратно на склад. Это промежуточный статус, после которого менеджер выясняет, нужно ли пытаться заново доставить заказ, или это окончательная недоставка.44": CANCELED message="филиал в Санкт- Не доставлен (ВозвратПетербурге" title="Отправлено со склада" eventtown="Москва город" country="RU">DEPARTURE</Отмена)status>: RETURNING <status eventstore="филиал в Санкт-Петербурге" eventtime="2016- Планируется возврат: RETURNED 06- Возвращен02 07: WMSASSEMBLED - Скомплектован на складе41: WMSDISASSEMBLED 00" createtimegmt="2016- Разукомплектован: CONFIRM 06- Согласована доставка03 16: DATECHANGE - Перенос14: NEWPICKUP - Создан забор44": UNCONFIRM message="" title="Получен складом" eventtown="Санкт- Не удалось согласовать доставкуПетербург город" country="RU">ACCEPTED</status>: PICKUPREADY <status eventstore="филиал в Санкт- Готов к выдаче: LOST Петербурге" eventtime="2016- Утрачен/утерян: COURIERPARTIALLY 06- Частично со слов курьера02 09: COURIERCANCELED - Отказ со слов курьера ''Примечание17:'' В будущем возможно расширение и изменение используемого набора статусов. <div style00" createtimegmt="color: #a94442; background2016-06-color03 16: #f2dede; border14: 1px solid #ebccd1; padding: 3px 10px 10px;44">'''Обратите внимание!''' # Атрибуты контейнера '''status''' заполняются для версий системы '''2008.0.0.670''' и новее.# Контейнер '''statushistory''' заполняется для тарифа message="" title="Выдан курьеру на доставку" eventtown="[[Личный_кабинет#.D0.9F.D0.BE.D0.B4.D0.BA.D0.BB.D1.8E.D1.87.D0.B5.D0.BD.D0.B8.D0.B5|Премиум]]Санкт-Петербург город" и версий системы '''2008.0.0.670''' и новее.# Контейнер '''deliveryprice''' заполняется для тарифа country="[[Личный_кабинет#.D0.9F.D0.BE.D0.B4.D0.BA.D0.BB.D1.8E.D1.87.D0.B5.D0.BD.D0.B8.D0.B5|Премиум]]RU".>DELIVERY</divstatus> <br /> status eventstore="филиал в Санкт-Петербурге" eventtime="2016-06-02 17:22:00" createtimegmt= Передача только изменившихся статусов =="2016-06-03 16:14:44" message=В нашем API предусмотрено очень удобное средство получения статусов всех заказов, без необходимости "бомбить" сервер запросами статусов по каждому заказу. Работает это так: раз в какое-то время, например, в 10 минут, вы посылаете запрос title="А покажите все изменившиеся статусы". Пример запроса ниже. Система вам отдает ВСЕ заказы, статусы Доставлен (или некоторые другие поля, см нижепредварительно) которых изменились с момента последнего запроса. Вы разбираете полученный документ, по каждому заказу сохраняете его актуальный статус в своей системе, и если все хорошо, у вас все получилось, ваша система неожиданно не упала от наплыва информации, посылаете нам запрос подтверждения получения статусов (commitlaststatus). Мы у себя отмечаем, что эти статусы вами получены, и их не надо передавать повторно. Т.о. сколько бы заказов у вас не было, статусы по ним всем почти в реальном времени вы можете получать всего 2" eventtown="Санкт-мя запросами. Для получения только изменившихся статусов отправьте запрос<source langПетербург город" country="xmlRU">COURIERDELIVERED</status> <?xml versionstatus eventstore="филиал в Санкт-Петербурге" eventtime="1.02016-06-02 17:22:00" encodingcreatetimegmt="UTF2016-806-03 16:14:44" ?><statusreq> <auth extra message="" title="8Доставлен" logineventtown="loginСанкт-Петербург город" passcountry="passRU">COMPLETE</authstatus> </statushistory> <customstatecode>2<customstatecode> <changesclientstatecode>ONLY_LAST</changesclientstatecode> <deliveredto>Иванова, секр.</statusreqdeliveredto> <delivereddate>2016-06-02</sourcedelivereddate> Система выдает все заказы, в которых, с момента последнего запроса в этом режиме, изменилось хотя бы одно из полей <deliveredtime>17:22</deliveredtime> orderno <department>Отдел</department> status <costcode>cc12345</costcode> delivereddate <outstrbarcode>EXT123456</outstrbarcode> deliveredtime <respstore>14</respstore> deliveredto <partner>Офис на Ленина</partner> receiver <arrival>2016->date receiver05-02 23:21</arrival>address price После успешной обработки ответа необходимо отметить полученные статусы успешно полученными, отправив запрос <source langreceipt fdNum="xml124555"><?xml versionfnSn="9289000100295555" kktNum="1.00001611984048555" encodinginn="UTF-87722756555" ?><commitlaststatus> <auth extrafdValue="82899551555" loginsumm="login387.5" passofdUrl="passgate.ofd.ru"><https://ofd.ru/rec/7722756555/0001611984048555/9289000100295555/124555/auth> <client>CLIENT2899551555</clientreceipt> </commitlaststatusitems> </source> '''Описание полей запроса''' *'''auth''' - Авторизацияitem code="34533" extcode="abc123" quantity="1" mass="0. Обязательный элемент2" retprice="37.*'''client''' - Признак клиента или агента. Необязательный элемент.:* CLIENT - Признак клиента, значение по умолчанию:* AGENT - Признак агента. В ответ отдается информация по заказам, переданным агенту на доставку В случае успеха Вы получите ответ <source lang5" VATrate="0" barcode="xml2345625213125"><?xml versionarticle="1." returns="0" encodingorigincountry="040" GTD="UTF-8" ?><commitlaststatus errorexcise="0.0" governmentCode="11223311" suppcompany="Поставщик" suppINN="1112223334" suppphone="79161234567">OKМяч</commitlaststatusitem> <item code="34456" extcode="abc124" quantity="2" mass="2" retprice="100" VATrate="10" barcode="4645625213138" article="2" returns="0" governmentCode="">Обруч</sourceitem> Данный способ передачи статусов гарантирует полную корректную передачу статусов, даже в случае, если в нашей системе статус изменился в промежутке времени между запросом статусов и подтверждением их получения. Если система не получила подтверждение успешной передачи статуса, она будет считать информацию не переданной, и выдаст ее при повторном запросе.   <div styleitem code="34421" extcode="color: #a94442; background-color: #f2dede; border: 1px solid #ebccd1; padding: 3px 10px 10px;abc125" quantity=">'''Обратите внимание!''' # При данном способе передачи (<changes>ONLY_LAST</changes>) система просматривает заказы, оформленные за последние 3 месяца" mass="0. Если заказ сделан ранее - изменение статуса по нему не попадет в результат выполнения данного запроса.# Система всегда выдает текущий статус. Т.е. Вы можете одним запросом получить статус 3" retprice="50" VATrate="18" barcode="2345625213126" itemcode="NEW44123", а следующим - article="COMPLETE3". В промежутке между запросами отправление могло пройти через несколько промежуточных статусов. Если нужна гарантия получения всех промежуточных статусов, нужно анализировать блок statushistory (может не заполняться в следствии ограничений версии или тарифа конкретной службы доставки).# Система никогда не гарантирует последовательность прохождения заказом набора статусов. Т.е. Вы можете получить статус returns="COMPLETE0", а следующим запросом - governmentCode="NEW" - такое может произойти, например, если оператор ошибочно отметил заказ выполненным, а затем исправил ошибку.>Погремушка желтая</divitem> <br /items> <packages>  <package code="33331" strbarcode= Трекинг заказа по номеру "ORD0000001" mass="1" message= Запрос трекинга по номеру предназначен для выдачи минимальной обезличенной информации о конкретном заказе не авторизованному пользователю. Наша система имеет для этого интерфейс по адресу "home.courierexe.ru/{код экстра}/tracking". Вы можете либо сделать ссылку на такую страницу на своем сайте, либо разместить ее iframe'ом у себя, либо сделать свою и пользоваться нашим API. Этот интерфейс создан специально для выдачи информации живому пользователю сайта. Для получения статусов заказов в свою информационную систему нужно использовать запрос got="statusreqYES", желательно с параметром changes=ONLY_LAST! '''Пример запроса:'''></package> <source langpackage code="xml33332"><?xml versionstrbarcode="ORD0000002" mass="12.05" message="" encodinggot="UTF-8NO"?><tracking/package> <extra>8 </extrapackages> <orderno>1234 </ordernoorder></trackingstatusreq>

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

<?xml version="1.0" encoding="UTFutf-8"?><tracking> <order ordernostatusreq count="1111110"> <barcode>111111</barcodestatusreq> <AWB>111111</AWBsource> '''Пример ответа при ошибке авторизации''' <sendersource lang="xml"> <town code?xml version="1.0" countryencoding="RUutf-8"?>Москва город</townrequest> <dateerror error="1" errormsg="authorization error">2014-03-22</dateerror> <time_min>09:00</time_minrequest> <time_max>14:00</time_maxsource> </sender> '''Пример ответа при ошибке синтаксиса''' <receiversource lang="xml"> <town code?xml version="1.0" countryencoding="RUUTF-8"?>Москва город</townrequest> <zipcodeerror>column:1 line:11 message:expected '>125480'</zipcodeerror> <date/request>2014-03-22</datesource> <time_min>09=== Описание полей ответа статусов ===Все поля ответа соответствуют структуре order при создании заказа, с некоторыми добавлениями: * Атрибуты контейнера '''order''':00</time_min> <time_max>14:00</time_max>* '''''awb''''' — Номер накладной в системе курьерской службы. </receiver>:* '''''orderno2''''' — Номер накладной в подсистеме срочной доставки курьерской службы. <price>387:* '''''ordercode''''' — внутренний код заказа в системе, применяется для некоторых внутренних операций.5</price> <inshprice>387:* '''''givencode''''' — внутренний код заказа в системе, применяется для некоторых внутренних операций.5</inshprice> <*'''paytype>''' - Тип оплаты заказа получателем. Принимает значения::: CASH</- Наличными при получении (по-умолчанию):: CARD - Картой при получении:: NO - Без оплаты.:: OTHER - Прочее (Предусмотрен для того, чтобы оплата поступала непосредственно в курьерскую службу посредством прочих типов оплаты - таких как: вебмани, яденьги, картой на сайте, прочие платежные системы и т.д.)* Атрибуты контейнера '''paytype>''': <weight>5** '''''code''''' - (integer) внутренний код типа оплаты заказа в системном справочнике "Типы оплаты корреспонденции". Не обязательный элемент.1</weight> <quantity>2</quantity> <service>2</service> <type>3</type>* атрибут '''''code''''' контейнера '''item''' — внутренний код строки заказа в системе, применяется для некоторых внутренних операций.:* '''''returns''''' — количество данного товара, от которого отказался получатель. Не нулевое только в случае частичного отказа. <return>NO</return> <return_service>2<* атрибут '''''got''''' контейнера '''package''' — признак принятого места YES /service>NO. <return_date></return_date>:* '''''returns''''' — количество данного товара, от которого отказался получатель. Не нулевое только в случае частичного отказа. <return_time></return_time> <return_message><* '''''area''''' в контейнере '''receiver''' — район/return_message>метро получателя. <waittime>12</waittime>* '''''coords''''' в контейнере '''receiver''' — координаты получателя. <enclosure>Детские игрушки</enclosure>* '''''deliveryPIN''''' в контейнере '''receiver''' — Пин-код. <instruction>Проверить при покупателе* '''pickup''' — признак оформления забора, возможные значения: '''YES''', подписать акт</instruction> <deliveryprice total="158'''NO'''.6" delivery="100Если указано '''YES''', то весь заказ считается заданием на забор груза, а не на доставку.00" return="58* '''currcoords''' — текущие координаты заказа.6" />Атрибуты::* '''''lat''''' — широта <courier>:* '''''lon''''' — долгота <code>26</code>:* '''''accuracy''''' — точность в метрах <name>Иванов Владимир Петрович<:* '''''RequestDateTime''''' — дата/name>время последнего обновления координат. <phone>+79161234567</phone> </* '''courier>''' — Данные курьера, которому выдан заказ. Если заказ не выдан, то выводятся данные запланированного курьера. <currcoords lat="55* '''waittime ''' — Время ожидания курьера.680327" lon="37* '''deliveryprice''' — Стоимость услуг в валюте расчетов с клиентом.604456" accuracy="50" RequestDateTime="2014-04-21 18Атрибуты::07* '''''total''''' — общая стоимость услуг:45" />* '''''delivery''''' — стоимость доставки «Туда» <status eventstore="филиал в Санкт:* '''''return''''' — стоимость доставки «Обратно» (если order-Петербурге" eventtime>return="2016-06-02 17YES)Тэг '''deliveryprice''' включает список дополнительных услуг (только для тарифа «Премиум»):22:00" createtimegmt="2016-06-03 16* '''''advprice''''' — наименование дополнительной услуги:14* '''''code''''' — код дополнительной услуги:44" message="" title="Доставлен">COMPLETE</* '''''price''''' — стоимость дополнительной услуги * '''status>''' — статус доставки (список статусов см. ниже). Атрибуты (заполняются начиная с версии системы 2008.0.0.670)::* '''''eventstore''''' — филиал, к которому относится текущий статус <statushistory>:* '''''eventtime''''' — время события по часовому поясу места его наступления. :* '''''createtimegmt''''' — время по GMT создания записи о смене статуса в БД. Используется для сортировки записей, чтобы соблюсти хронологическую последовательность. <status eventstorespoiler text="Офис Подробнее">Большинство событий фиксируются в Москве" полях eventtime="2016-05-30 и createtimegmt на основании одного действия, тогда они отличаются только сдвигом от GMT. Однако, если курьер доставил отправление 10.10.2010 в 20:00, по какой-то причине не внес это в мобильное приложение, на следующий день сдал накладную, и в 9 утра оператор внесла, что он доставил вчера в 20:00" . Тогда в createtimegmt="2016будет сегодня 6 утра (для Москвы), а в eventtime — вчера в 20:00. При этом оператор по каким-06то причинам может внести время вручения раньше, чем какое-03 16:14:44" message="" title="Новый">NEWто предыдущее событие, т.о. нарушится последовательность времени в eventtime, но при сортировке по createtimegmt все-равно все будет правильно.</statusspoiler> <status eventstore="Офис в Москве" eventtime="2016-06-01 17:38:00" createtimegmt="2016* '''''message''''' — наименование филиала-06-03 16получателя, при передаче между филиалами:14:44" message="филиал * '''''title''''' — русское наименование статуса * '''statushistory''' — история статусов доставки. Содержит список контейнеров '''status'''. Заполняется только для тарифа «Премиум» начиная с версии системы 2008.0.0.670.* '''customstatecode''' — код внутреннего статуса курьерской службы. Значения уточняйте в курьерской службе. Назначаются курьерской службой в разделе «Справочники» — «Статусы» — «15 Статусы корреспонденции». Справочник не передается через API клиенту по причине возможного наличия в Санкт-Петербурге" title="Планируется отправка">DEPARTURING<нем внутренних технологических статусов курьерской службы.* '''clientstatecode''' — код статуса клиента. Используется, если клиент предлагает свои коды статусов доставки/status>причин недоставки.* '''deliveredto''' — данные из поля «Инфо. о доставке» (может быть информация о доставке, причина недоставки и т. п.).* '''delivereddate''' — дата вручения.* '''deliveredtime''' — время вручения. В случае недоставки может быть пустым. <status eventstore="Офис * '''arrival''' — плановая дата прибытия в Москве" eventtime="2016формате гггг-06мм-01 19дд чч:53мм:00" createtimegmt="2016сс. Заполняется только при использовании автоматических систем планирования (Максоптра, Яндекс доставка), во всех остальных случаях -06-03 16пустое.* '''outstrbarcode''' — код у подрядчика (код заказа во внешней системе). Используется в интеграциях с внешними системами.* '''partner''' — текущий филиал/подрядчик.* '''return_message''' — информация о возврате* '''department''' — Подразделение, в котором оформляется заказ. Контейнер '''status''' может принимать следующие значения:14:44" message="филиал AWAITING_SYNC — Ожидает синхронизации. Данные заказа пока не появились в Санкт-Петербурге" title="Отправлено со склада">DEPARTURE</status>службе доставки. <status eventstore="филиал : '''NEW''' — Успешно создан, передан в Санкт-Петербурге" eventtime="2016-06-02 07службу доставки.:41NEWPICKUP — Создан забор.:00" createtimegmt="2016-06-03 16PICKUP — Забран у отправителя.:14WMSASSEMBLED — Скомплектован на складе фулфилмента.:44" message="" title="WMSDISASSEMBLED — Разукомплектован на склад фулфилмента.: '''ACCEPTED''' — Получен складом">ACCEPTED</status>.: CUSTOMSPROCESS — Производится таможенный контроль.: CUSTOMSFINISHED — Таможенный контроль произведен.: CONFIRM — Согласована доставка.: UNCONFIRM — Не удалось согласовать доставку. <status eventstore="филиал в Санкт-Петербурге" eventtime="2016-06-02 09:17DEPARTURING — Планируется отправка со склада на другой склад.:00" createtimegmt="2016-06-03 16DEPARTURE — Отправлено со склада на другой склад.:14INVENTORY — Инвентаризация. Убедились в наличии отправления на складе.:44" message="" title="PICKUPREADY — Готов к выдаче в ПВЗ.: '''DELIVERY''' — Выдан курьеру на доставку">DELIVERY</status>. <status eventstore="филиал : COURIERDELIVERED — Доставлен (предварительно, ожидает подтверждения менеджером, чтобы перейти в Санкт-Петербурге" eventtime="2016-06-02 17статус COMPLETE).:22:00" createtimegmt="2016-06-03 16COURIERPARTIALLY — Частично доставлен (предварительно, ожидает подтверждения менеджером, чтобы перейти в статус PARTIALLY).:14:44" message="" title="Доставлен COURIERCANCELED — Отказ (предварительно, после этого ожидается COURIERRETURN)">COURIERDELIVERED<.: COURIERRETURN — Возвращено курьером. Курьер не смог доставить до получателя и вернул заказ обратно на склад. Это промежуточный статус, после которого менеджер выясняет, нужно ли повторно доставлять (статусы DATECHANGE/status>DELIVERY) или это окончательная недоставка (CANCELED). <status eventstore="филиал в Санкт-Петербурге" eventtime="2016-06-02 17:22DATECHANGE — Перенос даты доставки. :00" createtimegmt="2016-06-03 16'''COMPLETE''' — Доставлен.:14'''PARTIALLY''' — Доставлен частично.:44" message="" title="Доставлен">COMPLETE<'''CANCELED''' — Не доставлен (Возврат/status>Отмена). После этого статуса отправление должны вернуть заказчику, будут статусы RETURNING и RETURNED  </statushistory>: RETURNING — Планируется возврат заказчику (после CANCELED). <deliveredto>Иванова, секр: RETURNED — Возвращен заказчику.<: LOST — Утрачен/deliveredto>утерян. <delivereddate>2016-06-02</delivereddate> <deliveredtime>17:22</deliveredtime>PARTLYRETURNING — Планируется возврат остатков. <outstrbarcode>EXT123456</outstrbarcode>: PARTLYRETURNED — Остаток возвращен. <items>: TRANSACCEPTED — Прибыл на склад перевозчика. <item code="34533" extcode="abc123" quantity="1" mass="0: PICKUPTRANS — Забран у перевозчика.2" retprice="37  '''Примечание.5" VATrate="0" barcode="2345625213125" article="1" returns="0" origincountry="040" GTD="" excise="0''' В будущем возможно дополнение используемого набора статусов.00" governmentCode="11223311" suppcompany="Поставщик" suppINN="1112223334" suppphone="79161234567">Мяч</item> <item code="34456" extcode="abc124" quantity="2" mass="2" retprice="100" VATrate="10" barcode="4645625213138" article="2" returns="0" governmentCodediv style="color: #a94442; background-color: #f2dede; border: 1px solid #ebccd1; padding: 3px 10px 10px;">Обруч</item> <item code="34421" extcode="abc125" quantity="3" mass="0'''Обратите внимание!''' # Контейнер '''statushistory''' и '''deliveryprice''' заполняется для тарифов [[Личный кабинет курьерской службы#Функции личного кабинета|Премиум и Максимум]].3" retprice="50" VATrate="18" barcode="2345625213126" article="3" returns="0" governmentCode="">Погремушка желтая</item> </items># Система никогда не гарантирует последовательность прохождения заказом набора статусов. То есть Вы можете получить статус «COMPLETE», а следующим запросом — «NEW» — такое может произойти, например, если оператор ошибочно отметил заказ выполненным, а затем исправил ошибку. </orderdiv></tracking></sourcebr>

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

<?xml version="1.0" encoding="UTF-8"?><tracking17statusreq> <auth extra="8" login="login" pass="pass"></auth> <changes>8ONLY_LAST</extrachanges> <ordernostreamid>1234</ordernostreamid></tracking17statusreq>

'''Пример ответа:'''<pre>{ "number":"ExtNumber"Система выдает все заказы, "oriNumber"в которых с момента последнего запроса в этом режиме изменилось хотя бы одно из полей:"1234", "oriCountry":"RU", orderno "destCountry":"RU", status "status":"Complete", delivereddate "events":[ deliveredtime { deliveredto "time":"2016 receiver-06>date receiver-02 17:22:00",>address "location":"RU", price "content":"Complete" }После успешной обработки ответа необходимо отметить полученные статусы успешно полученными, { "time":"2016-06-02 17:22отправив запрос:00", <source lang="locationxml":"RU",> <?xml version="content1.0":encoding="CourierdeliveredUTF-8"?> },<commitlaststatus> { "time": <auth extra="2016-06-02 09:17:008", login="locationlogin":pass="RUpass",></auth> "content":"Delivery" <client>CLIENT</client> }, <streamid>1234</streamid> {</commitlaststatus> "time":"2016-06-02 07:41:00",</source> "location":"RU", "content":"Accepted"'''Описание полей запроса''' }, {* '''auth''' — авторизация. Обязательный элемент. "time":"2016-06-01 19:53:00"* '''streamid''' — идентификатор потока. Если у вас несколько интеграций и каждая нуждается в получении статусов, вы можете передавать данный параметр и тем самым разделять получение и отметку об успешном получении статусов по заказам. Значение должно входить в промежуток от 100 до 10000,включительно. Необязательный элемент.* '''client''' — признак клиента или агента. Необязательный элемент. "location":"RU"* CLIENT — признак клиента,значение по умолчанию "content":"Departure" }* AGENT — признак агента. В ответ отдается информация по заказам,переданным агенту на доставку { "time":"2016-06-01 17:38В случае успеха вы получите ответ:00", <source lang="locationxml":"RU",> "content<?xml version=":1.0"Departuringencoding=" }, { "time":"2016-05UTF-30 10:20:008",?> <commitlaststatus error="location0":"RU",>OK</commitlaststatus> "content":"New" } ]}</presource> Такой способ передачи статусов гарантирует полную корректную передачу статусов, даже если в нашей системе статус изменился между запросом статусов и подтверждением их получения. Если система не получила подтверждение передачи статуса, она будет считать информацию непереданной и выдаст ее при повторном запросе.

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

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

Запрос предназначен для изменения заказов, находящихся в статусах '''Пример запроса:'''<source lang="Ожидает синхронизацииxml" или ><?xml version="Новый1.0", а также по которым не было произведено изменений - статуса корреспонденции, времени доставки - то есть заказов, которые ещё не находятся в работе. <div styleencoding="color: #a94442; backgroundUTF-color: #f2dede; border: 1px solid #ebccd1; padding: 3px 10px 10px;8"?>'''Обратите внимание!'''<tracking># Данные запроса изменения указываются '''полностью''', как если бы заказ создавался впервые. <extra>8</extra># При отсутствии вложения в запросе изменения данное вложение '''не удаляется''' из заказа, но его количество становится равным 0.# При одновременном изменении заказа в API и системе курьерской службы приоритет отдается данным системы курьерской службы. То есть изменения в API приняты не будут! <orderno>1234</orderno></divtracking><br /source>

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

<?xml version="1.0" encoding="UTF-8" ?><cancelordertracking> <auth extraorder orderno="8111111" login> <barcode>111111</barcode> <AWB>111111</AWB> <sender> <town code="login1" passcountry="passRU" >Москва город</town> <date>2014-03-22</date> <time_min>09:00</time_min> <time_max>14:00</time_max> <order orderno="" ordercode="123456" /sender> <receiver> <order ordernotown 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> <paytype>CASH</paytype>*'''auth''' - Авторизация. Обязательный элемент <weight>5.1</weight> <quantity>2</quantity> <service>2</service> <type>3</type> <return>NO</return> <return_service>2</return_service> <return_date></return_date> <return_time></return_time> <return_message></return_message> <waittime>12</waittime> <enclosure>Детские игрушки</enclosure> <instruction>Проверить при покупателе, подписать акт</instruction>*'''order''' - Контейнер отменяемого заказа <deliveryprice total="158. Обязательный элемент6" delivery="100. Запрос может содержать более одного контейнера '''order'''00" return="58. Атрибуты:6" />:* '''''orderno''''' - Шифр заказа. <courier>:* '''''ordercode''''' - Внутренний код заказа. <code>26</code>Обратите внимание, что должен быть указан хотя бы один из атрибутов ''orderno'' или ''ordercode''! <name>Иванов Владимир Петрович</name> <phone>+79161234567</phone> </courier>'''Пример ответа:''' <source langcurrcoords lat="55.680327" lon="37.604456" accuracy="50" RequestDateTime="xml2014-04-21 18:07:45"/> <?xml versionstatus eventstore="филиал в Санкт-Петербурге" eventtime="1.02016-06-02 17:22:00" encodingcreatetimegmt="UTF2016-06-803 16:14:44" message="" title="Доставлен" ?>COMPLETE</status> <cancelorderstatushistory> <order ordernostatus eventstore="123testОфис в Москве" ordercodeeventtime="1234562016-05-30 10:20:00" errorcreatetimegmt="02016-06-03 16:14:44" errormsgmessage="OK" errormsgrutitle="УспешноНовый" >NEW</status> <order ordernostatus eventstore="123aaaОфис в Москве" ordercodeeventtime="2016-06-01 17:38:00" errorcreatetimegmt="522016-06-03 16:14:44" errormsgmessage="order not foundфилиал в Санкт-Петербурге" errormsgrutitle="Заказ не найденПланируется отправка" >DEPARTURING</status> <status eventstore="Офис в Москве" eventtime="2016-06-01 19:53:00" createtimegmt="2016-06-03 16:14:44" message="филиал в Санкт-Петербурге" title="Отправлено со склада">DEPARTURE</cancelorderstatus> <status eventstore="филиал в Санкт-Петербурге" eventtime="2016-06-02 07:41:00" createtimegmt="2016-06-03 16:14:44" message="" title="Получен складом">ACCEPTED</sourcestatus>  <status eventstore="филиал в Санкт-Петербурге" eventtime= Добавление вложений к накладной "2016-06-02 09:17:00" createtimegmt="2016-06-03 16:14:44" message= '''Пример запроса:'''<source lang"" title="xmlВыдан курьеру на доставку">DELIVERY</status> <?xml versionstatus eventstore="1.0филиал в Санкт-Петербурге" eventtime="2016-06-02 17:22:00" encodingcreatetimegmt="UTF2016-806-03 16:14:44" message="" title="Доставлен (предварительно)" ?>COURIERDELIVERED<addattachments/status> <auth extrastatus eventstore="филиал в Санкт-Петербурге" eventtime="82016-06-02 17:22:00" createtimegmt="2016-06-03 16:14:44" loginmessage="login" passtitle="passДоставлен" >COMPLETE</status> </statushistory> <deliveredto>Иванова, секр.</deliveredto> <delivereddate>2016-06-02</delivereddate> <deliveredtime>17:22</deliveredtime> <ordernooutstrbarcode>1234567EXT123456</ordernooutstrbarcode> <attachmentsitems> <item namecode="34533" extcode="abc123" quantity="1" mass="0.2" retprice="37.5" VATrate="0" barcode="2345625213125" article="1" returns="0" origincountry="040" GTD="" excise="photo10.jpg00" governmentCode="11223311" suppcompany="Поставщик" suppINN="1112223334" suppphone="79161234567">Мяч</item>JVBERi0xLjMN1wb25lbnQgMQ JUBQREYwMTIzNDU2Nzg5IDI NMyAwIG9iag08PA0vVHlwZSA U3VidHlwZSAvSW1hZ2UNL1d pZHRoIDE4MDgNL0hlaWdodCA ggNCAwIFINL0JpdHNQZXJDb 21wb25lbnQgMQ0vRGVjb2RlU ENL0NvbHVtbnMgMTgwOA0+P g0vSW1hZ2VNYXNrIHRydWUNL XhEZWNvZGUNPj4Nc3RyZWFt DQ <item code="34456" extcode="abc124" quantity="2" mass="2" retprice="100" VATrate="10" barcode="4645625213138" article="2" returns="0" governmentCode="">Обруч</item> <item namecode="34421" extcode="abc125" quantity="3" mass="photo20.jpg3" retprice="50" VATrate="18" barcode="2345625213126" article="3" returns="0" governmentCode="">Погремушка желтая</item>VBERi0xLjMNAwIG9iag0HRoJ JUBQREYwMTIzNDU2Nzg5IDI NMyAwIG9iag08PA0vVHlwZSA vWE9iamVjdA0vU3VidHlwZS AvSW1hZ2UNL1dpZHRoIDEzNj gNL0hlaWdodCAxMzMzDS9MZ W5ndGggNCAwIFINL0JpdHNQZ XJDb21wb25lbnQgMQ0vRGVj b2RlUGFybXMgPDwNL0sgLTEN L0NvbHVtbnMgMTM2OA0+Pg0 vSW </itemitems> </attachmentsorder></addattachmentstracking>

'''Описание полей:Получение информации в формате 17 TRACK'''

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

<addattachmentstracking17> <attachmentsextra> 8<item name="photo1.jpg" error="0" errormsg="OK" errormsgru="Успешно" /extra> <item name="photo2.jpg" error="0" errormsg="OK" errormsgru="Успешно" /orderno> 1234</attachmentsorderno></addattachmentstracking17>

== Получение вложений к накладной == '''Пример запросаответа:'''<source lang=pre>{ "number":"xmlExtNumber">,<?xml version= "1.0oriNumber" encoding=:"UTF-81234" ?>,<attachments> "oriCountry":"RU", <auth extra= "destCountry"8:" login=RU"login, " pass=status"pass:" />Complete", <orderno>1234567</orderno> "events":[</attachments> {</source> "time":"2016-06-02 17:22:00", "location":"RU",'''Описание полей "content":'''"Complete" }, {'''attachments''' "time":"2016-06- Корневой контейнер. Обязательный элемент.02 17:22:00",*'''auth''' "location":"RU", "content":"Courierdelivered" }, { "time":"2016-06- Авторизация. Обязательный элемент.02 09:17:00", "location":"RU", "content":"Delivery"*'''orderno''' - Номер/код заказа. Обязательный элемент. }, { "time":"2016-06-02 07:41:00",'''Пример ответа "location":'''"RU",<source lang= "content":"xmlAccepted"><?xml version= }, { "1.0time" encoding=:"UTF2016-806-01 19:53:00"?>,<attachments> "location":"RU", <item name= "doc1.docxcontent" size=:"35654Departure">JVBERi0xLjMN JUBQREYwMTIzNDU2Nzg5IDI NMyAwIG9iag08PA0vVHlwZSA }, U3VidHlwZSAvSW1hZ2UNL1d pZHRoIDE4MDgNL0hlaWdodCA { ggNCAwIFINL0JpdHNQZXJDb 21wb25lbnQgMQ0vRGVjb2RlU "time":"2016-06-01 17:38:00", ENL0NvbHVtbnMgMTgwOA0+P g0vSW1hZ2VNYXNrIHRydWUNL "location":"RU", XhEZWNvZGUNPj4Nc3RyZWFt DQ</item> <item name= "photo2.jpgcontent" size=:"74861Departuring">VBERi0xLjMN JUBQREYwMTIzNDU2Nzg5IDI NMyAwIG9iag08PA0vVHlwZSA }, vWE9iamVjdA0vU3VidHlwZS AvSW1hZ2UNL1dpZHRoIDEzNj { gNL0hlaWdodCAxMzMzDS9MZ W5ndGggNCAwIFINL0JpdHNQZ "time":"2016-05-30 10:20:00", XJDb21wb25lbnQgMQ0vRGVj b2RlUGFybXMgPDwNL0sgLTEN "location":"RU", L0NvbHVtbnMgMTM2OA0+Pg0 vSW</item> "content":"New" }</attachments> ]}</sourcepre>

В тегах item возвращаются бинарные данные Функция ищет последний заказ по номеру среди заказов всех клиентов. Выдает неперсонализированную информацию о текущем состоянии заказа.<br>Описание контейнеров ответа аналогично описанию [[API#.D0.97.D0.B0.D0.BF.D1.80.D0.BE.D1.81 .D1.81.D1.82.D0.B0.D1.82.D1.83.D1.81.D0.B0 .D0.B7.D0.B0.D0.BA.D0.B0.D0.B7.D0.BE.D0.B2|Запроса статусов заказов]]. == Изменение заказа ==Запрос предназначен для изменения заказов. Изменять заказы могут курьерские службы с тарифами «Премиум» и «Максимум». Чтобы разрешить изменение заказов, в личном кабинете курьерской службы перейдите в '''Настройки''' > '''Заказы''' и в разделе '''Отмена и редактирование''' установите флажок '''Разрешить отмену и изменение заказов'''. Вы также можете пометить в списке '''Статусы для отмены и редактирования заказов''' галками статусы корреспонденции, для которых возможны отмена и изменение заказов. По умолчанию (файлыкогда в этом списке ничего не выбрано)редактирование и отмена разрешены для статуса «Новый» <div style="color: #a94442; background-color: #f2dede; border: 1px solid #ebccd1; padding: 3px 10px 10px;">'''Обратите внимание!'''# Данные запроса изменения указываются '''полностью''', как если бы заказ создавался впервые.# При отсутствии вложения в запросе изменения данное вложение '''не удаляется''' из заказа, закодированные но его количество становится равным 0.# При одновременном изменении заказа в API и системе курьерской службы приоритет отдается данным системы курьерской службы. То есть изменения в base64API приняты не будут.</div>

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

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

'''Пример запроса # Заказ нельзя изменить, пока он не синхронизирован с системой (пока предыдущие изменения статуса:'''<source lang="xml"><?xml version="1.0" encoding="UTFне переданы в бэк-8" ?><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" reason="0" /> <item code="34456" quantity="0" reason="0" /> <item code="34421" quantity="2" reason="0" /> </items> <image filename="filename1.jpg"> /9j/4AAQSkZJRgA BAQAAAQABAAD/2wBDAA0JCg sKCA0LCgsODg0PEyAVExISEy ccHhcgLikxMC4pLSwzOko+M zZGNywtQFdBRkxOUlNSMj5aY VpQYEpRUk//2wBDAQ4ODhMR EyYVFSZPNS01T09PT09PT09P T09PT09PT09PT09PT09PT09 PT09PT09PT09PT09PT09PT09 PT09PT0//wAARCAYACAADAS IA</image> </order></setorderinfo></source>офисом (для записей указываются метки Удалено)

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

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

<waybillcancelorder>

<orders> <order orderno="1234567" ordercode="33331123456" /> <order orderno="1234568123aaa" ordercode="33332" /> </orders> <form>1</form></waybillcancelorder>

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

<?xml version="1.0" encoding="UTF-8"?><waybillcancelorder> <contentorder orderno="123test" ordercode="123456" error="0" errormsg="OK" errormsgru="Успешно" />EODIcaI8KSBlwQ 4MnEOR7Px8U8EBAyGICBnwpw IZhQgz0ZxuPs8EBM/GcbjzB AwhBl8hwQYIO00GmEwg1CeEG mqYTChNU0wqf8l8nz4zgc+K fCno+zwU5GjOZmzXGcbEQYIM 4zkegRE40zWzONyoNNMIOIa cWnp6aDCGEGE9NQmoQd2mg00 79U4f3hPTwnfp6Sdrafeqpa JDpFw/1aYT077VNNNdO00G3q mqqvp9p2E7T0/wiFemv8uG6 OM<order orderno="123aaa" ordercode="" error="52" errormsg="order not found" errormsgru="Заказ не найден" /content></waybillcancelorder>

В тэге content возвращаются бинарные данные (файл pdf), закодированные в base64Метод позволяет прикрепить файлы к корреспонденции.Размер загружаемого файла не должен превышать 1 Мб.

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

<?xml version="1.0" encoding="UTF-8"?><townlistaddattachments> <auth extra="8" login="login" pass="pass" /> <codesearchorderno> <zipcode>1100001234567</zipcodeorderno> <kladrcode>0100000100800 </kladrcodeattachments> <fiascode>bd21979d-46f8-49d0-9105-e8d65172a983</fiascodeitem name="photo1.jpg">JVBERi0xLjMN1wb25lbnQgMQ <code>123</code>JUBQREYwMTIzNDU2Nzg5IDI NMyAwIG9iag08PA0vVHlwZSA </codesearch> <conditions> U3VidHlwZSAvSW1hZ2UNL1d pZHRoIDE4MDgNL0hlaWdodCA <city>Краснодарский край</city>ggNCAwIFINL0JpdHNQZXJDb 21wb25lbnQgMQ0vRGVjb2RlU <namecontains>новгород</namecontains>ENL0NvbHVtbnMgMTgwOA0+P g0vSW1hZ2VNYXNrIHRydWUNL <namestarts>МоскXhEZWNvZGUNPj4Nc3RyZWFt DQ</namestartsitem> <item name="photo2.jpg">Москва</name>VBERi0xLjMNAwIG9iag0HRoJ <fullname>Москва город</fullname>JUBQREYwMTIzNDU2Nzg5IDI NMyAwIG9iag08PA0vVHlwZSA <country>1</country> </conditions> <limit>vWE9iamVjdA0vU3VidHlwZS AvSW1hZ2UNL1dpZHRoIDEzNj <limitfrom>30</limitfrom>gNL0hlaWdodCAxMzMzDS9MZ W5ndGggNCAwIFINL0JpdHNQZ <limitcount>10</limitcount>XJDb21wb25lbnQgMQ0vRGVj b2RlUGFybXMgPDwNL0sgLTEN <countall>YESL0NvbHVtbnMgMTM2OA0+Pg0 vSW</countallitem> </limitattachments></townlistaddattachments>

*'''authОписание полей:''' - Авторизация, необязательный элемент. Используется в случае включенного и настроенного ограничения по населенным пунктам в конкретной курьерской службе.

'''addattachments''' — Корневой контейнер. Обязательный элемент.*'''codesearchauth''' - Поиск по кодам — Авторизация. В случае использования - контейнеры conditions и limit игнорируютсяОбязательный элемент.:* '''zipcodeorderno''' - Поиск по индексу — Номер заказа. Обратите внимание на то, что один почтовый индекс может распространяться на несколько населенных пунктовОбязательный элемент. В этом случае система вернет несколько записейМожет использоваться тэг <ordercode> с указанием внутреннего кода заказа.:* '''kladrcodeattachments''' - Поиск по 13-ти значному коду КЛАДР — Обязательный элемент, в котором перечисляются передаваемые данные файлов.:** '''fiascodeitem''' - Поиск по коду ФИАС  — Бинарные данные (AOGUIDфайл), закодированные в base64. Обязательный элемент.:*** '''codename''' - Поиск по коду  — Атрибут элемента '''item''', в системекотором передается имя файла. Обязательный элемент.

<townlist countaddattachments> <attachments> <item name="3photo1.jpg" pageerror="10" totalcounterrormsg="3OK" totalpageserrormsgru="1Успешно"> <town> <code>26379</code> <city> <code>23</code> <name>Краснодарский край</name> </city> <item name>Сочи город</name> <fiascode>79da737a-603b-4c19-9b54-9114c96fb912</fiascode> <kladrcode>2300000700000</kladrcode> <shortname /> (not yet supported) <typename /> (not yet supported) <coords lat="43photo2.5855jpg" error="0" lonerrormsg="39.7231OK" errormsgru="Успешно" /> </townattachments> <town> <code>40331</code> <cityaddattachments> <code>32</codesource> <name>Брянская область</name> </city>== Получение вложений к накладной == <name>Сочилов хутор</name>'''Пример запроса:''' <fiascode>c9c96c67-2cc9-4f10-afde-fd32417ea216</fiascodesource lang="xml"> <kladrcode>3201900011100</kladrcode> <shortname /> <typename /> <coords lat?xml version="521.64070" lonencoding="33.1724UTF-8" /?> </townattachments> <town> <code>114016<auth extra="8" login="login" pass="pass" /code> <city> <code>60</code> <nameorderno>Псковская область1234567</nameorderno> </cityattachments> <name>Сочихино деревня</namesource> <fiascode>10df7588-19c1-49d1-a387-9de1cf3eb26f</fiascode> <kladrcode>6001900015400</kladrcode>'''Описание полей:''' <shortname /> <typename />'''attachments''' — Корневой контейнер. Обязательный элемент. <coords lat="56* '''auth''' — Авторизация.6003" lon="29Обязательный элемент.3542" /> <* '''orderno''' — Номер/town>код заказа. Обязательный элемент.</townlist></source>

В ответе города сортируются по популярности, важности (районные центры и т'''Пример ответа:'''<source lang="xml"><?xml version="1.д.), и только затем 0" encoding="UTF- по алфавиту.8"?><attachments> <item name="doc1.docx" size= Справочник регионов "35654">JVBERi0xLjMN JUBQREYwMTIzNDU2Nzg5IDI NMyAwIG9iag08PA0vVHlwZSA U3VidHlwZSAvSW1hZ2UNL1d pZHRoIDE4MDgNL0hlaWdodCA ggNCAwIFINL0JpdHNQZXJDb 21wb25lbnQgMQ0vRGVjb2RlU ENL0NvbHVtbnMgMTgwOA0+P g0vSW1hZ2VNYXNrIHRydWUNL XhEZWNvZGUNPj4Nc3RyZWFt DQ</item> <item name="photo2.jpg" size="74861">VBERi0xLjMN JUBQREYwMTIzNDU2Nzg5IDI NMyAwIG9iag08PA0vVHlwZSA vWE9iamVjdA0vU3VidHlwZS AvSW1hZ2UNL1dpZHRoIDEzNj gNL0hlaWdodCAxMzMzDS9MZ W5ndGggNCAwIFINL0JpdHNQZ XJDb21wb25lbnQgMQ0vRGVj b2RlUGFybXMgPDwNL0sgLTEN L0NvbHVtbnMgMTM2OA0+Pg0 vSW</item></attachments></source> В тегах item возвращаются бинарные данные (файлы), закодированные в base64.

== Изменение статуса агентом ==Запрос изменения статуса заказа позволяет установить окончательный статус заказа — «Доставлен» или «Не доставлен (Возврат/Отмена)». Кроме этого, устанавливается дата и время (при необходимости) изменения статуса, а также сообщение в поле ''Инфо о доставке''. При необходимости к заказу можно прикрепить изображения.  '''Пример запроса справочникаизменения статуса:'''

<?xml version="1.0" encoding="UTF-8"?><regionlistsetorderinfo> <codesearchauth extra="8" login="login" pass="pass" /> <order ordercode="123456"> <message>Получил Иванов</message> <codeoutstrbarcode>777654312</codeoutstrbarcode> </codesearchorder> <conditionsorder ordercode="234567"> <status>PICKUPREADY</status> <namecontainseventtime>край2016-05-30 10:20:00</namecontainseventtime> <namestartsmessage>МоскКлиент отказался от покупки</namestartsmessage> <fullnamepaytype>Московская областьCASH</fullnamepaytype> <countrystoreprice>123</storeprice> <items> <item code="34533" quantity="1" reason="0" governmentCode="11223311" /> <item code="34456" quantity="0" reason="0" /country> <item code="34421" quantity="2" reason="0" /> </items> <image filename="filename1.jpg"> /9j/4AAQSkZJRgA BAQAAAQABAAD/2wBDAA0JCg sKCA0LCgsODg0PEyAVExISEy ccHhcgLikxMC4pLSwzOko+M zZGNywtQFdBRkxOUlNSMj5aY VpQYEpRUk//2wBDAQ4ODhMR EyYVFSZPNS01T09PT09PT09P T09PT09PT09PT09PT09PT09 PT09PT09PT09PT09PT09PT09 PT09PT0//wAARCAYACAADAS IA</image> </conditionsorder></regionlistsetorderinfo></source>  '''Описание полей запроса статуса:''' '''setorderinfo''' — Корневой контейнер. Обязательный элемент.* '''auth''' — Авторизация. Обязательный элемент.* '''order''' — Контейнер заказа. Обязательный элемент. Запрос может содержать более одного контейнера '''order'''. Атрибут '''''ordercode''''' — внутренний код заказа.* '''status''' — Новый статус заказа. Доступны статусы из раздела [[#Описание полей ответа статусов]], кроме AWAITING_SYNC и NEW.* '''eventtime''' — Дата и время изменения статуса. Обязательно при указании статуса.* '''message''' — Текст сообщения ''Инфо о доставке''.* '''outstrbarcode''' — код у подрядчика (код заказа во внешней системе). Используется в интеграциях с внешними системами.* '''paytype''' — Тип оплаты заказа. Допустимые значения CASH/CARD.* '''storeprice''' — Агентское вознаграждение.* '''items''' — Контейнер для описания вложений '''item''' . Атрибуты::* '''''code''''' — Код вложения.:* '''''quantity''''' — Количество доставленных единиц вложения.:* '''''reason''''' — Причина недоставки, выбирается из соответствующего списка статусов.:* '''''governmentCode''''' — Указание кода ТН для вложения при необходимости.* '''image''' — Контейнер прикрепляемого изображения. Содержит текст файла изображения, закодированный по стандарту ''base64''. Контейнер '''order''' может содержать более одного контейнера '''image'''. Атрибут::* '''''filename''''' — Имя файла.  

<regionlist count="2"setorderinfo> <city> <code>80<order ordercode="123456" error="0" errormsg="OK" errormsgru="Успешно" /code> <country> <code>1</code> <name>Россия</name> <id>643</id> <ShortName1>RU</ShortName1> <ShortName2>RUS</ShortName2> </country> <name>Агинский Бурятский автономный округ</name> <order ordercode="234567" error="59" errormsg="value [date_put] is already set" errormsgru="Значение [Дата доставки] уже указано" /city> <city> <code>1</code> <country> <code>1</code> <name>Россия</name> <id>643</id> <ShortName1>RU</ShortName1> <ShortName2>RUS</ShortName2> </country> <name>Адыгея республика</name> </city></regionlistsetorderinfo></source> == Справочник улиц Получение документов для печати == '''Пример запроса справочника улицполучения печатных форм:'''

<?xml version="1.0" encoding="UTF-8"?><streetlistwaybill> <conditionsauth extra="8" login="login" pass="pass" /> <town>Москва город</town> // ОБЯЗАТЕЛЬНОЕ ПОЛЕ! <namecontains>Хохло</namecontainsorders> <namestarts>Академика Х<order orderno="1234567" ordercode="33331" /namestarts> <name>Академика Хохлова<order orderno="1234568" ordercode="33332" /name> <fullname>Академика Хохлова ул.</fullname> </conditionsorders> <limitform> <limitfrom>301</limitfromform> <limitcountstart>10</limitcount> <countall>YES</countall> 5</limitstart></streetlistwaybill>

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

<streetlist count="1" page="1" totalcount="3" totalpages="1"waybill> <streetcontent>EODIcaI8KSBlwQ 4MnEOR7Px8U8EBAyGICBnwpw <name>Академика Хохлова ул.< IZhQgz0ZxuPs8EBM/name>GcbjzB AwhBl8hwQYIO00GmEwg1CeEG mqYTChNU0wqf8l8nz4zgc+K fCno+zwU5GjOZmzXGcbEQYIM <shortname>Академика Хохлова</shortname> 4zkegRE40zWzONyoNNMIOIa cWnp6aDCGEGE9NQmoQd2mg00 <typename>ул.< 79U4f3hPTwnfp6Sdrafeqpa JDpFw/typename>1aYT077VNNNdO00G3q mqqvp9p2E7T0/wiFemv8uG6 OM</streetcontent></streetlistwaybill>

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

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

<?xml version="1.0" encoding="UTF-8" ?><itemlistwaybill> <auth extra="8" login="login" pass="pass"error>Текст ошибки</auth> <codesearch> <code>123456</code> <article>FD343</article> <barcode>2345625213125</barcode> </codesearch> <conditions> <namecontains>телевизор</namecontains> <namestarts>sony</namestarts> <name>Sony KDL-55W905 ЖК-телевизор</name> <quantity>EXISTING_ONLY</quantity> </conditions> <limit> <limitfrom>30</limitfrom> <limitcount>10</limitcount> <countall>YES</countall> </limiterror></itemlistwaybill>

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

<itemlist counttownlist> <auth extra="3" totalcount="3" page="1" totalpages="18"/> <itemcodesearch> <codezipcode>123456110000</codezipcode> <articlekladrcode>FD3430100000100800</articlekladrcode> <barcodefiascode>2345625213125bd21979d-46f8-49d0-9105-e8d65172a983</barcodefiascode> <namecode>Sony KDL-55W905 ЖК-телевизор123</namecode> <retprice/codesearch>65000 </retpriceconditions> <purchpricecity>50000Краснодарский край</purchpricecity> <weightnamecontains>5.1новгород</weightnamecontains> <lengthnamecontainsparts>50молоково моск</lengthnamecontainsparts> <widthnamestarts>30Моск</widthnamestarts> <heightname>40Москва</heightname> <CountInPalletfullname>30Москва город</CountInPalletfullname> <HasSerialscountry>1</HasSerialscountry> <CountryOfOrigin>Малайзия </CountryOfOriginconditions> (not yet supported) <Message>Хороший телевизор</Messagelimit> <Message2limitfrom>Снова хороший телевизор30</Message2limitfrom> <quantitylimitcount>1210</quantitylimitcount> <reservedcountall>3YES</reservedcountall> <item/limit> ...</itemlisttownlist>

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

* '''Пример запроса движения номенклатурыcodesearch''' — Поиск по кодам. В случае использования — контейнеры conditions и limit игнорируются.:* '''zipcode''' — Поиск по индексу. Обратите внимание на то, что один почтовый индекс может распространяться на несколько населенных пунктов. В этом случае система вернет несколько записей.<source lang="xml">:* '''kladrcode''' — Поиск по 13-ти значному коду КЛАДР.<?xml version="1:* '''fiascode''' — Поиск по коду ФИАС (AOGUID).0" encoding="UTF-8" ?><itemmovements> <auth extra="8" login="login" pass="pass"></auth> <:* '''code>4259</code></itemmovements></source>''' — Поиск по коду в системе.

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

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

<?xml version="1.0" encoding="UTF-8" ?><itemmovements townlist count="163" page="1" totalcount="3" totalpages="1"> <itemmovementtown> <code>15150026379</code> <datecity> <code>2017-05-2623</datecode> <retpricename>0Краснодарский край</retpricename> <quantity>1</quantitycity> <deliveredname>0Сочи город</deliveredname> <itemfiascode> <code>425979da737a-603b-4c19-9b54-9114c96fb912</codefiascode> <namekladrcode>Настольная игра Дженга2300000700000</namekladrcode> <shortname /item> (not yet supported) <statustypename /> (not yet supported) <codecoords lat="43.5855" lon="39.7231" />5 </codetown> <nametown>Возврат от покупателя </namecode> 40331</statuscode> <storecity> <code>132</code> <name>офис в МосквеБрянская область</name> </storecity> <order> <ordercodename>3374830Сочилов хутор</ordercodename> <numberfiascode>123660c9c96c67-2cc9-4f10-afde-0fd32417ea216</numberfiascode> <datekladrcode>2017-05-243201900011100</datekladrcode> <ordernoshortname />14123 <typename /orderno> <barcodecoords lat="52.6407" lon="33.1724" />0000000670 </barcodetown> <company>ТОВАР</companytown> <addresscode>Кравченко ул., 1114016</addresscode> <delivereddate>2017-05-29 </delivereddatecity> <deliveredtimecode>12:00:0060</deliveredtimecode> <deliveredto name>Псковская область</name> </ordercity> <document> <codename>21991Сочихино деревня</codename> <numberfiascode>31810df7588-19c1-49d1-a387-9de1cf3eb26f</numberfiascode> <datekladrcode>2017-05-266001900015400</datekladrcode> <messageshortname /> <typename /message> <coords lat="56.6003" lon="29.3542" /document> </itemmovementstown></itemlisttownlist>

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

*'''status''' - контейнер статуса операции:* '''code''' - код статуса:* '''name''' - наименование *'''store''' - контейнер филиала, к которому относится операция:* '''code''' - код филиала:* '''name''' - наименование филиала *'''order''' - контейнер корреспонденции:* '''ordercode''' - внутренний код заказа:* '''number''' - номер заказа:* '''date''' - дата заказа:* '''orderno''' - шифр:* '''barcode''' - штрих-код:* '''company''' - компания:* '''address''' - адрес:* '''delivereddate''' - дата вручения:* '''deliveredtime''' - время вручения:* '''deliveredto''' - данные о вручении, либо причина недоставки *'''document''' - контейнер документа операции:* '''code''' - внутренний код документа:* '''number''' - номер документа:* '''date''' - дата документа:* '''message''' - комментарий == Справочник пунктов самовывоза == Для отображения списка пунктов выдачи (ПВЗ) есть '''готовый JavaScript модуль''': https://home.courierexe.ru/js/measoft_map.js Инструкция по использованию - внутри. '''Пример запроса пунктов самовывозаответа:'''

<?xml version="1.0" encoding="UTF-8" ?><pvzlistregionlist count="2"> <city> <auth extra="8" login="login" pass="pass"code>80</authcode> <country> <code>12341</code> <townname>Нижний ТагилРоссия</townname> <parentcodeid>6643</parentcodeid> <acceptcashShortName1>YESRU</acceptcashShortName1> <acceptcardShortName2>RUS</ShortName2>YES </acceptcardcountry> <name>Агинский Бурятский автономный округ<acceptfitting/name>YES </acceptfittingcity> <city> <maxweightcode>301</maxweightcode> <acceptindividualscountry>YES <code>1</acceptindividualscode> <ltname>57.924737Россия</ltname> <lgid>59.940019643</lgid> <rtShortName1>57.905682RU</rtShortName1> <rgShortName2>59.984669RUS</rgShortName2> <json/country>YES <name>Адыгея республика</name> </jsoncity></pvzlistregionlist>

*'''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 == Справочник улиц =='''Пример ответа запроса справочника пунктов самовывозаулиц:'''

<?xml version="1.0" encoding="UTF-8" ?><pvzlist count="2"streetlist> <pvz> <code>126</code> <clientcode>3</clientcode> <name>Нижний Тагил</name> <parentcode>6</parentcode> <parentname>Интеграция</parentnameconditions> <town code="124267" regioncode="66" regionname="Свердловская область">Нижний Тагил Москва город</town> <address>622036, г. Нижний Тагил, ул. Циолковского, д. 17< /address> <phone>+73435417709, +73435254989</phone>ОБЯЗАТЕЛЬНОЕ ПОЛЕ! <commentnamecontains>Новый пункт доставкиХохло</commentnamecontains> <worktimenamestarts>Вс 10:00-16:00, Сб 10:00-16:00, Пн-Пт 10:00-20:00Академика Х</worktimenamestarts> <traveldescriptionname>Жилое 5-ти этажное здание, торцом к дороге, второе здание от перекрестка Пархоменко-ЦиолковскогоАкадемика Хохлова</traveldescriptionname> <maxweightfullname>10</maxweight> <acceptcash>YES</acceptcash> <acceptcard>YES</acceptcard> <acceptfitting>YES</acceptfitting> <acceptindividuals>YES</acceptindividuals> <latitude>57Академика Хохлова ул.93457</latitude> <longitude>59.95131</longitudefullname> </pvzconditions> <pvz> <code>245</code> <clientcode>NTG1</clientcode> <name>На Красноармейской</name> <parentcode>6</parentcode> <parentname>Интеграция</parentname> <town code="124267" regioncode="66" regionname="Свердловская область">Нижний Тагил город</townlimit> <addresslimitfrom>КРАСНОАРМЕЙСКАЯ, д.7930</addresslimitfrom> <phonelimitcount>+7(3435)379-044</phone> <comment>Возможность примерки отсутствует</comment> <worktime>Вс 10:00-16:00, Сб 10:00-16:00, Пн-Пт 10:00-20:00</worktimelimitcount> <traveldescription>Напротив ТЦ Пирамида</traveldescription> <maxweight>20</maxweight> <acceptcash>YES</acceptcash> <acceptcardcountall>YES</acceptcard> <acceptfitting>NO</acceptfitting> <acceptindividuals>YES</acceptindividuals> <latitude>57.93468</latitude> <longitude>60.55476</longitudecountall> </pvzlimit></pvzliststreetlist></source> *'''codeconditions''' - Код ПВЗ в системе — Задает условия поиска. Все вложенные элементы одновременно накладывают условие «И». Используется в запросе [[API#Оформление заказа|оформления заказов]]:*'''clientcodetown''' - Код ПВЗ используемый компанией-подрядчиком — Обязательное поле. Название или код населенного пункта.:*'''namenamecontains''' - Наименование ПВЗ — Поиск улиц, название которых содержит указанный текст.:*'''parentcodenamestarts''' - Код родительского элемента — Поиск улиц, название которых начинается с указанного текста.:*'''parentnamename''' - Наименование родительского элемента — Поиск улиц, название которых соответствует указанному тексту.:*'''townfullname''' - Населенный пункт с кодом из [[#Справочник городов|справочника городов]] — Поиск улиц, а также для которых название вместе с кодом и наименованием регионатипом соответствует указанному тексту. *'''addresslimit''' - Адрес ПВЗ — Ограничивает вывод результата.:*'''phonelimitfrom'''  — Задает номер записи результата, начиная с которой выдавать ответ. По- Телефоны ПВЗумолчанию — 0.:*'''commentlimitcount''' - Дополнительная информацияЗадает количество записей результата, которые нужно вернуть. По-умолчанию — 10000.:*'''worktimecountall''' - Режим работы ПВЗ — YES указывает на необходимость подсчета общего количества найденных совпадений. Это может замедлять выполнение запроса. Если отключено, в ответе не указываются totalcount и totalpages.*'''traveldescriptionПример ответа:''' <source lang="xml"><?xml version="1.0" encoding="UTF- Описание местонахождения ПВЗ или пути к нему8"?><streetlist count="1" page="1" totalcount="3" totalpages="1"> <street> <code>124</code> <name>Академика Хохлова ул.</name>*'''maxweight''' - Максимальный вес, с которым работает ПВЗ <shortname>Академика Хохлова</shortname> <typename>ул.</typename>*'''acceptcash''' - Признак приема наличных </street>*'''acceptcard''' - Признак приема банковских карт</streetlist>*'''acceptfitting''' - Наличие примерки</source>*'''latitude''' - Широта*'''longitude''' - ДолготаВ ответе улицы сортируются по алфавиту. == Справочник Видов срочности номенклатуры == '''Пример запроса Видов срочностисправочника номенклатуры:'''

<servicesitemlist> <auth extra="8"login="login" pass="pass"></auth> <codesearch> <code>123456</code> <article>FD343</article> <barcode>2345625213125</barcode> </servicescodesearch> <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''' — Задает количество записей результата, которые нужно вернуть. '''Пример ответа справочника Видов срочности:'''

<?xml version="1.0" encoding="UTF-8" ?><services itemlist count="23" totalcount="3" page="1" totalpages="1"> <serviceitem> <code>1123456</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</serviceVATrate> <CountInPallet>30<service/CountInPallet> <codeCountInBox>2</codeCountInBox> <HasSerials>1</HasSerials> <CountryOfOrigin>Малайзия</CountryOfOrigin> (not yet supported) <Message>Хороший телевизор</Message> <Message2>Снова хороший телевизор</Message2> <quantity>12</quantity> <namereserved>Срочно3</namereserved> </serviceitem> ...</servicesitemlist></source> '''Описание полей:'''* '''code''' — Внутренний идентификатор, присвоенный системой.* '''article''' — Артикул, назначенный клиентом (поставщиком).* '''barcode''' — Штрихкод производителя.* '''name''' — Наименование.* '''retprice''' — Розничная цена по-умолчанию. При оформлении заказа цена используется та, которая указана в заказе.* '''purchprice''' — Закупочная цена.* '''weight''' — Масса в килограммах.* '''length''' — Длина в сантиметрах.* '''width''' — Ширина в сантиметрах.* '''height''' — Высота в сантиметрах.* '''VATrate''' — Ставка НДС, целое число процентов.* '''CountInPallet''' — Количество штук в паллете.* '''CountInBox''' — Количество штук в упаковке.* '''HasSerials''' — Требует учета серийных номеров. Принимает значения 1 — да, 0 — нет.* '''CountryOfOrigin''' — Наименование страны происхождения на русском языке.* '''Message''' — Комментарий.* '''Message2''' — Дополнительный комментарий.* '''quantity''' — Количество на складе. Товары, уже собранные в заказы в этом количестве не присутствуют, считаются покинувшими товарный склад. ''Это поле может быть недоступным в некоторых установках.''* '''reserved''' — Количество зарезервированного товара. Может превышать остаток на складе, если покупатели ждут следующей поставки. ''Это поле может быть недоступным в некоторых установках.'' == Справочник дополнительных услуг Движение номенклатуры == '''Пример запроса дополнительных услугдвижения номенклатуры:'''

<?xml version="1.0" encoding="UTF-8"?><advpricesitemmovements> <auth extra="8" login="login" pass="pass" ></auth> <code>4259</code> <datefrom>2020-10-01</datefrom> <dateto>2020-10-02</dateto></advpricesitemmovements>

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

<advpricesitemmovements count="16"> <advpriceitemmovement> <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> <typecode>int5</typecode> <name>Возврат от покупателя</advpricename> <advprice/status> <store> <code>21</code> <name>Коэффициент надбавкиофис в Москве</name> </store> <order> <ordercode>3374830</ordercode> <number>123660-0</number> <typedate>float2017-05-24</typedate> <orderno>14123</advpriceorderno> <barcode>0000000670<advprice/barcode> <company>ТОВАР</company> <address>Кравченко ул., 1</address> <delivereddate>2017-05-29</delivereddate> <deliveredtime>12:00:00</deliveredtime> <deliveredto /> </order> <document> <code>321991</code> <namenumber>318</number> <date>Расписаться на упаковке2017-05-26</namedate> <typemessage>bool</typemessage> </advpricedocument> </advpricesitemmovements></itemlist></source> Параметры''' Описание полей ответа '''* '''code''' — внутренний код операции движения* '''date''' — дата операции* '''retprice''' — цена товара* '''quantity''' — количество товара операции* '''delivered''' — количество доставленного товара * '''item''' — контейнер товара:* '''code''' — внутренний код товара:* '''name''' — наименование товара * '''status''' — контейнер статуса операции:* '''code''' — код статуса:* '''name''' — наименование * '''store''' — контейнер филиала, к которому относится операция:*'''code''' - внутренний  — код услугифилиала:*'''name''' -  — наименование услугифилиала * '''order''' — контейнер корреспонденции:* '''ordercode''' — внутренний код заказа:* '''number''' — номер заказа:* '''date''' — дата заказа:* '''orderno''' — шифр:* '''barcode''' — штрихкод:* '''company''' — компания:*'''typeaddress''' — адрес:* ' - тип услуги. Может иметь значения''delivereddate''' — дата вручения:* '''deliveredtime''' — время вручения:*'''booldeliveredto''' - для услуг вида "чекбокс" — данные о вручении, "Да"либо причина недоставки * '''document''' — контейнер документа операции:* '''code''' — внутренний код документа:* '''number''' — номер документа:* '''extnumber''' — внешний номер документа:*'''floatdate''' - для числа с плавающей точкой — дата документа:*'''intmessage''' - для целого числа — комментарий == Расчет стоимости доставки Получение справочника тарифов по городам == '''Пример запроса стоимости доставки:справочника тарифов по городам'''

<?xml version="1.0" encoding="UTF-8" ?><calculatortariffs> <auth extra="8" login="login" pass="pass" /> <calc townfrom=">Москва" </townfrom> addressfrom="Ленинский проспект, 95" zipcode="664000" townto="3800000300000" addressto="Ленина ул., 10" l="10" w="20" h="30" mass="3.7" <service=">1"</service> price="1200" inshprice="1200" paytype="CASH" <mainonly>1</mainonly> </calculatortariffs>

Параметры:* '''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> ''' Описание полей ответа '''*'''addressfromtownfrom'''  — код ФИАС города- Адрес отправленияотправителя.* '''service''' — режим доставки.* '''tariffs''' — cписок тарифов по городу.:*'''zipcodetownregion'''  — регион города- Почтовый индекс получателя.:* '''towntofias''' — код ФИАС города назначения-получателя.:*'''towntotowntocode'''  — внутренний код города- Город назначенияполучателя.:*'''addresstotowntoname'''  — наименование города- Адрес назначенияполучателя.:* '''distance''' — дистанция в км до города от МКАД, если в запросе townfrom — Москва.:* '''pricedistance''' — сумма за километраж до города от МКАД, если в запросе townfrom — Москва.:* '''pricesnew''' — ваши настройки тарифов из справочника '''Межгород''' > '''Тарифы по зонам'''.::* '''before/after''' — контейнеры ДО/ОТ.:::*'''lprice''' - Длина  — цена. Если ответ идет по «before», то в сантиметрах (цену также плюсуется сумма pricedistance:::* '''every''' — за каждые.:::* '''mass''' — масса.:* '''prices''' — устаревший элемент, не обязательный параметр)используется.:* '''deliveryPeriodMin''' — минимальный срок доставки.:*'''wdeliveryPeriodMax''' — максимальный срок доставки. == Номенклатура приходной накладной =='' 'Пример запроса номенклатуры приходной накладной:'''<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> ''' Описание полей ответа '''*'''hcode'''  — внутренний код приходной накладной* '''number''' — номер документа* '''date''' — дата документа* '''message''' — комментарий * '''item''' — контейнер товара:* '''code''' — внутренний код товара:* '''barcode''' — штрихкод товара:* '''article''' — артикул товара:* '''quantity''' — количество поступившего товара == Справочник филиалов =='''Пример запроса списка филиалов:'''<source lang="xml"><?xml version="1.0" encoding="UTF- Высота 8" ?><storelist> <auth extra="8"></auth> <json>YES</json> <client_code>7890</client_code></storelist></source> * '''auth''' — Атрибут '''extra''' — обязателен, по нему определяется курьерская служба* '''json''' — Признак вывода ответа в сантиметрах виде JSON YES/NO* '''client_code''' — Код клиента курьерской службы '''Пример ответа:'''<source lang="xml"><?xml version="1.0" encoding="UTF-8" ?><storelist count="2"> <store> <code>123</code> <name>ABC</name> </store> <store> <code>456</code> <name>Филиал 2</name> </store></storelist></source> * '''code''' — Код филиала.* '''name''' — Наименование филиала. == Справочник пунктов самовывоза ==Для отображения списка пунктов выдачи (ПВЗ) есть '''готовый JavaScript модуль''': https://home.courierexe.ru/js/measoft_map.js Инструкция по использованию — внутри. Посмотреть пример работы можно [https://home.courierexe.ru/pvz_test.html Здесь] Уникальные запросы списка ПВЗ кешируются на стороне личного кабинета и хранятся до 7 часов утра по московскому времени следующего дня. Например, если уникальный запрос с массой 2 кг был отправлен сегодня в 10 часов, то завтра в 7 утра он сбросится. Если сегодня в 18 часов в этом же запросе вы укажете массу 2 кг, в ответе вернется тот же список ПВЗ. Если передадите массу 3 кг, список может быть другим. Обратите внимание, что если в выборке количество ПВЗ больше '''10000''' и не обязательный параметр)указаны параметры '''code''', '''json''' или '''limitcount''', то будет возвращаться ошибка. В этом случае необходимо использовать блок '''limit'''. '''Пример запроса пунктов самовывоза:'''<source lang="xml"><?xml version="1.0" encoding="UTF-8" ?><pvzlist> <auth extra="8" login="login" pass="pass"></auth> <code>1234</code> <client_code>7890</client_code> <city>Свердловская область</city> <town regioncode="66" country="RU">Нижний Тагил</town> <address>Щёлковское шоссе</address> <house>77</house> <parentcode>6</parentcode> <acceptcash>YES</acceptcash> <acceptcard>YES</acceptcard> <acceptfitting>YES</acceptfitting> <maxweight>30</maxweight> <acceptindividuals>YES</acceptindividuals> <lt>57.924737</lt> <lg>59.940019</lg> <rt>57.905682</rt> <rg>59.984669</rg> <json>YES</json> <with_coords>YES</with_coords> <limit> <limitfrom>30</limitfrom> <limitcount>2</limitcount> <countall>YES</countall> </limit></pvzlist></source> *'''massauth''' — Атрибут '''extra''' — обязателен, по нему определяется курьерская служба, '''login''' и '''pass''' - Масса позволяют авторизоваться под клиентом: для отдельного клиента могут быть ограничения по доступности некоторых ПВЗ, и в килограммахэтом случае они будут учтены.* '''code''' — Внутренний код.* '''client_code''' — Код клиента курьерской службы.*'''servicecity''' — Регион получателя. Можно указать код региона или полное наименование региона из [[#Справочник регионов|справочника регионов]].* '''town''' — Город получателя.Для тега города '''town''' можно указать код региона в атрибуте '''''regioncode''''' из [[#Справочник регионов|справочника регионов]]. Поиск будет производиться в указанном регионе. Также можно указать страну получателя в атрибуте '''''country''''' в соответствии с [https://ru.wikipedia.org/wiki/ISO_3166- Режим доставки 1 стандартом ISO_3166- число1], например, «RU», указывающее на запись «RUS» или «643» для России.Для формата запроса JSON фильтрация по городу работает только в связке с фильтром по адресу. * '''address''' — Фильтр по адресу, работает только в связке с фильтром по городу* '''house''' — Фильтр по номеру дома, работает только в справочнике связке с фильтрами по адресу и городу* '''parentcode''' — Фильтр по родительскому [[#Справочник Видов срочностифилиалов|видов срочностифилиалу]]* '''acceptcash''' — Фильтр по приему наличных YES/NO* '''acceptcard''' — Фильтр по приему банковских карт YES/NO* '''acceptfitting''' — Фильтр по наличию примерки YES/NO* '''maxweight''' — Фильтр по максимальному весу, с которым работает ПВЗ* '''acceptindividuals''' — Фильтр по доступности физическим лицам YES/NO* '''lt''' — Широта левого верхнего угла* '''lg''' — Долгота левого верхнего угла* '''rt''' — Широта правого нижнего угла* '''rg''' — Долгота правого нижнего угла* '''json''' — Признак вывода ответа в виде JSON YES/NO* '''with_coords''' — Признак вывода ПВЗ только с наличием координат YES/NO* '''limit''' — Ограничивает вывод результата.:* '''limitfrom''' — Задает номер записи результата, начиная с которой выдавать ответ. По-умолчанию — 0.:* '''limitcount'''- Задает количество записей результата, которые нужно вернуть. По-умолчанию — 100.:* '''countall''' — YES указывает на необходимость подсчета общего количества найденных совпадений. Это может замедлять выполнение запроса. Если этот параметр опуститьотключено — в ответе не указываeтся totalcount.  '''Пример ответа справочника пунктов самовывоза:'''<source lang="xml"><?xml version="1.0" encoding="UTF-8" ?><pvzlist count="2" totalcount="40465"> <pvz> <code>126</code> <clientcode>3</clientcode> <name>Нижний Тагил</name> <parentcode>6</parentcode> <parentname>Интеграция</parentname> <town code="124267" regioncode="66" regionname="Свердловская область">Нижний Тагил город</town> <address>622036, г. Нижний Тагил, ул. Циолковского, д. 17</address> <phone>+73435417709, +73435254989</phone> <comment>Новый пункт доставки</comment> <worktime>Вс 10:00-16:00, система выдаст расчет для всех доступных видов срочностиСб 10:00-16:00, Пн-Пт 10:00-20:00</worktime> <traveldescription>Жилое 5-ти этажное здание, торцом к дороге, второе здание от перекрестка Пархоменко-Циолковского</traveldescription> <maxweight>10</maxweight> <acceptcash>YES</acceptcash> <acceptcard>YES</acceptcard> <acceptfitting>YES</acceptfitting> <acceptindividuals>YES</acceptindividuals> <latitude>57.93457</latitude> <longitude>59.95131</longitude> <uid>40606d00-9c51-11eb-b2c9-cfd6c1111392</uid> </pvz> <pvz> <code>245</code> <clientcode>NTG1</clientcode> <name>На Красноармейской</name> <parentcode>6</parentcode> <parentname>Интеграция</parentname> <town code="124267" regioncode="66" regionname="Свердловская область">Нижний Тагил город</town> <address>КРАСНОАРМЕЙСКАЯ, д.79</address> <phone>+7(3435)379-044</phone> <comment>Возможность примерки отсутствует</comment> <worktime>Вс 10:00-16:00, Сб 10:00-16:00, передав много контейнеров Пн-Пт 10:00-20:00</worktime> <traveldescription>Напротив ТЦ Пирамида</traveldescription> <maxweight>20</maxweight> <acceptcash>YES</acceptcash> <acceptcard>YES</acceptcard> <acceptfitting>NO</acceptfitting> <acceptindividuals>YES</acceptindividuals> <latitude>57.93468</latitude> <longitude>60.55476</longitude> <uid>41116853-9c51-11eb-b2c9-cfd6c1451392</uid> </pvz></pvzlist><calc/source>  * '''code''' — Код ПВЗ в системе. Используется в запросе [[API#Оформление заказа|оформления заказов]]* '''clientcode''' — Код ПВЗ используемый компанией-подрядчиком.* '''name''' — Наименование ПВЗ.* '''parentcode''' — Код родительского элемента.* '''parentname''' — Наименование родительского элемента.* '''town''' — Населенный пункт с кодом из [[#Справочник городов|справочника городов]], а также с кодом и наименованием региона.* '''address''' — Адрес ПВЗ.* '''phone''' — Телефоны ПВЗ.* '''comment''' — Дополнительная информация.* '''worktime''' — Режим работы ПВЗ.* '''traveldescription''' — Описание местонахождения ПВЗ или пути к нему.* '''maxweight''' — Максимальный вес, с которым работает ПВЗ.* '''acceptcash''' — Признак приема наличных* '''acceptcard''' — Признак приема банковских карт* '''acceptfitting''' — Наличие примерки* '''latitude''' — Широта* '''longitude''' — Долгота* '''uid''' — Уникальный идентификатор ПВЗ в системе Measoft* '''count''' — Количество записей в ответе* '''totalcount''' — Общее количество записей, отвечающее параметрам запроса == Получение фискальных данных заказа =='''Пример запроса получения фискальных данных:'''<source lang="xml"><?xml version="1.0" encoding="UTF-8"?><receiptdata> <auth extra="8" login="login" pass="pass" /> <orders> <order orderno="123456" /> <order orderno="890111C" /> </orders></receiptdata>  </source> '''Пример ответа получения фискальных данных:'''<source lang="xml">  <?xml version="1.0" encoding="UTF-8"?><receipts count="1"> <receipt> <orderno>123456</orderno> <fdDatetime>2020-06-07 12:14:00</fdDatetime> <fdValue>123</fdValue> <fdNum>456</fdNum> <fnSn>789</fnSn> <kktNum>100</kktNum> <inn>222</inn> <ofdUrl>gate.ofd.ru</ofdUrl> <fullUrl>https://check.ofd.ru/123</fullUrl> <price>12345</price> <lines count="1"> <line> <item>1111764</item> <name>Сапоги</name> <qty>1</qty> <price>1000</price> <vatRate>20</vatRate> <governmentCode>Z16513LK2</governmentCode> <itemType>1</itemType> </line> </lines> </receipt></receipts></source> Параметры ответа:* '''orderno''' — Номер заказа* '''fdDatetime''' — Дата и время пробития фискального чека* '''fdValue''' — ФПД (фискальный признак документа)* '''fdNum''' — ФИСКАЛЬНЫЙ ДОКУМЕНТ (фискальный номер чека)* '''fnSn''' — ФН (номер фискального накопителя)* '''kktNum''' — РН (регистрационный номер кассы)* '''inn''' — ИНН* '''ofdUrl''' — URL адрес (доменное имя) ОФД*'''price''' -  — Сумма наложенного платежачека* '''fullUrl''' — URL чека для просмотра онлайн* '''lines''' — Позиции чека:* '''item''' — код товара:*'''inshpricename''' — наименование товара:* '''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 системах, настраивая цены для определенной группы покупателей.

В авторизации можно опустить параметры login и pass, тогда расчет будет производиться по стандартному тарифу курьерской службы, без учета возможных отличий для конкретного клиента.<br>Объемный вес будет учитываться только при условии указания всех габаритов: длины, ширины и высоты.<br>В полях город-отправитель и город-получатель можно указывать название города (не рекомендуется!), либо код города из нашего справочника, либо 13-ти значный код КЛАДР, либо 36-ти значный код адресной системы ФИАС (AOID).  '''Пример ответа стоимости доставки:'''<source lang="xml"><?xml version="1.0" encoding="UTF-8"?><calculator> <calc> <townfrom code="1">Москва город</townfrom> <townto code="56603">Иркутск город</townto> <mass>3.7</mass> <service name="Экспресс">1</service> <zone>2</zone> <price>1113</price> <mindeliverydays>1</mindeliverydays> <maxdeliverydays>3</maxdeliverydays> <mindeliverydate>2020-05-13</mindeliverydate> <intervals> <workdays> <interval>10:00-16:00</interval> <interval>16:00-22:00</interval> </workdays> <holidays> <interval>12:00-16:00</interval> </holidays> </intervals> <deliveryprice> <advprice code="1" price="1000">База</advprice> <advprice code="4" price="100">Процент от суммы руб</advprice> <advprice code="5" price="63">Процент от объявленной стоимости</advprice> <advprice code="6" price="-50">Скидка при доставке</advprice> </deliveryprice> </calc></calculator></source> Параметры:* '''townfrom''' — Город-отправитель так, как система его распознала и привязала к справочнику. Атрибут '''code''' — код из справочника городов системы.* '''townto''' — Город-получатель так, как система его распознала и привязала к справочнику. Атрибут '''code''' — код из справочника городов системы.* '''mass''' — Масса в килограммах* '''service''' — Режим доставки — число, указывающее на запись в справочнике видов срочности (см описание на этой странице).* '''zone''' — номер тарифной зоны, по которой рассчиталась стоимость. В зависимости от зоны выбирается тарифная сетка. Так же к цене могут применяться повышающие или понижающие коэффициенты при доставке не из/в региональный центр.* '''price''' — рассчитанная стоимость доставки в валюте прайс-листа курьерской службы. Рекомендуется к использованию в отличие от одноименного атрибута родительского контейнера.* '''maxdeliverydays''' — максимальный срок доставки в рабочих днях.* '''mindeliverydate''' — минимальная дата доставки в учетом выходных дней.* '''intervals''' — список интервалов доставки для соответствующей зоны и режима срочности.* '''deliveryprice''' — Данные по составляющим ценам доставки '''''Обратите внимание:''''' В реальном ответе сервера в теге calc присутствует атрибут «price». Он оставлен для обратной совместимости, не используйте его. Пользуйтесь вложенным тегом price. == Получение информации о клиенте =='''Пример запроса получения информации о клиенте:'''<source lang="xml"><?xml version="1.0" encoding="UTF-8" ?><client> <auth extra="8" login="login" pass="pass" /> </client></source> '''client''' — Корневой контейнер. Обязательный элемент.* '''auth''' — Авторизация. Обязательный элемент. '''Пример ответа на запрос получения информации о клиенте:'''<source lang="xml"><?xml version="1.0" encoding="UTF-8" ?><client> <code>1082</code></client></source> * '''code''' — Код клиента == Список актов передачи денег =='''Пример запроса списка актов передачи денег:'''<source lang="xml"><?xml version="1.0" encoding="UTF-8" ?><smalist> <auth extra="8" login="login" pass="pass" /> <datefrom>2016-02-10</datefrom> <dateto>2016-03-10</dateto></smalist></source> '''smalist''' — Корневой контейнер. Обязательный элемент.* '''auth''' — Авторизация. Обязательный элемент.* '''datefrom''' — Дата «с». Необязательный элемент.* '''dateto''' — Дата «по». Необязательный элемент.Если интервал дат не указан, то возвращаются акты передачи денег за последний месяц. '''Пример ответа на запрос списка актов передачи денег:'''<source lang="xml"><?xml version="1.0" encoding="UTF-8"?><smalist count="1"> <sma> <code>6278</code> <number>3992</number> <actdate>2016-02-12</actdate> <datepay></datepay> <dateto>2016-02-12</dateto> <promiseddatepay></promiseddatepay> <price>637.00</price> <pricecorr>113.00</pricecorr> <rur>13430.00</rur> <pricekur>570.00</pricekur> <priceag>67.00</priceag> <payno>42423</payno> <paytype>1</paytype> <paytypename>Безнал</paytypename> <signedcopyreceived>NO</signedcopyreceived> </sma></smalist></source> * '''code''' — Код акта* '''number''' — Номер акта в системе* '''actdate''' — Дата акта* '''datepay''' — Дата оплаты по акту* '''dateto''' — Дата конечного периода для формирования АПД* '''promiseddatepay''' — Плановая дата оплаты* '''price''' — Стоимость услуг* '''pricecorr''' — Сумма корректировки* '''rur''' — Сумма заказа* '''pricekur''' — Стоимость курьерской доставки* '''priceag''' — Агентское вознаграждение* '''payno''' — Номер платежного поручения* '''paytype''' — Тип оплаты: 1 — безнал, 2 — наличными курьером, 3 — наличными в офисе, 4 — перевод на карту* '''paytypename''' — Строковое представление типа оплаты* '''signedcopyreceived''' — Признак факта возврата акта YES/NO == Детализация актов передачи денег =='''Пример запроса детализации актов передачи денег:'''<source lang="xml"><?xml version="1.0" encoding="UTF-8" ?><smadetail> <auth extra="8" login="login" pass="pass" /> <code>6278</code></smadetail></source> '''smadetail''' — Корневой контейнер. Обязательный элемент.* '''auth''' — Авторизация. Обязательный элемент.* '''code''' — Код акта передачи денег (см. запрос списка АПД). Обязательный элемент. '''Пример ответа на запрос детализации актов передачи денег:'''<source lang="xml"><?xml version="1.0" encoding="UTF-8"?><smadetail count="2"> <specialsma> <code>42494</code> <ordercode>14424</ordercode> <orderno>11111</orderno> <orderdate>2018-01-01</orderdate> <delivereddate>2018-10-01</delivereddate> <company>Компания</company> <price>314.00</price> <rur>8800.00</rur> <inshprice>314.00</inshprice> <pricekur>270.00</pricekur> <priceag>44.00</priceag> <pricecalc>8486.00</pricecalc> <paytype>2</paytype> <paytypename>наличными курьером</paytypename> <weight>0.400</weight> <distance>0.0</distance> <status>Доставлено</status> </specialsma></smadetail></source> * '''code''' — Код записи.* '''ordercode''' — Код заказа.* '''orderno''' — Шифр заказа.* '''orderdate''' — Дата заказа.* '''delivereddate''' — Дата доставки.* '''company''' — Получатель.* '''price''' — Стоимость услуг.* '''rur''' — Сумма заказа.* '''inshprice''' — Стоимость заказа.* '''pricekur''' — Стоимость курьерской доставки.* '''priceag''' — Агентское вознаграждение.* '''pricecalc''' — Сумма для передачи агенту.* '''paytype''' — Тип оплаты: 1 — безнал, 2 — наличными курьером, 3 — наличными в офисе, 4 — перевод на карту.* '''paytypename''' — Строковое представление типа оплаты* '''weight''' — Вес заказа.* '''distance''' — Дистанция по заказу* '''status''' — Статус заказа. == Генерация коротких ссылок ==В некоторых случаях, например, при использовании в СМС, может потребоваться использование коротких ссылок на ЛК.Для этого, необходимо отправить запрос с полной ссылкой, в ответ на который придёт хэш-код для ссылки. '''Пример запроса генерации коротких ссылок:'''<source lang="xml"><?xml version="1.0" encoding="UTF-8" ?><shortlink> <link short="0"> https://home.courierexe.ru/8/site/orders </link></shortlink></source> '''shortlink''' — Корневой контейнер. Обязательный элемент.* '''link''' — Полная ссылка, для которой необходимо получить код. Обязательный элемент. Если атрибут '''short''' равен 1, то ответ не будет содержать XML, а только хэш-код. '''Пример ответа на запрос генерации коротких ссылок:'''<source lang="xml"><?xml version="1.0" encoding="UTF-8"?><shortlink> <hash>35AF350C</hash></shortlink></source> * '''hash''' — Хэш-код ссылки. Далее, можно использовать ссылку на ЛК: <nowiki>https://home.courierexe.ru/35AF350C или curie.ru/35AF350C</nowiki>  '''Примечание!''' Сервис коротких ссылок работает только для ресурсов компании MeaSoft. == Проверка надежности покупателя ==Проверка надежности работает только для тарифа «Максимум» личного кабинета.

<smalistmcheck>

<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>Безнал</paytypenamephones> <signedcopyreceivedphone>NO89161147992</signedcopyreceivedphone> </smaphones></smalistmcheck>

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

<smadetailmcheck> <auth extraphones> <phone rate="8" login="login" pass="pass90" >89161147992</phone> <code>6278</codephones></smadetailmcheck>

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

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

В некоторых случаях, например, при использовании в СМС, может потребоваться использование коротких ссылок на ЛК[https://ya.Для этого, необходимо отправить запрос с полной ссылкойru/search/?text=iframe Фрейм] — контейнер внутри обычной страницы, в ответ на который придёт хэш-код для ссылкипозволяет загружать сторонние страницы.Пример загрузки калькулятора:

'''Пример запроса генерации коротких ссылок:'''<source lang="xmlhtml"><?xml version="1.0" encodingiframe id="UTF-8frame" ?><shortlink> <link shortsrc="0"> https://home.courierexe.ru/8/site/orders </linkcalculator"> Здесь должен отобразиться калькулятор</shortlinkiframe>

Для удобства пользователей вашего сайта можно указать язык интерфейса (который переключается непосредственно на сайте) параметром '''shortlinklang''' - Корневой контейнер. Обязательный элемент.*'''link''' - Полная ссылка, для которой необходимо получить код. Обязательный элемент. Если атрибут '''short''' равен 1, то ответ не будет содержать XML, а только хэш-код.:

'''Пример ответа на запрос генерации коротких ссылок:'''<source lang="xmlhtml"><?xml versioniframe id="1.0frame" encodingsrc="UTF-https://home.courierexe.ru/8/calculator?lang=2"?><shortlink> <hash>35AF350C</hash> Здесь должен отобразиться калькулятор</shortlinkiframe>

*'''hash''' - Хэш-код ссылкиОбратите внимание! Если язык не указать, то на страницах калькулятора и трекинга отображается свой переключатель языка. Если язык указан, то переключатель не отоборажается.

Далее, можно использовать ссылку на ЛКПоддерживаемые языки и их коды::'''1''' — русский<nowiki>https://home.courierexe.ru/35AF350C или curie.ru/35AF350C</nowiki> '''2''' — английский:'''Примечание!4''' Сервис коротких ссылок работает только для ресурсов компании MeaSoft.— узбекский