Изменения

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

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

<source langdiv style="xmlcolor: #a94442; background-color: #f2dede; border: 1px solid #ebccd1; padding: 3px 10px 10px;"><?xml version="1'''Обратите внимание!'''# Периода запроса статусов (контейнеры '''datefrom''' и '''dateto''') ограничивается двумя месяцами — два месяца до даты '''«по»'''.# Если не указаны обе даты — '''dateto''' принимается равной текущей дате.# Если не указана дата '''dateto''' — она принимается равной '''datefrom''' плюс 2 месяца.0" encoding="utf-8"?><request># Если не указана дата '''datefrom''' — она принимается равной '''dateto''' минус 2 месяца.<error error="1" errormsg="authorization error"></error># Поиск по '''conditions''' работает только для «Номер заказа(шифр)» и только от 4 символов</requestdiv></sourcebr>

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

<requeststatusreq count="23"> <order orderno="111111" awb="qwerty" orderno2="123123" ordercode="34534234" givencode="2345334"> <errorbarcode>111111</barcode> <sender> <company>МВД</company>column:1 line:11 message:expected ' <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> <contacts> <phone>+74951234567</phone> <phone>+79162344521</phone>:* '''''givencode''''' - внутренний код заказа в системе, применяется для некоторых внутренних операций <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>:* '''''RequestDateTime''''' - дата <print_check>YES</print_check> <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- статус доставки (список статусов см. ниже). Атрибуты (заполняются начиная с версии системы 2008.0.0.670)06-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 ="2016- вчера в 20:00. При этом оператор по каким06-то причинам может внести время вручения раньше, чем какое-то предыдущее событие, т.о. нарушится последовательность времени в eventtime, но при сортировке по createtimegmt все-равно все будет правильно.</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''' - дата вручения.* '''deliveredtime''' <status eventstore="Офис в Москве" eventtime="2016- время вручения. В случае недоставки может быть пустым.* '''outstrbarcode''' 06- код у подрядчика (код заказа во внешней системе). Используется в интеграциях с внешними системами.  Значения контейнеров '''status''' могут принимать следующие значения01 17:38: AWAITING_SYNC - Ожидает синхронизации. Данные заказа пока не появились в бэкофисе: NEW 00" createtimegmt="2016- Новый: PICKUP 06- Забран у отправителя03 16: ACCEPTED - Получен складом14: INVENTORY - Инвентаризация44": 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-color: #f2dede; border03 16: 1px solid #ebccd1; padding14: 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-06-803 16:14:44" ?><statusreq> <auth extra message="" title="8Доставлен" logineventtown="loginСанкт-Петербург город" passcountry="passRU">COMPLETE</status> </authstatushistory> <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="124555" fnSn="9289000100295555" kktNum="0001611984048555" inn="7722756555" fdValue="xml2899551555"summ="387.5" ofdUrl="gate.ofd.ru">https://ofd.ru/rec/7722756555/0001611984048555/9289000100295555/124555/2899551555</receipt> <items> <?xml versionitem code="34533" extcode="abc123" quantity="1" mass="0.2" retprice="37.5" VATrate="0" barcode="2345625213125" article="1" returns="0" origincountry="040" GTD="" excise="0.00" governmentCode="11223311" suppcompany="Поставщик" suppINN=" encoding1112223334" suppphone="UTF-879161234567" ?>Мяч<commitlaststatus/item> <auth extraitem code="34456" extcode="abc124" quantity="2" mass="2" retprice="100" VATrate="810" barcode="4645625213138" article="2" loginreturns="login0" passgovernmentCode="pass">Обруч</authitem> <clientitem code="34421" extcode="abc125" quantity="3" mass="0.3" retprice="50" VATrate="18" barcode="2345625213126" itemcode="44123" article="3" returns="0" governmentCode="">CLIENTПогремушка желтая</clientitem> </commitlaststatusitems> </sourcepackages> '''Описание полей запроса''' *'''auth''' - Авторизация. Обязательный элемент.*'''client''' - Признак клиента или агента. Необязательный элемент.:* CLIENT - Признак клиента, значение по умолчанию:* AGENT - Признак агента. В ответ отдается информация по заказам, переданным агенту на доставку В случае успеха Вы получите ответ <source langpackage code="xml33331"strbarcode="ORD0000001" mass="1" message="" got="YES"></package> <?xml versionpackage code="133332" strbarcode="ORD0000002" mass="2.05" message="" encodinggot="UTF-8NO" ?></package> <commitlaststatus error="0"/packages> </order>OK</commitlaststatusstatusreq>

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

<div stylesource lang="color: #a94442; backgroundxml"><?xml version="1.0" encoding="utf-color: #f2dede; border: 1px solid #ebccd1; padding: 3px 10px 10px;8"?><statusreq count="0">'''Обратите внимание!'''</statusreq> </source>

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

