Изменения

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

|[[Файл: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/ Установить плагин]|Модуль предназначен для отправки заявок в КС, а плагин для расчета стоимости доставки при оформлении заказа. Инструкции есть в маркете, а также см. [[Webasyst|описание]].

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

|style="text-align: center;"|[https://www.amocrm.ru/extensions/courier2008 Установитьmeasoft Описание на сайте amoCRM]|Внимание! Модуль новый, поэтому возможна некорректная передача данных. Проверяйте, если что - сообщайте, исправим!<br>Подробнее см. Подробное описание настроек читайте [[Интеграция с другими системами#amoCRM|описаниетут]].

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

|[[Файл:MoySclad.jpg|center|x44px]]|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.cs-cart.ru/download/apicom/ms_courierexemeasoft-v1.1.1en.zip Скачатьhtml Установить]|Поддерживает версии 4.10 и выше.<br>[[Интеграция с другими системами#cs.cartCS-Cart|Инструкция]]|-|[[Файл:Тильда.png|center|x60px]]|style="text-align: center;"|https://salesbeat.pro/|По вопросам интеграции обращайтесь в [https://salesbeat.pro Salesbeat]

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

|[[Файл:MogutaLogo_tilda_black.png|center|x80pxx100px]]|style="text-align: center;"|https://salesbeat.pro/Читайте описание [[Tilda|на этой странице]]|По вопросам интеграции обращайтесь в [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 пароль: testm, параметр extra: 8. Обратите внимание, что тестовая площадка для всех одна. Не нужно передавать в нее заказы с конфиденциальными данными, их смогут увидеть другие участники.Для использования интеграции в "боевом" «боевом» режиме, запросите '''логин''', '''пароль''', и параметр '''extra''' у той компании, с которой интегрируетесь.Вы можете отправлять тестовые запросы к нашему сервису в личном кабинете на закладке "Автоматизация". В личном кабинете так же можно видеть историю отправленных Вами запросов.

Клиент отправляет Вы можете отправлять тестовые запросы к нашему сервису, методом 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;

Клиент отправляет запросы к сервису методом 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> <weightinshprice>387.5.1</weightinshprice> <deliveryprice VATrate="20">150</deliveryprice> <discount>120</discount> <paytype>CASH</paytype> <return_weightweight>5.1</return_weightweight>

<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''' -  — Корневой контейнер, обязательный элемент.

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

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

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

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

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

*'''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 — Забор товара. Если товар нужно у получателя забрать, возможно — вернуть деньги, или его стоимость вычтется из суммы других товаров. У такого товара в заказе будет отрицательное количество независимо от знака в запросе.:: 9 — Код подтверждения. Используется для вложения, в котором сохраняется регулярное выражение для проверки кодов вложений. См. '''''extraTags''''':* '''''extcode''''' — Внешний код строки. Используется для идентификации строк заказов при получении статусов. Необязательное поле.:*'''instruction''origincountry'''''  — Код страны-производителя в соответствии со [https://ru.wikipedia.org/wiki/ISO_3166- Поручение 1 стандартом ISO_3166- Примечание1], например, «RU», «RUS» или «643» для России.:* '''''GTD''''' — Номер ГТД.:*'''courier''excise' - Запланированный курьер'''' — Сумма акциза. Согласно коду курьера в КС2008:* '''''suppcompany''''' — Наименование компании поставщика, если отличается от заказчика.:*'''receiverpays''suppphone'''' - Признак оплаты стоимости доставки - услуг службы доставки получателем' — Номер телефона компании поставщика, а не заказчиком YES/NOесли отличается от заказчика.:*'''department''suppINN'' - Подразделение''' — ИНН компании поставщика, в котором оформляется заказесли отличается от заказчика.:*'''pickup''governmentCode''''' — Код товарной номенклатуры. Используется для [[Маркировка|маркированных товаров, например («Честный знак»)]]. Для кода '''Честный знак''' Нужно указывать все данные из нанесенного QR- Признак оформления забора YES/NOкода кроме не читаемых символов (#29). Если стоит YESкод не известен — укажите знак вопроса «?», то весь заказ тогда курьер отсканирует код фактически передаваемого покупателю товара. Для некоторых процессов может использоваться значение «!» — в этом случае курьер сканирует серийный номер товара, но это не считается заданием на забор грузакодом маркировки. При этом, а не на доставкуесли указано значение «?» или «! Применяется для вызова курьера к отправителю для забора других отправлений» и quantity больше 1, то такое вложение растиражируется quantity раз.:*'''acceptpartially''govType'''''  — Тип маркировки товара. В данный момент существуют следующие типы маркировки::: 1 — Честный знак. По- Признак возможности частичного выкупа товаров отправления YES/NOумолчанию.:: 2 — ГИИС ДМДК.:: 3 — Серийный номер.:* '''''message''''' — Строка сообщения.:* '''''extraTags''''' — Строка в формате JSON для различных целей.

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

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

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

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

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

*:: Маска валидации - регулярное выражение для проверки кодов вложений курьером. Указывается во вложении с типом 9 (см. атрибут вложения '''''type'costcode''' - Кост-код сотрудника.')

<source lang="json">"item_industry_props":{"tag1262":"020","tag1263":"14.12.2018","tag1264":"1556","tag1265":"tm=mdlp&sid= Примеры ответов ===00000000XXXXXX"},"tag1212": "1"При успешном выполнении запроса, создании заказа, возвращается ошибка 0. При не успешном "ValidationMask": "(A-Z0- номер ошибки и текст ее на английском языке в атрибуте errormsg9){6, для некоторых ошибок выводится перевод на русский в атрибуте errormsgru.8}"</source>

Для клиентов из '''Узбекистана''' необходимо указывать код ИКПУ и код упаковки в следующем формате:<source lang="xmljson"><?xml version="1.0ikpu" encoding=:"UTF-8123123123"?><neworder> <createorder orderno=,"AB23541packageCode" error=:"0123456" errormsg="success"></createorder> <createorder orderno="55_6542" error="0" errormsg="success"></createorder> <createorder orderno="AB23542" error="0" errormsg="success"></createorder></neworder>

* '''Пример ответа при ошибке авторизации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.

<source lang=* '''extrafields''' — Контейнер для описания расширенных полей. Необязательный элемент. Может содержать несколько элементов extrafield* '''extrafield''' — Контейнер для описания расширенного поля.:* '''''name''''' — наименование переменной. Может содержать только латинские буквы, цифры и знак подчеркивания "xml_">, но начинаться может только с буквы. Максимальная длина - 20 символов.:* '''''value''''' — значение переменной. Максимальная длина - 250 символов. * '''overall_volume''' — Общий объем, м3. Виртуальное поле. Необязательное. Из этого поля рассчитывается длина/высота/ширина места. Расчет срабатывает только если в каждом месте есть нулевые значения длины или высоты или ширины. * '''userid''' — Идентификатор пользователя, строковый или числовой тип. Виртуальное поле. Необязательное. Данное поле используется совместно с настройками «Цена доставки для получателя», определяя приоритет правила. Можно использовать в различных CMS/CRM системах, настраивая цены для определенного покупателя. * '''groupid''' — Идентификатор группы пользователя, строковый или числовой тип. Виртуальное поле. Необязательное. Данное поле используется совместно с настройками «Цена доставки для получателя», определяя приоритет правила. Можно использовать в различных CMS/CRM системах, настраивая цены для определенной группы покупателей. <?xml versiondiv style="1.0" encoding="utfcolor: #a94442; background-8color: #f2dede; border: 1px solid #ebccd1; padding: 3px 10px 10px;"?>'''Обратите внимание!'''При передаче заказов, у которых плановая дата доставки/забора меньше ближайшей возможной, дата автоматически меняется на самую раннюю возможную. [[Личный кабинет курьерской службы#Как считается минимальная дата возможной доставки|Подробнее]]<request/div><error error В случае необходимости указания, помимо товаров, дополнительных услуг (например, ДОСТАВКА, комплектация, подъем на этаж и т. д.) — их нужно указать в том же контейнере items как товары, без артикула. === Примеры ответов =="1" errormsg="authorization error"></error></request>При успешном выполнении запроса, создании заказа, возвращается сумма заказа в атрибуте orderprice, а также ошибка 0. При не успешном — номер ошибки и текст ее на английском языке в атрибуте errormsg, для некоторых ошибок выводится перевод на русский в атрибуте errormsgru.</source>В атрибут orderno помещается номер заказа, в атрибут barcode — штрихкод заказа.

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

<requestneworder> <createorder orderno="AB23541" barcode="67567#114" error="0" errormsg="Success" errormsgru="Успешно" orderprice="5000" />column:1 line:11 message:expected ' <createorder orderno="AB23542" barcode="67567#115" error="0" errormsg="Success" errormsgru="Успешно" orderprice="6000" />' <createorder orderno="AB23543" barcode="67567#116" error="0" errormsg="Success" errormsgru="Успешно" orderprice="0" /error></requestneworder>

== Запрос статуса заказов ==  === '''Пример запроса статуса заказа ===ответа с ошибкой'''

<?xml version="1.0" encoding="UTF-8" ?><statusreqneworder> <auth extracreateorder orderno="AB23541" barcode="67567#114" error="867" loginerrormsg="loginOrder barcode already exists in the database." passerrormsgru="passТакой штрихкод заказа уже есть в базе."></auth> <client>CLIENT <createorder orderno="AB23542" barcode="67567#115" error="17" errormsg="Order number already exists in the database." errormsgru="Такой номер заказа уже есть в базе." /client> <createorder orderno>1234</orderno> <orderno2>5678</orderno2> <ordercode>34234</ordercode> <givencode>234534</givencode> <datefrom>2016-07-21</datefrom> <dateto>2016-07-21</dateto> <target>Автозавод</target> <done>ONLY_NOT_DONE</done> <changes>ONLY_LAST<="AB23543" barcode="67567#116" error="67" errormsg="Order barcode already exists in the database." errormsgru="Такой штрихкод заказа уже есть в базе." /changes></statusreqneworder>

'''statusreq''' - Корневой контейнер. Обязательный элемент.<source lang="xml">*'''auth''' - Авторизация<?xml version="1. Обязательный элемент.*'''client''' 0" encoding="utf- Признак клиента или агента. Необязательный элемент.:* CLIENT - Признак клиента, значение по умолчанию:* AGENT - Признак агента. В ответ отдается информация по заказам, переданным агенту на доставку*'''orderno''' - Номер заказа. Необязательный элемент.*'''ordercode''' - Внутренний код заказа. Необязательный элемент.8"?>*'''orderno2''' - Номер заказа из срочных. Необязательный элемент.<request>*'''datefrom''' - Дата заказа <error error="с1". Необязательный элемент.*'''dateto''' - Дата заказа errormsg="поauthorization error". Необязательный элемент.></error>*'''target''' - Строка поиска. Позволяет указать текст, который содержится в названии компании или адресе получателя.</request>*'''done''' - Может принимать значения: :* ONLY_DONE - Только доставленные (имеются в виду успешные статусы, например, '''Доставлен''' или '''Частично доставлен'''):* ONLY_NOT_DONE - Только не доставленные (заказы, которые не являются доставленными, например, '''Не доставлен''' или '''Утерян'''):* ONLY_NEW - Только новые:* ONLY_DELIVERY - Только заказы в обработке - заказы, находящиеся в любом статусе, кроме конечных: Доставлено, Не доставлено, Отменён и т.д.:* ''Пусто'' - все корреспонденции</source>

*'''changesПример ответа при ошибке синтаксиса''' - может принимать значение только ONLY_LAST. Если указан этот параметр, все остальные игнорируются. Описание данного режима приведено здесь: [[#Передача только изменившихся статусов|Передача только изменившихся статусов]]

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

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

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

<source lang="xml"><?xml version="1.0" encoding="UTF-8"?><request> <error>column:1 line:11 message:expected '>'</error></request></source> === Описание полей ответа статусов ===Все поля ответа соответствуют структуре order при создании заказа, с некоторыми добавлениями: * Атрибуты контейнера '''order'''::* '''''awb''''' - Номер накладной в системе курьерской службы.:* '''''orderno2''''' - Номер накладной в подсистеме срочной доставки курьерской службы.:* '''''ordercode''limit''' - внутренний код заказа в системе, применяется для некоторых внутренних операций — Необязательный параметр.:* '''''givencode''''' - внутренний код заказа в системе, применяется для некоторых внутренних операций. * атрибут '''''code''''' контейнера '''item''' - внутренний код строки заказа в системе, применяется для некоторых внутренних операций.:* '''''returns''''' - количество данного товара, от которого отказался получатель. Не нулевое только в случае частичного отказа. * атрибут '''''got''''' контейнера '''package''' - признак принятого места YES / NO.:* '''''returns''''' - количество данного товара, от которого отказался получатель. Не нулевое только в случае частичного отказа. * '''''coords''''' в контейнере '''receiver''' - координаты получателя.* '''currcoords''' - текущие координаты заказа. Атрибуты::* '''''lat''''' - широта:* '''''lon''''' - долгота:* '''''accuracy''''' - точность в метрах:* '''''RequestDateTime''''' - дата/время последнего обновления координат. * '''courier''' - Данные курьера, которому выдан заказ. Если заказ Дает возможность получить не выданвсе измененные заказы, то выводятся данные запланированного курьера.* '''waittime ''' - Время ожидания курьера.* '''deliveryprice''' - Стоимость услуг в валюте расчетов с клиентом. Атрибуты::* '''''total''''' - общая стоимость услуг:* '''''delivery''''' - стоимость доставки "Туда":* '''''return''''' - стоимость доставки "Обратно" (если order->return=YES)Тэг '''deliveryprice''' включает список дополнительных услуг (только для тарифа "Премиум")::* '''''advprice''''' - наименование дополнительной услуги:* '''''code''''' - код дополнительной услуги:* '''''price''''' - стоимость дополнительной услуги * '''status''' - статус доставки (список статусов см. ниже). Атрибуты (заполняются начиная с версии системы 2008.0.0.670)::* '''''eventstore''''' - филиал, к которому относится текущий статус:* '''''eventtime''''' - время события по часовому поясу места его наступления.:* '''''createtimegmt''''' - время по GMT создания записи о смене статуса в БД. Используется для сортировки записей, чтобы соблюсти хронологическую последовательность. <spoiler text="Подробнее">Большинство событий фиксируются в полях eventtime и createtimegmt на основании одного действия, тогда они отличаются а только сдвигом от GMT. Однако, если курьер доставил отправление 10.10.2010 в 20:00, по какой-то причине не внес это в мобильное приложение, на следующий день сдал накладную, и в 9 утра оператор внесла, что он доставил вчера в 20:00. Тогда в createtimegmt будет сегодня 6 утра (для Москвы), а в eventtime - вчера в 20:00. При этом оператор по каким-то причинам может внести время вручения раньше, чем какое-то предыдущее событие, топределенное количество.о. нарушится последовательность времени в eventtime, но при сортировке по createtimegmt все-равно все будет правильно.</spoiler>:* '''''message''''' - наименование филиала-получателя, при передаче между филиалами:* '''''title''''' - русское наименование статуса * '''statushistory''' - история статусов доставки. Содержит список контейнеров '''status'''. Заполняется только для тарифа "Премиум" начиная с версии системы 2008.0.0.670.* '''customstatecode''' - код внутреннего статуса курьерской службы. Значения уточняйте в курьерской службе. Назначаются курьерской службой в разделе "Справочники" - "Статусы" - "15 Статусы корреспонденции". Справочник не передается через API клиенту по причине возможного наличия в нем внутренних технологических статусов курьерской службы.* '''clientstatecode''' - код статуса клиента. ИспользуетсяПомогает на случай, если клиент предлагает свои коды статусов доставки/причин недоставки.* '''deliveredto''' - данные о вручении, либо причина недоставки.* '''delivereddate''' - дата вручения.* '''deliveredtime''' - время вручения. В случае недоставки может быть пустым.* '''arrival''' - плановая дата прибытия в формате гггг-мм-дд чч:мм:сс* '''outstrbarcode''' - код у подрядчика (код заказа во внешней системе). Используется в интеграциях с внешними системами.  Значения контейнеров '''status''' могут принимать следующие значения:: AWAITING_SYNC - Ожидает синхронизации. Данные заказа пока не появились в бэкофисе: NEW - Новый: PICKUP - Забран у отправителя: ACCEPTED - Получен складом: INVENTORY - Инвентаризация: DEPARTURING - Планируется отправка: DEPARTURE - Отправлено со склада: DELIVERY - Выдан курьеру на доставку: COURIERDELIVERED - Доставлен (предварительно): COMPLETE - Доставлен: PARTIALLY - Доставлен частично: COURIERRETURN - Возвращено курьером. Курьер не смог доставить до получателя, вас скопилось очень много измененных заказов и вернул заказ обратно на складнужно их грузить лимитировано. Это промежуточный статус, после которого менеджер выясняет, После каждой итерации нужно ли пытаться заново доставить заказвызывать commitlaststatus с контейнером списка обработанных кодов, или это окончательная недоставка.: CANCELED - Не доставлен (Возврат/Отмена): RETURNING - Планируется возврат: RETURNED - Возвращен: WMSASSEMBLED - Скомплектован на складе: WMSDISASSEMBLED - Разукомплектован: CONFIRM - Согласована доставка: DATECHANGE - Перенос: NEWPICKUP - Создан забор: UNCONFIRM - Не удалось согласовать доставку: PICKUPREADY - Готов к выдаче: LOST - Утрачен/утерян: COURIERPARTIALLY - Частично со слов курьера: COURIERCANCELED - Отказ со слов курьера ''Примечание:'' В будущем возможно расширение и изменение используемого набора статусов.[[#Лимитирование запросов|читать подробнее]]

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

<br />

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

<?xml version="1.0" encoding="UTF-8" ?><statusreqcount="23"> <auth extraorder orderno="8111111" awb="qwerty" orderno2="123123" loginordercode="login34534234" passgivencode="pass2345334"></auth> <changesbarcode>ONLY_LAST111111</changesbarcode> </statusreqsender> <company>МВД</sourcecompany> <person>Иванов И.И.</person>Система выдает все заказы, в которых, с момента последнего запроса в этом режиме, изменилось хотя бы одно из полей: <phone>123-45-67</phone> orderno <contacts> status <phone>+74951234567</phone> delivereddate deliveredtime deliveredto receiver->date receiver->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> <time_max>14:00</commitlaststatustime_max> </sourcesender> <receiver>'''Описание полей запроса''' <company>МВД</company> <person>Иванов И.И.</person>*'''auth''' <phone>123-45- Авторизация. Обязательный элемент.*'''client''' 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>Данный способ передачи статусов гарантирует полную корректную передачу статусов, даже в случае, если в нашей системе статус изменился в промежутке времени между запросом статусов и подтверждением их получения. Если система не получила подтверждение успешной передачи статуса, она будет считать информацию не переданной, и выдаст ее при повторном запросе. <zipcode>125480</zipcode> <div styletown code="color: #a94442; background153361" regioncode="78" regionname="Санкт-color: #f2dede; border: 1px solid #ebccd1; padding: 3px 10px 10px;Петербург город">'''Обратите внимание!''' # При данном способе передачи (<changes>ONLY_LASTСанкт-Петербург город</changestown> <address>Петровка 38 офис 35</address>) система просматривает заказы, оформленные за последние 3 месяца. Если заказ сделан ранее - изменение статуса по нему не попадет в результат выполнения данного запроса.# Система всегда выдает текущий статус. Т.е. Вы можете одним запросом получить статус "NEW", а следующим - "COMPLETE". В промежутке между запросами отправление могло пройти через несколько промежуточных статусов. Если нужна гарантия получения всех промежуточных статусов, нужно анализировать блок statushistory (может не заполняться в следствии ограничений версии или тарифа конкретной службы доставки). <area>Район 1</area> <pvz># Система никогда не гарантирует последовательность прохождения заказом набора статусов. Т.е. Вы можете получить статус "COMPLETE", а следующим запросом - "NEW" - такое может произойти, например, если оператор ошибочно отметил заказ выполненным, а затем исправил ошибку. <code>126</code> <clientcode>QWERTY</divclientcode> <br /pvz> <date>2014-03-22</date> <time_min>09:00</time_min> <time_max>14:00</time_max> <coords lat== Трекинг заказа по номеру == Запрос трекинга по номеру предназначен для выдачи минимальной обезличенной информации о конкретном заказе не авторизованному пользователю"55. Наша система имеет для этого интерфейс по адресу 680327" lon="home37.courierexe.ru604456"></{код экстра}coords> <deliveryPIN>1234</tracking". Вы можете либо сделать ссылку на такую страницу на своем сайте, либо разместить ее iframe'ом у себя, либо сделать свою и пользоваться нашим API. Этот интерфейс создан специально для выдачи информации живому пользователю сайта. Для получения статусов заказов в свою информационную систему нужно использовать запрос "statusreq", желательно с параметром changes=ONLY_LAST! '''Пример запроса:'''deliveryPIN> <source lang="xml"/receiver> <?xml version="1price>387.0" encoding="UTF-8"?>5<tracking/price> <extrainshprice>8387.5</extrainshprice> <ordernopaytype code="1">1234CASH</ordernopaytype> <weight>5.1</trackingweight> </sourcequantity>2</quantity> '''Пример ответа:''' <source lang="xml"service>2</service> <?xml version="1.0" encoding="UTF-8"?type>3<tracking/type> <order orderno="111111"return>NO</return> <barcodereturn_service>1111112</barcodeservice> <AWBreturn_type>1111113</AWBreturn_type> <senderreturn_weight>5.1</return_weight> <town code="1" country="RU">Москва город <return_message>Доставлено в целости</townreturn_message> <datereturn_date>20142026-0301-2219</datereturn_date> <time_minreturn_time>0913:18:00</time_minreturn_time> <time_maxpickup>14:00NO</time_maxpickup> <print_check>YES</senderprint_check> <receiverwaittime>12</waittime> <town code="1" country="RU">Москва городenclosure>Детские игрушки</townenclosure> <zipcodeinstruction>125480Проверить при покупателе, подписать акт</zipcodeinstruction> <date>currcoords lat="55.680327" lon="37.604456" accuracy="50" RequestDateTime="2014-0304-2221 18:07:45"></datecurrcoords> <courier> <time_mincode>09:0026</time_mincode> <time_maxname>14:00Иванов Владимир Петрович</time_maxname> <phone>+79161234567</receiverphone> <price>387.5</pricecourier> <inshprice>387deliveryprice total="158.6" delivery="100.00" return="58.5</inshprice6"> <paytypeadvprice code="1" price="150">CASHБаза</paytypeadvprice> <weightadvprice code="2" price="0">5.1% от объявленной стоимости</weightadvprice> <quantityadvprice code="3" price="8.6">2Топливный сбор</quantityadvprice> <serviceadvprice code="4" price="0">2Округление</serviceadvprice> <type>3</typedeliveryprice> <returnreceiverpays>NO</returnreceiverpays> <return_serviceacceptpartially>2NO</serviceacceptpartially> <return_date></return_date> <return_time></return_time> <return_message></return_message> <waittime>12</waittime> <enclosurestatus eventstore="филиал в Санкт-Петербурге" eventtime="2016-06-02 17:22:00" createtimegmt="2016-06-03 16:14:44" message="" title="Доставлен" eventtown="Санкт-Петербург город" color="16777215">Детские игрушкиCOMPLETE</enclosurestatus> <instructionstatushistory>Проверить при покупателе, подписать акт </instruction> <deliveryprice totalstatus eventstore="158.6Офис в Москве" deliveryeventtime="100.2016-05-30 10:20:00" returncreatetimegmt="58.62016-06-03 16:14:44" /> <courier message="" title="Новый" eventtown="Москва город" country="RU"> <code>26NEW</codestatus> <name>Иванов Владимир Петрович</name> <phone>+79161234567</phone> </courier> <currcoords lat=status eventstore="Офис в Москве" eventtime="2016-06-01 17:38:00"55.680327" loncreatetimegmt="37.6044562016-06-03 16:14:44" accuracy message="50филиал в Санкт-Петербурге" RequestDateTimetitle="2014-04-21 18:07:45Планируется отправка" eventtown="Москва город" country="RU" >DEPARTURING</status> <status eventstore="филиал Офис в Санкт-ПетербургеМоскве" eventtime="2016-06-02 1701 19:2253:00" createtimegmt="2016-06-03 16:14:44" message="филиал в Санкт-Петербурге" title="ДоставленОтправлено со склада" eventtown="Москва город" country="RU">COMPLETEDEPARTURE</status> <statushistory> <status eventstore="Офис филиал в МосквеСанкт-Петербурге" eventtime="2016-0506-30 1002 07:2041:00" createtimegmt="2016-06-03 16:14:44" message="" title="НовыйПолучен складом" eventtown=">NEWСанкт-Петербург город" country="RU">ACCEPTED</status> <status eventstore="Офис филиал в МосквеСанкт-Петербурге" eventtime="2016-06-01 02 09:17:38:00" createtimegmt="2016-06-03 16:14:44" message="филиал в Санкт-Петербурге" title="Планируется отправкаВыдан курьеру на доставку" eventtown="Санкт-Петербург город" country="RU">DEPARTURINGDELIVERY</status> <status eventstore="Офис филиал в МосквеСанкт-Петербурге" eventtime="2016-06-01 1902 17:5322:00" createtimegmt="2016-06-03 16:14:44" message="филиал в " title="Доставлен (предварительно)" eventtown="Санкт-ПетербургеПетербург город" titlecountry="Отправлено со складаRU">DEPARTURECOURIERDELIVERED</status> <status eventstore="филиал в Санкт-Петербурге" eventtime="2016-06-02 0717:4122:00" createtimegmt="2016-06-03 16:14:44" message="" title="Получен складомДоставлен" eventtown="Санкт-Петербург город" country="RU">ACCEPTEDCOMPLETE</status> <status eventstore="филиал в Санкт-Петербурге" eventtime="2016-06-02 09:17:00" createtimegmt="/statushistory> <customstatecode>2<customstatecode> <clientstatecode></clientstatecode> <deliveredto>Иванова, секр.</deliveredto> <delivereddate>2016-06-03 16:1402</delivereddate> <deliveredtime>17:44" message="" title="Выдан курьеру на доставку">DELIVERY22</statusdeliveredtime> <department>Отдел</department> <costcode>cc12345</costcode> <status eventstore="филиал в Санкт-Петербурге" eventtime="2016outstrbarcode>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">COURIERDELIVERED</status> <status eventstoresumm="филиал в Санкт-Петербурге387.5" eventtimeofdUrl="2016-06-02 17:22:00gate.ofd.ru" createtimegmt="2016-06-03 16>https:14:44" message="" title="Доставлен">COMPLETE//ofd.ru/rec/7722756555/0001611984048555/9289000100295555/124555/2899551555</statusreceipt> </statushistoryitems> <deliveredto>Иванова, секрitem code="34533" extcode="abc123" quantity="1" mass="0.</deliveredto> <delivereddate>2016-06-02</delivereddate> <deliveredtime>17:22</deliveredtime> <outstrbarcode>EXT123456</outstrbarcode> <items> <item code2" retprice="37.5" VATrate="0" barcode="2345625213125" article="1" returns="0" origincountry="040" GTD="" excise="345330.00" extcodegovernmentCode="abc12311223311" quantitygovType="1" masssuppcompany="0.2Поставщик" retpricesuppINN="37.51112223334" VATratesuppphone="079161234567" barcode>Мяч</item> <item code="234562521312534456" articleextcode="1abc124" returnsquantity="02" origincountrymass="0402" GTDretprice="100" exciseVATrate="0.0010" governmentCodebarcode="112233114645625213138" suppcompanyarticle="Поставщик2" suppINNreturns="0" governmentCode="1112223334" suppphonegovType="791612345671">МячОбруч</item> <item code="3445634421" extcode="abc124abc125" quantity="23" mass="20.3" retprice="10050" VATrate="1018" barcode="46456252131382345625213126" itemcode="44123" article="23" returns="0" governmentCode="" govType="1">ОбручПогремушка желтая</item> </items> <packages> <item package code="3442133331" extcodestrbarcode="abc125ORD0000001" quantitymass="31" massmessage="0.3" retpricegot="50YES" VATrate></package> <package code="1833332" barcodestrbarcode="2345625213126ORD0000002" articlemass="32.5" returnsmessage="0" governmentCodegot="NO">Погремушка желтая</itempackage> </itemspackages> <extrafields> <extrafield> <name>courier_car</name> <value>ВАЗ 2106, бежевый</value> </extrafield> </extrafields> </order></trackingstatusreq> </source> '''Пример ответа если нет заказов''' <source lang="xml"><?xml version="1.0" encoding="utf-8"?><statusreq count="0"></statusreq> </source> '''Пример ответа при ошибке авторизации''' <source lang="xml"><?xml version="1.0" encoding="utf-8"?><request><error error="1" errormsg="authorization error"></error></request>

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

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

Функция ищет последний заказ по номеру среди заказов всех клиентов. Выдает неперсонализированную информацию о текущем состоянии заказаСистема выдает все заказы, в которых с момента последнего запроса в этом режиме изменилось хотя бы одно из полей: orderno status delivereddate deliveredtime deliveredto receiver->date receiver->address price После успешной обработки ответа необходимо отметить полученные статусы успешно полученными, отправив запрос:<source lang="xml"><?xml version="1.0" encoding="UTF-8" ?><commitlaststatus> <auth extra="8" login="login" pass="pass"></auth> <client>CLIENT</client> <streamid>1234</streamid></commitlaststatus><br /source> '''Описание контейнеров ответа аналогично описанию [[API#полей запроса''' * '''auth''' — авторизация.D0Обязательный элемент.97* '''streamid''' — идентификатор потока.D0Если у вас несколько интеграций и каждая нуждается в получении статусов, вы можете передавать данный параметр и тем самым разделять получение и отметку об успешном получении статусов по заказам.B0Значение должно входить в промежуток от 100 до 10000, включительно.D0Необязательный элемент.BF* '''client''' — признак клиента или агента.D1Необязательный элемент.80.D0.BE.D1.81_.D1.81.D1.82.D0.B0.D1.82.D1.83.D1.81.D0.B0_.D0.B7.D0.B0.D0.BA.D0.B0.D0.B7.D0.BE.D0.B2|Запроса статусов заказов]]:* CLIENT — признак клиента, значение по умолчанию:* AGENT — признак агента.В ответ отдается информация по заказам, переданным агенту на доставку В случае успеха вы получите ответ:<source lang="xml"><?xml version= Изменение заказа "1.0" encoding="UTF-8" ?><commitlaststatus error="0">OK</commitlaststatus></source>

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

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

<br />

=== Описание полей ответа изменения Лимитирование запросов ===Все поля ответа соответствуют ответу при создании заказа за исключением корневого тэга Дает возможность получить не все измененные заказы, а только какое- вместо то определенное количество. Помогает на случай, если у вас скопилось очень много измененных заказов и нужно их грузить лимитировано. После успешной обработки получнных заказов, '''neworder''' возвращается '''editorderобязательно'''нужно вызвать commitlaststatus с кодами обработанных заказов.

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

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

<cancelordercommitlaststatus> <auth extra="8" login="login" pass="pass" ></auth> <order orderno="" ordercode="123456" acs> <ac>11111</ac> <ac>22222</ac> <ac>33333</ac> <ac>44444</ac> <ac>55555</ac> <order orderno="123aaa" ordercode="" /acs></cancelordercommitlaststatus>

* '''Описание полей acs''' — контейнер. Обязательный элемент.* '''ac''' — атрибут''' ordercode''' контейнера '''order''' полученного на этапе запроса статуса:'''statusreq'''.

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

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

<?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" loginordercode="login12345" pass> <barcode>111111</barcode> <AWB>111111</AWB> <sender> <town code="1" country="passRU" >Москва город</town> <date>2014-03-22</date> <time_min>09:00</time_min> <time_max>14:00<orderno/time_max>1234567 </ordernosender> <attachmentsreceiver> <item nametown code="1" country="photo1.jpgRU">JVBERi0xLjMN1wb25lbnQgMQМосква город</town> JUBQREYwMTIzNDU2Nzg5IDI NMyAwIG9iag08PA0vVHlwZSA <zipcode>125480</zipcode> U3VidHlwZSAvSW1hZ2UNL1d pZHRoIDE4MDgNL0hlaWdodCA <date>2014-03-22</date> ggNCAwIFINL0JpdHNQZXJDb 21wb25lbnQgMQ0vRGVjb2RlU <time_min>09:00</time_min> <time_max>14:00</time_max> ENL0NvbHVtbnMgMTgwOA0+P g0vSW1hZ2VNYXNrIHRydWUNL </receiver> XhEZWNvZGUNPj4Nc3RyZWFt DQ <price>387.5</itemprice> <item name="photo2inshprice>387.jpg"5</inshprice>VBERi0xLjMNAwIG9iag0HRoJ JUBQREYwMTIzNDU2Nzg5IDI NMyAwIG9iag08PA0vVHlwZSA <paytype>CASH</paytype> vWE9iamVjdA0vU3VidHlwZS AvSW1hZ2UNL1dpZHRoIDEzNj <weight>5.1</weight> gNL0hlaWdodCAxMzMzDS9MZ W5ndGggNCAwIFINL0JpdHNQZ <quantity>2</quantity> XJDb21wb25lbnQgMQ0vRGVj b2RlUGFybXMgPDwNL0sgLTEN <service>2</service> L0NvbHVtbnMgMTM2OA0+Pg0 vSW <type>3</type> <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> <name>Иванов Владимир Петрович</name>*'''auth''' - Авторизация <phone>+79161234567</phone> </courier> <currcoords lat="55. Обязательный элемент680327" lon="37.604456" accuracy="50" RequestDateTime="2014-04-21 18:07:45" />*'''orderno''' <status eventstore="филиал в Санкт-Петербурге" eventtime="2016-06-02 17:22:00" createtimegmt="2016-06- Номер заказа. Обязательный элемент. Может использоваться тэг 03 16:14:44" message="" title="Доставлен">COMPLETE</status> <ordercodestatushistory> с указанием внутреннего кода заказа.*'''attachments''' <status eventstore="Офис в Москве" eventtime="2016-05-30 10:20:00" createtimegmt="2016-06- Обязательный элемент, 03 16:14:44" message="" title="Новый">NEW</status> <status eventstore="Офис в котором перечисляются передаваемые данные файлов.**'''item''' Москве" eventtime="2016-06-01 17:38:00" createtimegmt="2016-06- Бинарные данные (файл), закодированные 03 16:14:44" message="филиал в base64. Обязательный элемент.Санкт-Петербурге" title="Планируется отправка">DEPARTURING</status>***'''name''' <status eventstore="Офис в Москве" eventtime="2016-06-01 19:53:00" createtimegmt="2016-06- Атрибут элемента '''item''', 03 16:14:44" message="филиал в котором передается имя файла. Обязательный элемент.Санкт-Петербурге" title="Отправлено со склада">DEPARTURE</status> <status eventstore="филиал в Санкт-Петербурге" eventtime="2016-06-02 07:41:00" createtimegmt="2016-06-03 16:14:44" message="" title="Получен складом">ACCEPTED</status> '''Пример ответа <status eventstore="филиал в Санкт-Петербурге" eventtime="2016-06-02 09:17:00" createtimegmt="2016-06-03 16:14:'''44" message="" title="Выдан курьеру на доставку">DELIVERY</status> <source langstatus eventstore="филиал в Санкт-Петербурге" eventtime="2016-06-02 17:22:00" createtimegmt="2016-06-03 16:14:44" message="" title="xmlДоставлен (предварительно)">COURIERDELIVERED</status> <?xml versionstatus eventstore="филиал в Санкт-Петербурге" eventtime="1.02016-06-02 17:22:00" encodingcreatetimegmt="UTF2016-06-803 16:14:44" message="" title="Доставлен"?>COMPLETE</status> </statushistory> <deliveredto>Иванова, секр.</deliveredto> <addattachmentsdelivereddate>2016-06-02</delivereddate> <attachmentsdeliveredtime>17:22</deliveredtime> <outstrbarcode>EXT123456</outstrbarcode> <items> <item namecode="34533" extcode="abc123" quantity="1" mass="0.2" retprice="photo137.jpg5" errorVATrate="0" errormsgbarcode="2345625213125" article="1" returns="OK0" errormsgruorigincountry="Успешно040" GTD="" excise="0.00" governmentCode="11223311" suppcompany="Поставщик" suppINN="1112223334" suppphone="79161234567">Мяч</item> <item code="34456" extcode="abc124" quantity="2" mass="2" retprice="100" VATrate="10" barcode="4645625213138" article="2" returns="0" governmentCode="">Обруч</item> <item namecode="34421" extcode="abc125" quantity="3" mass="photo20.jpg3" errorretprice="50" VATrate="18" barcode="2345625213126" article="3" returns="0" errormsggovernmentCode="OK" errormsgru>Погремушка желтая</item> </items> <acquirers> <acquirer code="Успешно2" name="Ibox" /> <acquirer code="5" name="Payme"/attachments> <acquirer code="6" name="Click"/> </addattachmentsacquirers> </order></tracking></source> где,* '''acquirers''' / '''acquirer''' - эквайринг, доступный для получения ссылки на оплату заказа** '''acquirers''' / '''acquirer''' / ''code'' - внутренний код эквайринга** '''acquirers''' / '''acquirer''' / ''name'' - наименование эквайринга 

== '''Получение вложений к накладной ==информации в формате 17 TRACK'''

<?xml version="1.0" encoding="UTF-8" ?><attachmentstracking17> <auth extra=">8" login="login" pass="pass" </extra> <orderno>12345671234</orderno></attachmentstracking17>

<source lang=pre>{ "number"xml:">ExtNumber",<?xml version= "1.0oriNumber" encoding=:"UTF-81234"?>,<attachments> "oriCountry":"RU", <item name= "doc1.docxdestCountry" size=:"35654RU">JVBERi0xLjMN, JUBQREYwMTIzNDU2Nzg5IDI NMyAwIG9iag08PA0vVHlwZSA "status":"Complete", U3VidHlwZSAvSW1hZ2UNL1d pZHRoIDE4MDgNL0hlaWdodCA "events":[ ggNCAwIFINL0JpdHNQZXJDb 21wb25lbnQgMQ0vRGVjb2RlU { ENL0NvbHVtbnMgMTgwOA0+P g0vSW1hZ2VNYXNrIHRydWUNL "time":"2016-06-02 17:22:00", XhEZWNvZGUNPj4Nc3RyZWFt DQ</item> "location":"RU", <item name= "photo2.jpgtown" size=:"74861Москва">VBERi0xLjMN , JUBQREYwMTIzNDU2Nzg5IDI NMyAwIG9iag08PA0vVHlwZSA "store":"Москва Главный", vWE9iamVjdA0vU3VidHlwZS AvSW1hZ2UNL1dpZHRoIDEzNj "content":"Complete" gNL0hlaWdodCAxMzMzDS9MZ W5ndGggNCAwIFINL0JpdHNQZ }, XJDb21wb25lbnQgMQ0vRGVj b2RlUGFybXMgPDwNL0sgLTEN { L0NvbHVtbnMgMTM2OA0+Pg0 vSW</item> "time":"2016-06-02 17:22:00",</attachments> "location":"RU",</source> "town":"Москва", В тегах item возвращаются бинарные данные (файлы) "store":"Москва Главный", закодированные в base64. "content":"Courierdelivered"== Изменение статуса агентом == }, {Запрос изменения статуса заказа позволяет установить окончательный статус заказа "time":"2016-06- 02 09:17:00"Доставлен, " или location":"Не доставлен (Возврат/Отмена)RU"., "town":"Москва",Кроме этого "store":"Москва Главный", устанавливается дата и время (при необходимости) изменения статуса "content":"Delivery" }, а также сообщение в поле ''Инфо о доставке''. {При необходимости к заказу можно прикрепить изображения. "time":"2016-06-02 07:41:00", "location":"RU", "town":"Москва",'''Пример запроса изменения статуса "store":'''"Москва Главный",<source lang= "content":"xmlAccepted"><?xml version= }, { "1.0time" encoding=:"UTF2016-06-801 19:53:00" ?>,<setorderinfo> "location":"RU", <auth extra= "town":"8Горький" login=, "loginstore" pass=:"passГорький Автозавод" />, <order ordercode= "content":"123456Departure"> <message>Получил Иванов</message> }, </order> { <order ordercode= "time"234567:"> <status>PICKUPREADY</status> <eventtime>2016-0506-30 1001 17:2038:00</eventtime>", <message>Клиент отказался от покупки</message> "location":"RU", <paytype>CASH</paytype> "town":"Горький", <items> "store":"Горький Автозавод", <item code= "content":"34533Departuring" quantity= }, { "1time" reason=:"02016-05-30 10:20:00" />, <item code= "location":"34456RU" quantity=, "0town" reason=:"0Горький" />, <item code= "34421store" quantity=:"2Горький Автозавод" reason=, "0content" /> </items> <image filename=:"filename1.jpgNew"> /9j/4AAQSkZJRgA BAQAAAQABAAD/2wBDAA0JCg sKCA0LCgsODg0PEyAVExISEy ccHhcgLikxMC4pLSwzOko+M zZGNywtQFdBRkxOUlNSMj5aY VpQYEpRUk//2wBDAQ4ODhMR EyYVFSZPNS01T09PT09PT09P } T09PT09PT09PT09PT09PT09 PT09PT09PT09PT09PT09PT09 ] PT09PT0//wAARCAYACAADAS IA}</imagepre> </order>Функция ищет последний заказ по номеру среди заказов всех клиентов. Выдает неперсонализированную информацию о текущем состоянии заказа.</setorderinfobr></source>Описание контейнеров ответа аналогично описанию [[API#.D0.97.D0.B0.D0.BF.D1.80.D0.BE.D1.81 .D1.81.D1.82.D0.B0.D1.82.D1.83.D1.81.D0.B0 .D0.B7.D0.B0.D0.BA.D0.B0.D0.B7.D0.BE.D0.B2|Запроса статусов заказов]].

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

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

<setorderinfo> <order ordercode="123456" acqlink error="0" errormsgamount="OK2000" errormsgruextid="Успешно161083231" >https:/> <order ordercode/qr.nspk.ru/AD10001A7GLVGA9YDO2I0789SIOPV3?type=02&amp;bank="234567" error1000011&amp;sum="59" errormsg2000&amp;cur="value [date_put] is already set" errormsgruRUB&amp;crc="Значение [Дата доставки] уже указано" />7E9C</setorderinfoacqlink>

== Получение документов для печати ==где*'''Пример запроса получения печатных форм:acqlink'''<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''' - Авторизацияacqlink. Обязательный элемент*'''ordersamount''' - Список заказов для получения печатных форм. Содержит тэги '''order''' тип integer сумма платежа в копейках в общем случае, в других случаях в соответствии с атрибутами:типом валюты:* acqlink.'''''orderno''extid''' - шифр заказаидентификатор счета на стороне платежной системы:* acqlink.'''''ordercode'''error'' - внутренний код заказа. Указывать необходимо один из атрибутов для всех заказов. Приоритет имеет атрибут '''''ordercode'''''*'''form''' - Формат накладной. Не обязательный элемент. Принимает значения::* 1 - Подробная накладная (по-умолчанию):* 2 - Наклейки Zebra:* 3 - Наклейки ошибки, если отличается от 0, означает невозможность получения ссылки на оплату, в этом случае ссылки на страницу формата А4оплату не будет и ответ будет выглядеть так:* 4 - Акты приема-передачи  '''Пример ответа:'''

<waybill> <content>EODIcaI8KSBlwQ 4MnEOR7Px8U8EBAyGICBnwpw IZhQgz0ZxuPs8EBMacqlink error="2" message="Ошибка авторизации: Invalid token" amount="2000" extid=""/GcbjzB AwhBl8hwQYIO00GmEwg1CeEG mqYTChNU0wqf8l8nz4zgc+K fCno+zwU5GjOZmzXGcbEQYIM 4zkegRE40zWzONyoNNMIOIa cWnp6aDCGEGE9NQmoQd2mg00 79U4f3hPTwnfp6Sdrafeqpa JDpFw/1aYT077VNNNdO00G3q mqqvp9p2E7T0/wiFemv8uG6 OM</content></waybill>

В тэге content возвращаются бинарные данные Возможные типы ошибок получения ссылки:* '''1''' - не настроен эквайринг, либо не найден заказ* '''2''' - ошибка на стороне эквайринга* '''3''' - запрещающий статус курьера (файл pdfзаказ доставлен, частично доставлен), закодированные в base64.* '''4''' - оплата заказа не разрешена

Изменять заказы могут курьерские службы с тарифами «Премиум» и «Максимум». Чтобы разрешить изменение заказов, в личном кабинете курьерской службы перейдите в '''Настройки''' > '''Заказы''' и в разделе '''Отмена и редактирование'Обратите внимание''установите флажок '''Разрешить отмену и изменение заказов'''. Вы также можете пометить в списке '''Статусы для отмены и редактирования заказов''' галками статусы корреспонденции, что печатные формы для заборов которых возможны отмена и изменение заказов. По умолчанию (когда в этом списке ничего не формируются.выбрано) редактирование и отмена разрешены для статуса «Новый»

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

<?xml version="1.0" encoding="UTF-8"?><townlistcancelorder> <auth extra="8" login="login" pass="pass" /> <codesearch> <zipcode>110000</zipcode> <kladrcode>0100000100800<order orderno="" ordercode="123456" /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="" /limit></townlistcancelorder>

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

'''cancelorder''' — Корневой контейнер. Обязательный элемент.*'''codesearchauth''' - Поиск по кодам — Авторизация. В случае использования - контейнеры conditions и limit игнорируютсяОбязательный элемент.:* '''zipcodeorder''' - Поиск по индексу — Контейнер отменяемого заказа. Обратите внимание на то, что один почтовый индекс Обязательный элемент. Запрос может распространяться на несколько населенных пунктов. В этом случае система вернет несколько записейсодержать более одного контейнера '''order'''.Атрибуты::* '''kladrcode''orderno'' - Поиск по 13-ти значному коду КЛАДР''' — Шифр заказа.:* '''fiascode''ordercode' - Поиск по коду ФИАС (AOGUID)'''' — Внутренний код заказа.:* Обратите внимание, что должен быть указан хотя бы один из атрибутов ''orderno''или 'code'ordercode'' - Поиск по коду в системе.!

<?xml version="1.0" encoding="UTF-8"?><townlist countcancelorder> <order orderno="123test" ordercode="3123456" pageerror="10" totalcounterrormsg="3OK" totalpageserrormsgru="1Успешно"/> <townorder orderno="123aaa" ordercode="" error="52" errormsg="order not found" errormsgru="Заказ не найден" /> <code>26379</codecancelorder> <city/source> <code>23</code> <name>Краснодарский край</name>== Добавление вложений к накладной == </city> <name>Сочи город</name>Метод позволяет прикрепить файлы к корреспонденции. <fiascode>79da737a-603b-4c19-9b54-9114c96fb912</fiascode>Размер загружаемого файла не должен превышать 1 Мб. <kladrcode>2300000700000</kladrcode> <shortname /> (not yet supported)'''Пример запроса:''' <typename /source lang="xml"> (not yet supported) <coords lat?xml version="431.58550" lonencoding="39.7231UTF-8" /?> </townaddattachments> <town> <code>40331<auth extra="8" login="login" pass="pass" /code> <cityorderno> <code>321234567</codeorderno> <name>Брянская область</nameattachments> </cityitem name="photo1.jpg">JVBERi0xLjMN1wb25lbnQgMQ <name>Сочилов хутор</name>JUBQREYwMTIzNDU2Nzg5IDI NMyAwIG9iag08PA0vVHlwZSA <fiascode>c9c96c67-2cc9-4f10-afde-fd32417ea216</fiascode>U3VidHlwZSAvSW1hZ2UNL1d pZHRoIDE4MDgNL0hlaWdodCA <kladrcode>3201900011100</kladrcode>ggNCAwIFINL0JpdHNQZXJDb 21wb25lbnQgMQ0vRGVjb2RlU <shortname />ENL0NvbHVtbnMgMTgwOA0+P g0vSW1hZ2VNYXNrIHRydWUNL XhEZWNvZGUNPj4Nc3RyZWFt DQ<typename /item> <coords latitem name="52photo2.6407jpg" lon="33.1724" /> </town> <town> <code>114016</code> <city> <code>60</code> <name>Псковская область</name>VBERi0xLjMNAwIG9iag0HRoJ </city>JUBQREYwMTIzNDU2Nzg5IDI NMyAwIG9iag08PA0vVHlwZSA <name>Сочихино деревня</name>vWE9iamVjdA0vU3VidHlwZS AvSW1hZ2UNL1dpZHRoIDEzNj <fiascode>10df7588-19c1-49d1-a387-9de1cf3eb26f</fiascode>gNL0hlaWdodCAxMzMzDS9MZ W5ndGggNCAwIFINL0JpdHNQZ <kladrcode>6001900015400</kladrcode>XJDb21wb25lbnQgMQ0vRGVj b2RlUGFybXMgPDwNL0sgLTEN L0NvbHVtbnMgMTM2OA0+Pg0 vSW<shortname /> <typename /> <coords lat="56.6003" lon="29.3542" /item> </townattachments></townlistaddattachments>

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

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

<regionlistaddattachments> <codesearchattachments> <code>77<item name="photo1.jpg" error="0" errormsg="OK" errormsgru="Успешно" /code> <item name="photo2.jpg" error="0" errormsg="OK" errormsgru="Успешно" /codesearch> <conditions/attachments> <namecontains>край</namecontainsaddattachments> <namestarts>Моск</namestartssource> == Получение вложений к накладной =='''Пример запроса:'''<fullnamesource lang="xml">Московская область</fullname?xml version="1.0" encoding="UTF-8" ?> <countryattachments>1 <auth extra="8" login="login" pass="pass" /country> <orderno>1234567</conditionsorderno></regionlistattachments>

<regionlist countattachments> <item name="doc1.docx" timestamp="22025-01-01 12:00:00" size="35654">JVBERixLjMN <city>UwLJdLwIDKxTn+AScMjKqor7Xm3sp1yj1k6BzlPdX2Qsiit6yg3g1fCI4YVAgclUOIY5tDra2LvAcIS <code>80< 5/+8PsL/sXb0+aoper/9kL/4Ov/code>YE9QsHwyg7YZTtKICy0YVIYb4Nt7L1tPUMfaX9NpuTsvFCtBAvYG <country> eJVZoZ2tm6+fZVqAavZpeLizVLtct1a+xvG0+bTSkw3Ac8PhdNfL4smrT2hSgPJLfyaVGyA2ndyW22t <code>1< sFtTP5knktPNumSZ56QsFRPJkaU8ExDxAcMYMDIoBiIoR4/dDjHMbMW/code>EW4fiB1pvWmV2ONWIl1Xdub <name>Россия< Xg1ob0qWX9W4qagsqzGhjRLsEGeJGVXg9oVC+XkJa9esrhGUmC0tuKEla+AplVO/name>OtHwXcW0FWui1z7 <id>643</id> 6KHrtobuWV0xa9sCEiSvb91w3ePHOvfcveo5xt9o4ZevHF7ZOeKxV5qmVx2MI44a1L+Mhk5YuGT12xd <ShortName1>RU< Ibsb7r+j9bff/ShortName1> <ShortName2>RUS<unQlv0al6HBnoD5G89q4+tkjgDtvwwARmqm2aa2Jgvmth8mrXquTNtl2u467vbF/ShortName2>5r < vnMt9uesu21Me1bjeNJGlVfAaCtw+/country> <name>Агинский Бурятский автономный округ<jfenJ/name>fWjqa7ygExx+L0BcTGroxrKexQXIQ1ImfEW7ZRJZa+O <ip7xJmmNESMxrgu/city>dquBbGypjJpFDJVRH1rVPR1Ifl4aFS5IEdDWZFSdyBBWKWhVSVu517ZgzOCFAwp <city> <code>1<wwbFph29g4fTaxnvn/code>3X78x+Tt56ZNffArgULt+HByvy7+yz6U6XWMawCi3+6gJXN0S+jf4t+HT34wg <country> <code>1< km7/code>HDp55YTSWMoCMgZsvZkBrXtIv4WA7xgkT4YpYpxjwLvnsWKkGE+pDbxER0UUWlpVFRY4oilTfM4 <name>Россия</name> MIzgCPgxjOlZ87ceA7ceRJrgpipFGyugPQ4OTI2S8lWJoqTpHJlJbNOeYM7zTcoVxSNyJXiYWSAMklT <id>643< q/id> <ShortName1>RU<xd+3fd3/ShortName1>USq2V1rJ7RyBLHsuDSiLwgaOFc5LUCRGI+QWuBAsIwPlZrgRpSMseJyTzD15PKiIRE7bc <ShortName2>RUS</ShortName2> Rggk5ijXAPpqISetD4wVm0AD2LHuBZdaxmK3HOKIZoG0QLmiZdVqspXnFIJwVyCKhWiDCI4bzH8Y76w </country> TAnwM67HIqMISOkmJXY8mlYhpiNa7g2oTBkKxo4wgnvETQIUUrlFOn9KdOreDiKQx071rN4N61yRAi1 <name>Адыгея республика< 7EGRhSOgoeLYv+k41+KZ1SVBXAuDjB+xuxnQmm8wJDcP5IRn+5penzbR/name>ivm7qleHK5o790w8ejXchI vOHIPWtWwYhtAO34LdDXqFqWxZEBLNstMCwwITBTWirxk12zuUppp</cityitem></regionlistattachments>

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

Кроме этого, устанавливается дата и время (при необходимости) изменения статуса, а также сообщение в поле ''Инфо о доставке'Пример запроса справочника улиц:'''<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"> <namestatus>Академика Хохлова ул.PICKUPREADY</status> <eventtime>2016-05-30 10:20:00</eventtime> <message>Клиент отказался от покупки</message> <paytype>CASH</paytype> <storeprice>123</storeprice> <items> <item code="34533" quantity="1" reason="0" governmentCode="11223311" /> <item code="34456" quantity="0" reason="0" /name> <shortnameitem code="34421" quantity="2" reason="0" />Академика Хохлова </shortnameitems> <attachments> <attachment filename="filename1.jpg">/9j/4AAQSkZJRgA BAQAAAQABAAD/2wBDAA0JCg sKCA0LCgsODg0PEyAVExISEy ccHhcgLikxMC4pLSwzOko+M zZGNywtQFdBRkxOUlNSMj5aY VpQYEpRUk//2wBDAQ4ODhMR EyYVFSZPNS01T09PT09PT09P T09PT09PT09PT09PT09PT09 PT09PT09PT09PT09PT09PT09 PT09PT0//wAARCAYACAADAS IA<typename/attachment>ул <attachment filename="filename2.jpg"> /9j/4AAQSkZJRgA BAQAAAQABAAD/2wBDAA0JCg sKCA0LCgsODg0PEyAVExISEy ccHhcgLikxMC4pLSwzOko+M zZGNywtQFdBRkxOUlNSMj5aY VpQYEpRUk//2wBDAQ4ODhMR EyYVFSZPNS01T09PT09PT09P T09PT09PT09PT09PT09PT09 PT09PT09PT09PT09PT09PT09 PT09PT0//wAARCAYACAADAS IA</attachment> </typenameattachments> </streetorder></streetlistsetorderinfo>

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

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

<?xml version="1.0" encoding="UTF-8" ?><itemlistsetorderinfo> <auth extraorder ordercode="8123456" error=" login0" errormsg="loginOK" passerrormsgru="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> <order ordercode="234567" error="59" errormsg="value [date_put] is already set" errormsgru="Значение [Дата доставки] уже указано" /limit></itemlistsetorderinfo>

Внутри контейнера itemlist все элементы могут как отсутствовать, так и комбинироваться. Поиск не чувствителен к регистру.== Получение документов для печати ==*'''codesearchПример запроса получения печатных форм:''' - Поиск по кодам<source lang="xml"><?xml version="1. В случае использования 0" encoding="UTF- контейнеры conditions и limit игнорируются.8" ?><waybill> <auth extra="8" login="login" pass="pass" /> <client>CLIENT</client> <orders> <order orderno="1234567" ordercode="33331" /> <order orderno="1234568" ordercode="33332" /> </orders> <form>1</form> <start>5</start> <integration>21</integration></waybill></source> :* '''codeОписание полей:''' - Поиск по внутреннему коду системы.:* '''articlewaybill''' - Поиск по артикулу — Корневой контейнер.Обязательный элемент:* '''barcodeauth''' - Поиск по штрих-коду — Авторизация.Обязательный элемент*'''conditionsclient''' - Задает условия поиска — Признак клиента или агента. Все вложенные элементы одновременно накладывают условие "И"Необязательный элемент.:* CLIENT — Признак клиента, значение по умолчанию:* AGENT — Признак агента. В ответ отдается информация по заказам, переданным агенту на доставку* '''namecontainsorders''' - Поиск товаров, название которых содержит указанный текст — Список заказов для получения печатных форм.Содержит тэги '''order''' с атрибутами::* '''namestarts''orderno'' - Поиск товаров, название которых начинается с указанного текста.''' — шифр заказа:* '''name''ordercode'''' - Поиск товаров, название которых соответствует указанному тексту' — внутренний код заказа. Указывать необходимо один из атрибутов для всех заказов.Приоритет имеет атрибут '''''ordercode''''':* '''quantityform''' - Наличие на складе — Формат накладной. Не обязательный элемент. Принимает значения EXISTING_ONLY ::* 1 — Подробная накладная (по- Только в наличии, NOT_EXISTING_ONLY умолчанию):* 2 — Наклейки Zebra:* 3 — Наклейки на страницу формата А4:* 4 — Акты приема- Только не в наличии, ALL - Все. передачи* '''start'Это поле может быть недоступным в некоторых установках.'' — Имеет смысл только для form = 3. Начальная позиция первой наклейки. Используется для пропуска наклеек на листе для их экономии.:* '''storeintegration''' - Поиск товаров по определенному складуПолучение наклеек от подрядчика. Не обязательный элемент, имеет смысл при наличии кода подрядчика в карточке заказа.Принимает значение::* 21 - подрядчик GTD

<itemlist count="3" totalcount="3" page="1" totalpages="1"waybill> <itemintegration code="21"> <order code>123456</code="33331"> <articlecontent>FD343</article> <barcode>2345625213125JVBERi0xLjYNJeLjz9MNC...</barcodecontent> <name>Sony KDL-55W905 ЖК-телевизор</nameorder> <retprice>65000</retpriceorder code="33332"> <purchpricecontent>50000</purchprice> <weight>5JVBERi0xLjYNJeLjz9MNC...1</weightcontent> <length>50</lengthorder> <width>30 </widthintegration> <height>40 </heightcontent>EODIcaI8KSBlwQ 4MnEOR7Px8U8EBAyGICBnwpw <CountInPallet>30< IZhQgz0ZxuPs8EBM/CountInPallet>GcbjzB AwhBl8hwQYIO00GmEwg1CeEG <HasSerials>1</HasSerials> mqYTChNU0wqf8l8nz4zgc+K fCno+zwU5GjOZmzXGcbEQYIM <CountryOfOrigin>Малайзия</CountryOfOrigin> (not yet supported) 4zkegRE40zWzONyoNNMIOIa cWnp6aDCGEGE9NQmoQd2mg00 <Message>Хороший телевизор< 79U4f3hPTwnfp6Sdrafeqpa JDpFw/Message>1aYT077VNNNdO00G3q <Message2>Снова хороший телевизор< mqqvp9p2E7T0/Message2> <quantity>12wiFemv8uG6 OM</quantitycontent> <reserved>3</reserved> <item> ...</itemlistwaybill>

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

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

<?xml version="1.0" encoding="UTF-8" ?><itemmovementswaybill> <auth extra="8" login="login" pass="pass"error>Текст ошибки</auth> <code>4259</code> <datefrom>2020-10-01</datefrom> <dateto>2020-10-02</datetoerror></itemmovementswaybill>

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

<?xml version="1.0" encoding="UTF-8" ?><itemmovements count="16"townlist> <itemmovement> <code>151500<auth extra="8" /code> <date>2017-05-26 </datecodesearch> <retpricezipcode>0110000</retpricezipcode> <quantitykladrcode>10100000100800</quantitykladrcode> <deliveredfiascode>0bd21979d-46f8-49d0-9105-e8d65172a983</deliveredfiascode> <item> <code>4259123</code> <name>Настольная игра Дженга </namecodesearch> </itemconditions> <statuscity> <code>5Краснодарский край</codecity> <namenamecontains>Возврат от покупателяновгород</namenamecontains> <namecontainsparts>молоково моск</statusnamecontainsparts> <storenamestarts> <code>1Моск</codenamestarts> <name>офис в МосквеМосква</name> </store> <order> <ordercodefullname>3374830Москва город</ordercodefullname> <number>123660-0</number> <date>2017-05-24</date> <orderno>14123</orderno> <barcodecountry>0000000670</barcode> <company>ТОВАР</company> <address>Кравченко ул., 1</addresscountry> <delivereddate>2017-05-29 </delivereddateconditions> <deliveredtime>12:00:00</deliveredtimelimit> <deliveredto /limitfrom> 30</orderlimitfrom> <documentlimitcount> <code>2199110</codelimitcount> <number>318 </numbercountall> <date>2017-05-26</date> <message></message> YES</documentcountall> </itemmovementslimit></itemlisttownlist>

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

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

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

*'''orderlimit''' - контейнер корреспонденции — Ограничивает вывод результата.:* '''ordercode''' - внутренний код заказа:* 'limitfrom''number''' -  — Задает номер заказа:* '''date''' записи результата, начиная с которой выдавать ответ. По- дата заказаумолчанию — 0.:* '''ordernolimitcount''' - шифр:* '''barcode''' Задает количество записей результата, которые нужно вернуть. По- штрих-кодумолчанию — 10000.:* '''companycountall''' - компания:* '''address''' - адрес:* '''delivereddate''' - дата вручения:* '''deliveredtime''' - время вручения:* '''deliveredto''' - данные о вручении, либо причина недоставки — YES указывает на необходимость подсчета общего количества найденных совпадений. Это может замедлять выполнение запроса. Если отключено — в ответе не указываются totalcount и totalpages.

*'''document''' - контейнер документа операции:* '''code''' - внутренний код документа:* '''number''' - номер документа:* '''date''' - дата документа:* '''message''' - комментарий == Номенклатура приходной накладной == '''Пример запроса номенклатуры приходной накладнойответа:'''<source lang="xml"><?xml version="1.0" encoding="UTF-8" ?><itemdoc> <auth extratownlist count="83" loginpage="login1" passtotalcount="pass3"totalpages="1"> <town> <code>26379</authcode> <city> <code>2199123</code> <name>Краснодарский край</itemdocname> </sourcecity> <name>Сочи город</name>*'''code''' <fiascode>79da737a-603b-4c19-9b54- внутренний код документа приходной накладной 9114c96fb912</fiascode> <kladrcode>2300000700000</kladrcode> <shortname /> (см. предыдущий запросnot yet supported).  '''Пример ответа движения номенклатуры:''' <source lang="xml"typename /> (not yet supported) <?xml versioncoords lat="143.05855" encodinglon="UTF-839.7231" ?/> <itemdoc/town> <town> <code>2199140331</code> <city> <code>32</code> <name>Брянская область</name> </city> <numbername>318Сочилов хутор</numbername> <datefiascode>2017c9c96c67-2cc9-4f10-05afde-26fd32417ea216</datefiascode> <kladrcode>3201900011100<message/kladrcode> <shortname /message> <itemstypename /> <item codecoords lat="425952.6407" quantitylon="1" barcode="200300" article="12355533.1724"/>Настольная игра Дженга </itemtown> <town> <code>114016</itemscode> <city> <code>60</itemdoccode> <name>Псковская область</sourcename> </city>''' Описание полей ответа ''' <name>Сочихино деревня</name>* '''code''' <fiascode>10df7588-19c1-49d1-a387- внутренний код приходной накладной9de1cf3eb26f</fiascode>* '''number''' - номер документа <kladrcode>6001900015400</kladrcode> <shortname /> <typename /> <coords lat="56.6003" lon="29.3542" /> </town>* '''date''' - дата документа</townlist>* '''message''' - комментарий</source>

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

<?xml version="1.0" encoding="UTF-8" ?><storelistregionlist> <auth extra="8"codesearch> <code>77</code> </codesearch> <conditions> <namecontains>край</authnamecontains> <jsonnamestarts>YESМоск</jsonnamestarts> <client_codefullname>7890Московская область</fullname> <country>RU</country> </client_codeconditions></storelistregionlist>

<?xml version="1.0" encoding="UTF-8" ?><storelist regionlist count="2"> <storecity> <code>12380</code> <country> <code>1</code> <name>Россия</name> <id>643</id> <ShortName1>RU</ShortName1> <ShortName2>RUS</ShortName2> </country> <name>ABCАгинский Бурятский автономный округ</name> </storecity> <storecity> <code>1</code> <country> <code>4561</code> <name>Россия</name> <id>643</id> <ShortName1>RU</ShortName1> <ShortName2>RUS</ShortName2> </country> <name>Филиал 2Адыгея республика</name> </storecity></storelistregionlist>

*'''code''' - Код филиала. *'''name''' - Наименование филиала. == Справочник пунктов самовывоза улиц == Для отображения списка пунктов выдачи (ПВЗ) есть '''готовый JavaScript модуль''': https://home.courierexe.ru/js/measoft_map.js Инструкция по использованию - внутри. '''Пример запроса пунктов самовывозасправочника улиц:'''

<?xml version="1.0" encoding="UTF-8" ?><pvzliststreetlist> <auth extra="8" login="login" pass="pass"conditions> <town>Москва город</authtown> // ОБЯЗАТЕЛЬНОЕ ПОЛЕ! <codenamecontains>1234Хохло</codenamecontains> <client_codenamestarts>7890Академика Х</client_codenamestarts> <townname>Нижний ТагилАкадемика Хохлова</townname> <parentcodefullname>6Академика Хохлова ул.</fullname> </parentcodeconditions> <limit> <acceptcashlimitfrom>YES30</acceptcashlimitfrom> <acceptcardlimitcount>YES10</acceptcardlimitcount> <acceptfittingcountall>YES</acceptfittingcountall> <maxweight/limit>30</maxweightstreetlist> <acceptindividuals/source> * '''conditions''' — Задает условия поиска. Все вложенные элементы одновременно накладывают условие «И».:* '''town''' — Обязательное поле. Название или код населенного пункта.:* '''namecontains''' — Поиск улиц, название которых содержит указанный текст.:* '''namestarts''' — Поиск улиц, название которых начинается с указанного текста.:* '''name''' — Поиск улиц, название которых соответствует указанному тексту.:* '''fullname''' — Поиск улиц, для которых название вместе с типом соответствует указанному тексту. * '''limit''' — Ограничивает вывод результата.:* '''limitfrom''' — Задает номер записи результата, начиная с которой выдавать ответ. По-умолчанию — 0.:* '''limitcount'''- Задает количество записей результата, которые нужно вернуть. По-умолчанию — 10000.:* '''countall''' — YESуказывает на необходимость подсчета общего количества найденных совпадений. Это может замедлять выполнение запроса. Если отключено, в ответе не указываются totalcount и totalpages. '''Пример ответа:'''<source lang="xml"><?xml version="1.0" encoding="UTF-8"?></acceptindividualsstreetlist count="1" page="1" totalcount="3" totalpages="1"> <street> <ltcode>57.924737124</ltcode> <lgname>59Академика Хохлова ул.940019</lgname> <rtshortname>57.905682Академика Хохлова</rtshortname> <rgtypename>59ул.984669</rgtypename> <json>YES </jsonstreet></pvzliststreetlist>

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

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

<pvzlist count="2"itemlist> <pvz> <code>126</code> <clientcode>3</clientcode> <name>Нижний Тагил</name> <parentcode>6</parentcode> <parentname>Интеграция</parentname> <town codeauth extra="1242678" regioncodelogin="66login" regionnamepass="Свердловская областьpass">Нижний Тагил город</townauth> <address>622036, г. Нижний Тагил, ул. Циолковского, д. 17</addresscodesearch> <phonecode>+73435417709, +73435254989123456</phonecode> <commentarticle>Новый пункт доставкиFD343</commentarticle> <worktimebarcode>Вс 10:00-16:00, Сб 10:00-16:00, Пн-Пт 10:00-20:002345625213125</worktimebarcode> <traveldescription>Жилое 5-ти этажное здание, торцом к дороге, второе здание от перекрестка Пархоменко-Циолковского</traveldescriptioncodesearch> <maxweight>10</maxweightconditions> <acceptcashnamecontains>YESтелевизор</acceptcashnamecontains> <acceptcardnamestarts>YESsony</acceptcardnamestarts> <acceptfittingname>YESSony KDL-55W905 ЖК-телевизор</acceptfittingname> <acceptindividualsquantity>YESEXISTING_ONLY</acceptindividualsquantity> <latitudestore>57.934572</latitudestore> <longitude>59.95131</longitudeconditions> </pvz> <pvzexcept> <code>245</code> <clientcode>NTG1</clientcode> <name>На Красноармейской</name> <parentcode>6123478</parentcode> <parentname>Интеграция</parentname> <town code="124267" regioncode="66" regionname="Свердловская область">Нижний Тагил город</town> <address>КРАСНОАРМЕЙСКАЯ, д.79</addressexcept> <phone>+7(3435)379-044</phonelimit> <commentlimitfrom>Возможность примерки отсутствует30</commentlimitfrom> <worktimelimitcount>Вс 10:00-16:00, Сб 10:00-16:00, Пн-Пт 10:00-20:00</worktime> <traveldescription>Напротив ТЦ Пирамида</traveldescription> <maxweight>20</maxweight> <acceptcash>YES</acceptcash> <acceptcard>YES</acceptcardlimitcount> <acceptfitting>NO</acceptfitting> <acceptindividualscountall>YES</acceptindividuals> <latitude>57.93468</latitudecountall> <longitude>60.55476</longitude> </pvzlimit></pvzlistitemlist>

*'''code''' - Код ПВЗ в системе. Используется в запросе [[API#Оформление заказа|оформления заказов]]*'''clientcode''' - Код ПВЗ используемый компанией-подрядчиком.*'''name''' - Наименование ПВЗ.*'''parentcode''' - Код родительского элемента.*'''parentname''' - Наименование родительского элемента.*'''town''' - Населенный пункт с кодом из [[#Справочник городов|справочника городов]]Внутри контейнера itemlist все элементы могут как отсутствовать, а также с кодом так и наименованием регионакомбинироваться.*'''address''' - Адрес ПВЗПоиск не чувствителен к регистру.*'''phonecodesearch''' - Телефоны ПВЗ — Поиск по кодам.*'''comment''' - Дополнительная информацияВ случае использования — контейнеры conditions и limit игнорируются.:*'''worktimecode''' - Режим работы ПВЗ — Поиск по внутреннему коду системы.:*'''traveldescriptionarticle''' - Описание местонахождения ПВЗ или пути к нему — Поиск по артикулу.:*'''maxweightbarcode''' - Максимальный вес, с которым работает ПВЗ — Поиск по штрихкоду.*'''acceptcash''' - Признак приема наличных*'''acceptcard''' - Признак приема банковских карт*'''acceptfitting''' - Наличие примерки*'''latitude''' - Широта*'''longitude''' - Долгота

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

* '''Пример запроса получения фискальных данныхlimit''' — Ограничивает вывод результата.:* '''limitfrom''' — Задает номер записи результата, начиная с которой выдавать ответ.<source lang="xml"><?xml version="1:* '''limitcount''' — Задает количество записей результата, которые нужно вернуть.0" encoding="UTF-8"?><receiptdata> <auth extra="8" login="test" pass="testm" /> <orders> <order orderno="123456" /> <order orderno="890111C" /> </orders></receiptdata>

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

<receipts itemlist count="3" totalcount="3" page="1" totalpages="1"> <receiptitem> <ordernocode>123456</ordernocode> <fdDatetimearticle>2020-06-07 12:14:00FD343</fdDatetimearticle> <fdValuebarcode>1232345625213125</fdValuebarcode> <fdNumname>456Sony KDL-55W905 ЖК-телевизор</fdNumname> <fnSnretprice>78965000</fnSnretprice> <kktNumpurchprice>10050000</kktNumpurchprice> <innweight>2225.1</innweight> <ofdUrllength>gate.ofd.ru50</ofdUrllength> <fullUrlwidth>https://check.ofd.ru/12330</fullUrlwidth> <priceheight>1234540</priceheight> <lines count="1"VATrate> 20<line/VATrate> <itemCountInPallet>111176430</itemCountInPallet> <nameCountInBox>Сапоги2</nameCountInBox> <qtyHasSerials>1</qtyHasSerials> <priceCountryOfOrigin>1000Малайзия</priceCountryOfOrigin> (not yet supported) <vatRateMessage>20Хороший телевизор</vatRateMessage> <governmentCodeMessage2>Z16513LK2Снова хороший телевизор</governmentCodeMessage2> <itemTypequantity>112</itemTypequantity> </linereserved> 3</linesreserved> </receiptitem> ...</receiptsitemlist>

Параметры ответа'''Описание полей:'''* '''code''' — Внутренний идентификатор, присвоенный системой.*'''ordernoarticle''' - Номер заказа — Артикул, назначенный клиентом (поставщиком).*'''fdDatetimebarcode''' - Дата и время пробития фискального чека — Штрихкод производителя.*'''fdValuename''' - ФПД (фискальный признак документа) — Наименование.*'''fdNumretprice'''  — Розничная цена по- ФИСКАЛЬНЫЙ ДОКУМЕНТ (фискальный номер чека)умолчанию. При оформлении заказа цена используется та, которая указана в заказе.*'''fnSnpurchprice''' - ФН (номер фискального накопителя) — Закупочная цена.*'''kktNumweight''' - РН (регистрационный номер кассы) — Масса в килограммах.*'''innlength''' - ИНН — Длина в сантиметрах.*'''ofdUrlwidth''' - URL адрес (доменное имя) ОФД — Ширина в сантиметрах.*'''priceheight''' - Сумма чека — Высота в сантиметрах.*'''fullUrlVATrate''' - URL чека для просмотра онлайн — Ставка НДС, целое число процентов.*'''linesCountInPallet''' - Позиции чека — Количество штук в паллете.:*'''itemCountInBox''' - код товара — Количество штук в упаковке.:*'''nameHasSerials''' - наименование товара — Требует учета серийных номеров. Принимает значения 1 — да, 0 — нет.:*'''qtyCountryOfOrigin''' - количество товара — Наименование страны происхождения на русском языке.:*'''priceMessage''' - цена товара — Комментарий.:*'''governmentCodeMessage2''' - считанная последовательность, которая в дальнейшем преобразуется по алгоритму тега 1162 — Дополнительный комментарий.:*'''vatRatequantity''' — Количество на складе. Товары, уже собранные в заказы в этом количестве не присутствуют, считаются покинувшими товарный склад. ''Это поле может быть недоступным в некоторых установках.'' - НДС товара:*'''itemTypereserved''' - тип  — Количество зарезервированного товара (товар. Может превышать остаток на складе, доставка и тесли покупатели ждут следующей поставки.д''Это поле может быть недоступным в некоторых установках.)''

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

<servicesitemmovements> <auth extra="8"login="login" pass="pass"></auth> <code>4259</code> <datefrom>2020-10-01</datefrom> <dateto>2020-10-02</dateto></servicesitemmovements>

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

<services itemmovements count="216"> <serviceitemmovement> <code>1151500</code> <date>2017-05-26</date> <retprice>0</retprice> <namequantity>Эконом1</namequantity> <delivered>0</servicedelivered> <serviceitem> <code>24259</code> <name>СрочноНастольная игра Дженга</name> </serviceitem> <status> <code>5</servicescode> <name>Возврат от покупателя</sourcename> </status> == Справочник дополнительных услуг == '''Пример запроса дополнительных услуг:''' <source lang="xml"store> <?xml version="code>1.0" encoding="UTF-8"?</code> <advpricesname>офис в Москве</name> <auth extra="8" login="login" pass="pass" /store> <visibleorder>NO <ordercode>3374830</visibleordercode> <number>123660-0</advpricesnumber> </sourcedate> '''advprices''' 2017- Корневой контейнер. Обязательный элемент. *'''visible''' 05- Признак возврата '''только''' тех услуг, что доступны для отображения в ЛК YES24</NO. Необязательный элемент. По-умолчанию NOdate> <orderno>14123</orderno> '''Пример ответа справочника дополнительных услуг:''' <source lang="xml"barcode>0000000670<?xml version="1.0" encoding="UTF-8" ?/barcode> <advpricescompany> ТОВАР<advprice/company> <codeaddress>Кравченко ул., 1</codeaddress> <namedelivereddate>Этажей в доме2017-05-29</namedelivereddate> <typedeliveredtime>int12:00:00</typedeliveredtime> <deliveredto /advprice> <advprice/order> <document> <code>221991</code> <namenumber>Коэффициент надбавки318</namenumber> <typedate>float2017-05-26</typedate> <message></advpricemessage> <advprice/document> <code>3</codeserials> <nameserial>Расписаться на упаковке123456789</nameserial> <type>bool </typeserials> </advpriceitemmovements></advpricesitemlist>

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

* '''status''' — контейнер статуса операции:* '''code''' — код статуса:* '''name''' — наименование * '''store''' — контейнер филиала, к которому относится операция:* '''code''' — код филиала:* '''name''' — наименование филиала * '''order''' — контейнер корреспонденции:* '''ordercode''' — внутренний код заказа:* '''number''' — номер заказа:* '''date''' — дата заказа:* '''orderno''' — шифр:* '''barcode''' — штрихкод:* '''company''' — компания:* '''address''' — адрес:* '''delivereddate''' — дата вручения:* '''deliveredtime''' — время вручения:* '''deliveredto''' — данные о вручении, либо причина недоставки * '''document''' — контейнер документа операции:* '''code''' — внутренний код документа:* '''number''' — номер документа:* '''extnumber''' — внешний номер документа:* '''date''' — дата документа:* '''message''' — комментарий * '''serials''' — контейнер серийных номеров:* '''serial''' — серийный номер единицы номенклатуры, участвующей в движении   == Серийные номера =='''Пример запроса стоимости доставкидвижения номенклатуры с серийным номером:'''

<calculatorserialmovements> <auth extra="8" login="login" pass="pass" ></auth> <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" serial>123456789</serial></calculatorserialmovements>

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

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

<?xml version="1.0" encoding="UTF-8"?><calculatorserialmovements count="16"> <calcserialmovement> <townfrom code="1">Москва город151500</code> <serial>123456789</townfromserial> <townto code="56603"date>Иркутск город2017-05-26</towntodate> <massdelivered>3.70</massdelivered> <service item> <code>4259</code> <name>Настольная игра Дженга</name="Экспресс">1 </serviceitem> <zonestatus> <code>25</zonecode> <name>Возврат от покупателя<price/name>1163 </pricestatus> <mindeliverydaysorder> <ordercode>13374830</mindeliverydaysordercode> <maxdeliverydaysnumber>3123660-0</maxdeliverydaysnumber> <mindeliverydatedate>20202017-05-1324</date> <orderno>14123</mindeliverydateorderno> <barcode>0000000670</calcbarcode> <company>ТОВАР</calculatorcompany> <address>Кравченко ул., 1</sourceaddress> <delivereddate>2017-05-29</delivereddate>Параметры <deliveredtime>12:00:00</deliveredtime>*'''townfrom''' - Город-отправитель так, как система его распознала и привязала к справочнику. Атрибут ''' <deliveredto /> </order> <document> <code>21991</code''' - код из справочника городов системы.> <number>318</number>*'''townto''' <date>2017- Город05-получатель так, как система его распознала и привязала к справочнику. Атрибут '''code''' - код из справочника городов системы.26</date> <message></message>*'''mass''' - Масса в килограммах </document>*'''service''' - Режим доставки - число, указывающее на запись в справочнике видов срочности (см описание на этой странице). </serialmovement>*'''zone''' - номер тарифной зоны, по которой рассчиталась стоимость. В зависимости от зоны выбирается тарифная сетка. Так же к цене могут применяться повышающие или понижающие коэффициенты при доставке не из</в региональный центр.serialmovements>*'''price''' - рассчитанная стоимость доставки в валюте прайс-листа курьерской службы. Рекомендуется к использованию в отличие от одноименного атрибута родительского контейнера.</source>*'''maxdeliverydays''' - максимальный срок доставки в рабочих днях.*'''mindeliverydateОписание полей ответа ''' - минимальная дата доставки в учетом выходных дней.  '''''Обратите внимание:''''' В реальном ответе сервера в теге calc присутствует атрибут "price". Он оставлен для обратной совместимости, не используйте его. Пользуйтесь вложенным тегом price.Описание аналогично описанию полей [[#Движение номенклатуры|движения номенклатуры]] == Получение информации о клиенте ==

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

<clientorderserials> <auth extra="8" login="testlogin" pass="testmpass" ></auth> <ordercode>123456789</ordercode> <orderno>123456789</orderno> <barcode>123456789</barcode> </clientorderserials>

* '''clientordercode''' - Корневой контейнер — внутренний код заказа. Обязательный элемент* '''orderno''' — шифр заказа.*'''authbarcode'''  — штрих- Авторизациякод заказа. Обязательный элементУказывать необходимо один из идентификаторов заказа. 

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

<clientorderserials> <order> <code>10823374830</code> <orderno>14123</orderno> <barcode>0000000670</barcode> <delivereddate>2024-07-20</delivereddate> <deliveredtime>10:04:00</deliveredtime> <assemblydate>2024-07-19 07:05:34</assemblydate> </order> <items> <item> <code>4259</code> <name>Настольная игра Дженга</name> <article>123000</article> <state>Delivered</state> <serials> <serial>123456789</serial> </serials> </item> </items></clientorderserials>

''' Описание полей ответа ''' * '''order''' — блок заказа::*'''code'''  — код:* '''orderno''' — шифр:* '''barcode''' — штрих- Код клиентакод:* '''delivereddate''' — дата доставки факт:* '''deliveredtime''' — время доставки факт:* '''assemblydate''' — дата сборки

* '''item''' — блок товара::* '''code''' — код:* '''name''' — наименование:* '''article''' — артикул:* '''state''' — статус Доставлено (Delivered) или Возвращено (Returned):* '''serials''' — блок серийных номеров по заказу == Список актов передачи денег Получение справочника тарифов по городам ==

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

<?xml version="1.0" encoding="UTF-8" ?><smalisttariffs> <auth extra="8" login="login" pass="pass" /> <datefromtownfrom>2016-02-10Москва</datefromtownfrom> <datetoservice>2016-03-101</datetoservice> <mainonly>1</mainonly> </smalisttariffs>

* '''auth''' — атрибут '''extra'''smalistобязателен, по нему определяется курьерская служба.* ''' townfrom''' — город- Корневой контейнеротправитель. Обязательный элементЕсли не передан, то городом будет «Москва».*'''authservice''' - Авторизация — режим доставки. Обязательный элемент.*'''datefrommainonly''' - Дата "с". Необязательный  — необязательный элемент.*Если передан, то в ответе будут данные только по городам из справочника '''Межгород''' > '''datetoЗоны''' - Дата .  Важно понимать, что в ответе отдаются только тарифы, указанные в разделе "Тарифы позонам" раздела "Межгород"в офисной системе курьерской службы, т. Необязательный элементе. считающихся междугородними.Если интервал дат не указанДоставка до городов, рассчитываемая по внутригородским тарифам, то возвращаются акты передачи денег за последний месяц. в ответе НЕ ОТДАЕТСЯ!

  '''Пример ответа на запрос списка актов передачи денег:справочника тарифов по городам'''<source lang="xmljson"><?xml version={ "townfrom": "0c5b2444-70a0-4932-980c-b4dc0d3f02b5", "service": 1.0, "tariffs": [ { "towntofias" encoding=: "UTF0c5b2444-70a0-4932-980c-8b4dc0d3f02b5"?>,<smalist count= "towntocode": 1, "towntoname": "Москва город", "townregion": "Город Москва", "distance": 0, "pricedistance": 0, "pricesnew": { "before": [ { "price": 100, "every">: 0, "mass": 1 }, { <sma> "price": 150, <code>6278</code> "every": 0, <number>3992</number> "mass": 5 <actdate>2016-02-12</actdate> } <datepay></datepay> ], <dateto>2016-02-12</dateto> "after": [ <promiseddatepay></promiseddatepay> { < "price>637": 0, "every": 1, "mass": 38.00</01 }, { "price>": 15, <pricecorr>113.00</pricecorr> "every": 1, <rur>13430 "mass": 51.00</rur>01 <pricekur>570.00</pricekur> } <priceag>67.00</priceag> ] <payno>42423</payno> }, <paytype> "deliveryPeriodMin": 1</paytype>, "deliveryPeriodMax": 2 <paytypename>Безнал</paytypename> } <signedcopyreceived>NO</signedcopyreceived> </sma>]</smalist>}

*'''codeОписание полей ответа ''' - Код акта*'''numbertownfrom'''  — код ФИАС города- Номер акта в системеотправителя.*'''actdateservice''' - Дата акта — режим доставки.*'''datepaytariffs''' - Дата оплаты  — cписок тарифов по актугороду.:*'''datetotownregion'''  — регион города- Дата конечного периода для формирования АПДполучателя.:*'''promiseddatepaytowntofias'''  — код ФИАС города- Плановая дата оплатыполучателя.:*'''pricetowntocode'''  — внутренний код города- Стоимость услугполучателя.:*'''pricecorrtowntoname'''  — наименование города- Сумма корректировкиполучателя.:*'''rurdistance''' - Сумма заказа — дистанция в км до города от МКАД, если в запросе townfrom — Москва.:*'''pricekurpricedistance''' - Стоимость курьерской доставки — сумма за километраж до города от МКАД, если в запросе townfrom — Москва.:*'''priceagpricesnew''' — ваши настройки тарифов из справочника '''Межгород''' > '''Тарифы по зонам'' - Агентское вознаграждение'.::*'''paynobefore/after''' - Номер платежного поручения — контейнеры ДО/ОТ.:::*'''paytypeprice''' - Тип оплаты: 1 - безнал, 2 - наличными курьером — цена. Если ответ идет по «before», 3 - наличными то в офисецену также плюсуется сумма pricedistance:::* '''every''' — за каждые.:::* '''mass''' — масса.:* '''prices''' — устаревший элемент, 4 - перевод на картуне используется.:*'''paytypenamedeliveryPeriodMin''' - Строковое представление типа оплаты — минимальный срок доставки.:*'''signedcopyreceiveddeliveryPeriodMax''' - Признак факта возврата акта YES/NO — максимальный срок доставки.

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

<smadetailitemdoc> <auth extra="8" login="login" pass="pass" ></auth> <code>627821991</code></smadetailitemdoc>

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

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

<?xml version="1.0" encoding="UTF-8"?><smadetail itemdoc> <code>21991</code> <number>318</number> <date>2017-05-26</date> <message></message> <items> <item code="4259" quantity="1" barcode="200300" article="123555">Настольная игра Дженга</item> </items></itemdoc></source> ''' Описание полей ответа '''* '''code''' — внутренний код приходной накладной* '''number''' — номер документа* '''date''' — дата документа* '''message''' — комментарий * '''item''' — контейнер товара:* '''code''' — внутренний код товара:* '''barcode''' — штрихкод товара:* '''article''' — артикул товара:* '''quantity''' — количество поступившего товара == Справочник филиалов =='''Пример запроса списка филиалов:'''<source lang="xml"><?xml version="1.0" encoding="UTF-8" ?><storelist> <auth extra="8"></auth> <json>YES</json> <client_code>7890</client_code></storelist></source> * '''auth''' — Атрибут '''extra''' — обязателен, по нему определяется курьерская служба* '''json''' — Признак вывода ответа в виде JSON YES/NO* '''client_code''' — Код клиента курьерской службы '''Пример ответа:'''<source lang="xml"><?xml version="1.0" encoding="UTF-8" ?><storelist count="2"> <store> <code>123</code> <name>ABC</name> </store> <store> <code>456</code> <name>Филиал 2</name> </store></storelist></source> * '''code''' — Код филиала.* '''name''' — Наименование филиала. == Справочник пунктов самовывоза ==Для отображения списка пунктов выдачи (ПВЗ) есть '''готовый JavaScript модуль''': https://home.courierexe.ru/js/measoft_map.js Инструкция по использованию — внутри. Посмотреть пример работы можно [https://home.courierexe.ru/pvz_test.html Здесь] Уникальные запросы списка ПВЗ кешируются на стороне личного кабинета и хранятся до 7 часов утра по московскому времени следующего дня. Например, если уникальный запрос с массой 2 кг был отправлен сегодня в 10 часов, то завтра в 7 утра он сбросится. Если сегодня в 18 часов в этом же запросе вы укажете массу 2 кг, в ответе вернется тот же список ПВЗ. Если передадите массу 3 кг, список может быть другим. Обратите внимание, что если в выборке количество ПВЗ больше '''10000''' и не указаны параметры '''code''', '''json''' или '''limitcount''', то будет возвращаться ошибка. В этом случае необходимо использовать блок '''limit'''. '''Пример запроса пунктов самовывоза:'''<source lang="xml"><?xml version="1.0" encoding="UTF-8" ?><pvzlist> <auth extra="8" login="login" pass="pass"></auth> <code>1234</code> <client_code>7890</client_code> <city>Свердловская область</city> <town regioncode="66" country="RU">Нижний Тагил</town> <address>Щёлковское шоссе</address> <house>77</house> <advanced_search>Строка поиска</advanced_search> <parentcode>6</parentcode> <acceptcash>YES</acceptcash> <acceptcard>YES</acceptcard> <acceptfitting>YES</acceptfitting> <maxweight>30</maxweight> <acceptindividuals>YES</acceptindividuals> <respstores>YES</respstores> <lt>57.924737</lt> <lg>59.940019</lg> <rt>57.905682</rt> <rg>59.984669</rg> <json>YES</json> <with_coords>YES</with_coords> <limit> <limitfrom>30</limitfrom> <limitcount>2</limitcount> <countall>YES</countall> </limit></pvzlist></source> * '''auth''' — Атрибут '''extra''' — обязателен, по нему определяется курьерская служба, '''login''' и '''pass''' позволяют авторизоваться под клиентом: для отдельного клиента могут быть ограничения по доступности некоторых ПВЗ, и в этом случае они будут учтены.* '''code''' — Внутренний код, целое число.* '''client_code''' — Код клиента курьерской службы.* '''city''' — Регион получателя. Можно указать код региона или полное наименование региона из [[#Справочник регионов|справочника регионов]].* '''town''' — Город получателя.Для тега города '''town''' можно указать код региона в атрибуте '''''regioncode''''' из [[#Справочник регионов|справочника регионов]]. Поиск будет производиться в указанном регионе. Также можно указать страну получателя в атрибуте '''''country''''' в соответствии с [https://ru.wikipedia.org/wiki/ISO_3166-1 стандартом ISO_3166-1], например, «RU», «RUS» или «643» для России.Для формата запроса JSON фильтрация по городу работает только в связке с фильтром по адресу. * '''address''' — Фильтр по адресу, работает только в связке с фильтром по городу* '''house''' — Фильтр по номеру дома, работает только в связке с фильтрами по адресу и городу* '''advanced_search''' — Фильтр по коду агента, наименованию, телефону или комментарию* '''parentcode''' — Фильтр по родительскому [[#Справочник филиалов|филиалу]]* '''acceptcash''' — Фильтр по приему наличных YES/NO* '''acceptcard''' — Фильтр по приему банковских карт YES/NO* '''acceptfitting''' — Фильтр по наличию примерки YES/NO* '''maxweight''' — Фильтр по максимальному весу, с которым работает ПВЗ* '''acceptindividuals''' — Фильтр по доступности физическим лицам YES/NO* '''respstores''' - Признак вывода ответственных филиалов при значении YES* '''lt''' — Широта левого верхнего угла* '''lg''' — Долгота левого верхнего угла* '''rt''' — Широта правого нижнего угла* '''rg''' — Долгота правого нижнего угла* '''json''' — Признак вывода ответа в виде JSON YES/NO* '''with_coords''' — Признак вывода ПВЗ только с наличием координат YES/NO* '''limit''' — Ограничивает вывод результата.:* '''limitfrom''' — Задает номер записи результата, начиная с которой выдавать ответ. По-умолчанию — 0.:* '''limitcount'''- Задает количество записей результата, которые нужно вернуть. По-умолчанию — 100.:* '''countall''' — YES указывает на необходимость подсчета общего количества найденных совпадений. Это может замедлять выполнение запроса. Если отключено — в ответе не указываeтся totalcount.  '''Пример ответа справочника пунктов самовывоза:'''<source lang="xml"><?xml version="1.0" encoding="UTF-8" ?><pvzlist count="2" totalcount="40465"> <specialsmapvz> <code>42494126</code> <clientcode>3</clientcode> <name>Нижний Тагил</name> <parentcode>6</parentcode> <parentname>Интеграция</parentname> <town code="124267" regioncode="66" regionname="Свердловская область">Нижний Тагил город</town> <ordercodeaddress>14424622036, г. Нижний Тагил, ул. Циолковского, д. 17</ordercodeaddress> <phone>+73435417709, +73435254989</phone> <comment>Новый пункт доставки</comment> <worktime>Вс 10:00-16:00, Сб 10:00-16:00, Пн-Пт 10:00-20:00</worktime> <traveldescription>Жилое 5-ти этажное здание, торцом к дороге, второе здание от перекрестка Пархоменко-Циолковского</traveldescription> <maxweight>10</maxweight> <acceptcash>YES</acceptcash> <acceptcard>YES</acceptcard> <acceptfitting>YES</acceptfitting> <acceptindividuals>YES</acceptindividuals> <latitude>57.93457</latitude> <longitude>59.95131</longitude> <uid>40606d00-9c51-11eb-b2c9-cfd6c1111392</uid> </pvz> <pvz> <code>245</code> <clientcode>NTG1</clientcode> <name>На Красноармейской</name> <parentcode>6</parentcode> <parentname>Интеграция</parentname> <town code="124267" regioncode="66" regionname="Свердловская область">Нижний Тагил город</town> <address>КРАСНОАРМЕЙСКАЯ, д.79</address> <phone>+7(3435)379-044</phone> <comment>Возможность примерки отсутствует</comment> <worktime>Вс 10:00-16:00, Сб 10:00-16:00, Пн-Пт 10:00-20:00</worktime> <traveldescription>Напротив ТЦ Пирамида</traveldescription> <maxweight>20</maxweight> <acceptcash>YES</acceptcash> <acceptcard>YES</acceptcard> <acceptfitting>NO</acceptfitting> <acceptindividuals>YES</acceptindividuals> <latitude>57.93468</latitude> <longitude>60.55476</longitude> <uid>41116853-9c51-11eb-b2c9-cfd6c1451392</uid> </pvz></pvzlist></source> * '''code''' — Код ПВЗ в системе. Используется в запросе [[API#Оформление заказа|оформления заказов]]* '''clientcode''' — Код ПВЗ используемый компанией-подрядчиком.* '''name''' — Наименование ПВЗ.* '''parentcode''' — Код родительского элемента.* '''parentname''' — Наименование родительского элемента.* '''town''' — Населенный пункт с кодом из [[#Справочник городов|справочника городов]], а также с кодом и наименованием региона.* '''address''' — Адрес ПВЗ.* '''phone''' — Телефоны ПВЗ.* '''comment''' — Дополнительная информация.* '''worktime''' — Режим работы ПВЗ.* '''traveldescription''' — Описание местонахождения ПВЗ или пути к нему.* '''maxweight''' — Максимальный вес, с которым работает ПВЗ.* '''acceptcash''' — Признак приема наличных* '''acceptcard''' — Признак приема банковских карт* '''acceptfitting''' — Наличие примерки* '''latitude''' — Широта* '''longitude''' — Долгота* '''uid''' — Уникальный идентификатор ПВЗ в системе Measoft. Создается автоматически при получении данных о ПВЗ от агентов.* '''count''' — Количество записей в ответе* '''totalcount''' — Общее количество записей, отвечающее параметрам запроса == Получение фискальных данных заказа =='''Пример запроса получения фискальных данных:'''<source lang="xml"><?xml version="1.0" encoding="UTF-8"?><receiptdata> <auth extra="8" login="login" pass="pass" /> <orders> <order orderno="123456" /> <order orderno="890111C" /> </orders></receiptdata>  </source> '''Пример ответа получения фискальных данных:'''<source lang="xml">  <?xml version="1.0" encoding="UTF-8"?><receipts count="1"> <receipt> <orderno>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> <payType>2</payType> <lines count="1"> <line> <item>1111764</item> <name>Сапоги</name> <extcode>27113415</extcode> <qty>1</qty> <price>1000</price> <vatRate>20</vatRate> <governmentCode>Z16513LK2</governmentCode> <itemType>1</itemType> </line> </lines> </receipt></receipts></source> Параметры ответа:* '''orderno''' — Номер заказа* '''fdDatetime''' — Дата и время пробития фискального чека* '''fdValue''' — ФПД (фискальный признак документа)* '''fdNum''' — ФИСКАЛЬНЫЙ ДОКУМЕНТ (фискальный номер чека)* '''fnSn''' — ФН (номер фискального накопителя)* '''kktNum''' — РН (регистрационный номер кассы)* '''inn''' — ИНН* '''ofdUrl''' — URL адрес (доменное имя) ОФД* '''price''' — Сумма чека* '''paytype''' — Тип оплаты чека. Принимает значения::* CASH — Наличными (по-умолчанию):* CARD — Безналичным способом* '''fullUrl''' — URL чека для просмотра онлайн* '''lines''' — Позиции чека:* '''item''' — код товара:* '''name''' — наименование товара:* '''extcode''' — код товара во внешних системах:* '''qty''' — количество товара:* '''price''' — цена товара:* '''governmentCode''' — считанная последовательность, которая в дальнейшем преобразуется по алгоритму тега 1162:* '''vatRate''' — НДС товара:* '''itemType''' — тип товара (товар, доставка и т. д.) == Справочник Виды срочности =='''Пример запроса видов срочности:'''<source lang="xml"><?xml version="1.0" encoding="UTF-8" ?><services><auth extra="8"/></services></source> '''Пример ответа справочника видов срочности:'''<source lang="xml"><?xml version="1.0" encoding="UTF-8" ?><services count="2"> <service> <code>1</code> <name>Эконом</name> </service> <service> <code>2</code> <name>Срочно</name> </service></services></source> == Справочник дополнительных услуг =='''Пример запроса дополнительных услуг:'''<source lang="xml"><?xml version="1.0" encoding="UTF-8"?><advprices> <auth extra="8" login="login" pass="pass" /></advprices></source> '''advprices''' — Корневой контейнер. Обязательный элемент.  '''Пример ответа справочника дополнительных услуг:'''<source lang="xml"><?xml version="1.0" encoding="UTF-8" ?><advprices> <advprice> <code>1</code> <name>Этажей в доме</name> <type>int</type> </advprice> <advprice> <code>2</code> <name>Коэффициент надбавки</name> <type>float</type> </advprice> <advprice> <code>3</code> <name>Расписаться на упаковке</name> <type>bool</type> </advprice></advprices></source> Параметры:* '''code''' — внутренний код услуги* '''name''' — наименование услуги. Если поле «название в ЛК» в настройках услуги не пусто, то возвращает значение поля «название в ЛК».* '''hine''' — подсказка по доп услуге для пользователя* '''type''' — тип услуги. Может иметь значения::* '''bool''' — для услуг вида «чекбокс», «Да»:* '''float''' — для числа с плавающей точкой:* '''int''' — для целого числа == Расчет стоимости доставки =='''Пример запроса стоимости доставки:'''<source lang="xml"><?xml version="1.0" encoding="UTF-8" ?><calculator> <auth extra="8" login="login" pass="pass" /> <order> <pricetype>CUSTOMER</pricetype> <sender> <town>Санкт-Петербург</town> <address>Петровка 38 офис 35</address> <coords lat="55.680327" lon="37.604456"></coords> </sender> <receiver> <zipcode>125480</zipcode> <town regioncode="78" country="RU">Санкт-Петербург</town> <address>Петровка 38 офис 35</address> <pvz>124</pvz> <coords lat="55.680327" lon="37.604456"></coords> </receiver> <weight>5.1</weight> <service>2</service> <paytype>CASH</paytype> <price>387.5</price> <deliveryprice>150</deliveryprice> <inshprice>387.5</inshprice> <packages> <package mass="1" quantity="5"></package> <package mass="2.5" length="10" width="20" height="30"></package> </packages> <userid>user123</userid> <groupid>customer</groupid> </order></calculator></source>  Параметры:Структура данных и заполнение полей аналогичны и совместимы с [[#Оформление заказа]]. Дополнительные поля:* '''pricetype''' — тип требуемой цены. Возможные значения: «CUSTOMER» (по-умолчанию) — [[Личный кабинет клиента#Цена доставки для получателя|цена для конечного получателя]], «CLIENT» — цена курьерской службы для клиента.* '''userid''' — Идентификатор пользователя, строковый или числовой тип. Виртуальное поле. Необязательное. Данное поле используется совместно с настройками «Цена доставки для получателя», определяя приоритет правила. Можно использовать в различных CMS/CRM системах, настраивая цены для определенного покупателя.* '''groupid''' — Идентификатор группы пользователя, строковый или числовой тип. Виртуальное поле. Необязательное. Данное поле используется совместно с настройками «Цена доставки для получателя», определяя приоритет правила. Можно использовать в различных CMS/CRM системах, настраивая цены для определенной группы покупателей. Суммы НП и ОЦ, а также тип оплаты CARD имеют значение при настроенных в тарифе на вкладке Прочее долях (в процентах) от данных сумм. В авторизации можно опустить параметры login и pass, тогда расчет будет производиться по стандартному тарифу курьерской службы, без учета возможных отличий для конкретного клиента.<br>Объемный вес будет учитываться только при условии указания всех габаритов: длины, ширины и высоты.<br>В полях город-отправитель и город-получатель можно указывать название города (не рекомендуется!), либо код города из нашего справочника, либо 13-ти значный код КЛАДР, либо 36-ти значный код адресной системы ФИАС (AOID).  '''Пример ответа стоимости доставки:'''<source lang="xml"><?xml version="1.0" encoding="UTF-8"?><calculator> <calc> <townfrom code="1">Москва город</townfrom> <townto code="56603">Иркутск город</townto> <mass>3.7</mass> <service name="Экспресс">1</service> <zone>2</zone> <price>1113</price> <mindeliverydays>1</mindeliverydays> <maxdeliverydays>3</maxdeliverydays> <orderdatemindeliverydate>2020-05-13</mindeliverydate> <intervals> <workdays> <interval>10:00-16:00</interval> <interval>16:00-22:00</interval> </workdays> <holidays>2018 <interval>12:00-0116: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. === Коды и описание ошибок ==={|class=wikitable!Код ошибки!Английское описание!Русское описание!Примечание|-|15||tarif not found||Тариф не найден||Ошибка получения тарифов: для клиента не указан тариф|-|19||field [town to] cannot be empty||Поле [город получателя] не может быть пустым||Необходимо указать город получателя или ПВЗ|-|20||field [weight] is incorrect||Некорректное значение [масса]||Значение массы некорректное, например, не является числом. Его необходимо исправить|-|21||town from not found||Город отправителя не найден||Системе не удалось найти указанный населенный пункт отправителя|-|22||town to not found||Город получателя не найден||Системе не удалось найти указанный населенный пункт отправителя|-|23||field [weight] cannot be empty||Поле [масса] не может быть пустым||Необходимо указать значение массы отправления, поле [weight]|-|36||subtown not found||Город в регионе не найден||Не настроено направление доставки до города в регионе: не добавлен регион или указанный город отсутствует в списке региона|-|37||zoneprice not found||Тариф зоны не найден||Отсутствуют зоны тарификации или для них не указаны стоимости|-|38||tarif not found - 1||Тариф не найден 1||Результаты расчета отсутствуют: общая ошибка в случае, если других ошибок нет, но результат пустой |-|39||tarif not found - 2||Тариф не найден 2||Ошибка получения тарифов: для клиента не настроен тариф или тарификация от количества заказов|-|82||field [weight] exceeded limit PVZ||Значение [weight] превышает ограничение ПВЗ||Указанное значение массы больше, чем максимально допустимое для указанного ПВЗ|-|83||attribute [paytype] not allowed PVZ||Значение [paytype] не допустимо для ПВЗ||В ПВЗ не допустим указанный тип оплаты|-|} == Получение информации о клиенте =='''Пример запроса получения информации о клиенте:'''<source lang="xml"><?xml version="1.0" encoding="UTF-8" ?><client> <auth extra="8" login="login" pass="pass" /> </client></source> '''client''' — Корневой контейнер. Обязательный элемент.* '''auth''' — Авторизация. Обязательный элемент. '''Пример ответа на запрос получения информации о клиенте:'''<source lang="xml"><?xml version="1.0" encoding="UTF-8" ?><client> <code>1082</code></client></source> * '''code''' — Код клиента == Список актов передачи денег =='''Пример запроса списка актов передачи денег:'''<source lang="xml"><?xml version="1.0" encoding="UTF-8" ?><smalist> <auth extra="8" login="login" pass="pass" /> <datefrom>2016-02-10</datefrom> <dateto>20182016-03-10</dateto></smalist></source> '''smalist''' — Корневой контейнер. Обязательный элемент.* '''auth''' — Авторизация. Обязательный элемент.* '''datefrom''' — Дата «с». Необязательный элемент.* '''dateto''' — Дата «по». Необязательный элемент.Если интервал дат не указан, то возвращаются акты передачи денег за последний месяц. '''Пример ответа на запрос списка актов передачи денег:'''<source lang="xml"><?xml version="1.0" encoding="UTF-8"?><smalist count="1"> <sma> <code>6278</code> <number>3992</number> <actdate>2016-02-12</actdate> <datepay></datepay> <dateto>2016-0102-12</delivereddatedateto> <companypromiseddatepay>Компания</companypromiseddatepay> <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</signedcopyreceived> </sma></smalist></source> * '''code''' — Код акта* '''number''' — Номер акта в системе* '''actdate''' — Дата акта* '''datepay''' — Дата оплаты по акту* '''dateto''' — Дата конечного периода для формирования АПД* '''promiseddatepay''' — Плановая дата оплаты* '''price''' — Стоимость услуг* '''pricecorr''' — Сумма корректировки* '''rur''' — Сумма заказа* '''pricekur''' — Стоимость курьерской доставки* '''priceag''' — Агентское вознаграждение* '''payno''' — Номер платежного поручения* '''paytype''' — Тип оплаты: 1 — безнал, 2 — наличными курьером, 3 — наличными в офисе, 4 — перевод на карту* '''paytypename''' — Строковое представление типа оплаты* '''signedcopyreceived''' — Признак факта возврата акта YES/NO == Детализация актов передачи денег =='''Пример запроса детализации актов передачи денег:'''<source lang="xml">Доставлено<?xml version="1.0" encoding="UTF-8" ?><smadetail> <auth extra="8" login="login" pass="pass" /status> <code>6278</specialsmacode>

</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"?><setapprovalstatus> <auth extra="8" login="login" pass="pass" /> <order ordercode="1234561"> <confirmstate>1</confirmstate> <message>Сообщение статуса</message> </order> <order ordercode="1234562"> <confirmstate>2</confirmstate> <message>Согласовано</message> </order> <order ordercode="1234563"> <confirmstate>3</confirmstate> <message>Не согласовано</message> </order></setapprovalstatus></source> * '''order''' — Контейнер заказа. Обязателен как минимум один элемент.:* '''ordercode''' — Внутренний код заказа.* '''confirmstate''' — Код статуса заказа. Все статусы с кодами можно получить запросом [[#Получение списка статусов согласования заказа|Получение списка статусов согласования заказа]]* '''message''' — Дополнительный комментарий, который отобразится в поле ''Инфо о доставке''. == Получение списка статусов согласования заказа =='''Пример запроса списка статусов согласования заказа'''<source lang="xml"><?xml version="1.0" encoding="UTF-8"?><approvalstatuses> <auth extra="8" login="login" pass="pass" /></approvalstatuses></source> '''Пример ответа списка статусов согласования заказа'''<source lang="xml"><?xml version="1.0" encoding="UTF-8" ?><approvalstatuses count="6"> <status> <code>1</code> <name>Неизвестно</name> </status> <status> <code>2</code> <name>Согласование запрошено</name> </status> <status> <code>3</code> <name>Доставка полностью согласована</name> </status> <status> <code>4</code> <name>Согласовано с изменением времени</name> </status> <status> <code>5</code> <name>Перенос на другую дату</name> </status> <status> <code>6</code> <name>Отказ</name> </status></approvalstatuses></source> == Генерация коротких ссылок == В некоторых случаях, например, при использовании в СМС, может потребоваться использование коротких ссылок на ЛК.Для этого, необходимо отправить запрос с полной ссылкой, в ответ на который придёт хэш-код для ссылки. '''Пример запроса генерации коротких ссылок:'''<source lang="xml"><?xml version="1.0" encoding="UTF-8" ?><shortlink> <link short="0"> https://home.courierexe.ru/8/site/orders </link></shortlink></source> '''shortlink''' -  — Корневой контейнер. Обязательный элемент.*'''link''' -  — Полная ссылка, для которой необходимо получить код. Обязательный элемент. Если атрибут '''short''' равен 1, то ответ не будет содержать XML, а только хэш-код. '''Пример ответа на запрос генерации коротких ссылок:'''<source lang="xml"><?xml version="1.0" encoding="UTF-8"?><shortlink> <hash>35AF350C</hash></shortlink></source> * '''hash''' — Хэш-код ссылки. Далее, можно использовать ссылку на ЛК: <nowiki>https://home.courierexe.ru/35AF350C или curie.ru/35AF350C</nowiki>  '''Примечание!''' Сервис коротких ссылок работает только для ресурсов компании MeaSoft. == Проверка надежности покупателя ==Проверка надежности работает только для тарифа «Максимум» личного кабинета. <source lang="xml"><?xml version="1.0" encoding="UTF-8" ?><mcheck> <auth extra="8" login="login" pass="pass" /> <phones> <phone>89161147992</phone> </phones></mcheck></source> Ответ: <source lang="xml"><?xml version="1.0" encoding="UTF-8" ?><mcheck> <phones> <phone rate="90">89161147992</phone> </phones></mcheck></source>  == Размещение страниц на своем сайте (iframe) == В некоторых случаях имеет смысл разметить те или иные страницы на своем сайте. Например, чтобы клиенты могли рассчитать стоимость доставки не переходя по внешней ссылке, а там же, на сайте, калькулятор можно разместить прямо на странице такого сайта посредством так называемого фрейма — '''iframe'''. [https://ya.ru/search/?text=iframe Фрейм] — контейнер внутри обычной страницы, который позволяет загружать сторонние страницы. Пример загрузки калькулятора: <source lang="html"><iframe id="frame" src="https://home.courierexe.ru/8/calculator"> Здесь должен отобразиться калькулятор</iframe></source> Для удобства пользователей вашего сайта можно указать язык интерфейса (который переключается непосредственно на сайте) параметром '''lang''': <source lang="html"><iframe id="frame" src="https://home.courierexe.ru/8/calculator?lang=2"> Здесь должен отобразиться калькулятор</iframe></source>  <div style="color: #a94442; background-color: #f2dede; border: 1px solid #ebccd1; padding: 3px 10px 10px;">'''Обратите внимание!'''# При использовании iFrame могут не работать некоторые функции, например, подписка на push-уведомления на странице трекинга или отслеживания.# Если язык не указать, то на страницах калькулятора и трекинга отображается свой переключатель языка. Если язык указан, то переключатель не отображается. Поддерживаемые языки и их коды::'''1''' — русский:'''2''' — английский:'''4''' — узбекский</div> == Оформление манифеста == '''Пример запроса на создание манифеста:'''<source lang="xml"><?xml version="1.0" encoding="UTF-8" ?><manifest> <auth extra="8" login="login" pass="pass" /> <store_from>1</store_from> <store_to>2</store_to> <trn_code>3</trn_code> <sentdate>2024-11-07</sentdate> <places> <place> <number>1</number> <seal>7890AABBB</seal> </place> <place> <number>2</number> <seal>123456ABC</seal> </place> </places> <addresses> <address> <code>12345</code> <place>1</place> </address> <address> <code>67890</code> <place>2</place> </address> </addresses></manifest></source>  '''manifest''' - Корневой контейнер. Обязательный элемент.*'''auth''' - Авторизация. Обязательный элемент.*'''store_from''' - код филиала отправителя. Обязательный элемент.*'''store_to''' - код филиала получателя. Обязательный элемент.*'''trn_code''' - код перевозчика. Обязательный элемент.*'''sentdate''' - дата отправки манифеста. Не обязательный элемент.*'''addresses''' - корневой элемент для списка заказов.*:'''address''' - корневой элемент для заказа.*::'''code''' - наш внутренний номер заказа. Обязательный элемент.*::'''place''' - номер места заказа. Обязательный элемент, если переданы места.*'''places''' - корневой элемент для списка мест.*::'''place''' - корневой элемент для места.*::'''number''' - номер места. Обязательный элемент.*::'''seal''' - номер пломбы. Необязательный элемент.  '''Пример успешного ответа'''<source lang="xml"><?xml version="1.0" encoding="UTF-8"?><manifest> <result>OK</result></manifest></source>  '''Пример ответа с ошибкой'''

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

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