Изменения

<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]. Обязательно представьтесь, напишите Ваши ваши контактные данные (телефон, скайп) и название компании, с которой Вы вы хотите интегрироваться.

|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 и выше. Подробнее см. [[Интеграция с другими системами#Bitrix1C-Битрикс|описание]].

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

|[[Файл:OpencartOCStore.png|center|x70pxx60px]]|style="text-align: center;"|[httphttps://courierexe.ru/download/api/opencart.zip Скачать для версии 1.5.5.1]<br>[httphttps://courierexe.ru/download/api/measoft_oc2.ocmod.zip Скачать для версии 2.0]<br>[httphttps://courierexe.ru/download/api/measoft_oc2.3.ocmod.zip Скачать для версии 2.3]<br>[httphttps://courierexe.ru/download/api/measoft_ос3measoft_oc3.ocmod.zip Скачать для версии 3.0]|Поддерживает версии с 1.5.5.1.<br>Скачивайте модули для своей версии OpenCart.<br>Подробнее см. [[Интеграция с другими системами#OpenCart 1.5.5.1|описание]].<br>[https://opencartforum.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|x80px]]|style="text-align: center;"|Настраивается в [http://www.insales.ru/collection/all/product/kurierskaya-sluzhba-2008 Установить[Личный кабинет клиента|ЛК пользователя]]|[[Интеграция с другими системами#InSalesIiko|НастраиваетсяИнструкция по настройке]] в ЛК пользователя в системе

|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 версия)]

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

|Внимание! Модуль новый, поэтому возможна некорректная передача данных. Проверяйте, если что - сообщайте, исправим!<br>Подробнее см. [[Интеграция с другими системами#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|Инструкция]]<br>Внимание! Модуль новый, поэтому возможна некорректная передача данных. Проверяйте, если что - сообщайте, исправим!

|style="text-align: center;"|[httphttps://courierexemarketplace.ru/download/api/ms_courierexecs-v1cart.1.1.zip Скачать]|[[Интеграция с другими системами#cs.cart|Инструкция]]|com/measoft-|[[Файл:Тильдаen.png|center|x60px]html Установить]|style="text-align: center;"|https://salesbeatПоддерживает версии 4.pro/|По вопросам интеграции обращайтесь в [https://salesbeat10 и выше.pro Salesbeat]|-|<br>[[Файл:JoomShopping.pngCS-Cart|center|x60px]Инструкция]|style="text-align: center;"|https://salesbeat.pro/|По вопросам интеграции обращайтесь в [https://salesbeat.pro Salesbeat]

|[[Файл:Mogutawebhooks.pngjpg|center|x80pxx100px]]|style="text-align: center;"|https://salesbeat.pro/Читайте описание [[Webhook|на этой странице]]|По вопросам интеграции обращайтесь Передача информации о статусах и заказах в [https://salesbeat.pro Salesbeat]вашу систему

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

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

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

Для подключения к площадке Вашего Описание параметров:* '''extra''' — экстра-код, уникальный идентификатор компании, с которой вы интегрируетесь.* '''login''' — логин клиента необходимо иметь три параметра: ;* '''pass''' — пароль клиента;* '''measoftid''' — системная переменная, используемая системой.

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

[[Файл== Авторизация курьерской службы ==Если курьерской службе требуется подключение под своими учетным данными, используйте строку вида:extra1.png|750px]]

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

3. Описание:* '''Парольextra''' - параметр учетной записи для ЛК клиента и API, указывается в карточке клиента на вкладке  — уникальный идентификатор компании;* '''login''' — логин курьерской службы;* '''"Прочее"pass''' в поле  — пароль курьерской службы;* '''"Пароль"clientcode'''  — внутренний код клиента (на скриншоте нижевкладка '''Клиенты''', столбец «Внутренний код»).

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

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

Клиент отправляет запросы к сервисуДля использования интеграции в «боевом» режиме, методом HTTP POSTзапросите '''логин''', '''пароль''', сервис обрабатывает запросы и возвращает результат выполнения. Все запросы и ответы передаются в формате XML.Кодировка - UTF-8. Разделитель целой и дробной частей чисел - используется символ точки. Даты представляются в виде YYYY-MM-DDпараметр '''extra''' у той компании, время - 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;

Вы можете отправлять тестовые запросы к нашему сервису и видеть историю отправленных запросов в личном кабинете на закладке '''Интеграция'''. Клиент отправляет запросы к сервису методом 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 порт, на котором будут приниматься запросы.

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

* не нужно «бомбить» наше API запросами статусов, последовательно перебирая номера всех ваших заказов, особенно запросами "tracking"«tracking», они предназначены не для этого (смотрите описание). Особенно ровно в 00 минут каждого часа;

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

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

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

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

*'''order''' <spoiler text="Заполнение номера заказа (шифра) и штрих- Контейнер для описания одного заказа, обязательный элемент. В одном контейнере '''neworder''' может быть много контейнеров '''order''' для создания нескольких заказов одним запросом.кода">Шифр и штрих-код заполняются исходя из начальных значений:

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

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

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

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

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

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

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

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

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

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

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

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

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

<br />

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

<?xml version="1.0" encoding="UTF-8" ?><statusreqcount="23"> <auth extraorder orderno="111111" awb="qwerty" orderno2="8123123" loginordercode="login34534234" passgivencode="pass2345334"></auth> <changesbarcode>ONLY_LAST111111</changesbarcode> </statusreqsender> <company>МВД</sourcecompany> <person>Иванов И.И.</person>Система выдает все заказы, в которых, с момента последнего запроса в этом режиме, изменилось хотя бы одно из полей: orderno <phone>123-45-67</phone> status delivereddate deliveredtime deliveredto receiver- <contacts>date receiver- <phone>+74951234567</phone>address price После успешной обработки ответа необходимо отметить полученные статусы успешно полученными, отправив запрос </contacts> <source langtown code="xml23432">Санкт-Петербург</town> <?xml version="1.0" encoding="UTF-8" ?address>Петровка 38 офис 35<commitlaststatus/address> <auth extra="8" login="login" pass="pass">date>2014-03-22</authdate> <clienttime_min>CLIENT09:00</clienttime_min> </commitlaststatustime_max>14:00</sourcetime_max> </sender>'''Описание полей запроса''' <receiver> <company>МВД</company>*'''auth''' - Авторизация <person>Иванов И. Обязательный элементИ.</person>*'''client''' <phone>123-45-67 - Признак клиента или агентаИван (916)234. Необязательный элемент45.:* CLIENT - Признак клиента21 Петр, значение по умолчанию:* AGENT - Признак агентаmvd@mail. В ответ отдается информация по заказам, переданным агенту на доставкуru</phone> <contacts>В случае успеха Вы получите ответ <phone>+74951234567<source lang="xml"/phone> <?xml version="1.0" encoding="UTF-8" ?phone>+79162344521</phone> <commitlaststatus error="0"email>OKmvd@mail.ru</commitlaststatusemail> </sourcecontacts> <inn>1112223335</inn>Данный способ передачи статусов гарантирует полную корректную передачу статусов, даже в случае, если в нашей системе статус изменился в промежутке времени между запросом статусов и подтверждением их получения. Если система не получила подтверждение успешной передачи статуса, она будет считать информацию не переданной, и выдаст ее при повторном запросе.   <div style="color: #a94442; background-color: #f2dede; border: 1px solid #ebccd1; padding: 3px 10px 10px;">'''Обратите внимание!''' # При данном способе передачи (<changes>ONLY_LASTzipcode>125480</changeszipcode>) система просматривает заказы, оформленные за последние 3 месяца. Если заказ сделан ранее - изменение статуса по нему не попадет в результат выполнения данного запроса.# Система всегда выдает текущий статус. Т.е. Вы можете одним запросом получить статус <town code="NEW153361", а следующим - regioncode="COMPLETE78". В промежутке между запросами отправление могло пройти через несколько промежуточных статусов. Если нужна гарантия получения всех промежуточных статусов, нужно анализировать блок statushistory (может не заполняться в следствии ограничений версии или тарифа конкретной службы доставки).# Система никогда не гарантирует последовательность прохождения заказом набора статусов. Т.е. Вы можете получить статус regionname="COMPLETE", а следующим запросом Санкт- Петербург город"NEW" >Санкт- такое может произойти, например, если оператор ошибочно отметил заказ выполненным, а затем исправил ошибку.Петербург город</town> <address>Петровка 38 офис 35</divaddress> <area>Район 1<br /area> <pvz> <code>126</code>== Трекинг заказа по номеру == <clientcode>QWERTY</clientcode> </pvz>Запрос трекинга по номеру предназначен для выдачи минимальной обезличенной информации о конкретном заказе не авторизованному пользователю. Наша система имеет для этого интерфейс по адресу "home.courierexe.ru <date>2014-03-22</{код экстра}date> <time_min>09:00</tracking". Вы можете либо сделать ссылку на такую страницу на своем сайте, либо разместить ее iframe'ом у себя, либо сделать свою и пользоваться нашим APItime_min> <time_max>14:00</time_max> <coords lat="55. Этот интерфейс создан специально для выдачи информации живому пользователю сайта. Для получения статусов заказов в свою информационную систему нужно использовать запрос 680327"statusreqlon=", желательно с параметром changes=ONLY_LAST! '''Пример запроса:'''37.604456"><source lang="xml"/coords> <?xml version="1.0" encoding="UTF-8"?deliveryPIN>1234</deliveryPIN> <tracking/receiver> <extraprice>8387.5</extraprice> <ordernoinshprice>1234387.5</ordernoinshprice> <paytype code="1">CASH</trackingpaytype> </sourceweight>5.1</weight> '''Пример ответа:''' <source lang="xml"quantity>2<?xml version="1.0" encoding="UTF-8"?/quantity> <trackingservice> 2<order orderno="111111"/service> <barcodetype>1111113</barcodetype> <AWBreturn>111111NO</AWBreturn> <senderreturn_service>2</service> <return_type>3<town code="1" country="RU"/return_type> <return_weight>Москва город5.1</townreturn_weight> <datereturn_message>2014-03-22Доставлено в целости</datereturn_message> <time_minpickup>09:00NO</time_minpickup> <time_maxprint_check>14:00YES</time_maxprint_check> <waittime>12</senderwaittime> <receiverenclosure> Детские игрушки<town code="1" country="RU"/enclosure> <instruction>Москва городПроверить при покупателе, подписать акт</towninstruction> <zipcode>125480</zipcode> <date>2014currcoords lat="55.680327" lon="37.604456" accuracy="50" RequestDateTime="2014-0304-2221 18:07:45"></datecurrcoords> <time_mincourier>09:00 <code>26</time_mincode> <time_maxname>14:00Иванов Владимир Петрович</time_maxname> </receiverphone> <price>387.5+79161234567</pricephone> <inshprice>387.5</inshpricecourier> <paytype>CASH</paytypedeliveryprice total="158.6" delivery="100.00" return="58.6"> <weight>5.advprice code="1" price="150">База</weightadvprice> <quantityadvprice code="2" price="0">2% от объявленной стоимости</quantityadvprice> <serviceadvprice code="3" price="8.6">2Топливный сбор</serviceadvprice> <typeadvprice code="4" price="0">3Округление</typeadvprice> <return>NO</return/deliveryprice> <return_servicereceiverpays>2NO</servicereceiverpays> <return_dateacceptpartially>NO</return_dateacceptpartially> <return_time></return_time> <return_message></return_message> <waittime>12</waittime> <enclosure>Детские игрушки</enclosure> <instruction>Проверить при покупателе, подписать акт</instruction> <deliveryprice totalstatus eventstore="филиал в Санкт-Петербурге" eventtime="2016-06-02 17:22:00" createtimegmt="2016-06-03 16:14:44" message="158.6" deliverytitle="100.00Доставлен" eventtown="Санкт-Петербург город" returncolor="58.616777215" >COMPLETE</status> <courierstatushistory> <code>26</code> <name>Иванов Владимир Петрович</name> <phone>+79161234567</phone> </courier> <currcoords latstatus eventstore="Офис в Москве" eventtime="2016-05-30 10:20:00" createtimegmt="55.6803272016-06-03 16:14:44" lon message="37.604456" accuracytitle="50Новый" RequestDateTimeeventtown="2014-04-21 18:07:45Москва город" country="RU" >NEW</status> <status eventstore="филиал Офис в Санкт-ПетербургеМоскве" eventtime="2016-06-02 01 17:2238:00" createtimegmt="2016-06-03 16:14:44" message="филиал в Санкт-Петербурге" title="ДоставленПланируется отправка" eventtown="Москва город" country="RU">COMPLETEDEPARTURING</status> <statushistory> <status eventstore="Офис в Москве" eventtime="2016-0506-30 1001 19:2053:00" createtimegmt="2016-06-03 16:14:44" message="филиал в Санкт-Петербурге" title="НовыйОтправлено со склада">NEW</status> <status eventstoreeventtown="Офис Москва город" country="RU">DEPARTURE</status> <status eventstore="филиал в МосквеСанкт-Петербурге" eventtime="2016-06-01 1702 07:3841:00" createtimegmt="2016-06-03 16:14:44" message="филиал в " title="Получен складом" eventtown="Санкт-ПетербургеПетербург город" titlecountry="Планируется отправкаRU">DEPARTURINGACCEPTED</status> <status eventstore="Офис филиал в МосквеСанкт-Петербурге" eventtime="2016-06-01 1902 09:5317:00" createtimegmt="2016-06-03 16:14:44" message="филиал в Санкт-Петербурге" title="Отправлено со складаВыдан курьеру на доставку" eventtown=">DEPARTUREСанкт-Петербург город" country="RU">DELIVERY</status> <status eventstore="филиал в Санкт-Петербурге" eventtime="2016-06-02 0717:4122:00" createtimegmt="2016-06-03 16:14:44" message="" title="Получен складомДоставлен (предварительно)" eventtown=">ACCEPTED<Санкт-Петербург город" country="RU">COURIERDELIVERED</status> <status eventstore="филиал в Санкт-Петербурге" eventtime="2016-06-02 0917:1722:00" createtimegmt="2016-06-03 16:14:44" message="" title="Выдан курьеру на доставкуДоставлен" eventtown=">DELIVERY</Санкт-Петербург город" country="RU">COMPLETE</status> </statushistory> <status eventstore="филиал в Санкт-Петербурге" eventtime="2016-06-02 17:22:00" createtimegmt="customstatecode>2<customstatecode> <clientstatecode></clientstatecode> <deliveredto>Иванова, секр.</deliveredto> <delivereddate>2016-06-03 16:1402</delivereddate> <deliveredtime>17:44" message="" title="Доставлен (предварительно)">COURIERDELIVERED22</statusdeliveredtime> <status eventstore="филиал в Санкт-Петербурге" eventtime="2016department>Отдел</department> <costcode>cc12345</costcode> <outstrbarcode>EXT123456</outstrbarcode> <respstore>14</respstore> <partner>Офис на Ленина</partner> <arrival>2016-0605-02 1723:22:0021</arrival> <receipt fdNum="124555" createtimegmtfnSn="2016-06-03 16:14:449289000100295555" messagekktNum="0001611984048555" titleinn="Доставлен7722756555" fdValue="2899551555" summ="387.5" ofdUrl="gate.ofd.ru">COMPLETEhttps://ofd.ru/rec/7722756555/0001611984048555/9289000100295555/124555/2899551555</statusreceipt> </statushistoryitems> <deliveredto>Иванова, секр.</deliveredto> <delivereddate>2016-06-02</delivereddate> <deliveredtime>17:22</deliveredtime> <outstrbarcode>EXT123456</outstrbarcode> <items> <item codeitem code="34533" extcode="abc123" quantity="1" mass="0.2" retprice="37.5" VATrate="0" barcode="2345625213125" article="345331" extcodereturns="abc1230" quantityorigincountry="1040" massGTD="0.2" retpriceexcise="370.500" VATrategovernmentCode="011223311" barcodesuppcompany="2345625213125Поставщик" articlesuppINN="11112223334" returnssuppphone="079161234567" origincountry>Мяч</item> <item code="04034456" GTDextcode="abc124" excisequantity="0.002" governmentCodemass="112233112" suppcompanyretprice="Поставщик100" VATrate="10" barcode="4645625213138" article="2" suppINNreturns="11122233340" suppphonegovernmentCode="79161234567">МячОбруч</item> <item code="3445634421" extcode="abc124abc125" quantity="23" mass="20.3" retprice="10050" VATrate="1018" barcode="46456252131382345625213126" itemcode="44123" article="23" returns="0" governmentCode="">ОбручПогремушка желтая</item> <item code="34421" extcode/items> <packages> <package code="abc12533331" quantitystrbarcode="3ORD0000001" mass="0.31" retpricemessage="50" VATrategot="18YES" barcode></package> <package code="33332" strbarcode="2345625213126ORD0000002" articlemass="32.5" returnsmessage="0" governmentCodegot="NO">Погремушка желтая</itempackage> </itemspackages> </order></trackingstatusreq> </source> '''Пример ответа если нет заказов''' <source lang="xml"><?xml version="1.0" encoding="utf-8"?><statusreq count="0"></statusreq>

<?xml version="1.0" encoding="UTFutf-8"?><tracking17request><error error="1" errormsg="authorization error"></error></request></source> '''Пример ответа при ошибке синтаксиса''' <extrasource lang="xml"><?xml version="1.0" encoding="UTF-8"?></extrarequest> <ordernoerror>column:1 line:11 message:expected '>1234'</ordernoerror></tracking17request>

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

Запрос предназначен для изменения заказов, находящихся в статусах "Ожидает синхронизации" или "Новый", а также по которым не было произведено изменений - статуса корреспонденции, времени доставки - то есть заказов, которые ещё не находятся в работе'''Примечание.''' В будущем возможно дополнение используемого набора статусов.

 # Данные запроса изменения указываются Контейнер '''полностьюstatushistory''', как если бы заказ создавался впервые.# При отсутствии вложения в запросе изменения данное вложение и '''не удаляетсяdeliveryprice''' из заказа, но его количество становится равным 0заполняется для тарифов [[Личный кабинет курьерской службы#Функции личного кабинета|Премиум и Максимум]].# При одновременном изменении заказа в API и системе курьерской службы приоритет отдается данным системы курьерской службыСистема никогда не гарантирует последовательность прохождения заказом набора статусов. То есть изменения в API приняты не будут!Вы можете получить статус «COMPLETE», а следующим запросом — «NEW» — такое может произойти, например, если оператор ошибочно отметил заказ выполненным, а затем исправил ошибку.

<br />

=== Описание полей запроса изменения Передача только изменившихся статусов ===Все В нашем API предусмотрено удобное средство получения статусов всех заказов, без необходимости «бомбить» сервер запросами статусов по каждому заказу. Работает это так: раз, например, в 10 минут, вы посылаете запрос «покажите все изменившиеся статусы». Пример запроса ниже. Система вам отдает ВСЕ заказы, статусы (или некоторые другие поля , см. ниже) которых изменились с момента последнего запроса соответствуют структуре order при создании заказа за исключением:* вместо корневого тэга '''neworder''' указывается '''editorder'''* тэг штрих-кода '''barcode''' . Вы разбираете полученный документ, по каждому заказу сохраняете его актуальный статус в своей системе, и если все хорошо, у вас все получилось, ваша система неожиданно не упала от наплыва информации, посылаете нам запрос подтверждения получения статусов (commitlaststatus). Мы у себя отмечаем, что эти статусы вами получены и их не указываетсянадо передавать повторно. Таким образом, сколько бы заказов у вас ни было, поскольку присваивается при создании заказастатусы по ним всем почти в реальном времени вы можете получать всего двумя запросами.

Для получения только изменившихся статусов отправьте запрос:<source lang="xml"><?xml version="1.0" encoding= Описание полей ответа изменения "UTF-8" ?><statusreq> <auth extra="8" login="login" pass="pass"></auth>Все поля ответа соответствуют ответу при создании заказа за исключением корневого тэга - вместо '''neworder''' возвращается '''editorder'''. <changes>ONLY_LAST</changes> <streamid>1234</streamid></statusreq></source>

Запрос отмены предназначен для отмены тех заказовПосле успешной обработки ответа необходимо отметить полученные статусы успешно полученными, по которым не было произведено изменений отправив запрос:<source lang="xml"><?xml version="1.0" encoding="UTF- статуса доставки, статуса корреспонденции, времени доставки - то есть заказов, которые ещё не находятся в работе.8" ?><commitlaststatus>Возможность отмены заказа есть только у курьерских служб с тарифом <auth extra="8"Премиумlogin=" и по-умолчанию она выключена, ее нужно отдельно включить: [[Личный кабинет курьерской службы#Дополнительные настройки]].login" pass="pass"></auth> <client>CLIENT</client> <streamid>1234</streamid></commitlaststatus></source>

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

<cancelorder> <auth extra="8" login="login" passcommitlaststatus error="pass0" /> <order orderno="" ordercode="123456" /> <order orderno="123aaa" ordercode="" />OK</cancelordercommitlaststatus></source>

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

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

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

<?xml version="1.0" encoding="UTF-8" ?><cancelordertracking> <order orderno="123test" ordercode="123456" error="0" errormsg="OK" errormsgru="Успешно" extra>8</extra> <order orderno="123aaa" ordercode="" error="52" errormsg="order not found" errormsgru="Заказ не найден" >1234</orderno></cancelordertracking>

== Добавление вложений к накладной == '''Пример запросаответа:'''

<?xml version="1.0" encoding="UTF-8" ?><addattachmentstracking> <auth extraorder orderno="8111111" login> <barcode>111111</barcode> <AWB>111111</AWB> <sender> <town code="login1" passcountry="passRU" >Москва город</town> <date>2014-03-22</date> <time_min>09:00</time_min> <ordernotime_max>14:00</time_max>1234567 </ordernosender> <attachmentsreceiver> <item nametown code="1" country="photo1.jpgRU">JVBERi0xLjMN1wb25lbnQgMQМосква город</town> JUBQREYwMTIzNDU2Nzg5IDI NMyAwIG9iag08PA0vVHlwZSA <zipcode>125480</zipcode> <date>2014-03-22</date> U3VidHlwZSAvSW1hZ2UNL1d pZHRoIDE4MDgNL0hlaWdodCA <time_min>09:00</time_min> ggNCAwIFINL0JpdHNQZXJDb 21wb25lbnQgMQ0vRGVjb2RlU <time_max>14:00</time_max> ENL0NvbHVtbnMgMTgwOA0+P g0vSW1hZ2VNYXNrIHRydWUNL </receiver> XhEZWNvZGUNPj4Nc3RyZWFt DQ <price>387.5</itemprice> <item name="photo2inshprice>387.jpg"5</inshprice> <paytype>CASH</paytype>VBERi0xLjMNAwIG9iag0HRoJ JUBQREYwMTIzNDU2Nzg5IDI NMyAwIG9iag08PA0vVHlwZSA <weight>5.1</weight> vWE9iamVjdA0vU3VidHlwZS AvSW1hZ2UNL1dpZHRoIDEzNj <quantity>2</quantity> gNL0hlaWdodCAxMzMzDS9MZ W5ndGggNCAwIFINL0JpdHNQZ <service>2</service> XJDb21wb25lbnQgMQ0vRGVj b2RlUGFybXMgPDwNL0sgLTEN <type>3</type> L0NvbHVtbnMgMTM2OA0+Pg0 vSW <return>NO</itemreturn> <return_service>2</attachmentsreturn_service> <return_date></addattachmentsreturn_date> <return_time></sourcereturn_time> <return_message></return_message> <waittime>12</waittime>'''Описание полей:''' <enclosure>Детские игрушки</enclosure> <instruction>Проверить при покупателе, подписать акт</instruction>'''addattachments''' - Корневой контейнер <deliveryprice total="158. Обязательный элемент6" delivery="100.00" return="58.6" /> <courier> <code>26</code>*'''auth''' - Авторизация. Обязательный элемент. <name>Иванов Владимир Петрович</name>*'''orderno''' - Номер заказа. Обязательный элемент. Может использоваться тэг <ordercodephone>+79161234567</phone> с указанием внутреннего кода заказа.*'''attachments''' - Обязательный элемент, в котором перечисляются передаваемые данные файлов. </courier>**'''item''' - Бинарные данные (файл), закодированные в base64 <currcoords lat="55. Обязательный элемент680327" lon="37.604456" accuracy="50" RequestDateTime="2014-04-21 18:07:45" />***'''name''' <status eventstore="филиал в Санкт-Петербурге" eventtime="2016-06-02 17:22:00" createtimegmt="2016-06- Атрибут элемента '''item''', в котором передается имя файла. Обязательный элемент.03 16:14:44" message="" title="Доставлен">COMPLETE</status> <statushistory> <status eventstore="Офис в Москве" eventtime="2016-05-30 10:20:00" createtimegmt="2016-06-03 16:14:44" message="" title="Новый">NEW</status>'''Пример ответа <status eventstore="Офис в Москве" eventtime="2016-06-01 17:'''38:00" createtimegmt="2016-06-03 16:14:44" message="филиал в Санкт-Петербурге" title="Планируется отправка">DEPARTURING</status> <source langstatus eventstore="Офис в Москве" eventtime="2016-06-01 19:53:00" createtimegmt="xml2016-06-03 16:14:44" message="филиал в Санкт-Петербурге" title="Отправлено со склада">DEPARTURE</status> <?xml versionstatus eventstore="1.0филиал в Санкт-Петербурге" eventtime="2016-06-02 07:41:00" encodingcreatetimegmt="UTF2016-806-03 16:14:44" message="?" title="Получен складом">ACCEPTED</status> <addattachmentsstatus eventstore="филиал в Санкт-Петербурге" eventtime="2016-06-02 09:17:00" createtimegmt="2016-06-03 16:14:44" message="" title="Выдан курьеру на доставку"> DELIVERY<attachments/status> <item namestatus eventstore="филиал в Санкт-Петербурге" eventtime="photo1.jpg2016-06-02 17:22:00" errorcreatetimegmt="02016-06-03 16:14:44" errormsgmessage="OK" errormsgrutitle="УспешноДоставлен (предварительно)" >COURIERDELIVERED</status> <item namestatus eventstore="филиал в Санкт-Петербурге" eventtime="photo2.jpg2016-06-02 17:22:00" errorcreatetimegmt="02016-06-03 16:14:44" errormsgmessage="OK" errormsgrutitle="УспешноДоставлен" >COMPLETE</status> </attachmentsstatushistory> <deliveredto>Иванова, секр.</addattachmentsdeliveredto> <delivereddate>2016-06-02</sourcedelivereddate> <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= '''Пример запроса:'''<source lang"1" returns="0" origincountry="040" GTD="" excise="0.00" governmentCode="11223311" suppcompany="Поставщик" suppINN="1112223334" suppphone="xml79161234567">Мяч</item> <?xml versionitem code="34456" extcode="abc124" quantity="2" mass="2" retprice="100" VATrate="10" barcode="4645625213138" article="2" returns="1.0" encodinggovernmentCode="UTF-8" ?>Обруч<attachments/item> <auth extraitem code="34421" extcode="abc125" quantity="3" mass="0.3" retprice="50" VATrate="18" barcode="2345625213126" article="83" loginreturns="login0" passgovernmentCode="pass" >Погремушка желтая</item> <orderno/items>1234567 </ordernoorder></attachmentstracking>

'''attachmentsПолучение информации в формате 17 TRACK''' - Корневой контейнер. Обязательный элемент.*'''auth''' - Авторизация. Обязательный элемент.*'''orderno''' - Номер/код заказа. Обязательный элемент.

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

<attachmentstracking17> <item name="doc1.docx" size="35654"extra>JVBERi0xLjMN JUBQREYwMTIzNDU2Nzg5IDI NMyAwIG9iag08PA0vVHlwZSA U3VidHlwZSAvSW1hZ2UNL1d pZHRoIDE4MDgNL0hlaWdodCA ggNCAwIFINL0JpdHNQZXJDb 21wb25lbnQgMQ0vRGVjb2RlU ENL0NvbHVtbnMgMTgwOA0+P g0vSW1hZ2VNYXNrIHRydWUNL XhEZWNvZGUNPj4Nc3RyZWFt DQ8</itemextra> <item name="photo2.jpg" size="74861"orderno>VBERi0xLjMN JUBQREYwMTIzNDU2Nzg5IDI NMyAwIG9iag08PA0vVHlwZSA vWE9iamVjdA0vU3VidHlwZS AvSW1hZ2UNL1dpZHRoIDEzNj gNL0hlaWdodCAxMzMzDS9MZ W5ndGggNCAwIFINL0JpdHNQZ XJDb21wb25lbnQgMQ0vRGVj b2RlUGFybXMgPDwNL0sgLTEN L0NvbHVtbnMgMTM2OA0+Pg0 vSW1234</itemorderno></attachmentstracking17>

В тегах item возвращаются бинарные данные (файлы)'''Пример ответа:'''<pre>{ "number":"ExtNumber", закодированные в base64. "oriNumber":"1234",== Изменение статуса агентом == "oriCountry":"RU", "destCountry":"RU",Запрос изменения статуса заказа позволяет установить окончательный статус заказа - "Доставленstatus" или :"Не доставлен (Возврат/Отмена)Complete", "events".:[ {Кроме этого "time":"2016-06-02 17:22:00", устанавливается дата и время (при необходимости) изменения статуса "location":"RU", а также сообщение в поле ''Инфо о доставке''. "content":"Complete"При необходимости к заказу можно прикрепить изображения. }, { "time":"2016-06-02 17:22:00",'''Пример запроса изменения статуса "location":'''"RU",<source lang= "content":"xmlCourierdelivered"><?xml version= }, { "1.0time" encoding=:"UTF2016-806-02 09:17:00" ?>,<setorderinfo> <auth extra= "8location" login=:"loginRU" pass=, "passcontent" /> <order ordercode=:"123456Delivery"> <message>Получил Иванов</message> }, </order> { <order ordercode= "time"234567:"> <status>PICKUPREADY</status> <eventtime>2016-0506-30 1002 07:2041:00</eventtime>", "location":"RU", <message>Клиент отказался от покупки</message> "content":"Accepted" <paytype>CASH</paytype> }, <items> { <item code= "time":"345332016-06-01 19:53:00" quantity=, "1location" reason=:"0RU" />, <item code= "content"34456:" quantity=Departure"0 }, { " reason=time"0:" />2016-06-01 17:38:00", <item code= "34421location" quantity=:"2RU" reason=, "0content" /> </items> <image filename=:"filename1.jpgDeparturing"> /9j/4AAQSkZJRgA BAQAAAQABAAD/2wBDAA0JCg sKCA0LCgsODg0PEyAVExISEy }, ccHhcgLikxMC4pLSwzOko+M zZGNywtQFdBRkxOUlNSMj5aY { VpQYEpRUk//2wBDAQ4ODhMR EyYVFSZPNS01T09PT09PT09P "time":"2016-05-30 10:20:00", T09PT09PT09PT09PT09PT09 PT09PT09PT09PT09PT09PT09 "location":"RU", PT09PT0//wAARCAYACAADAS IA</image> "content":"New" </order> }</setorderinfo> ]}</sourcepre>

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

=== Описание полей запроса изменения ===Все поля запроса соответствуют структуре order при создании заказа за исключением: * значение '''orderno''' данным методом изменить нельзя.* значение '''barcode''' изменяется в случае явного его указания. В случае отсутствия или пустого значения - остается прежним.* вместо корневого тэга '''neworder''' указывается '''editorder''';* тэг курьера '''courier'''можно изменить только при включенной настройке ''Пример ответа:'Разрешить изменение курьера по АПИ''';<source lang="xml">* для вложений '''item''' указывается внутренний код вложения в атрибуте '''code''', который можно получить при получении статуса заказа.<?xml version="1* для мест '''package''' указывается внутренний код вложения в атрибуте '''code''', который можно получить при получении статуса заказа.0" encoding="UTF-8"?><setorderinfo> <order ordercode="123456" error="0" errormsg="OK" errormsgru="Успешно" /> <order ordercode="234567" error="59" errormsg="value [date_put] is already set" errormsgru="Значение [Дата доставки] уже указано" />Необходимо иметь в виду, что: </setorderinfo># Заказ нельзя изменить, пока он не синхронизирован с системой (пока предыдущие изменения не переданы в бэк-офис)</source># Удаление вложений и мест выполняется не моментально, а в процессе синхронизации с бэк-офисом (для записей указываются метки Удалено)

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

'''Пример запроса получения печатных форм:'''<source lang="xml"><?xml version="1.0" encodingОтмена заказа ="UTF-8" ?><waybill> <auth extra="8" login="login" pass="pass" /> <orders> <order orderno="1234567" ordercode="33331" /> <order orderno="1234568" ordercode="33332" /> </orders> <form>1</form></waybill></source>Запрос предназначен для отмены заказов.

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

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

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

<?xml version="1.0" encoding="UTF-8"?><waybillcancelorder> <contentauth extra="8" login="login" pass="pass" />EODIcaI8KSBlwQ 4MnEOR7Px8U8EBAyGICBnwpw IZhQgz0ZxuPs8EBM<order orderno="" ordercode="123456" /GcbjzB AwhBl8hwQYIO00GmEwg1CeEG mqYTChNU0wqf8l8nz4zgc+K fCno+zwU5GjOZmzXGcbEQYIM > 4zkegRE40zWzONyoNNMIOIa cWnp6aDCGEGE9NQmoQd2mg00 79U4f3hPTwnfp6Sdrafeqpa JDpFw/1aYT077VNNNdO00G3q mqqvp9p2E7T0/wiFemv8uG6 OM<order orderno="123aaa" ordercode="" /content></waybillcancelorder>

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

<?xml version="1.0" encoding="UTF-8"?><townlistcancelorder> <auth extraorder orderno="8123test" ordercode="123456" error="0" errormsg="OK" errormsgru="Успешно" /> <codesearch> <zipcode>110000</zipcode> <kladrcode>0100000100800</kladrcode> <fiascode>bd21979d-46f8-49d0-9105-e8d65172a983</fiascode> <code>123</code> </codesearch> <conditions> <city>Краснодарский край</city> <namecontains>новгород</namecontains> <namestarts>Моск</namestarts> <name>Москва</name> <fullname>Москва город</fullname> <country>1</country> </conditions> <limit> <limitfrom>30</limitfrom> <limitcount>10</limitcount> <countall>YES</countall> <order orderno="123aaa" ordercode="" error="52" errormsg="order not found" errormsgru="Заказ не найден" /limit></townlistcancelorder>

Внутри контейнера townlist все элементы могут как отсутствовать, так и комбинироваться. Поиск не чувствителен == Добавление вложений к регистру.накладной ==

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

*'''codesearchПример запроса:''' - Поиск по кодам<source lang="xml"><?xml version="1. В случае использования 0" encoding="UTF- контейнеры conditions и limit игнорируются8" ?><addattachments> <auth extra="8" login="login" pass="pass" /> <orderno>1234567</orderno> <attachments> <item name="photo1.jpg">JVBERi0xLjMN1wb25lbnQgMQ JUBQREYwMTIzNDU2Nzg5IDI NMyAwIG9iag08PA0vVHlwZSA U3VidHlwZSAvSW1hZ2UNL1d pZHRoIDE4MDgNL0hlaWdodCA:* '''zipcode''' - Поиск по индексу. Обратите внимание на то, что один почтовый индекс может распространяться на несколько населенных пунктов. В этом случае система вернет несколько записей ggNCAwIFINL0JpdHNQZXJDb 21wb25lbnQgMQ0vRGVjb2RlU ENL0NvbHVtbnMgMTgwOA0+P g0vSW1hZ2VNYXNrIHRydWUNL XhEZWNvZGUNPj4Nc3RyZWFt DQ</item> <item name="photo2.jpg">VBERi0xLjMNAwIG9iag0HRoJ JUBQREYwMTIzNDU2Nzg5IDI NMyAwIG9iag08PA0vVHlwZSA vWE9iamVjdA0vU3VidHlwZS AvSW1hZ2UNL1dpZHRoIDEzNj gNL0hlaWdodCAxMzMzDS9MZ W5ndGggNCAwIFINL0JpdHNQZ XJDb21wb25lbnQgMQ0vRGVj b2RlUGFybXMgPDwNL0sgLTEN L0NvbHVtbnMgMTM2OA0+Pg0 vSW</item> </attachments></addattachments></source>  :* '''kladrcodeОписание полей:''' - Поиск по 13-ти значному коду КЛАДР.:* '''fiascodeaddattachments''' - Поиск по коду ФИАС (AOGUID) — Корневой контейнер. Обязательный элемент.:* '''codeauth''' - Поиск по коду в системе — Авторизация. Обязательный элемент. *'''conditionsorderno''' - Задает условия поиска — Номер заказа. Все вложенные элементы одновременно накладывают условие "И"Обязательный элемент.:* '''city''' - Поиск по всем населенным пунктам регионаМожет использоваться тэг <ordercode> с указанием внутреннего кода заказа.:* '''namecontainsattachments''' - Поиск населенных пунктов — Обязательный элемент, название которых содержит указанный текств котором перечисляются передаваемые данные файлов.:** '''namestartsitem''' - Поиск населенных пунктов — Бинарные данные (файл), название которых начинается с указанного текстазакодированные в base64. Обязательный элемент.:*** '''name''' - Поиск населенных пунктов, название которых соответствует указанному тексту.:*  — Атрибут элемента '''fullnameitem''' - Поиск населенных пунктов, название вместе с типом населенного пункта которых соответствует указанному текстув котором передается имя файла.:* '''country''' - Поиск только по стране с указанным кодомОбязательный элемент.

<townlist countaddattachments> <attachments> <item name="3photo1.jpg" pageerror="10" totalcounterrormsg="3OK" totalpageserrormsgru="1Успешно"> <town> <code>26379</code> <city> <code>23</code> <name>Краснодарский край</name> </city> <item name>Сочи город</name> <fiascode>79da737a-603b-4c19-9b54-9114c96fb912</fiascode> <kladrcode>2300000700000</kladrcode> <shortname /> (not yet supported) <typename /> (not yet supported) <coords lat="43photo2.5855jpg" lonerror="39.72310" errormsg="OK" errormsgru="Успешно" /> </townattachments> <town> <code>40331</codeaddattachments> <city> <code>32</codesource> <name>Брянская область</name> </city>== Получение вложений к накладной == <name>Сочилов хутор</name>'''Пример запроса:''' <fiascode>c9c96c67-2cc9-4f10-afde-fd32417ea216</fiascodesource lang="xml"> <kladrcode>3201900011100</kladrcode> <shortname /> <typename /> <coords lat?xml version="521.64070" lonencoding="33.1724UTF-8" /?> </townattachments> <town> <code>114016</code> <city> <code>60</code> <name>Псковская область</name> </city> <name>Сочихино деревня</name> <fiascode>10df7588-19c1-49d1-a387-9de1cf3eb26f</fiascode> <kladrcode>6001900015400</kladrcode> <shortname /> <typename /> <coords latauth extra="8" login="56.6003login" lonpass="29.3542pass" /> <orderno>1234567</townorderno></townlistattachments>

<regionlist count="2"attachments> <city> <code>80</code> <country> <code>1</code> <name>Россия</item name="doc1.docx" size="35654">JVBERi0xLjMN <id>643</id> JUBQREYwMTIzNDU2Nzg5IDI NMyAwIG9iag08PA0vVHlwZSA <ShortName1>RU</ShortName1> U3VidHlwZSAvSW1hZ2UNL1d pZHRoIDE4MDgNL0hlaWdodCA <ShortName2>RUS</ShortName2> ggNCAwIFINL0JpdHNQZXJDb 21wb25lbnQgMQ0vRGVjb2RlU </country> <name>Агинский Бурятский автономный округ</name> ENL0NvbHVtbnMgMTgwOA0+P g0vSW1hZ2VNYXNrIHRydWUNL XhEZWNvZGUNPj4Nc3RyZWFt DQ</cityitem> <city> <code>1</code> <country> <code>1</code> <name>Россия</item name="photo2.jpg" size="74861">VBERi0xLjMN <id>643</id> JUBQREYwMTIzNDU2Nzg5IDI NMyAwIG9iag08PA0vVHlwZSA <ShortName1>RU</ShortName1> vWE9iamVjdA0vU3VidHlwZS AvSW1hZ2UNL1dpZHRoIDEzNj <ShortName2>RUS</ShortName2> gNL0hlaWdodCAxMzMzDS9MZ W5ndGggNCAwIFINL0JpdHNQZ </country> <name>Адыгея республика</name> XJDb21wb25lbnQgMQ0vRGVj b2RlUGFybXMgPDwNL0sgLTEN L0NvbHVtbnMgMTM2OA0+Pg0 vSW</cityitem></regionlistattachments>

'''Пример запроса справочника улиц:'''<source lang="xml"><?xml version="1.0" encodingИзменение статуса агентом =="UTF-8"?><streetlist> <conditions> <town>Москва город<Запрос изменения статуса заказа позволяет установить окончательный статус заказа — «Доставлен» или «Не доставлен (Возврат/town> // ОБЯЗАТЕЛЬНОЕ ПОЛЕ!Отмена)». <namecontains>Хохло</namecontains> <namestarts>Академика Х</namestarts> <name>Академика Хохлова</name> <fullname>Академика Хохлова улКроме этого, устанавливается дата и время (при необходимости) изменения статуса, а также сообщение в поле ''Инфо о доставке''.</fullname> </conditions> <limit> <limitfrom>30</limitfrom> <limitcount>10</limitcount> <countall>YES</countall> </limit></streetlist></source>

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

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

<?xml version="1.0" encoding="UTF-8"?><streetlist countsetorderinfo> <auth extra="18" pagelogin="1login" totalcountpass="3pass" totalpages/> <order ordercode="1123456"> <message>Получил Иванов</message> <outstrbarcode>7654312</outstrbarcode> </order> <streetorder ordercode="234567"> <status>PICKUPREADY</status> <eventtime>2016-05-30 10:20:00</eventtime> <message>Клиент отказался от покупки</message> <paytype>CASH</paytype> <storeprice>123</storeprice> <nameitems>Академика Хохлова ул. <item code="34533" quantity="1" reason="0" governmentCode="11223311" /name> <shortnameitem code="34456" quantity="0" reason="0" />Академика Хохлова <item code="34421" quantity="2" reason="0" /shortname> <typename/items>ул <image filename="filename1.jpg"> /9j/4AAQSkZJRgA BAQAAAQABAAD/2wBDAA0JCg sKCA0LCgsODg0PEyAVExISEy ccHhcgLikxMC4pLSwzOko+M zZGNywtQFdBRkxOUlNSMj5aY VpQYEpRUk//2wBDAQ4ODhMR EyYVFSZPNS01T09PT09PT09P T09PT09PT09PT09PT09PT09 PT09PT09PT09PT09PT09PT09 PT09PT0//wAARCAYACAADAS IA</typenameimage> </streetorder></streetlistsetorderinfo>

== Справочник номенклатуры == '''Пример Описание полей запроса справочника номенклатурыстатуса:'''<source lang="xml"><?xml version="1.0" encoding="UTF-8" ?><itemlist> <auth extra="8" login="login" pass="pass"></auth> <codesearch> <code>123456</code> <article>FD343</article> <barcode>2345625213125</barcode> </codesearch> <conditions> <namecontains>телевизор</namecontains> <namestarts>sony</namestarts> <name>Sony KDL-55W905 ЖК-телевизор</name> <quantity>EXISTING_ONLY</quantity> <store>2</store> </conditions> <limit> <limitfrom>30</limitfrom> <limitcount>10</limitcount> <countall>YES</countall> </limit></itemlist></source>

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

<itemlist countsetorderinfo> <order ordercode="3123456" totalcounterror="30" pageerrormsg="1OK" totalpageserrormsgru="1Успешно"/> <item> <code>123456</code> <article>FD343</article> <barcode>2345625213125</barcode> <name>Sony KDL-55W905 ЖК-телевизор</name> <retprice>65000</retprice> <purchprice>50000</purchprice> <weight>5.1</weight> <length>50</length> <width>30</width> <height>40</height> <CountInPallet>30</CountInPallet> <HasSerials>1<order ordercode="234567" error="59" errormsg="value [date_put] is already set" errormsgru="Значение [Дата доставки] уже указано" /HasSerials> <CountryOfOrigin>Малайзия</CountryOfOrigin> (not yet supported) <Message>Хороший телевизор</Message> <Message2>Снова хороший телевизор</Message2> <quantity>12</quantity> <reserved>3</reserved> <item> ...</itemlistsetorderinfo>

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

<itemmovementswaybill> <auth extra="8" login="login" pass="pass"/> <orders> <order orderno="1234567" ordercode="33331" /auth> <codeorder orderno="1234568" ordercode="33332" />4259 </codeorders> <datefromform>2020-10-011</datefromform> <datetostart>2020-10-025</datetostart></itemmovementswaybill>

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

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

<?xml version="1.0" encoding="UTF-8" ?><itemmovements count="16"waybill> <itemmovementcontent>EODIcaI8KSBlwQ 4MnEOR7Px8U8EBAyGICBnwpw <code>151500< IZhQgz0ZxuPs8EBM/code>GcbjzB AwhBl8hwQYIO00GmEwg1CeEG <date>2017-05-26</date> mqYTChNU0wqf8l8nz4zgc+K fCno+zwU5GjOZmzXGcbEQYIM <retprice>0</retprice> 4zkegRE40zWzONyoNNMIOIa cWnp6aDCGEGE9NQmoQd2mg00 <quantity>1< 79U4f3hPTwnfp6Sdrafeqpa JDpFw/quantity>1aYT077VNNNdO00G3q <delivered>0< mqqvp9p2E7T0/delivered> <item> <code>4259wiFemv8uG6 OM</codecontent> <name>Настольная игра Дженга</namewaybill> </itemsource> <status> <code>5</code> <name>Возврат от покупателя</name> </status>В тэге content возвращаются бинарные данные (файл pdf), закодированные в base64. <store> <code>1</code> <name>офис При записи в Москве</name>файл необходимо использовать двоичный формат записи! </store> <order> <ordercode>3374830</ordercode> <number>123660-0</number> <date>2017-05-24</date> <orderno>14123</orderno> <barcode>0000000670</barcode> <company>ТОВАР</company> <address>Кравченко ул'''Обратите внимание''', что печатные формы для заборов не формируются., 1</address> <delivereddate>2017-05-29</delivereddate> <deliveredtime>12:00:00</deliveredtime> <deliveredto /> </order> <document> <code>21991</code> <number>318</number> <date>2017-05-26</date> <message></message> </document> </itemmovements></itemlist></source>

''' Описание полей Пример ответа '''*'''code''' - внутренний код операции движения*'''date''' - дата операции*'''retprice''' - цена товара*'''quantity''' - количество товара операции*'''delivered''' - количество доставленного товара *'''item''' - контейнер товара:* '''code''' - внутренний код товара:* '''name''' - наименование товара *'''status''' - контейнер статуса операции:* '''code''' - код статуса:* '''name''' - наименование *'''store''' - контейнер филиала, к которому относится операция:* '''code''' - код филиала:* '''name''' - наименование филиала *'''order''' - контейнер корреспонденции:* '''ordercode''' - внутренний код заказа:* '''number''' - номер заказа:* '''date''' - дата заказа:* '''orderno''' - шифр:* '''barcode''' - штрих-код:* '''company''' - компания:* '''address''' - адрес:* '''delivereddate''' - дата вручения:* '''deliveredtime''' - время вручения:* '''deliveredto''' - данные о вручении, либо причина недоставки *'''document''' - контейнер документа операции:* '''code''' - внутренний код документа:* '''number''' - номер документа:* '''date''' - дата документа:* '''message''' - комментарий == Номенклатура приходной накладной == '''Пример запроса номенклатуры приходной накладнойс ошибкой:'''<source lang="xml"><?xml version="1.0" encoding="UTF-8" ?><itemdoc> <auth extra="8" login="login" pass="pass"></authwaybill> <codeerror>21991Текст ошибки</codeerror></itemdocwaybill>

*'''code''' - внутренний код документа приходной накладной (см. предыдущий запрос). == Справочник городов =='''Пример ответа движения номенклатурызапроса справочника городов:'''

<?xml version="1.0" encoding="UTF-8" ?><itemdoctownlist> <auth extra="8" /> <codesearch> <zipcode>110000</zipcode> <kladrcode>0100000100800</kladrcode> <fiascode>bd21979d-46f8-49d0-9105-e8d65172a983</fiascode> <code>21991123</code> <number/codesearch> <conditions> <city>Краснодарский край</city> <namecontains>новгород</namecontains> <namecontainsparts>318молоково моск</numbernamecontainsparts> <namestarts>Моск</namestarts> <name>Москва</name> <fullname>Москва город</fullname> <datecountry>2017-05-261</country> </dateconditions> <messagelimit> <limitfrom>30</messagelimitfrom> <limitcount>10<items/limitcount> <item code="4259" quantity="1" barcode="200300" article="123555"countall>Настольная игра ДженгаYES</itemcountall> </itemslimit></itemdoctownlist>

*'''itemauth''' - контейнер товара:* '''code''' - внутренний код товара:* '''barcode''' - штрих-код товара:* '''article''' - артикул товара:* '''quantity''' - количество поступившего товара — Авторизация, необязательный элемент. Используется в случае включенного и настроенного ограничения по населенным пунктам в конкретной курьерской службе.

* '''Пример запроса списка филиаловconditions''' — Задает условия поиска. Все вложенные элементы одновременно накладывают условие «И».:* '''city''' — Поиск по всем населенным пунктам региона.<source lang=:* '''namecontainsparts''' — Поиск населенных пунктов, название которых содержит все указанные слова, с разбиением поисковой фразы через пробел. Например "моск моло" найдет деревню "xmlМолоково">в Московской области.:* '''namecontains''' — Поиск населенных пунктов, название которых содержит указанный текст.<?xml version="1:* '''namestarts''' — Поиск населенных пунктов, название которых начинается с указанного текста.0" encoding="UTF-8" ?><storelist>:* '''name''' — Поиск населенных пунктов, название которых соответствует указанному тексту. <auth extra="8"></auth>:* '''fullname''' — Поиск населенных пунктов, название вместе с типом населенного пункта которых соответствует указанному тексту. <json>YES<:* '''country''' — Поиск только по стране с указанным внутренним кодом или текстовым кодом в соответствии [https:/json> <client_code>7890</client_code><ru.wikipedia.org/storelist><wiki/source>ISO_3166-1 стандартом ISO_3166-1], например, «RU», «RUS» для России.

*'''authlimit''' - Атрибут  — Ограничивает вывод результата.:* '''extralimitfrom'''  — Задает номер записи результата, начиная с которой выдавать ответ. По- обязателен, по нему определяется курьерская службаумолчанию — 0.:*'''jsonlimitcount''' - Признак вывода ответа в виде JSON YES/NOЗадает количество записей результата, которые нужно вернуть. По-умолчанию — 10000.:*'''client_codecountall''' - Код клиента курьерской службы — YES указывает на необходимость подсчета общего количества найденных совпадений. Это может замедлять выполнение запроса. Если отключено — в ответе не указываются totalcount и totalpages.

<?xml version="1.0" encoding="UTF-8" ?><storelist townlist count="23" page="1" totalcount="3" totalpages="1"> <storetown> <code>12326379</code> <namecity> <code>ABC23</code> <name> Краснодарский край</storename> <store/city> <codename>456Сочи город</codename> <namefiascode>Филиал 279da737a-603b-4c19-9b54-9114c96fb912</namefiascode> </storekladrcode>2300000700000</storelistkladrcode> <shortname /source> *'''code''' - Код филиала. *'''name''' - Наименование филиала. == Справочник пунктов самовывоза == Для отображения списка пунктов выдачи (ПВЗnot yet supported) есть '''готовый JavaScript модуль''': https://home.courierexe.ru/js/measoft_map.js Инструкция по использованию - внутри. '''Пример запроса пунктов самовывоза:''' <source lang="xml"typename /> (not yet supported) <?xml versioncoords lat="143.05855" encodinglon="UTF-839.7231" ?/> </town> <pvzlisttown> <auth extra="8" login="login" pass="pass"code>40331</authcode> <city> <code>123432</code> <name>Брянская область</name> </city> <client_codename>7890Сочилов хутор</client_codename> <townfiascode>Нижний Тагилc9c96c67-2cc9-4f10-afde-fd32417ea216</townfiascode> <parentcodekladrcode>63201900011100</parentcodekladrcode> <acceptcashshortname />YES <typename /acceptcash> <acceptcardcoords lat="52.6407" lon="33.1724" />YES </acceptcardtown> <town> <acceptfittingcode>YES114016</acceptfittingcode> <city> <maxweightcode>3060</maxweightcode> <name>Псковская область<acceptindividuals/name>YES </acceptindividualscity> <ltname>57.924737Сочихино деревня</ltname> <lgfiascode>59.94001910df7588-19c1-49d1-a387-9de1cf3eb26f</lgfiascode> <rtkladrcode>57.9056826001900015400</rtkladrcode> <rgshortname />59.984669 <typename /rg> <jsoncoords lat="56.6003" lon="29.3542" />YES </jsontown></pvzlisttownlist>

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

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

<?xml version="1.0" encoding="UTF-8" ?><pvzlist regionlist count="2"> <pvzcity> <code>12680</code> <clientcodecountry>3 <code>1</clientcodecode> <name>Нижний ТагилРоссия</name> <parentcodeid>6643</parentcodeid> <parentnameShortName1>ИнтеграцияRU</parentnameShortName1> <town code="124267" regioncode="66" regionname="Свердловская область"ShortName2>Нижний Тагил городRUS</townShortName2> <address>622036, г. Нижний Тагил, ул. Циолковского, д. 17</addresscountry> <phonename>+73435417709, +73435254989Агинский Бурятский автономный округ</phonename> <comment/city>Новый пункт доставки </commentcity> <worktimecode>Вс 10:00-16:00, Сб 10:00-16:00, Пн-Пт 10:00-20:001</worktimecode> <traveldescription>Жилое 5-ти этажное здание, торцом к дороге, второе здание от перекрестка Пархоменко-Циолковского</traveldescriptioncountry> <maxweightcode>101</maxweightcode> <acceptcashname>YESРоссия</acceptcashname> <acceptcardid>YES643</acceptcardid> <acceptfittingShortName1>YESRU</acceptfittingShortName1> <acceptindividualsShortName2>YESRUS</acceptindividualsShortName2> <latitude>57.93457</latitudecountry> <longitudename>59.95131Адыгея республика</longitudename> </pvz> <pvzcity> <code>245</coderegionlist> <clientcode>NTG1</clientcodesource> <name>На Красноармейской</name> <parentcode>6</parentcode>== Справочник улиц == <parentname>Интеграция</parentname>'''Пример запроса справочника улиц:''' <town codesource lang="124267xml" regioncode><?xml version="661.0" regionnameencoding="Свердловская областьUTF-8"?>Нижний Тагил город</townstreetlist> <address>КРАСНОАРМЕЙСКАЯ, д.79</addressconditions> <phonetown>+7(3435)379-044Москва город</phonetown> <comment>Возможность примерки отсутствует< //comment>ОБЯЗАТЕЛЬНОЕ ПОЛЕ! <worktimenamecontains>Вс 10:00-16:00, Сб 10:00-16:00, Пн-Пт 10:00-20:00Хохло</worktimenamecontains> <traveldescriptionnamestarts>Напротив ТЦ ПирамидаАкадемика Х</traveldescriptionnamestarts> <maxweightname>20Академика Хохлова</maxweightname> <acceptcashfullname>YESАкадемика Хохлова ул.</acceptcashfullname> <acceptcard>YES </acceptcardconditions> <acceptfitting>NO</acceptfittinglimit> <acceptindividualslimitfrom>YES30</acceptindividualslimitfrom> <latitudelimitcount>57.9346810</latitudelimitcount> <longitudecountall>60.55476YES</longitudecountall> </pvzlimit></pvzliststreetlist>

*'''codeconditions''' - Код ПВЗ в системе — Задает условия поиска. Используется в запросе [[API#Оформление заказа|оформления заказов]]*'''clientcode''' - Код ПВЗ используемый компанией-подрядчикомВсе вложенные элементы одновременно накладывают условие «И».:*'''nametown''' - Наименование ПВЗ — Обязательное поле.*'''parentcode''' - Код родительского элементаНазвание или код населенного пункта.:*'''parentnamenamecontains''' - Наименование родительского элемента — Поиск улиц, название которых содержит указанный текст.:*'''townnamestarts''' - Населенный пункт с кодом из [[#Справочник городов|справочника городов]] — Поиск улиц, а также название которых начинается с кодом и наименованием регионауказанного текста.:*'''addressname''' - Адрес ПВЗ — Поиск улиц, название которых соответствует указанному тексту.:*'''phonefullname''' - Телефоны ПВЗ.*'''comment''' - Дополнительная информация.*'''worktime''' - Режим работы ПВЗ.*'''traveldescription''' - Описание местонахождения ПВЗ или пути к нему.*'''maxweight''' - Максимальный вес — Поиск улиц, для которых название вместе с которым работает ПВЗтипом соответствует указанному тексту.*'''acceptcash''' - Признак приема наличных*'''acceptcard''' - Признак приема банковских карт*'''acceptfitting''' - Наличие примерки*'''latitude''' - Широта*'''longitude''' - Долгота

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

<receiptdata> <auth extrastreetlist count="1" page="81" logintotalcount="test3" passtotalpages="testm1" > <street> <code>124</code> <ordersname>Академика Хохлова ул.</name> <shortname>Академика Хохлова</shortname> <typename>ул.<order orderno="123456" /typename> <order orderno="890111C" /street> </ordersstreetlist></receiptdatasource>

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

  <?xml version="1.0" encoding="UTF-8"?><receipts countitemlist> <auth extra="18" login="login" pass="pass"></auth> <receiptcodesearch> <ordernocode>123456</ordernocode> <fdDatetimearticle>2020-06-07 12:14:00FD343</fdDatetimearticle> <fdValuebarcode>1232345625213125</fdValuebarcode> <fdNum>456 </fdNumcodesearch> <fnSn>789</fnSnconditions> <kktNumnamecontains>100телевизор</kktNumnamecontains> <innnamestarts>222sony</innnamestarts> <ofdUrlname>gate.ofd.ruSony KDL-55W905 ЖК-телевизор</ofdUrlname> <fullUrlquantity>https://check.ofd.ru/123EXISTING_ONLY</fullUrlquantity> <pricestore>123452</pricestore> <lines count="1"> <line> <item>1111764 </itemconditions> <name>Сапоги </nameexcept> <qtycode>1123478</qtycode> <price>1000 </priceexcept> <vatRate>20</vatRatelimit> <governmentCodelimitfrom>Z16513LK230</governmentCodelimitfrom> <itemTypelimitcount>110</itemTypelimitcount> </linecountall> YES</linescountall> </receiptlimit></receiptsitemlist>

Параметры ответа:Внутри контейнера itemlist все элементы могут как отсутствовать, так и комбинироваться. Поиск не чувствителен к регистру.*'''ordernocodesearch''' - Номер заказа*'''fdDatetime''' - Дата  — Поиск по кодам. В случае использования — контейнеры conditions и время пробития фискального чекаlimit игнорируются.:*'''fdValuecode''' - ФПД (фискальный признак документа) — Поиск по внутреннему коду системы.:*'''fdNumarticle''' - ФИСКАЛЬНЫЙ ДОКУМЕНТ (фискальный номер чека) — Поиск по артикулу.:*'''fnSnbarcode''' - ФН (номер фискального накопителя) — Поиск по штрихкоду.*'''kktNum''' - РН (регистрационный номер кассы)*'''innconditions''' - ИНН — Задает условия поиска. Все вложенные элементы одновременно накладывают условие «И».:*'''ofdUrlnamecontains''' - URL адрес (доменное имя) ОФД*'''price''' - Сумма чека*'''fullUrl''' - URL чека для просмотра онлайн*'''lines''' - Позиции чека — Поиск товаров, название которых содержит указанный текст.:*'''itemnamestarts''' - код товара — Поиск товаров, название которых начинается с указанного текста.:*'''name''' - наименование товара — Поиск товаров, название которых соответствует указанному тексту.:*'''qtyquantity''' - количество товара:*'''price''' - цена товара:*'''governmentCode''' - считанная последовательность — Наличие на складе. Принимает значения EXISTING_ONLY — Только в наличии, которая NOT_EXISTING_ONLY — Только не в дальнейшем преобразуется по алгоритму тега 1162:*наличии, ALL — Все. '''vatRateЭто поле может быть недоступным в некоторых установках.''' - НДС товара:*'''itemTypestore''' - тип товара (товар, доставка и т.д — Поиск товаров по определенному складу.)

* '''Пример запроса Видов срочностиlimit''' — Ограничивает вывод результата.:* '''limitfrom''' — Задает номер записи результата, начиная с которой выдавать ответ.<source lang="xml"><?xml version="1:* '''limitcount''' — Задает количество записей результата, которые нужно вернуть.0" encoding="UTF-8" ?><services><auth extra="8"/></services></source>

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

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

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

* '''advpricescode''' - Корневой контейнер. Обязательный элемент — внутренний код товара в справочнике номенклатуры. *'''visibledatefrom''' - Признак возврата  — дата начала периода.* '''толькоdateto''' тех услуг — дата окончания периода.Может быть указан или код, что доступны для отображения в ЛК YES/NO. Необязательный элементили период, или код и период одновременно. По-умолчанию NO

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

<advpricesitemmovements count="16"> <advpriceitemmovement> <code>151500</code> <date>2017-05-26</date> <retprice>0</retprice> <quantity>1</quantity> <delivered>0</delivered> <item> <code>4259</code> <name>Этажей в домеНастольная игра Дженга</name> </item> <status> <code>5</code> <typename>intВозврат от покупателя</typename> </advpricestatus> <advpricestore> <code>21</code> <name>Коэффициент надбавкиофис в Москве</name> </store> <order> <typeordercode>float3374830</typeordercode> <number>123660-0</advpricenumber> <advpricedate>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>321991</code> <number>318<name/number> <date>Расписаться на упаковке2017-05-26</namedate> <typemessage>bool</typemessage> </document> </advpriceitemmovements></advpricesitemlist>

Параметры:*'''codeОписание полей ответа ''' - внутренний код услуги*'''namecode''' - наименование услуги. Если поле "название в ЛК" в настройках услуги не пусто, то возвращает значение поля "название в ЛК".*'''hine''' - подсказка по доп услуге для пользователя — внутренний код операции движения*'''typedate''' - тип услуги. Может иметь значения: — дата операции:*'''boolretprice''' - для услуг вида "чекбокс", "Да" — цена товара:*'''floatquantity''' - для числа с плавающей точкой — количество товара операции:*'''intdelivered''' - для целого числа — количество доставленного товара

* '''Пример запроса стоимости доставкиstatus''' — контейнер статуса операции:* '''code''' — код статуса<source lang="xml"><?xml version="1.0" encoding="UTF-8" ?><calculator> <auth extra="8" login="login" pass="pass" /> <calc pricetype="CLIENT" townfrom="Москва" addressfrom="Ленинский проспект, 95" zipcode="664000" townto="3800000300000" addressto="Ленина ул., 10" pvz="123" l="10" w="20" h="30" mass="3.7" service="1" price="1200" inshprice="1200" paytype="CASH" /></calculator></source>:* '''name''' — наименование

Параметры:*'''pricetype''' - тип требуемой цены. Возможные значения: "CLIENT" (по-умолчанию) - цена для клиента. "CUSTOMER" - цена для конечного получателя. (пока не поддерживается)*'''townfrom''' - Город отправления*'''addressfrom''' - Адрес отправления*'''zipcode''' - Почтовый индекс города назначения*'''townto''' - Город назначения*'''addresstostore''' - Адрес назначения*'''pvz''' - Код пункта самовывоза по справочнику*'''l''' - Длина в сантиметрах (не обязательный параметр)*'''w''' - Ширина в сантиметрах (не обязательный параметр)*'''h''' - Высота в сантиметрах (не обязательный параметр)*'''mass''' - Масса в килограммах*'''service''' - Режим доставки - число — контейнер филиала, указывающее на запись в справочнике [[#Справочник Видов срочности|видов срочности]]. Если этот параметр опустить, система выдаст расчет для всех доступных видов срочности, передав много контейнеров <calc> в ответе.к которому относится операция:*'''pricecode''' - Сумма наложенного платежа*'''inshprice''' - Сумма объявленной ценности — код филиала:*'''paytypename''' - Тип оплаты — наименование филиала

Суммы НП и ОЦ* '''order''' — контейнер корреспонденции:* '''ordercode''' — внутренний код заказа:* '''number''' — номер заказа:* '''date''' — дата заказа:* '''orderno''' — шифр:* '''barcode''' — штрихкод:* '''company''' — компания:* '''address''' — адрес:* '''delivereddate''' — дата вручения:* '''deliveredtime''' — время вручения:* '''deliveredto''' — данные о вручении, а также тип оплаты CARD имеют значение при настроенных в тарифе на вкладке Прочее долях (в процентах) от данных сумм.либо причина недоставки

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

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

<calculatortariffs> <calc> <townfrom codeauth extra="8" login="1login">Москва город</townfrom> <townto codepass="56603pass">Иркутск город</townto> <masstownfrom>3.7Москва</masstownfrom> <service name="Экспресс">1</service> <zone>2</zone> <price>1163</price> <mindeliverydaysmainonly>1</mindeliverydays> <maxdeliverydays>3</maxdeliverydays> <mindeliverydate>2020-05-13</mindeliverydate> </calcmainonly> </calculatortariffs>

Параметры:*'''townfromauth''' - Город-отправитель так, как система его распознала и привязала к справочнику. Атрибут  — атрибут '''codeextra''' - код из справочника городов системыобязателен, по нему определяется курьерская служба.*'''towntotownfrom'''  — город- Город-получатель такотправитель. Если не передан, как система его распознала и привязала к справочнику. Атрибут '''code''' - код из справочника городов системыто городом будет «Москва».*'''mass''' - Масса в килограммах*'''service''' - Режим  — режим доставки - число, указывающее на запись в справочнике видов срочности (см описание на этой странице). Обязательный элемент.*'''zonemainonly''' - номер тарифной зоны — необязательный элемент. Если передан, то в ответе будут данные только по которой рассчиталась стоимость. В зависимости от зоны выбирается тарифная сетка. Так же к цене могут применяться повышающие или понижающие коэффициенты при доставке не городам из/в региональный центр.*'''price''справочника ' - рассчитанная стоимость доставки в валюте прайс-листа курьерской службы. Рекомендуется к использованию в отличие от одноименного атрибута родительского контейнера.*''Межгород'maxdeliverydays''> ' - максимальный срок доставки в рабочих днях.*''Зоны'mindeliverydate''' - минимальная дата доставки в учетом выходных дней.

'''Пример запроса получения информации о клиенте:ответа справочника тарифов по городам'''<source lang="xmljson"><?xml version={ "townfrom": "0c5b2444-70a0-4932-980c-b4dc0d3f02b5", "service": 1, "tariffs": [ { "towntofias": "0c5b2444-70a0-4932-980c-b4dc0d3f02b5", "towntocode": 1, "towntoname": "Москва город", "townregion": "Город Москва", "distance": 0, "pricedistance": 0, "pricesnew": { "before": [ { "price": 100, "every": 0, "mass": 1. }, { "price": 150, "every": 0, "mass": 5 } ], "after": [ { "price": 0, "every": 1, " encoding=mass": 38.01 }, { "UTF-8price" ?>: 15,<client> "every": 1, <auth extra= "8mass" login=: 51.01 } ] }, "testdeliveryPeriodMin" pass=: 1, "testmdeliveryPeriodMax" /> : 2 } ]</client>}

'''clientОписание полей ответа ''' * '''townfrom''' — код ФИАС города-отправителя.* '''service''' — режим доставки.* '''tariffs''' — cписок тарифов по городу.:* '''townregion''' — регион города- Корневой контейнерполучателя. Обязательный элемент:* '''towntofias''' — код ФИАС города-получателя.:* '''towntocode''' — внутренний код города-получателя.:*'''authtowntoname'''  — наименование города- Авторизацияполучателя. Обязательный :* '''distance''' — дистанция в км до города от МКАД, если в запросе townfrom — Москва.:* '''pricedistance''' — сумма за километраж до города от МКАД, если в запросе townfrom — Москва.:* '''pricesnew''' — ваши настройки тарифов из справочника '''Межгород''' > '''Тарифы по зонам'''.::* '''before/after''' — контейнеры ДО/ОТ.:::* '''price''' — цена. Если ответ идет по «before», то в цену также плюсуется сумма pricedistance:::* '''every''' — за каждые.:::* '''mass''' — масса.:* '''prices''' — устаревший элемент, не используется.:* '''deliveryPeriodMin''' — минимальный срок доставки.:* '''deliveryPeriodMax''' — максимальный срок доставки.

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

<clientitemdoc> <auth extra="8" login="login" pass="pass"></auth> <code>108221991</code></clientitemdoc>

*'''code''' - Код клиента — внутренний код документа приходной накладной (см. предыдущий запрос).

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

<smalistitemdoc> <auth extracode>21991</code> <number>318</number> <date>2017-05-26</date> <message></message> <items> <item code="84259" loginquantity="login1" passbarcode="pass200300" article="123555" /> <datefrom>2016-02-10Настольная игра Дженга</datefromitem> <dateto>2016-03-10</datetoitems></smalistitemdoc>

'''smalistОписание полей ответа ''' - Корневой * '''code''' — внутренний код приходной накладной* '''number''' — номер документа* '''date''' — дата документа* '''message''' — комментарий * '''item''' — контейнер. Обязательный элемент.товара:*'''authcode''' - Авторизация. Обязательный элемент. — внутренний код товара:*'''datefrombarcode''' - Дата "с". Необязательный элемент. — штрихкод товара:*'''datetoarticle''' - Дата "по". Необязательный элемент. — артикул товараЕсли интервал дат не указан, то возвращаются акты передачи денег за последний месяц.:* '''quantity''' — количество поступившего товара

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

<?xml version="1.0" encoding="UTF-8"?><smalist countstorelist> <auth extra="18"> <sma> <code>6278</code> <number>3992</numberauth> <actdatejson>2016-02-12YES</actdatejson> <datepayclient_code>7890</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> </smaclient_code></smaliststorelist></source>

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

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

<smadetailstorelist count="2"> <store> <code>123</code> <name>ABC</name> <auth extra="8" login="login" pass="pass" /store> <store> <code>6278456</code> <name>Филиал 2</name> </store></smadetailstorelist></source> * '''code''' — Код филиала.* '''name''' — Наименование филиала. == Справочник пунктов самовывоза ==Для отображения списка пунктов выдачи (ПВЗ) есть '''готовый JavaScript модуль''': https://home.courierexe.ru/js/measoft_map.js Инструкция по использованию — внутри. Посмотреть пример работы можно [https://home.courierexe.ru/pvz_test.html Здесь] Уникальные запросы списка ПВЗ кешируются на стороне личного кабинета и хранятся до 7 часов утра по московскому времени следующего дня. Например, если уникальный запрос с массой 2 кг был отправлен сегодня в 10 часов, то завтра в 7 утра он сбросится. Если сегодня в 18 часов в этом же запросе вы укажете массу 2 кг, в ответе вернется тот же список ПВЗ. Если передадите массу 3 кг, список может быть другим.

Обратите внимание, что если в выборке количество ПВЗ больше '''smadetail10000''' - Корневой контейнер. Обязательный элемент.*и не указаны параметры '''code''', '''json''' или '''authlimitcount''' - Авторизация, то будет возвращаться ошибка. Обязательный элемент.*В этом случае необходимо использовать блок '''codelimit''' - Код акта передачи денег (см. запрос списка АПД). Обязательный элемент.

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

<?xml version="1.0" encoding="UTF-8"?><smadetail pvzlist> <auth extra="8" login="login" pass="pass"></auth> <code>1234</code> <client_code>7890</client_code> <city>Свердловская область</city> <town regioncode="66" country="RU">Нижний Тагил</town> <address>Щёлковское шоссе</address> <house>77</house> <parentcode>6</parentcode> <acceptcash>YES</acceptcash> <acceptcard>YES</acceptcard> <acceptfitting>YES</acceptfitting> <maxweight>30</maxweight> <acceptindividuals>YES</acceptindividuals> <lt>57.924737</lt> <lg>59.940019</lg> <rt>57.905682</rt> <rg>59.984669</rg> <json>YES</json> <with_coords>YES</with_coords> <limit> <limitfrom>30</limitfrom> <limitcount>2</limitcount> <countall>YES</countall> </limit></pvzlist></source> * '''auth''' — Атрибут '''extra''' — обязателен, по нему определяется курьерская служба, '''login''' и '''pass''' позволяют авторизоваться под клиентом: для отдельного клиента могут быть ограничения по доступности некоторых ПВЗ, и в этом случае они будут учтены.* '''code''' — Внутренний код.* '''client_code''' — Код клиента курьерской службы.* '''city''' — Регион получателя. Можно указать код региона или полное наименование региона из [[#Справочник регионов|справочника регионов]].* '''town''' — Город получателя.Для тега города '''town''' можно указать код региона в атрибуте '''''regioncode''''' из [[#Справочник регионов|справочника регионов]]. Поиск будет производиться в указанном регионе. Также можно указать страну получателя в атрибуте '''''country''''' в соответствии с [https://ru.wikipedia.org/wiki/ISO_3166-1 стандартом ISO_3166-1], например, «RU», «RUS» или «643» для России.Для формата запроса JSON фильтрация по городу работает только в связке с фильтром по адресу. * '''address''' — Фильтр по адресу, работает только в связке с фильтром по городу* '''house''' — Фильтр по номеру дома, работает только в связке с фильтрами по адресу и городу* '''parentcode''' — Фильтр по родительскому [[#Справочник филиалов|филиалу]]* '''acceptcash''' — Фильтр по приему наличных YES/NO* '''acceptcard''' — Фильтр по приему банковских карт YES/NO* '''acceptfitting''' — Фильтр по наличию примерки YES/NO* '''maxweight''' — Фильтр по максимальному весу, с которым работает ПВЗ* '''acceptindividuals''' — Фильтр по доступности физическим лицам YES/NO* '''lt''' — Широта левого верхнего угла* '''lg''' — Долгота левого верхнего угла* '''rt''' — Широта правого нижнего угла* '''rg''' — Долгота правого нижнего угла* '''json''' — Признак вывода ответа в виде JSON YES/NO* '''with_coords''' — Признак вывода ПВЗ только с наличием координат YES/NO* '''limit''' — Ограничивает вывод результата.:* '''limitfrom''' — Задает номер записи результата, начиная с которой выдавать ответ. По-умолчанию — 0.:* '''limitcount'''- Задает количество записей результата, которые нужно вернуть. По-умолчанию — 100.:* '''countall''' — YES указывает на необходимость подсчета общего количества найденных совпадений. Это может замедлять выполнение запроса. Если отключено — в ответе не указываeтся totalcount.  '''Пример ответа справочника пунктов самовывоза:'''<source lang="xml"><?xml version="1.0" encoding="UTF-8" ?><pvzlist count="2" totalcount="40465"> <specialsmapvz> <code>42494126</code> <ordercodeclientcode>3</clientcode> <name>Нижний Тагил</name> <parentcode>6</parentcode> <parentname>Интеграция</parentname> <town code="124267" regioncode="66" regionname="Свердловская область">Нижний Тагил город</town> <address>622036, г. Нижний Тагил, ул. Циолковского, д. 17</address> <phone>+73435417709, +73435254989</phone> <comment>Новый пункт доставки</comment> <worktime>Вс 10:00-16:00, Сб 10:00-16:00, Пн-Пт 10:00-20:00</worktime> <traveldescription>Жилое 5-ти этажное здание, торцом к дороге, второе здание от перекрестка Пархоменко-Циолковского</traveldescription> <maxweight>10</maxweight> <acceptcash>YES</acceptcash> <acceptcard>YES</acceptcard> <acceptfitting>YES</acceptfitting> <acceptindividuals>YES</acceptindividuals> <latitude>57.93457</latitude> <longitude>59.95131</longitude> <uid>40606d00-9c51-11eb-b2c9-cfd6c1111392</uid> </pvz> <pvz> <code>245</code> <clientcode>NTG1</clientcode> <name>На Красноармейской</name> <parentcode>6</parentcode> <parentname>Интеграция</parentname> <town code="124267" regioncode="66" regionname="Свердловская область">Нижний Тагил город</town> <address>КРАСНОАРМЕЙСКАЯ, д.79</address> <phone>+7(3435)379-044</phone> <comment>Возможность примерки отсутствует</comment> <worktime>Вс 10:00-16:00, Сб 10:00-16:00, Пн-Пт 10:00-20:00</worktime> <traveldescription>Напротив ТЦ Пирамида</traveldescription> <maxweight>20</maxweight> <acceptcash>YES</acceptcash> <acceptcard>YES</acceptcard> <acceptfitting>NO</acceptfitting> <acceptindividuals>14424YES</ordercodeacceptindividuals> <latitude>57.93468</latitude> <longitude>60.55476</longitude> <uid>41116853-9c51-11eb-b2c9-cfd6c1451392</uid> </pvz></pvzlist></source> * '''code''' — Код ПВЗ в системе. Используется в запросе [[API#Оформление заказа|оформления заказов]]* '''clientcode''' — Код ПВЗ используемый компанией-подрядчиком.* '''name''' — Наименование ПВЗ.* '''parentcode''' — Код родительского элемента.* '''parentname''' — Наименование родительского элемента.* '''town''' — Населенный пункт с кодом из [[#Справочник городов|справочника городов]], а также с кодом и наименованием региона.* '''address''' — Адрес ПВЗ.* '''phone''' — Телефоны ПВЗ.* '''comment''' — Дополнительная информация.* '''worktime''' — Режим работы ПВЗ.* '''traveldescription''' — Описание местонахождения ПВЗ или пути к нему.* '''maxweight''' — Максимальный вес, с которым работает ПВЗ.* '''acceptcash''' — Признак приема наличных* '''acceptcard''' — Признак приема банковских карт* '''acceptfitting''' — Наличие примерки* '''latitude''' — Широта* '''longitude''' — Долгота* '''uid''' — Уникальный идентификатор ПВЗ в системе Measoft* '''count''' — Количество записей в ответе* '''totalcount''' — Общее количество записей, отвечающее параметрам запроса == Получение фискальных данных заказа =='''Пример запроса получения фискальных данных:'''<source lang="xml"><?xml version="1.0" encoding="UTF-8"?><receiptdata> <auth extra="8" login="login" pass="pass" /> <orders> <order orderno="123456" /> <order orderno="890111C" /> </orders></receiptdata>  </source> '''Пример ответа получения фискальных данных:'''<source lang="xml">  <?xml version="1.0" encoding="UTF-8"?><receipts count="1"> <receipt> <orderno>11111123456</orderno> <fdDatetime>2020-06-07 12:14:00</fdDatetime> <fdValue>123</fdValue> <fdNum>456</fdNum> <fnSn>789</fnSn> <kktNum>100</kktNum> <inn>222</inn> <ofdUrl>gate.ofd.ru</ofdUrl> <fullUrl>https://check.ofd.ru/123</fullUrl> <price>12345</price> <lines count="1"> <line> <item>1111764</item> <name>Сапоги</name> <qty>1</qty> <price>1000</price> <vatRate>20</vatRate> <governmentCode>Z16513LK2</governmentCode> <itemType>1</itemType> </line> </lines> </receipt></receipts></source> Параметры ответа:* '''orderno''' — Номер заказа* '''fdDatetime''' — Дата и время пробития фискального чека* '''fdValue''' — ФПД (фискальный признак документа)* '''fdNum''' — ФИСКАЛЬНЫЙ ДОКУМЕНТ (фискальный номер чека)* '''fnSn''' — ФН (номер фискального накопителя)* '''kktNum''' — РН (регистрационный номер кассы)* '''inn''' — ИНН* '''ofdUrl''' — URL адрес (доменное имя) ОФД* '''price''' — Сумма чека* '''fullUrl''' — URL чека для просмотра онлайн* '''lines''' — Позиции чека:* '''item''' — код товара:* '''name''' — наименование товара:* '''qty''' — количество товара:* '''price''' — цена товара:* '''governmentCode''' — считанная последовательность, которая в дальнейшем преобразуется по алгоритму тега 1162:* '''vatRate''' — НДС товара:* '''itemType''' — тип товара (товар, доставка и т. д.) == Справочник Виды срочности =='''Пример запроса видов срочности:'''<source lang="xml"><?xml version="1.0" encoding="UTF-8" ?><services><auth extra="8"/></services></source> '''Пример ответа справочника видов срочности:'''<source lang="xml"><?xml version="1.0" encoding="UTF-8" ?><services count="2"> <service> <code>1</code> <name>Эконом</name> </service> <service> <code>2</code> <name>Срочно</name> </service></services></source> == Справочник дополнительных услуг =='''Пример запроса дополнительных услуг:'''<source lang="xml"><?xml version="1.0" encoding="UTF-8"?><advprices> <auth extra="8" login="login" pass="pass" /></advprices></source> '''advprices''' — Корневой контейнер. Обязательный элемент.  '''Пример ответа справочника дополнительных услуг:'''<source lang="xml"><?xml version="1.0" encoding="UTF-8" ?><advprices> <advprice> <code>1</code> <name>Этажей в доме</name> <type>int</type> </advprice> <advprice> <code>2</code> <name>Коэффициент надбавки</name> <type>float</type> </advprice> <advprice> <code>3</code> <name>Расписаться на упаковке</name> <type>bool</type> </advprice></advprices></source> Параметры:* '''code''' — внутренний код услуги* '''name''' — наименование услуги. Если поле «название в ЛК» в настройках услуги не пусто, то возвращает значение поля «название в ЛК».* '''hine''' — подсказка по доп услуге для пользователя* '''type''' — тип услуги. Может иметь значения::* '''bool''' — для услуг вида «чекбокс», «Да»:* '''float''' — для числа с плавающей точкой:* '''int''' — для целого числа == Расчет стоимости доставки =='''Пример запроса стоимости доставки:'''<source lang="xml"><?xml version="1.0" encoding="UTF-8" ?><calculator> <auth extra="8" login="login" pass="pass" /> <order> <pricetype>CUSTOMER</pricetype> <sender> <town>Санкт-Петербург</town> <address>Петровка 38 офис 35</address> <coords lat="55.680327" lon="37.604456"></coords> </sender> <receiver> <zipcode>125480</zipcode> <town regioncode="78" country="RU">Санкт-Петербург</town> <address>Петровка 38 офис 35</address> <pvz>124</pvz> <coords lat="55.680327" lon="37.604456"></coords> </receiver> <weight>5.1</weight> <service>2</service> <paytype>CASH</paytype> <price>387.5</price> <deliveryprice>150</deliveryprice> <inshprice>387.5</inshprice> <packages> <package mass="1" quantity="5"></package> <package mass="2.5" length="10" width="20" height="30"></package> </packages> <userid>user123</userid> <groupid>customer</groupid> </order></calculator></source>  Параметры:Структура данных и заполнение полей аналогичны и совместимы с [[#Оформление заказа]]. Дополнительные поля:* '''pricetype''' — тип требуемой цены. Возможные значения: «CUSTOMER» (по-умолчанию) — [[Личный кабинет клиента#Цена доставки для получателя|цена для конечного получателя]], «CLIENT» — цена курьерской службы для клиента.* '''userid''' — Идентификатор пользователя, строковый или числовой тип. Виртуальное поле. Необязательное. Данное поле используется совместно с настройками «Цена доставки для получателя», определяя приоритет правила. Можно использовать в различных CMS/CRM системах, настраивая цены для определенного покупателя.* '''groupid''' — Идентификатор группы пользователя, строковый или числовой тип. Виртуальное поле. Необязательное. Данное поле используется совместно с настройками «Цена доставки для получателя», определяя приоритет правила. Можно использовать в различных CMS/CRM системах, настраивая цены для определенной группы покупателей. Суммы НП и ОЦ, а также тип оплаты CARD имеют значение при настроенных в тарифе на вкладке Прочее долях (в процентах) от данных сумм. В авторизации можно опустить параметры login и pass, тогда расчет будет производиться по стандартному тарифу курьерской службы, без учета возможных отличий для конкретного клиента.<br>Объемный вес будет учитываться только при условии указания всех габаритов: длины, ширины и высоты.<br>В полях город-отправитель и город-получатель можно указывать название города (не рекомендуется!), либо код города из нашего справочника, либо 13-ти значный код КЛАДР, либо 36-ти значный код адресной системы ФИАС (AOID).  '''Пример ответа стоимости доставки:'''<source lang="xml"><?xml version="1.0" encoding="UTF-8"?><calculator> <calc> <townfrom code="1">Москва город</townfrom> <townto code="56603">Иркутск город</townto> <mass>3.7</mass> <service name="Экспресс">1</service> <zone>2</zone> <price>1113</price> <orderdatemindeliverydays>1</mindeliverydays> <maxdeliverydays>3</maxdeliverydays> <mindeliverydate>2020-05-13</mindeliverydate> <intervals> <workdays> <interval>201810:00-0116: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="-0150">Скидка при доставке</orderdateadvprice> <delivereddate/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>2018 '''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-0103-10</delivereddatedateto></smalist></source> '''smalist''' — Корневой контейнер. Обязательный элемент.* '''auth''' — Авторизация. Обязательный элемент.* '''datefrom''' — Дата «с». Необязательный элемент.* '''dateto''' — Дата «по». Необязательный элемент.Если интервал дат не указан, то возвращаются акты передачи денег за последний месяц. '''Пример ответа на запрос списка актов передачи денег:'''<source lang="xml"><?xml version="1.0" encoding="UTF-8"?><smalist count="1"> <sma> <companycode>Компания6278</companycode> <number>3992</number> <actdate>2016-02-12</actdate> <datepay></datepay> <dateto>2016-02-12</dateto> <promiseddatepay></promiseddatepay> <price>314637.00</price> <rurpricecorr>8800113.00</rurpricecorr> <inshpricerur>31413430.00</inshpricerur> <pricekur>270570.00</pricekur> <priceag>4467.00</priceag> <pricecalcpayno>8486.0042423</pricecalcpayno> <paytype>21</paytype> <paytypename>наличными курьеромБезнал</paytypename> <statussignedcopyreceived>ДоставленоNO</statussignedcopyreceived> </specialsmasma></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>

</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- атрибут с текстом ошибки, если она была.