=== Описание полей ответа статусов ===Все поля ответа соответствуют структуре order при создании заказа, с некоторыми добавлениями: * Атрибуты контейнера '''order'''::* '''''awb''''' — Номер накладной в системе курьерской службы.:* '''''orderno2''''' — Номер накладной в подсистеме срочной доставки курьерской службы.:* '''''ordercode''''' — внутренний код заказа в системе, применяется для некоторых внутренних операций.:* '''''givencode''''' — внутренний код заказа в системе, применяется для некоторых внутренних операций. *'''paytype''' - Тип оплаты заказа получателем. Принимает значения::: CASH - Наличными при получении (по-умолчанию):: CARD - Картой при получении:: NO - Без оплаты.:: OTHER - Прочее (Предусмотрен для того, чтобы оплата поступала непосредственно в курьерскую службу посредством прочих типов оплаты - таких как: вебмани, яденьги, картой на сайте, прочие платежные системы и т.д.)* Атрибуты контейнера '''paytype''':** '''''code''''' - (integer) внутренний код типа оплаты заказа в системном справочнике "Типы оплаты корреспонденции". Не обязательный элемент.  * атрибут '''''code''''' контейнера '''item''' — внутренний код строки заказа в системе, применяется для некоторых внутренних операций.:* '''''returns''''' — количество данного товара, от которого отказался получатель. Не нулевое только в случае частичного отказа. * атрибут '''''got''''' контейнера '''package''' — признак принятого места YES / NO.:* '''''returns''''' — количество данного товара, от которого отказался получатель. Не нулевое только в случае частичного отказа. * '''''area''''' в контейнере '''receiver''' — район/метро получателя.* '''''coords''''' в контейнере '''receiver''' — координаты получателя.* '''''deliveryPIN''''' в контейнере '''receiver''' — Пин-код.* '''pickup''' — признак оформления забора, возможные значения: '''YES''', '''NO'''. Если указано '''YES''', то весь заказ считается заданием на забор груза, а не на доставку.* '''currcoords''' — текущие координаты заказа. Атрибуты::* '''''lat''''' — широта:* '''''lon''''' — долгота:* '''''accuracy''''' — точность в метрах:* '''''RequestDateTime''''' — дата/время последнего обновления координат. * '''courier''' — Данные курьера, которому выдан заказ. Если заказ не выдан, то выводятся данные запланированного курьера.* '''waittime ''' — Время ожидания курьера.* '''deliveryprice''' — Стоимость услуг в валюте расчетов с клиентом. Атрибуты::* '''''total''''' — общая стоимость услуг:* '''''delivery''''' — стоимость доставки «Туда»:* '''''return''''' — стоимость доставки «Обратно» (если order->return=YES)Тэг '''deliveryprice''' включает список дополнительных услуг (только для тарифа «Премиум»)::* '''''advprice''''' — наименование дополнительной услуги:* '''''code''''' — код дополнительной услуги:* '''''price''''' — стоимость дополнительной услуги * '''status''' — статус доставки (список статусов см. ниже). Атрибуты (заполняются начиная с версии системы 2008.0.0.670)::* '''''eventstore''''' — филиал, к которому относится текущий статус:* '''''eventtime''''' — время события по часовому поясу места его наступления.:* '''''createtimegmt''''' — время по GMT создания записи о смене статуса в БД. Используется для сортировки записей, чтобы соблюсти хронологическую последовательность. <spoiler text="Подробнее">Большинство событий фиксируются в полях eventtime и createtimegmt на основании одного действия, тогда они отличаются только сдвигом от GMT. Однако, если курьер доставил отправление 10.10.2010 в 20:00, по какой-то причине не внес это в мобильное приложение, на следующий день сдал накладную, и в 9 утра оператор внесла, что он доставил вчера в 20:00. Тогда в createtimegmt будет сегодня 6 утра (для Москвы), а в eventtime — вчера в 20:00. При этом оператор по каким-то причинам может внести время вручения раньше, чем какое-то предыдущее событие, т.о. нарушится последовательность времени в eventtime, но при сортировке по createtimegmt все-равно все будет правильно.</spoiler>:* '''''message''''' — наименование филиала-получателя, при передаче между филиалами:* '''''title''''' — русское наименование статуса * '''statushistory''' — история статусов доставки. Содержит список контейнеров '''status'''. Заполняется только для тарифа «Премиум» начиная с версии системы 2008.0.0.670.* '''customstatecode''' — код внутреннего статуса курьерской службы. Значения уточняйте в курьерской службе. Назначаются курьерской службой в разделе «Справочники» — «Статусы» — «15 Статусы корреспонденции». Справочник не передается через API клиенту по причине возможного наличия в нем внутренних технологических статусов курьерской службы.* '''clientstatecode''' — код статуса клиента. Используется, если клиент предлагает свои коды статусов доставки/причин недоставки.* '''deliveredto''' — данные из поля «Инфо. о доставке» (может быть информация о доставке, причина недоставки и т. п.).* '''delivereddate''' — дата вручения.* '''deliveredtime''' — время вручения. В случае недоставки может быть пустым.* '''arrival''' — плановая дата прибытия в формате гггг-мм-дд чч: мм: сс. Заполняется только при использовании автоматических систем планирования (Максоптра, Яндекс доставка), во всех остальных случаях - пустое.* '''Пример ответаoutstrbarcode''' — код у подрядчика (код заказа во внешней системе). Используется в интеграциях с внешними системами.* '''partner''' — текущий филиал/подрядчик.* '''return_message''' — информация о возврате* '''department''' — Подразделение, в котором оформляется заказ. Контейнер '''status''' может принимать следующие значения:: AWAITING_SYNC — Ожидает синхронизации. Данные заказа пока не появились в службе доставки.: '''NEW''' — Успешно создан, передан в службу доставки.: NEWPICKUP — Создан забор.: PICKUP — Забран у отправителя.: WMSASSEMBLED — Скомплектован на складе фулфилмента.: WMSDISASSEMBLED — Разукомплектован на склад фулфилмента.: '''ACCEPTED''' — Получен складом.: CUSTOMSPROCESS — Производится таможенный контроль.: CUSTOMSFINISHED — Таможенный контроль произведен.: CONFIRM — Согласована доставка.: UNCONFIRM — Не удалось согласовать доставку.: DEPARTURING — Планируется отправка со склада на другой склад.: DEPARTURE — Отправлено со склада на другой склад.: INVENTORY — Инвентаризация. Убедились в наличии отправления на складе.: PICKUPREADY — Готов к выдаче в ПВЗ.: '''DELIVERY''' — Выдан курьеру на доставку.: COURIERDELIVERED — Доставлен (предварительно, ожидает подтверждения менеджером, чтобы перейти в статус COMPLETE).: COURIERPARTIALLY — Частично доставлен (предварительно, ожидает подтверждения менеджером, чтобы перейти в статус PARTIALLY).: COURIERCANCELED — Отказ (предварительно, после этого ожидается COURIERRETURN).: COURIERRETURN — Возвращено курьером. Курьер не смог доставить до получателя и вернул заказ обратно на склад. Это промежуточный статус, после которого менеджер выясняет, нужно ли повторно доставлять (статусы DATECHANGE/DELIVERY) или это окончательная недоставка (CANCELED).: DATECHANGE — Перенос даты доставки. : '''COMPLETE''' — Доставлен.: '''PARTIALLY''' — Доставлен частично.: '''CANCELED''' — Не доставлен (Возврат/Отмена). После этого статуса отправление должны вернуть заказчику, будут статусы RETURNING и RETURNED : RETURNING — Планируется возврат заказчику (после CANCELED).: RETURNED — Возвращен заказчику.: LOST — Утрачен/утерян. : PARTLYRETURNING — Планируется возврат остатков.: PARTLYRETURNED — Остаток возвращен.: TRANSACCEPTED — Прибыл на склад перевозчика.: PICKUPTRANS — Забран у перевозчика.  '''Примечание.''' В будущем возможно дополнение используемого набора статусов. <div style="color: #a94442; background-color: #f2dede; border: 1px solid #ebccd1; padding:3px 10px 10px;">'''Обратите внимание!''' # Контейнер '''statushistory''' и '''deliveryprice''' заполняется для тарифов [[Личный кабинет курьерской службы#Функции личного кабинета|Премиум и Максимум]].# Система никогда не гарантирует последовательность прохождения заказом набора статусов. То есть Вы можете получить статус «COMPLETE», а следующим запросом — «NEW» — такое может произойти, например, если оператор ошибочно отметил заказ выполненным, а затем исправил ошибку.</div><br> === Передача только изменившихся статусов ===В нашем API предусмотрено удобное средство получения статусов всех заказов, без необходимости «бомбить» сервер запросами статусов по каждому заказу. Работает это так: раз, например, в 10 минут, вы посылаете запрос «покажите все изменившиеся статусы». Пример запроса ниже. Система вам отдает ВСЕ заказы, статусы (или некоторые другие поля, см. ниже) которых изменились с момента последнего запроса. Вы разбираете полученный документ, по каждому заказу сохраняете его актуальный статус в своей системе, и если все хорошо, у вас все получилось, ваша система неожиданно не упала от наплыва информации, посылаете нам запрос подтверждения получения статусов (commitlaststatus). Мы у себя отмечаем, что эти статусы вами получены и их не надо передавать повторно. Таким образом, сколько бы заказов у вас ни было, статусы по ним всем почти в реальном времени вы можете получать всего двумя запросами. Для получения только изменившихся статусов отправьте запрос:

<?xml version="1.0" encoding="UTF-8"?><trackingstatusreq> <order ordernoauth extra="1111118"> <barcode>111111</barcode> <AWB>111111</AWB> <sender> <town codelogin="1login" countrypass="RUpass">Москва город</townauth> <datechanges>2014-03-22ONLY_LAST</datechanges> <time_minstreamid>09:001234</time_minstreamid> <time_max>14:00</time_maxstatusreq> </sendersource> <receiver> <town code="1" country="RU">Москва город</town>Система выдает все заказы, в которых с момента последнего запроса в этом режиме изменилось хотя бы одно из полей: orderno status <zipcode>125480</zipcode> delivereddate <date>2014-03-22</date> deliveredtime <time_min>09:00</time_min> deliveredto <time_max>14:00</time_max receiver->date </ receiver->address < price>387.5</price> <inshprice>387.5</inshprice> После успешной обработки ответа необходимо отметить полученные статусы успешно полученными, отправив запрос:<paytype>CASH</paytypesource lang="xml"> <weight>5?xml version="1.1</weight0" encoding="UTF-8" ?> <quantity>2</quantitycommitlaststatus> <serviceauth extra="8" login="login" pass="pass">2</serviceauth> <typeclient>3CLIENT</typeclient> <returnstreamid>NO1234</returnstreamid> <return_service>2</servicecommitlaststatus> <return_date></return_datesource> <return_time></return_time> <return_message></return_message>'''Описание полей запроса''' <waittime>12</waittime> <enclosure>Детские игрушки</enclosure>* '''auth''' — авторизация. Обязательный элемент. <instruction>Проверить при покупателе* '''streamid''' — идентификатор потока. Если у вас несколько интеграций и каждая нуждается в получении статусов, подписать акт</instruction> <deliveryprice total="158вы можете передавать данный параметр и тем самым разделять получение и отметку об успешном получении статусов по заказам.6" delivery="Значение должно входить в промежуток от 100до 10000, включительно.00" return="58Необязательный элемент.6" /> <courier>* '''client''' — признак клиента или агента. Необязательный элемент. <code>26</code>:* CLIENT — признак клиента, значение по умолчанию <name>Иванов Владимир Петрович</name>:* AGENT — признак агента. В ответ отдается информация по заказам, переданным агенту на доставку <phone>+79161234567</phone> </courier>В случае успеха вы получите ответ: <currcoords lat="55.680327" lon="37.604456" accuracy="50" RequestDateTimesource lang="2014-04-21 18:07:45xml" /> <status eventstore?xml version="филиал в Санкт-Петербурге1.0" eventtimeencoding="2016UTF-06-02 17:22:00" createtimegmt="2016-06-03 16:14:44" message="" title="Доставлен8">COMPLETE</status> <statushistory?> <status eventstorecommitlaststatus error="Офис в Москве" eventtime="2016-05-30 10:20:00" createtimegmt="2016-06-03 16:14:44" message="" title="Новый0">NEWOK</statuscommitlaststatus> <status eventstore="Офис в Москве" eventtime="2016-06-01 17:38:00" createtimegmt="2016-06-03 16:14:44" message="филиал в Санкт-Петербурге" title="Планируется отправка">DEPARTURING</statussource> <status eventstore="Офис Такой способ передачи статусов гарантирует полную корректную передачу статусов, даже если в Москве" eventtime="2016-06-01 19:53:00" createtimegmt="2016-06-03 16:14:44" message="филиал в Санкт-Петербурге" title="Отправлено со склада">DEPARTURE</status>нашей системе статус изменился между запросом статусов и подтверждением их получения. Если система не получила подтверждение передачи статуса, она будет считать информацию непереданной и выдаст ее при повторном запросе.  <status eventstorediv style="филиал в Санктcolor: #a94442; background-Петербурге" eventtime="2016-06-02 07color:41:00" createtimegmt="2016-06-03 16#f2dede; border:141px solid #ebccd1; padding:44" message="" title="Получен складом3px 10px 10px;">ACCEPTED</status> # При этом способе передачи (<status eventstore="филиал в Санкт-Петербурге" eventtime="2016-06-02 09:17:00" createtimegmt="2016-06-03 16:14:44" message="" title="Выдан курьеру на доставку"changes>DELIVERYONLY_LAST</statuschanges> <status eventstore="филиал в Санкт-Петербурге" eventtime="2016-06-02 17:22:00" createtimegmt="2016-06-03 16:14:44" message="" title="Доставлен (предварительно)">COURIERDELIVERED</status> <status eventstore="филиал система просматривает заказы, оформленные за последние 3 месяца. Если заказ сделан ранее, изменение статуса по нему не попадет в Санкт-Петербурге" eventtime="2016-06-02 17:22:00" createtimegmt="2016-06-03 16:14:44" message="" title="Доставлен">COMPLETE</status>результат выполнения запроса. </# Система всегда выдает текущий статус. Вы можете одним запросом получить статус «NEW», а следующим — «COMPLETE». Между запросами отправление могло пройти через несколько промежуточных статусов. Если нужна гарантия получения всех промежуточных статусов, нужно анализировать блок statushistory>(может не заполняться вследствие ограничений версии или тарифа конкретной службы доставки). <deliveredto>Иванова# Система не гарантирует последовательность прохождения заказом набора статусов. Вы можете получить статус «COMPLETE», а следующим запросом «NEW» — такое может произойти, например, если оператор ошибочно отметил заказ выполненным, секра затем исправил ошибку.</deliveredto> <delivereddate>2016-06-02</delivereddatediv> <deliveredtime>17:22</deliveredtime> <outstrbarcode>EXT123456</outstrbarcodebr> <items> <item code="34533" extcode="abc123" quantityТрекинг заказа по номеру ="1" mass="0Запрос трекинга по номеру предназначен для выдачи минимальной обезличенной информации о конкретном заказе не авторизованному пользователю. Наша система имеет для этого интерфейс по адресу «home.courierexe.ru/{код экстра}/tracking».2" retprice="37Вы можете либо сделать ссылку на такую страницу на своем сайте, либо разместить ее [[#Размещение страниц на своем сайте (iframe)|iframe’ом]] у себя, либо сделать свою и пользоваться нашим API.5" VATrate="0" barcode="2345625213125" article="1" returns="0" origincountry="040" GTD="" excise="0Этот интерфейс создан специально для выдачи информации живому пользователю сайта.00" governmentCodeДля получения статусов заказов в свою информационную систему нужно использовать запрос «statusreq», желательно с параметром changes="11223311" suppcompany="Поставщик" suppINNONLY_LAST! '''Пример запроса:'''<source lang="1112223334" suppphone="79161234567xml">Мяч</item> <item code="34456" extcode="abc124" quantity="2" mass="2" retprice="100" VATrate="10" barcode="4645625213138" article="2" returns?xml version="1.0" governmentCodeencoding="UTF-8"?>Обруч</itemtracking> <item code="34421" extcode="abc125" quantity="3" mass="0.3" retprice="50" VATrate="18" barcode="2345625213126" article="3" returns="0" governmentCode=""extra>Погремушка желтая8</itemextra> </itemsorderno> 1234</orderorderno>

 '''Получение информации в формате 17 TRACK''' '''Пример запросаответа:'''<source lang="xml">

<tracking17tracking> <extraorder orderno="111111"> <barcode>8111111</extrabarcode> <ordernoAWB>1234111111</ordernoAWB> <sender> <town code="1" country="RU">Москва город</tracking17town> <date>2014-03-22</sourcedate> <time_min>09:00</time_min>'''Пример ответа <time_max>14:'''00</time_max> <pre/sender>{ <receiver> <town code="number1":country="ExtNumberRU">Москва город</town> <zipcode>125480</zipcode> <date>2014-03-22</date> <time_min>09:00</time_min> <time_max>14:00</time_max> </receiver> <price>387.5</price> <inshprice>387.5</inshprice> <paytype>CASH</paytype> <weight>5.1</weight> <quantity>2</quantity> <service>2</service> <type>3</type> <return>NO</return> <return_service>2</return_service> <return_date></return_date> <return_time></return_time> <return_message></return_message> <waittime>12</waittime> <enclosure>Детские игрушки</enclosure> <instruction>Проверить при покупателе,подписать акт</instruction> <deliveryprice total="158.6"oriNumberdelivery=":100.00" return="123458.6",/> <courier> "oriCountry":"RU",<code>26</code> "destCountry":"RU",<name>Иванов Владимир Петрович</name> <phone>+79161234567</phone> </courier> <currcoords lat="status55.680327" lon=":37.604456"Completeaccuracy=", 50"eventsRequestDateTime="2014-04-21 18:07:[45" /> { <status eventstore="timeфилиал в Санкт-Петербурге":eventtime="2016-06-02 17:22:00",createtimegmt="2016-06-03 16:14:44" message="" title="Доставлен">COMPLETE</status> <statushistory> <status eventstore="locationОфис в Москве"eventtime="2016-05-30 10:20:00"RUcreatetimegmt="2016-06-03 16:14:44", message="content":title="CompleteНовый">NEW</status> }, { <status eventstore="timeОфис в Москве":eventtime="2016-06-02 01 17:2238:00", "locationcreatetimegmt="2016-06-03 16:14:44"RUmessage=", филиал в Санкт-Петербурге"contenttitle=":"CourierdeliveredПланируется отправка">DEPARTURING</status> }, { <status eventstore="timeОфис в Москве":eventtime="2016-06-02 0901 19:1753:00", "locationcreatetimegmt="2016-06-03 16:14:44"RU", message="contentфилиал в Санкт-Петербурге":title="DeliveryОтправлено со склада">DEPARTURE</status> }, { <status eventstore="timeфилиал в Санкт-Петербурге":eventtime="2016-06-02 07:41:00",createtimegmt="2016-06-03 16:14:44" message="" title="Получен складом">ACCEPTED</status> <status eventstore="locationфилиал в Санкт-Петербурге"eventtime="2016-06-02 09:17:00"RUcreatetimegmt="2016-06-03 16:14:44", message="content":title="AcceptedВыдан курьеру на доставку">DELIVERY</status> }, { <status eventstore="timeфилиал в Санкт-Петербурге":eventtime="2016-06-01 1902 17:5322:00", "locationcreatetimegmt="2016-06-03 16:14:44"RUmessage=", "contenttitle=":"DepartureДоставлен (предварительно)">COURIERDELIVERED</status> }, { <status eventstore="timeфилиал в Санкт-Петербурге":eventtime="2016-06-01 02 17:3822:00", "locationcreatetimegmt="2016-06-03 16:14:44"RUmessage=", "contenttitle=":"DeparturingДоставлен">COMPLETE</status> </statushistory> } <deliveredto>Иванова,секр.</deliveredto> <delivereddate>2016-06-02</delivereddate> <deliveredtime>17:22</deliveredtime> <outstrbarcode>EXT123456</outstrbarcode> { <items> <item code="34533" extcode="abc123" quantity="1" mass="0.2" retprice="37.5" VATrate="0" barcode="2345625213125" article="time1":returns="0" origincountry="040" GTD="" excise="2016-05-30 10:20:00.00" governmentCode="11223311" suppcompany=",Поставщик" suppINN="1112223334" suppphone="79161234567">Мяч</item> <item code="34456" extcode="abc124" quantity="2" mass="2" retprice="location100":VATrate="10" barcode="4645625213138" article="2" returns="0" governmentCode="RU",>Обруч</item> <item code="34421" extcode="contentabc125":quantity="3" mass="0.3" retprice="50" VATrate="18" barcode="2345625213126" article="3" returns="0" governmentCode="New">Погремушка желтая</item> </items> } </order> ]</tracking>}</presource>

Запрос предназначен для изменения заказов, находящихся в статусах "Ожидает синхронизации" или "Новый", а также по которым не было произведено изменений - статуса корреспонденции, времени доставки - то есть заказов, которые ещё не находятся в работе. <div style="color: #a94442; background-color: #f2dede; border: 1px solid #ebccd1; padding: 3px 10px 10px;">'''Обратите внимание!'''# Данные запроса изменения указываются '''полностью''', как если бы заказ создавался впервые.# При отсутствии вложения в запросе изменения данное вложение '''не удаляется''' из заказа, но его количество становится равным 0.# При одновременном изменении заказа в API и системе курьерской службы приоритет отдается данным системы курьерской службы. То есть изменения в API приняты не будут!</div><br /> === Описание полей запроса изменения ===Все поля запроса соответствуют структуре order при создании заказа за исключением:* вместо корневого тэга '''neworder''' указывается '''editorder'''* тэг штрих-кода '''barcode''' не указывается, поскольку присваивается при создании заказа. === Описание полей ответа изменения ===Все поля ответа соответствуют ответу при создании заказа за исключением корневого тэга - вместо '''neworder''' возвращается '''editorder'''. == Отмена заказа == Запрос отмены предназначен для отмены тех заказов, по которым не было произведено изменений - статуса доставки, статуса корреспонденции, времени доставки - то есть заказов, которые ещё не находятся в работе.Возможность отмены заказа есть только у курьерских служб с тарифом "Премиум" и по-умолчанию она выключена, ее нужно отдельно включить: [[Личный кабинет курьерской службы#Дополнительные настройки]]. При отмене заказа поле "Инфо о доставке" получает значение "Отменено заказчиком", поле "Дата доставки" - текущую дату, а "Вручил курьер" - системную запись "ОТМЕНА".  '''Пример запроса отмены заказа:'''<source lang="xml"><?xml version="1.0" encoding="UTF-8" ?><cancelordertracking17> <auth extra=">8" login="login" pass="pass" </extra> <order orderno="" ordercode="123456" /> 1234<order /orderno="123aaa" ordercode="" /></cancelordertracking17></source>  '''Описание полей запроса статуса:''' '''cancelorder''' - Корневой контейнер. Обязательный элемент.*'''auth''' - Авторизация. Обязательный элемент.*'''order''' - Контейнер отменяемого заказа. Обязательный элемент. Запрос может содержать более одного контейнера '''order'''. Атрибуты::* '''''orderno''''' - Шифр заказа.:* '''''ordercode''''' - Внутренний код заказа.Обратите внимание, что должен быть указан хотя бы один из атрибутов ''orderno'' или ''ordercode''!

'''Пример ответа:'''Функция ищет последний заказ по номеру среди заказов всех клиентов. Выдает неперсонализированную информацию о текущем состоянии заказа.<source lang="xml"br><?xml version="1Описание контейнеров ответа аналогично описанию [[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|Запроса статусов заказов]].0" encoding="UTF-8" ?><cancelorder> <order orderno="123test" ordercode="123456" error="0" errormsg="OK" errormsgru="Успешно" /> <order orderno="123aaa" ordercode="" errorИзменение заказа ="52" errormsg="order not found" errormsgru="Заказ не найден" /></cancelorder></source>Запрос предназначен для изменения заказов.

<div style="color: #a94442; background-color: #f2dede; border: 1px solid #ebccd1; padding: 3px 10px 10px;">'''Обратите внимание!'''Пример # Данные запроса:изменения указываются '''полностью''', как если бы заказ создавался впервые.<source lang="xml"><?xml version="1# При отсутствии вложения в запросе изменения данное вложение '''не удаляется''' из заказа, но его количество становится равным 0.0" encoding="UTF-8" ?><addattachments> <auth extra="8" login="login" pass="pass" /> <orderno>1234567</orderno> <attachments> <item name="photo1# При одновременном изменении заказа в API и системе курьерской службы приоритет отдается данным системы курьерской службы.jpg">JVBERi0xLjMN1wb25lbnQgMQ JUBQREYwMTIzNDU2Nzg5IDI NMyAwIG9iag08PA0vVHlwZSA U3VidHlwZSAvSW1hZ2UNL1d pZHRoIDE4MDgNL0hlaWdodCA ggNCAwIFINL0JpdHNQZXJDb 21wb25lbnQgMQ0vRGVjb2RlU ENL0NvbHVtbnMgMTgwOA0+P g0vSW1hZ2VNYXNrIHRydWUNL XhEZWNvZGUNPj4Nc3RyZWFt DQ</item> <item name="photo2То есть изменения в API приняты не будут.jpg">VBERi0xLjMNAwIG9iag0HRoJ JUBQREYwMTIzNDU2Nzg5IDI NMyAwIG9iag08PA0vVHlwZSA vWE9iamVjdA0vU3VidHlwZS AvSW1hZ2UNL1dpZHRoIDEzNj gNL0hlaWdodCAxMzMzDS9MZ W5ndGggNCAwIFINL0JpdHNQZ XJDb21wb25lbnQgMQ0vRGVj b2RlUGFybXMgPDwNL0sgLTEN L0NvbHVtbnMgMTM2OA0+Pg0 vSW</item> </attachments></addattachments></sourcediv>

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

* значение '''addattachmentsorderno''' - Корневой контейнер. Обязательный элементданным методом изменить нельзя.*значение '''authbarcode''' изменяется в случае явного его указания. В случае отсутствия или пустого значения - Авторизация. Обязательный элементостается прежним.*вместо корневого тэга '''neworder''' указывается '''ordernoeditorder''' - Номер заказа. Обязательный элемент. Может использоваться тэг <ordercode> с указанием внутреннего кода заказа.;*тэг курьера '''courier''' можно изменить только при включенной настройке '''attachmentsРазрешить изменение курьера по АПИ''' - Обязательный элемент, в котором перечисляются передаваемые данные файлов.;**для вложений '''item''' - Бинарные данные (файл)указывается внутренний код вложения в атрибуте '''code''', закодированные в base64. Обязательный элементкоторый можно получить при получении статуса заказа.***для мест '''namepackage''' - Атрибут элемента указывается внутренний код вложения в атрибуте '''itemcode''', в котором передается имя файла. Обязательный элементкоторый можно получить при получении статуса заказа.

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

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

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

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

'''attachments''' - Корневой контейнер. Обязательный элемент.*'''auth''' - Авторизация. Обязательный элемент.*'''orderno''' - Номер/код При отмене заказа. Обязательный элементполе «Инфо о доставке» получает значение «Отменено заказчиком», поле «Дата доставки» — текущую дату, а «Вручил курьер» — системную запись «ОТМЕНА».

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

<?xml version="1.0" encoding="UTF-8"?><attachmentscancelorder> <item nameauth extra="doc1.docx8" sizelogin="35654login"pass="pass" />JVBERi0xLjMN JUBQREYwMTIzNDU2Nzg5IDI NMyAwIG9iag08PA0vVHlwZSA U3VidHlwZSAvSW1hZ2UNL1d pZHRoIDE4MDgNL0hlaWdodCA ggNCAwIFINL0JpdHNQZXJDb 21wb25lbnQgMQ0vRGVjb2RlU ENL0NvbHVtbnMgMTgwOA0+P g0vSW1hZ2VNYXNrIHRydWUNL XhEZWNvZGUNPj4Nc3RyZWFt DQ<order orderno="" ordercode="123456" /item> <item nameorder orderno="photo2.jpg123aaa" sizeordercode="74861">VBERi0xLjMN JUBQREYwMTIzNDU2Nzg5IDI NMyAwIG9iag08PA0vVHlwZSA vWE9iamVjdA0vU3VidHlwZS AvSW1hZ2UNL1dpZHRoIDEzNj gNL0hlaWdodCAxMzMzDS9MZ W5ndGggNCAwIFINL0JpdHNQZ XJDb21wb25lbnQgMQ0vRGVj b2RlUGFybXMgPDwNL0sgLTEN L0NvbHVtbnMgMTM2OA0+Pg0 vSW</item></attachmentscancelorder>

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

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

'''Пример запроса изменения статуса:'''

<setorderinfoaddattachments>

<order ordercode="123456"> <messageorderno>Получил Иванов1234567</messageorderno> </orderattachments> <order ordercodeitem name="234567photo1.jpg">JVBERi0xLjMN1wb25lbnQgMQ <status>PICKUPREADY</status>JUBQREYwMTIzNDU2Nzg5IDI NMyAwIG9iag08PA0vVHlwZSA <eventtime>2016-05-30 10:20:00</eventtime>U3VidHlwZSAvSW1hZ2UNL1d pZHRoIDE4MDgNL0hlaWdodCA <message>Клиент отказался от покупки</message>ggNCAwIFINL0JpdHNQZXJDb 21wb25lbnQgMQ0vRGVjb2RlU <paytype>CASH</paytype>ENL0NvbHVtbnMgMTgwOA0+P g0vSW1hZ2VNYXNrIHRydWUNL XhEZWNvZGUNPj4Nc3RyZWFt DQ<items> <item code="34533" quantity="1" reason="0" /> <item code="34456" quantity="0" reason="0" /> <item code="34421" quantity="2" reason="0" /> </items> <image filenameitem name="filename1photo2.jpg"> /9j/4AAQSkZJRgAVBERi0xLjMNAwIG9iag0HRoJ BAQAAAQABAAD/2wBDAA0JCg sKCA0LCgsODg0PEyAVExISEyJUBQREYwMTIzNDU2Nzg5IDI NMyAwIG9iag08PA0vVHlwZSA ccHhcgLikxMC4pLSwzOko+M zZGNywtQFdBRkxOUlNSMj5aYvWE9iamVjdA0vU3VidHlwZS AvSW1hZ2UNL1dpZHRoIDEzNj VpQYEpRUk//2wBDAQ4ODhMR EyYVFSZPNS01T09PT09PT09PgNL0hlaWdodCAxMzMzDS9MZ W5ndGggNCAwIFINL0JpdHNQZ T09PT09PT09PT09PT09PT09 PT09PT09PT09PT09PT09PT09XJDb21wb25lbnQgMQ0vRGVj b2RlUGFybXMgPDwNL0sgLTEN PT09PT0//wAARCAYACAADAS IAL0NvbHVtbnMgMTM2OA0+Pg0 vSW</imageitem> </orderattachments></setorderinfoaddattachments>

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

<setorderinfoaddattachments> <order ordercodeattachments> <item name="123456photo1.jpg" error="0" errormsg="OK" errormsgru="Успешно" /> <order ordercodeitem name="234567photo2.jpg" error="590" errormsg="value [date_put] is already setOK" errormsgru="Значение [Дата доставки] уже указаноУспешно" /> </attachments></setorderinfoaddattachments>

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

<waybillattachments>

<ordersorderno> 1234567<order orderno="1234567" ordercode="33331" /> <order orderno="1234568" ordercode="33332" /> </orders> <form>1</form></waybillattachments>

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

<waybillattachments> <contentitem name="doc1.docx" size="35654">EODIcaI8KSBlwQ 4MnEOR7Px8U8EBAyGICBnwpw JVBERi0xLjMN IZhQgz0ZxuPs8EBMJUBQREYwMTIzNDU2Nzg5IDI NMyAwIG9iag08PA0vVHlwZSA U3VidHlwZSAvSW1hZ2UNL1d pZHRoIDE4MDgNL0hlaWdodCA ggNCAwIFINL0JpdHNQZXJDb 21wb25lbnQgMQ0vRGVjb2RlU ENL0NvbHVtbnMgMTgwOA0+P g0vSW1hZ2VNYXNrIHRydWUNL XhEZWNvZGUNPj4Nc3RyZWFt DQ</GcbjzB AwhBl8hwQYIO00GmEwg1CeEG item> <item name="photo2.jpg" size="74861">VBERi0xLjMN mqYTChNU0wqf8l8nz4zgc+K fCno+zwU5GjOZmzXGcbEQYIM JUBQREYwMTIzNDU2Nzg5IDI NMyAwIG9iag08PA0vVHlwZSA vWE9iamVjdA0vU3VidHlwZS AvSW1hZ2UNL1dpZHRoIDEzNj 4zkegRE40zWzONyoNNMIOIa cWnp6aDCGEGE9NQmoQd2mg00 gNL0hlaWdodCAxMzMzDS9MZ W5ndGggNCAwIFINL0JpdHNQZ 79U4f3hPTwnfp6Sdrafeqpa JDpFw/1aYT077VNNNdO00G3q XJDb21wb25lbnQgMQ0vRGVj b2RlUGFybXMgPDwNL0sgLTEN mqqvp9p2E7T0/wiFemv8uG6 OML0NvbHVtbnMgMTM2OA0+Pg0 vSW</contentitem></waybillattachments>

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

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

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

<?xml version="1.0" encoding="UTF-8"?><townlistsetorderinfo> <auth extra="8" login="login" pass="pass" /> <codesearch> <zipcode>110000</zipcodeorder ordercode="123456"> <kladrcodemessage>0100000100800Получил Иванов</kladrcodemessage> <fiascodeoutstrbarcode>bd21979d-46f8-49d0-9105-e8d65172a9837654312</fiascode> <code>123</codeoutstrbarcode> </codesearchorder> <conditionsorder ordercode="234567"> <citystatus>Краснодарский крайPICKUPREADY</citystatus> <namecontainseventtime>новгород2016-05-30 10:20:00</namecontainseventtime> <namestartsmessage>МоскКлиент отказался от покупки</namestartsmessage> <namepaytype>МоскваCASH</namepaytype> <fullnamestoreprice>Москва город123</fullnamestoreprice> <countryitems> <item code="34533" quantity="1<" reason="0" governmentCode="11223311" /country> <item code="34456" quantity="0" reason="0" /conditions> <limititem code="34421" quantity="2" reason="0" /> <limitfrom>30</limitfromitems> <limitcountimage filename="filename1.jpg">10</limitcount>9j/4AAQSkZJRgA BAQAAAQABAAD/2wBDAA0JCg sKCA0LCgsODg0PEyAVExISEy ccHhcgLikxMC4pLSwzOko+M zZGNywtQFdBRkxOUlNSMj5aY VpQYEpRUk//2wBDAQ4ODhMR EyYVFSZPNS01T09PT09PT09P T09PT09PT09PT09PT09PT09 PT09PT09PT09PT09PT09PT09 <countall>YESPT09PT0//wAARCAYACAADAS IA</countallimage> </limitorder></townlistsetorderinfo>

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

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

<townlist countsetorderinfo> <order ordercode="3123456" pageerror="10" totalcounterrormsg="3OK" totalpageserrormsgru="1Успешно"/> <townorder ordercode="234567" error="59" errormsg="value [date_put] is already set" errormsgru="Значение [Дата доставки] уже указано" /> <code>26379</codesetorderinfo> <city/source> <code>23</code> <name>Краснодарский край</name>== Получение документов для печати == </city>'''Пример запроса получения печатных форм:''' <name>Сочи город</namesource lang="xml"> <fiascode>79da737a?xml version="1.0" encoding="UTF-603b-4c19-9b54-9114c96fb912</fiascode8" ?> <kladrcodewaybill>2300000700000 <auth extra="8" login="login" pass="pass" /kladrcode> <shortname /orders> (not yet supported) <typename order orderno="1234567" ordercode="33331" /> (not yet supported) <coords latorder orderno="43.58551234568" lonordercode="39.723133332" /> </townorders> <townform> <code>403311</codeform> <citystart> <code>325</codestart> <name>Брянская область</namewaybill> </citysource> <name>Сочилов хутор</name> <fiascode>c9c96c67'''Описание полей:''' '''waybill''' — Корневой контейнер. Обязательный элемент* '''auth''' — Авторизация. Обязательный элемент* '''orders''' — Список заказов для получения печатных форм. Содержит тэги '''order''' с атрибутами::* '''''orderno''''' — шифр заказа:* '''''ordercode''''' — внутренний код заказа. Указывать необходимо один из атрибутов для всех заказов. Приоритет имеет атрибут '''''ordercode'''''* '''form''' — Формат накладной. Не обязательный элемент. Принимает значения::* 1 — Подробная накладная (по-2cc9умолчанию):* 2 — Наклейки Zebra:* 3 — Наклейки на страницу формата А4:* 4 — Акты приема-4f10-afde-fd32417ea216</fiascode>передачи* '''start''' — Имеет смысл только для form = 3. Начальная позиция первой наклейки. Используется для пропуска наклеек на листе для их экономии.  <kladrcode>3201900011100</kladrcode> <shortname />'''Пример ответа:''' <typename /source lang="xml"> <coords lat?xml version="521.64070" lonencoding="33.1724UTF-8" /?> </townwaybill> <towncontent>EODIcaI8KSBlwQ 4MnEOR7Px8U8EBAyGICBnwpw <code>114016< IZhQgz0ZxuPs8EBM/code>GcbjzB AwhBl8hwQYIO00GmEwg1CeEG <city> mqYTChNU0wqf8l8nz4zgc+K fCno+zwU5GjOZmzXGcbEQYIM <code>60</code> 4zkegRE40zWzONyoNNMIOIa cWnp6aDCGEGE9NQmoQd2mg00 <name>Псковская область< 79U4f3hPTwnfp6Sdrafeqpa JDpFw/name>1aYT077VNNNdO00G3q < mqqvp9p2E7T0/city> <name>Сочихино деревня</name> <fiascode>10df7588-19c1-49d1-a387-9de1cf3eb26f</fiascode> <kladrcode>6001900015400</kladrcode> <shortname /> <typename /> <coords lat="56.6003" lon="29.3542" /> wiFemv8uG6 OM</towncontent></townlistwaybill>

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

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

<regionlistwaybill> <error>Текст ошибки</error></waybill></source> == Справочник городов =='''Пример запроса справочника городов:'''<source lang="xml"><?xml version="1.0" encoding="UTF-8"?><townlist> <auth extra="8" />

<zipcode>110000</zipcode> <kladrcode>0100000100800</kladrcode> <fiascode>bd21979d-46f8-49d0-9105-e8d65172a983</fiascode> <code>77123</code>

<city>Краснодарский край</city> <namecontains>крайновгород</namecontains> <namecontainsparts>молоково моск</namecontainsparts>

<name>Москва</name> <fullname>Московская областьМосква город</fullname>

<limit> <limitfrom>30</limitfrom> <limitcount>10</limitcount> <countall>YES</countall> </limit></regionlisttownlist>

<regionlist townlist count="23" page="1" totalcount="3" totalpages="1"> <citytown> <code>8026379</code> <countrycity> <code>123</code> <name>РоссияКраснодарский край</name> </city> <name>Сочи город</name> <fiascode>79da737a-603b-4c19-9b54-9114c96fb912</fiascode> <kladrcode>2300000700000</kladrcode> <shortname /> (not yet supported) <typename /> (not yet supported) <coords lat="43.5855" lon="39.7231" /> </town> <town> <idcode>64340331</idcode> <city> <ShortName1code>RU32</ShortName1code> <ShortName2name>RUSБрянская область</ShortName2name> </countrycity> <name>Агинский Бурятский автономный округСочилов хутор</name> <fiascode>c9c96c67-2cc9-4f10-afde-fd32417ea216</fiascode> <kladrcode>3201900011100</kladrcode> <shortname /> <typename /> <coords lat="52.6407" lon="33.1724" /> </citytown> <citytown> <code>1114016</code> <countrycity> <code>160</code> <name>РоссияПсковская область</name> </city> <idname>643Сочихино деревня</idname> <ShortName1fiascode>RU10df7588-19c1-49d1-a387-9de1cf3eb26f</ShortName1fiascode> <ShortName2kladrcode>RUS6001900015400</ShortName2kladrcode> <shortname /country> <nametypename />Адыгея республика <coords lat="56.6003" lon="29.3542" /name> </citytown></regionlisttownlist>

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

<streetlistregionlist> <codesearch> <code>77</code> </codesearch>

<town>Москва город</town> // ОБЯЗАТЕЛЬНОЕ ПОЛЕ! <namecontains>Хохлокрай</namecontains> <namestarts>Академика ХМоск</namestarts> <namefullname>Академика ХохловаМосковская область</namefullname> <fullnamecountry>Академика Хохлова ул.RU</fullnamecountry>

<limit> <limitfrom>30</limitfrom> <limitcount>10</limitcount> <countall>YES</countall> </limit></streetlistregionlist>

<streetlist regionlist count="1" page=2"> <city> <code>80</code> <country> <code>1" totalcount="3" totalpages="</code> <name>Россия</name> <id>643</id> <ShortName1>RU</ShortName1> <ShortName2>RUS</ShortName2> </country> <name>Агинский Бурятский автономный округ</name> </city> <city> <code>1"</code> <country> <code>1<street/code> <name>Академика Хохлова ул.Россия</name> <shortnameid>Академика Хохлова643</shortnameid> <typenameShortName1>ул.RU</typenameShortName1> <ShortName2>RUS</ShortName2> </country> <name>Адыгея республика</name> </streetcity></streetlistregionlist>

В ответе улицы сортируются по алфавиту. == Справочник номенклатуры улиц == '''Пример запроса справочника номенклатурыулиц:'''

<?xml version="1.0" encoding="UTF-8" ?><itemliststreetlist> <auth extra="8" login="login" pass="pass"></authconditions> <codesearch> <codetown>123456Москва город</codetown> <article>FD343< /article> <barcode>2345625213125</barcode>ОБЯЗАТЕЛЬНОЕ ПОЛЕ! </codesearch> <conditions> <namecontains>телевизорХохло</namecontains> <namestarts>sonyАкадемика Х</namestarts> <name>Sony KDL-55W905 ЖК-телевизорАкадемика Хохлова</name> <quantityfullname>EXISTING_ONLYАкадемика Хохлова ул.</quantityfullname> </conditions> <limit> <limitfrom>30</limitfrom> <limitcount>10</limitcount> <countall>YES</countall> </limit></itemliststreetlist>

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

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

<itemlist streetlist count="31" totalcountpage="31" pagetotalcount="13" totalpages="1"> <itemstreet> <code>123456124</code> <article>FD343</article> <barcode>2345625213125</barcode> <name>Sony KDL-55W905 ЖК-телевизорАкадемика Хохлова ул.</name> <retpriceshortname>65000Академика Хохлова</retpriceshortname> <purchpricetypename>50000</purchprice> <weight>5ул.1</weighttypename> <length>50 </lengthstreet> <width>30</widthstreetlist> <height>40</heightsource> <CountInPallet>30</CountInPallet> <HasSerials>1</HasSerials> <CountryOfOrigin>Малайзия</CountryOfOrigin> (not yet supported) <Message>Хороший телевизор</Message> <Message2>Снова хороший телевизор</Message2> <quantity>12</quantity> <reserved>3</reserved> <item> ..В ответе улицы сортируются по алфавиту.</itemlist></source>

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

<itemmovementsitemlist> <auth extra="8" login="login" pass="pass"></auth> <codesearch> <code>123456</code> <article>FD343</article> <barcode>2345625213125</barcode> </codesearch> <conditions> <namecontains>телевизор</namecontains> <namestarts>sony</namestarts> <name>Sony KDL-55W905 ЖК-телевизор</name> <quantity>EXISTING_ONLY</quantity> <store>2</store> </conditions> <except> <code>4259123478</code> </except> <limit> <limitfrom>30</limitfrom> <limitcount>10</limitcount> <countall>YES</countall> </limit></itemmovementsitemlist>

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

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

<?xml version="1.0" encoding="UTF-8" ?><itemmovements itemlist count="163" totalcount="3" page="1" totalpages="1"> <itemmovementitem> <code>151500123456</code> <datearticle>2017-05-26FD343</datearticle> <retpricebarcode>02345625213125</retpricebarcode> <quantityname>1Sony KDL-55W905 ЖК-телевизор</quantityname> <deliveredretprice>065000</deliveredretprice> <item> <codepurchprice>425950000</codepurchprice> <nameweight>Настольная игра Дженга5.1</nameweight> <length>50</itemlength> <statuswidth> <code>530</codewidth> <nameheight>Возврат от покупателя40</nameheight> <VATrate>20</statusVATrate> <storeCountInPallet> <code>130</codeCountInPallet> <nameCountInBox>офис в Москве2</nameCountInBox> <HasSerials>1</storeHasSerials> <orderCountryOfOrigin> <ordercode>3374830Малайзия</ordercodeCountryOfOrigin> (not yet supported) <numberMessage>123660-0Хороший телевизор</numberMessage> <dateMessage2>2017-05-24Снова хороший телевизор</dateMessage2> <ordernoquantity>1412312</ordernoquantity> <barcodereserved>00000006703</barcodereserved> <companyitem>ТОВАР ...</companyitemlist> <address/source>Кравченко ул '''Описание полей:'''* '''code''' — Внутренний идентификатор, присвоенный системой.* '''article''' — Артикул, 1</address>назначенный клиентом (поставщиком).* '''barcode''' — Штрихкод производителя.* '''name''' — Наименование. <delivereddate>2017* '''retprice''' — Розничная цена по-05-29</delivereddate>умолчанию. При оформлении заказа цена используется та, которая указана в заказе.* '''purchprice''' — Закупочная цена.* '''weight''' — Масса в килограммах.* '''length''' — Длина в сантиметрах.* '''width''' — Ширина в сантиметрах.* '''height''' — Высота в сантиметрах.* '''VATrate''' — Ставка НДС, целое число процентов.* '''CountInPallet''' — Количество штук в паллете.* '''CountInBox''' — Количество штук в упаковке.* '''HasSerials''' — Требует учета серийных номеров. Принимает значения 1 — да, 0 — нет.* '''CountryOfOrigin''' — Наименование страны происхождения на русском языке.* '''Message''' — Комментарий.* '''Message2''' — Дополнительный комментарий.* '''quantity''' — Количество на складе. Товары, уже собранные в заказы в этом количестве не присутствуют, считаются покинувшими товарный склад. ''Это поле может быть недоступным в некоторых установках.''* '''reserved''' — Количество зарезервированного товара. Может превышать остаток на складе, если покупатели ждут следующей поставки. ''Это поле может быть недоступным в некоторых установках.'' == Движение номенклатуры == <deliveredtime>12:00'''Пример запроса движения номенклатуры:00</deliveredtime>''' <deliveredto /source lang="xml"> </order?xml version="1.0" encoding="UTF-8" ?> <documentitemmovements> <codeauth extra="8" login="login" pass="pass">21991</codeauth> <numbercode>3184259</numbercode> <datedatefrom>20172020-0510-2601</datedatefrom> <messagedateto>2020-10-02</message> </documentdateto> </itemmovements></itemlist>

''' Описание полей ответа '''*'''code''' -  — внутренний код операции движениятовара в справочнике номенклатуры.*'''datedatefrom''' -  — дата операцииначала периода.*'''retpricedateto''' - цена товара — дата окончания периода.*'''quantity''' - количество товара операции*'''delivered''' - количество доставленного товараМожет быть указан или код, или период, или код и период одновременно.

*'''statusПример ответа движения номенклатуры:''' <source lang="xml"><?xml version="1.0" encoding="UTF- контейнер статуса операции8" ?><itemmovements count="16"> <itemmovement>:* ''' <code>151500</code''' > <date>2017-05- код статуса26</date> <retprice>0</retprice> <quantity>1</quantity> <delivered>0</delivered> <item> <code>4259</code> <name>Настольная игра Дженга</name> </item> <status> <code>5</code>:* ''' <name>Возврат от покупателя</name''' - наименование> </status> <store> <code>1</code> <name>офис в Москве</name>*''' </store''' > <order> <ordercode>3374830</ordercode> <number>123660-0</number> <date>2017-05- контейнер филиала24</date> <orderno>14123</orderno> <barcode>0000000670</barcode> <company>ТОВАР</company> <address>Кравченко ул., к которому относится операция1</address> <delivereddate>2017-05-29</delivereddate> <deliveredtime>12:* '''00:00</deliveredtime> <deliveredto /> </order> <document> <code>21991</code''' > <number>318</number> <date>2017-05- код филиала26</date> <message></message> </document> </itemmovements></itemlist>:* '''name''' - наименование филиала</source> *'''orderОписание полей ответа ''' - контейнер корреспонденции:* '''ordercodecode''' -  — внутренний код заказаоперации движения:* '''number''' - номер заказа:* '''date''' -  — дата заказаоперации:* '''ordernoretprice''' - шифр — цена товара:* '''barcodequantity''' - штрих-код — количество товара операции:* '''companydelivered''' - компания — количество доставленного товара:* '''address''' - адрес:* '''delivereddateitem''' - дата вручения — контейнер товара:* '''deliveredtimecode''' - время вручения — внутренний код товара:* '''deliveredtoname''' - данные о вручении, либо причина недоставки — наименование товара *'''documentstatus''' -  — контейнер документа статуса операции:* '''code''' - внутренний  — код документастатуса:* '''numbername''' - номер документа — наименование :* '''datestore''' - дата документа — контейнер филиала, к которому относится операция:* '''messagecode''' - комментарий — код филиала == Справочник пунктов самовывоза == Для отображения списка пунктов выдачи (ПВЗ) есть :* '''готовый JavaScript модульname''': https://home.courierexe.ru/js/measoft_map.js Инструкция по использованию - внутри. — наименование филиала * '''Пример запроса пунктов самовывоза:order''' — контейнер корреспонденции<source lang="xml"><?xml version="1.0" encoding="UTF-8" ?><pvzlist> <auth extra="8" login="login" pass="pass"></auth> <code>1234</code> <town>Нижний Тагил</town> <parentcode>6</parentcode> <acceptcash>YES</acceptcash> <acceptcard>YES</acceptcard> <acceptfitting>YES</acceptfitting> <maxweight>30</maxweight> <acceptindividuals>YES</acceptindividuals> <lt>57.924737</lt> <lg>59.940019</lg> <rt>57.905682</rt> <rg>59.984669</rg> <json>YES</json></pvzlist></source> :*'''authordercode''' - Атрибут  — внутренний код заказа:* '''extranumber''' - обязателен, по нему определяется курьерская служба,  — номер заказа:* '''logindate''' и '''pass''' позволяют авторизоваться под клиентом — дата заказа: для отдельного клиента могут быть ограничения по доступности некоторых ПВЗ, и в этом случае они будут учтены.*'''codeorderno''' - Внутренний код. — шифр:*'''townbarcode''' - Город получателя. — штрихкод:*'''parentcodecompany''' - Фильтр по родительскому элементу — компания:*'''acceptcashaddress''' - Фильтр по приему наличных YES/NO — адрес:*'''acceptcarddelivereddate''' - Фильтр по приему банковских карт YES/NO — дата вручения:*'''acceptfittingdeliveredtime''' - Фильтр по наличию примерки YES/NO — время вручения:*'''maxweightdeliveredto''' - Фильтр по максимальному весу — данные о вручении, с которым работает ПВЗлибо причина недоставки *'''acceptindividualsdocument''' - Фильтр по доступности физическим лицам YES/NO — контейнер документа операции:*'''ltcode''' - Широта левого верхнего угла — внутренний код документа:*'''lgnumber''' - Долгота левого верхнего угла — номер документа:*'''rtextnumber''' - Широта правого нижнего угла — внешний номер документа:*'''rgdate''' - Долгота правого нижнего угла — дата документа:*'''jsonmessage''' - Признак вывода ответа в виде JSON YES/NO — комментарий == Получение справочника тарифов по городам == '''Пример ответа запроса справочника пунктов самовывоза:тарифов по городам'''

<?xml version="1.0" encoding="UTF-8" ?><pvzlist counttariffs> <auth extra="8" login="login" pass="2pass"/> <pvz> <codetownfrom>126Москва</codetownfrom> <clientcodeservice>31</clientcodeservice> <namemainonly>Нижний Тагил1</namemainonly> <parentcode/tariffs>6</parentcodesource> <parentname* '''auth''' — атрибут '''extra''' обязателен, по нему определяется курьерская служба.* '''townfrom''' — город-отправитель. Если не передан, то городом будет «Москва».* '''service''' — режим доставки. Обязательный элемент.* '''mainonly''' — необязательный элемент. Если передан, то в ответе будут данные только по городам из справочника '''Межгород''' >Интеграция'''Зоны'''.   '''Пример ответа справочника тарифов по городам'''</parentnamesource lang="json">{ <town code="124267townfrom": "0c5b2444-70a0-4932-980c-b4dc0d3f02b5", "service": 1, "tariffs": [ { "towntofias": "0c5b2444-70a0-4932-980c-b4dc0d3f02b5", " regioncode=towntocode"66: 1, " regionname=towntoname"Свердловская область: ">Нижний Тагил Москва город</town>", "townregion": "Город Москва", "distance": 0, "pricedistance": 0, "pricesnew": { "before": [ { "price": 100, "every": 0, "mass": 1 }, { "price": 150, "every": 0, "mass": 5 } ], "after": [ { "price": 0, <address>622036 "every": 1, г "mass": 38. Нижний Тагил01 }, ул { "price": 15, "every": 1, "mass": 51. Циолковского01 } ] }, д. 17</address> "deliveryPeriodMin": 1, "deliveryPeriodMax": 2 } <phone>+73435417709, +73435254989]}</phonesource> <comment>Новый пункт ''' Описание полей ответа '''* '''townfrom''' — код ФИАС города-отправителя.* '''service''' — режим доставки</comment>.* '''tariffs''' — cписок тарифов по городу.:* '''townregion''' — регион города-получателя. <worktime>Вс 10:00* '''towntofias''' — код ФИАС города-16получателя.:00, Сб 10* '''towntocode''' — внутренний код города-получателя.:00* '''towntoname''' — наименование города-16получателя.:00* '''distance''' — дистанция в км до города от МКАД, Пн-Пт 10если в запросе townfrom — Москва.:* '''pricedistance''' — сумма за километраж до города от МКАД, если в запросе townfrom — Москва.:* '''pricesnew''' — ваши настройки тарифов из справочника '''Межгород''' > '''Тарифы по зонам'''.:00-20:00<* '''before/after''' — контейнеры ДО/worktime>ОТ. <traveldescription>Жилое 5-ти этажное здание:::* '''price''' — цена. Если ответ идет по «before», торцом к дорогето в цену также плюсуется сумма pricedistance:::* '''every''' — за каждые.:::* '''mass''' — масса.:* '''prices''' — устаревший элемент, второе здание от перекрестка Пархоменко-Циолковскогоне используется.:* '''deliveryPeriodMin''' — минимальный срок доставки.:* '''deliveryPeriodMax''' — максимальный срок доставки. == Номенклатура приходной накладной =='''Пример запроса номенклатуры приходной накладной:'''</traveldescriptionsource lang="xml"> <maxweight?xml version="1.0" encoding="UTF-8" ?>10</maxweightitemdoc> <acceptcashauth extra="8" login="login" pass="pass">YES</acceptcashauth> <acceptcardcode>YES21991</acceptcardcode> <acceptfitting>YES</acceptfittingitemdoc> <acceptindividuals>YES</acceptindividualssource> <latitude>57* '''code''' — внутренний код документа приходной накладной (см. предыдущий запрос).93457  '''Пример ответа движения номенклатуры:'''</latitudesource lang="xml"> <longitude>59?xml version="1.95131</longitude0" encoding="UTF-8" ?> </pvzitemdoc> <pvz> <code>24521991</code> <clientcodenumber>NTG1318</clientcodenumber> <namedate>На Красноармейской2017-05-26</namedate> <parentcodemessage>6</parentcodemessage> <parentname>Интеграция </parentnameitems> <town item code="1242674259" quantity="1" regioncodebarcode="66200300" regionnamearticle="Свердловская область123555">Нижний Тагил городНастольная игра Дженга</item> </townitems> <address/itemdoc>КРАСНОАРМЕЙСКАЯ, д.79</addresssource> ''' Описание полей ответа '''* '''code''' — внутренний код приходной накладной* '''number''' — номер документа* '''date''' — дата документа* '''message''' — комментарий * '''item''' — контейнер товара:* '''code''' — внутренний код товара:* '''barcode''' — штрихкод товара:* '''article''' — артикул товара:* '''quantity''' — количество поступившего товара == Справочник филиалов =='''Пример запроса списка филиалов:'''<phonesource lang="xml">+7(3435)379<?xml version="1.0" encoding="UTF-0448" ?><storelist> <auth extra="8"></phoneauth> <commentjson>Возможность примерки отсутствуетYES</commentjson> <worktimeclient_code>Вс 10:00-16:00, Сб 10:00-16:00, Пн-Пт 10:00-20:007890</worktimeclient_code> <traveldescription/storelist>Напротив ТЦ Пирамида</traveldescriptionsource> * '''auth''' — Атрибут '''extra''' — обязателен, по нему определяется курьерская служба* '''json''' — Признак вывода ответа в виде JSON YES/NO* '''client_code''' — Код клиента курьерской службы '''Пример ответа:'''<maxweightsource lang="xml">20</maxweight?xml version="1.0" encoding="UTF-8" ?> <acceptcashstorelist count="2">YES </acceptcashstore> <acceptcardcode>YES123</acceptcardcode> <acceptfittingname>NOABC</acceptfittingname> <acceptindividuals/store>YES </acceptindividualsstore> <latitudecode>57.93468456</latitudecode> <longitudename>60.55476Филиал 2</longitudename> </pvzstore></pvzliststorelist>

*'''code''' -  — Код ПВЗ в системе. Используется в запросе [[API#Оформление заказа|оформления заказов]]*'''clientcode''' - Код ПВЗ используемый компанией-подрядчикомфилиала.*'''name''' -  — Наименование ПВЗфилиала.*'''parentcode''' - Код родительского элемента.*'''parentname''' - Наименование родительского элемента.== Справочник пунктов самовывоза ==*Для отображения списка пунктов выдачи (ПВЗ) есть '''townготовый JavaScript модуль''' - Населенный пункт с кодом из [[#Справочник городов|справочника городов]], а также с кодом и наименованием региона: https://home.*'''address''' - Адрес ПВЗcourierexe.*'''phone''' - Телефоны ПВЗru/js/measoft_map.*'''comment''' - Дополнительная информацияjs Инструкция по использованию — внутри.*'''worktime''' - Режим Посмотреть пример работы ПВЗможно [https://home.*'''traveldescription''' - Описание местонахождения ПВЗ или пути к немуcourierexe.*'''maxweight''' - Максимальный вес, с которым работает ПВЗru/pvz_test.*'''acceptcash''' - Признак приема наличных*'''acceptcard''' - Признак приема банковских карт*'''acceptfitting''' - Наличие примерки*'''latitude''' - Широта*'''longitude''' - Долготаhtml Здесь]

Обратите внимание, что если в выборке количество ПВЗ больше '''Пример запроса Видов срочности:10000''' и не указаны параметры '''code''', '''json''' или '''limitcount''', то будет возвращаться ошибка. В этом случае необходимо использовать блок '''limit'''<source lang="xml"><?xml version="1.0" encoding="UTF-8" ?><services><auth extra="8"/></services></source>

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

<services countpvzlist> <auth extra="8" login="2login" pass="pass"> <service/auth> <code>11234</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> <nameacceptindividuals>ЭкономYES</nameacceptindividuals> <lt>57.924737</servicelt> <servicelg>59.940019</lg> <rt>57.905682<code/rt> <rg>59.984669</rg> <json>YES</json> <with_coords>YES</with_coords> <limit> <limitfrom>30</limitfrom> <limitcount>2</codelimitcount> <namecountall>СрочноYES</namecountall> </servicelimit></servicespvzlist>

== Расчет стоимости доставки ==* '''auth''' — Атрибут '''extra''' — обязателен, по нему определяется курьерская служба, '''login''' и '''pass''' позволяют авторизоваться под клиентом: для отдельного клиента могут быть ограничения по доступности некоторых ПВЗ, и в этом случае они будут учтены.* '''code''' — Внутренний код.* '''client_code''' — Код клиента курьерской службы.* '''city''' — Регион получателя. Можно указать код региона или полное наименование региона из [[#Справочник регионов|справочника регионов]].* '''town''' — Город получателя.Для тега города '''town''' можно указать код региона в атрибуте '''''regioncode''''' из [[#Справочник регионов|справочника регионов]]. Поиск будет производиться в указанном регионе. Также можно указать страну получателя в атрибуте '''''country''''' в соответствии с [https://ru.wikipedia.org/wiki/ISO_3166-1 стандартом ISO_3166-1], например, «RU», «RUS» или «643» для России.Для формата запроса JSON фильтрация по городу работает только в связке с фильтром по адресу.

* '''Пример запроса стоимости доставки:address''' — Фильтр по адресу, работает только в связке с фильтром по городу<source lang="xml">* '''house''' — Фильтр по номеру дома, работает только в связке с фильтрами по адресу и городу<?xml version="1.0" encoding="UTF-8" ?>* '''parentcode''' — Фильтр по родительскому [[#Справочник филиалов|филиалу]]<calculator>* '''acceptcash''' — Фильтр по приему наличных YES/NO <auth extra="8" login="login" pass="pass" * '''acceptcard''' — Фильтр по приему банковских карт YES/>NO <calc townfrom="Москва" * '''acceptfitting''' — Фильтр по наличию примерки YES/NO addressfrom="Ленинский проспект* '''maxweight''' — Фильтр по максимальному весу, 95"с которым работает ПВЗ zipcode="664000"* '''acceptindividuals''' — Фильтр по доступности физическим лицам YES/NO townto="3800000300000"* '''lt''' — Широта левого верхнего угла addressto="Ленина ул., 10"* '''lg''' — Долгота левого верхнего угла* '''rt''' — Широта правого нижнего угла l="10"* '''rg''' — Долгота правого нижнего угла w="20"* '''json''' — Признак вывода ответа в виде JSON YES/NO h="30"* '''with_coords''' — Признак вывода ПВЗ только с наличием координат YES/NO mass="3* '''limit''' — Ограничивает вывод результата.7" service="1":* '''limitfrom''' — Задает номер записи результата, начиная с которой выдавать ответ. По-умолчанию — 0. price="1200":* '''limitcount'''- Задает количество записей результата, которые нужно вернуть. По-умолчанию — 100. inshprice="1200" paytype="CASH" /></calculator></source>:* '''countall''' — YES указывает на необходимость подсчета общего количества найденных совпадений. Это может замедлять выполнение запроса. Если отключено — в ответе не указываeтся totalcount.

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

<?xml version="1.0" encoding="UTF-8"?><calculatorpvzlist count="2" totalcount="40465"> <calcpvz> <townfrom code>126</code> <clientcode>3</clientcode> <name>Нижний Тагил</name> <parentcode>6</parentcode> <parentname>Интеграция</parentname> <town code="124267" regioncode="66" regionname="1Свердловская область">Москва Нижний Тагил город</townfromtown> <townto 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="56603124267" regioncode="66" regionname="Свердловская область">Иркутск Нижний Тагил город</towntotown> <massaddress>3КРАСНОАРМЕЙСКАЯ, д.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</massacceptcash> <service name="Экспресс"acceptcard>1YES</serviceacceptcard> <zoneacceptfitting>2NO</zoneacceptfitting> <priceacceptindividuals>1163YES</priceacceptindividuals> <mindeliverydayslatitude>157.93468</mindeliverydayslatitude> <maxdeliverydayslongitude>360.55476</maxdeliverydayslongitude> <mindeliverydateuid>202041116853-9c51-0511eb-13b2c9-cfd6c1451392</mindeliverydateuid> </calcpvz></calculatorpvzlist></source> Параметры:* '''code''' — Код ПВЗ в системе. Используется в запросе [[API#Оформление заказа|оформления заказов]]*'''townfromclientcode'''  — Код ПВЗ используемый компанией- Город-отправитель так, как система его распознала и привязала к справочникуподрядчиком.* '''name''' — Наименование ПВЗ. Атрибут * '''codeparentcode''' - код из справочника городов системы — Код родительского элемента.*'''towntoparentname''' - Город-получатель так, как система его распознала и привязала к справочнику — Наименование родительского элемента. Атрибут * '''codetown''' - код  — Населенный пункт с кодом из [[#Справочник городов|справочника городов системы]], а также с кодом и наименованием региона.*'''massaddress''' - Масса в килограммах — Адрес ПВЗ.*'''servicephone''' - Режим доставки - число, указывающее на запись в справочнике видов срочности (см описание на этой странице) — Телефоны ПВЗ.*'''zonecomment''' - номер тарифной зоны, по которой рассчиталась стоимость — Дополнительная информация. В зависимости от зоны выбирается тарифная сетка* '''worktime''' — Режим работы ПВЗ. Так же * '''traveldescription''' — Описание местонахождения ПВЗ или пути к цене могут применяться повышающие или понижающие коэффициенты при доставке не из/в региональный центрнему.*'''pricemaxweight''' - рассчитанная стоимость доставки в валюте прайс-листа курьерской службы. Рекомендуется к использованию в отличие от одноименного атрибута родительского контейнера — Максимальный вес, с которым работает ПВЗ.*'''maxdeliverydaysacceptcash''' — Признак приема наличных* '''acceptcard''' - максимальный срок доставки в рабочих днях. — Признак приема банковских карт*'''mindeliverydateacceptfitting''' - минимальная дата доставки в учетом выходных дней.  — Наличие примерки* '''latitude''' — Широта* '''longitude'''Обратите внимание: — Долгота* '''uid''' В реальном ответе сервера  — Уникальный идентификатор ПВЗ в теге calc присутствует атрибут "price". Он оставлен для обратной совместимости, не используйте его. Пользуйтесь вложенным тегом price.системе Measoft* '''count''' — Количество записей в ответе== Список актов передачи денег ==* '''totalcount''' — Общее количество записей, отвечающее параметрам запроса

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

<?xml version="1.0" encoding="UTF-8" ?><smalistreceiptdata> <auth extra="8" login="login" pass="pass" /> <datefromorders>2016 <order orderno="123456" /> <order orderno="890111C" /> </orders></receiptdata>  </source> '''Пример ответа получения фискальных данных:'''<source lang="xml">  <?xml version="1.0" encoding="UTF-02-108"?><receipts count="1"> <receipt> <orderno>123456</datefromorderno> <datetofdDatetime>20162020-0306-1007 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> </datetoreceipt></smalistreceipts>

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

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

<?xml version="1.0" encoding="UTF-8"?><smalist countservices><auth extra="18"> <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></smalistservices>

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

<smadetailservices 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" /> <code>6278</code></smadetailadvprices>

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

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

<?xml version="1.0" encoding="UTF-8"?><smadetail count="advprices> <advprice> <code>1</code> <name>Этажей в доме</name> <type>int</type> </advprice> <advprice> <code>2"</code> <name>Коэффициент надбавки</name> <type>float</type> </advprice> <specialsmaadvprice> <code>424943</code> <ordercodename>14424Расписаться на упаковке</ordercodename> <ordernotype>11111bool</ordernotype> <orderdate/advprice>2018</advprices></source> Параметры:* '''code''' — внутренний код услуги* '''name''' — наименование услуги. Если поле «название в ЛК» в настройках услуги не пусто, то возвращает значение поля «название в ЛК».* '''hine''' — подсказка по доп услуге для пользователя* '''type''' — тип услуги. Может иметь значения::* '''bool''' — для услуг вида «чекбокс», «Да»:* '''float''' — для числа с плавающей точкой:* '''int''' — для целого числа == Расчет стоимости доставки =='''Пример запроса стоимости доставки:'''<source lang="xml"><?xml version="1.0" encoding="UTF-018" ?><calculator> <auth extra="8" login="login" pass="pass" /> <order> <pricetype>CUSTOMER</pricetype> <sender> <town>Санкт-01Петербург</town> <address>Петровка 38 офис 35</address> <coords lat="55.680327" lon="37.604456"></coords> </orderdatesender> <receiver> <zipcode>125480<delivereddate/zipcode>2018-10 <town regioncode="78" country="RU">Санкт-01Петербург</delivereddatetown> <companyaddress>КомпанияПетровка 38 офис 35</companyaddress> <pvz>124<price/pvz>314 <coords lat="55.680327" lon="37.00604456"></coords> </pricereceiver> <rurweight>88005.001</weight> <service>2</rurservice> <inshpricepaytype>314.00CASH</inshpricepaytype> <pricekurprice>270387.005</pricekurprice> <priceagdeliveryprice>44.00150</priceagdeliveryprice> <pricecalcinshprice>8486387.005</pricecalcinshprice> <packages> <package mass="1" quantity="5"><paytype/package> <package mass="2.5" length="10" width="20" height="30"></paytypepackage> </packages> <paytypenameuserid>наличными курьеромuser123</paytypenameuserid> <statusgroupid>Доставленоcustomer</statusgroupid> </specialsmaorder></smadetailcalculator>

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

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

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