Изменения

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

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

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

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

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

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

|[[Файл:insalesiiko.pngjpg|center|x80px]]

|[[Интеграция с другими системами#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.

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

|Подробнее см. [[Интеграция с другими системами#amoCRM|описание]].

|[[Интеграция с другими системами#Мой СкладМойСклад|Инструкция]]

|style="text-align: center;"|[httphttps://courierexe.ru/download/apiwordpress/wordpress.zip php Скачать]|[[Интеграция с другими системами#Wordpress|Инструкция]]

|Поддерживает версии 4.10 и выше.<br>[[Интеграция с другими системами#CS-Cart|Инструкция]]|-|[[Файл:webhooks.jpg|center|x100px]]|style="text-align: center;"|Читайте описание [[Webhook|на этой странице]]|Передача информации о статусах и заказах в вашу систему

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

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

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

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

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

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

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

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

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

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

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

Вы можете отправлять тестовые запросы к нашему сервису и видеть историю отправленных запросов в личном кабинете на закладке '''Интеграция'''. Клиент отправляет запросы к сервису методом HTTP POST, сервис обрабатывает запросы и возвращает результат выполнения. Все запросы и ответы передаются в формате XML.Кодировка — UTF-8. Разделитель целой и дробной частей чисел — используется символ точки. Даты представляются в виде YYYY-MM-DD, время — HH:MM. В силу [https://ru.wikipedia.org/wiki/XML#.D0.A0.D0.B5.D1.88.D0.B5.D0.BD.D0.B8.D0.B5_.D0.BF.D1.80.D0.BE.D0.B1.D0.BB.D0.B5.D0.BC.D1.8B_.D0.BD.D0.B5.D0.BE.D0.B4.D0.BD.D0.BE.D0.B7.D0.BD.D0.B0.D1.87.D0.BD.D0.BE.D1.81.D1.82.D0.B8_.D1.80.D0.B0.D0.B7.D0.BC.D0.B5.D1.82.D0.BA.D0.B8 особенностей языка XML], некоторые символы в тексте должны быть заменены: & на &amp;amp; < на &amp;lt; > на &amp;gt; " на &amp;quot; Наше API принципиально работает только по HTTPS, т.к. так как передает конфиденциальные данные. В некоторых системах с этим возникают проблемы. Если ваша система не может полноценно работать с шифрованием, мы рекомендуем развернуть http-сервер у себя локально, установить [http://courierexe.ru/download/api/proxy.zip прокси на PHP]. <spoiler text="Как запустить">Для теста можете запустить его на сервере следующей командой: php -S <IP>:8080 proxy.phpгде <IP> -  — это адрес вашего сервера, а 8080 порт, на котором будут приниматься запросы.

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

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

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

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

<item extcode="abc123" quantity="1" mass="0.2" retprice="37.5" VATrate="0" barcode="2345625213125" textArticle="1" article="1" volume="3" origincountry="AUT" GTD="321546654" excise="15.20" suppcompany="ООО &quot;Рога и копыта&quot;" suppphone="79161234567" suppINN="1112223334" govType="2" governmentCode="11223311" extraTags="">Мяч</item>

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

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

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

*'''orderbarcode''' - Контейнер для описания одного  — Штрихкод заказа. Если клиент штрихкодирует свои отправления и штрихкод отличается от номера заказа, обязательный элементв этом поле указывается штрихкод. В одном контейнере '''neworder''' может быть много контейнеров '''order''' для создания нескольких заказов одним запросомЕсли ШК содержит кириллицу или малое количество символов, то формируется ШК в формате EAN13.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

* '''advprices''' :: Тэг 1264 - Контейнер для описания дополнительных услуг. Необязательный элемент. Для обработки в API требует включения в настройках полей оформления [[Личный_кабинет_курьерской_службы#Настройка вкладки "Оформить заказ"|заказов]] / [[Личный_кабинет_курьерской_службы#Настройка вкладки номер нормативного акта федерального органа исполнительной власти = "Заявка на забор1556"|заборов]]:* '''''code''''' - код услуги:* '''''value''''' - значение услуги. Если тип услуги bool, то в значении передаем true(константа)

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

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

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

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

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

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

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

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

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

<source lang="xml"><?xml version="1.0" encoding="utf-8"?><request><error error="1" errormsg="authorization error"></error></request></source> '''Пример ответа при ошибке синтаксиса''' <source lang="xml"><?xml version="1.0" encoding="UTF-8"?><request> <error>column:1 line:11 message:expected '>'</error></request></source> === Описание полей ответа статусов ===Все поля ответа соответствуют структуре order при создании заказа, с некоторыми добавлениями: * Атрибуты контейнера '''orderchanges'''::* '''''awb''''' - Номер накладной в системе курьерской службы — может принимать значение только ONLY_LAST.:* '''''orderno2''''' - Номер накладной в подсистеме срочной доставки курьерской службы.:* '''''ordercode''''' - внутренний код заказа в системеЕсли указан этот параметр, применяется для некоторых внутренних операцийвсе остальные игнорируются.:* '''''givencode''''' - внутренний код заказа в системе, применяется для некоторых внутренних операций. * атрибут '''''code''''' контейнера '''item''' - внутренний код строки заказа в системе, применяется для некоторых внутренних операций.:* '''''returns''''' - количество Описание данного товара, от которого отказался получатель. Не нулевое только в случае частичного отказа. * атрибут '''''got''''' контейнера '''package''' - признак принятого места YES / NO.режима приведено здесь:* '''''returns''''' - количество данного товара, от которого отказался получатель. Не нулевое [[#Передача только в случае частичного отказа. * '''''coords''''' в контейнере '''receiver''' - координаты получателя.* '''pickup''' - признак оформления забора, возможные значения: '''YES''', '''NO'''. Если указано '''YES''', то весь заказ считается заданием на забор груза, а не на доставку.* '''currcoords''' - текущие координаты заказа. Атрибуты::* '''''lat''''' - широта:* '''''lon''''' - долгота:* '''''accuracy''''' - точность в метрах:* '''''RequestDateTime''''' - дата/время последнего обновления координат. * '''courier''' - Данные курьера, которому выдан заказ. Если заказ не выдан, то выводятся данные запланированного курьера.* '''waittime ''' - Время ожидания курьера.* '''deliveryprice''' - Стоимость услуг в валюте расчетов с клиентом. Атрибуты::* '''''total''''' - общая стоимость услуг:* '''''delivery''''' - стоимость доставки "Туда":* '''''return''''' - стоимость доставки "Обратно" (если order->return=YES)Тэг '''deliveryprice''' включает список дополнительных услуг (изменившихся статусов|Передача только для тарифа "Премиум")::* '''''advprice''''' - наименование дополнительной услуги:* '''''code''''' - код дополнительной услуги:* '''''price''''' - стоимость дополнительной услугиизменившихся статусов]]

* '''statusconditions''' - статус доставки (список статусов см. ниже) — Задает условия фильтрации по «orderno». Атрибуты (заполняются начиная с версии системы 2008Все вложенные элементы одновременно накладывают условие «И».0.0.670):Минимум 5 символов!:* '''namecontains''eventstore''''' - филиал — Поиск по номеру заказа(шифр), к которому относится текущий статус:* '''''eventtime''''' - время события по часовому поясу места его наступлениякоторый содержит «orderno».:* '''''createtimegmt'namestarts'''' - время по GMT создания записи о смене статуса в БД. Используется для сортировки записей, чтобы соблюсти хронологическую последовательность. <spoiler text="Подробнее">Большинство событий фиксируются в полях eventtime и createtimegmt на основании одного действия, тогда они отличаются только сдвигом от GMT. Однако, если курьер доставил отправление 10.10.2010 в 20:00,  — Поиск по какой-то причине не внес это в мобильное приложение, на следующий день сдал накладную, и в 9 утра оператор внесла, что он доставил вчера в 20:00. Тогда в createtimegmt будет сегодня 6 утра номеру заказа(для Москвышифр), а в eventtime - вчера в 20:00. При этом оператор по каким-то причинам может внести время вручения раньше, чем какое-то предыдущее событие, т.окоторый начинается с «orderno». нарушится последовательность времени в eventtime, но при сортировке по createtimegmt все-равно все будет правильно.</spoiler>:* '''''message''''' - наименование филиала-получателя, при передаче между филиалами:* '''''title''''' - русское наименование статуса

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

<br />

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

<?xml version="1.0" encoding="UTF-8" ?><statusreqcount="23"> <auth extraorder orderno="8111111" awb="qwerty" orderno2="123123" loginordercode="login34534234" passgivencode="pass2345334"> <barcode>111111</authbarcode> <sender> <changescompany>ONLY_LASTМВД</changescompany> <person>Иванов И.И.</statusreqperson> </sourcephone> Система выдает все заказы, в которых, с момента последнего запроса в этом режиме, изменилось хотя бы одно из полей: orderno status delivereddate deliveredtime deliveredto receiver123-45-67</phone>date receiver- <contacts>address price После успешной обработки ответа необходимо отметить полученные статусы успешно полученными, отправив запрос <source lang="xml"phone>+74951234567<?xml version="1.0" encoding="UTF-8" ?/phone> <commitlaststatus/contacts> <auth extra="8" logintown code="login" pass="pass23432">Санкт-Петербург</authtown> <clientaddress>CLIENTПетровка 38 офис 35</clientaddress> </commitlaststatusdate>2014-03-22</sourcedate> '''Описание полей запроса''' *'''auth''' - Авторизация. Обязательный элемент.*'''client''' - Признак клиента или агента. Необязательный элемент.:* CLIENT - Признак клиента, значение по умолчанию:* AGENT - Признак агента. В ответ отдается информация по заказам, переданным агенту на доставку В случае успеха Вы получите ответ <source lang="xml"time_min>09:00<?xml version="1.0" encoding="UTF-8" ?/time_min> <commitlaststatus error="0"time_max>OK14:00</commitlaststatustime_max> </sourcesender> Данный способ передачи статусов гарантирует полную корректную передачу статусов, даже в случае, если в нашей системе статус изменился в промежутке времени между запросом статусов и подтверждением их получения. Если система не получила подтверждение успешной передачи статуса, она будет считать информацию не переданной, и выдаст ее при повторном запросе.   <div style="color: #a94442; background-color: #f2dede; border: 1px solid #ebccd1; padding: 3px 10px 10px;"receiver>'''Обратите внимание!''' # При данном способе передачи ( <changescompany>ONLY_LASTМВД</changescompany>) система просматривает заказы, оформленные за последние 3 месяца. Если заказ сделан ранее - изменение статуса по нему не попадет в результат выполнения данного запроса.# Система всегда выдает текущий статус <person>Иванов И. ТИ.е. Вы можете одним запросом получить статус "NEW", а следующим - "COMPLETE". В промежутке между запросами отправление могло пройти через несколько промежуточных статусов. Если нужна гарантия получения всех промежуточных статусов, нужно анализировать блок statushistory (может не заполняться в следствии ограничений версии или тарифа конкретной службы доставки).# Система никогда не гарантирует последовательность прохождения заказом набора статусов. Т.е. Вы можете получить статус "COMPLETE", а следующим запросом - "NEW" - такое может произойти, например, если оператор ошибочно отметил заказ выполненным, а затем исправил ошибку.</divperson> <br /phone>  == Трекинг заказа по номеру == Запрос трекинга по номеру предназначен для выдачи минимальной обезличенной информации о конкретном заказе не авторизованному пользователю123-45-67 - Иван (916)234. Наша система имеет для этого интерфейс по адресу "home45.courierexe21 Петр,mvd@mail.ru</{код экстра}/tracking". Вы можете либо сделать ссылку на такую страницу на своем сайте, либо разместить ее iframe'ом у себя, либо сделать свою и пользоваться нашим API. Этот интерфейс создан специально для выдачи информации живому пользователю сайта. Для получения статусов заказов в свою информационную систему нужно использовать запрос "statusreq", желательно с параметром changes=ONLY_LAST! '''Пример запроса:'''<source lang="xml"><?xml version="1.0" encoding="UTF-8"?phone> <trackingcontacts> <extraphone>8+74951234567</extraphone> <ordernophone>1234+79162344521</ordernophone> </trackingemail>mvd@mail.ru</sourceemail> '''Пример ответа:''' <source lang="xml"/contacts> <?xml version="1.0" encoding="UTF-8"?><tracking> <order orderno="111111"> <barcodeinn>1111111112223335</barcodeinn> <AWBzipcode>111111125480</AWB> <senderzipcode> <town code="1153361" regioncode="78" countryregionname="RUСанкт-Петербург город">Москва Санкт-Петербург город</town> <dateaddress>2014-03-22Петровка 38 офис 35</dateaddress> <time_minarea>09:00Район 1</time_minarea> <time_maxpvz>14:00 </time_maxcode> 126</sendercode> <receiverclientcode> <town code="1" country="RU">Москва городQWERTY</townclientcode> <zipcode>125480</zipcodepvz> <date>2014-03-22</date> <time_min>09:00</time_min> <time_max>14:00</time_max> <coords lat="55.680327" lon="37.604456"></coords> <deliveryPIN>1234</deliveryPIN> </receiver> <price>387.5</price> <inshprice>387.5</inshprice> <paytypecode="1">CASH</paytype> <weight>5.1</weight> <quantity>2</quantity> <service>2</service> <type>3</type> <return>NO</return> <return_service>2</service> <return_datereturn_type>3</return_datereturn_type> <return_timereturn_weight>5.1</return_timereturn_weight> <return_message>Доставлено в целости</return_message> <pickup>NO</pickup> <print_check>YES</print_check> <waittime>12</waittime> <enclosure>Детские игрушки</enclosure> <instruction>Проверить при покупателе, подписать акт</instruction> <deliveryprice totalcurrcoords lat="15855.6680327" deliverylon="10037.00604456" accuracy="50" returnRequestDateTime="58.62014-04-21 18:07:45" ></currcoords> <courier> <code>26</code> <name>Иванов Владимир Петрович</name> <phone>+79161234567</phone> </courier> <currcoords latdeliveryprice total="158.6" delivery="100.00" return="5558.6803276"> <advprice code="1" price="150">База</advprice> <advprice code="2" price="0">% от объявленной стоимости</advprice> <advprice code="3" lonprice="378.6044566" accuracy>Топливный сбор</advprice> <advprice code="504" RequestDateTimeprice="2014-04-21 18:07:450" >Округление</advprice> </deliveryprice> <receiverpays>NO</receiverpays> <acceptpartially>NO</acceptpartially> <status eventstore="филиал в Санкт-Петербурге" eventtime="2016-06-02 17:22:00" createtimegmt="2016-06-03 16:14:44" message="" title="Доставлен" eventtown="Санкт-Петербург город" color="16777215">COMPLETE</status>

<status eventstore="Офис в Москве" eventtime="2016-05-30 10:20:00" createtimegmt="2016-06-03 16:14:44" message="" title="Новый" eventtown="Москва город" country="RU">NEW</status> <status eventstore="Офис в Москве" eventtime="2016-06-01 17:38:00" createtimegmt="2016-06-03 16:14:44" message="филиал в Санкт-Петербурге" title="Планируется отправка" eventtown="Москва город" country="RU">DEPARTURING</status> <status eventstore="Офис в Москве" eventtime="2016-06-01 19:53:00" createtimegmt="2016-06-03 16:14:44" message="филиал в Санкт-Петербурге" title="Отправлено со склада" eventtown="Москва город" country="RU">DEPARTURE</status> <status eventstore="филиал в Санкт-Петербурге" eventtime="2016-06-02 07:41:00" createtimegmt="2016-06-03 16:14:44" message="" title="Получен складом" eventtown="Санкт-Петербург город" country="RU">ACCEPTED</status> <status eventstore="филиал в Санкт-Петербурге" eventtime="2016-06-02 09:17:00" createtimegmt="2016-06-03 16:14:44" message="" title="Выдан курьеру на доставку" eventtown="Санкт-Петербург город" country="RU">DELIVERY</status> <status eventstore="филиал в Санкт-Петербурге" eventtime="2016-06-02 17:22:00" createtimegmt="2016-06-03 16:14:44" message="" title="Доставлен (предварительно)" eventtown="Санкт-Петербург город" country="RU">COURIERDELIVERED</status> <status eventstore="филиал в Санкт-Петербурге" eventtime="2016-06-02 17:22:00" createtimegmt="2016-06-03 16:14:44" message="" title="Доставлен" eventtown="Санкт-Петербург город" country="RU">COMPLETE</status> </statushistory> <customstatecode>2<customstatecode> <clientstatecode></clientstatecode>

<item code="34421" extcode="abc125" quantity="3" mass="0.3" retprice="50" VATrate="18" barcode="2345625213126" itemcode="44123" article="3" returns="0" governmentCode="">Погремушка желтая</item>

</trackingstatusreq>

<?xml version="1.0" encoding="UTFutf-8"?><tracking17statusreq count="0"></statusreq> </source> '''Пример ответа при ошибке авторизации''' <extrasource lang="xml"><?xml version="1.0" encoding="utf-8"?></extrarequest> <ordernoerror error="1" errormsg="authorization error">1234</ordernoerror></tracking17request>

'''Пример ответа:при ошибке синтаксиса''' <pre>{ source lang="numberxml":"ExtNumber",> <?xml version="oriNumber1.0":encoding="1234UTF-8",?> "oriCountry":"RU",<request> "destCountry" <error>column:"RU", "status"1 line:"Complete", "events"11 message:[expected '>'</error> {</request> "time":"2016-06-02 17:22:00",</source> "location":"RU", "content":"Complete"=== Описание полей ответа статусов === }Все поля ответа соответствуют структуре order при создании заказа,с некоторыми добавлениями: { "time"* Атрибуты контейнера '''order''':"2016-06-02 17:22* '''''awb''''' — Номер накладной в системе курьерской службы.:00",* '''''orderno2''''' — Номер накладной в подсистеме срочной доставки курьерской службы. "location":"RU"* '''''ordercode''''' — внутренний код заказа в системе,применяется для некоторых внутренних операций. "content":"Courierdelivered" }* '''''givencode''''' — внутренний код заказа в системе,применяется для некоторых внутренних операций. { "time":"2016-06*'''paytype''' -02 09Тип оплаты заказа получателем. Принимает значения:17:00", "location":"RU", "content":"Delivery" }, { "time":"2016CASH -06Наличными при получении (по-02 07умолчанию):41:00",CARD - Картой при получении "location":"RU",: NO - Без оплаты. "content":"Accepted" }, { "time":"2016OTHER -06Прочее (Предусмотрен для того, чтобы оплата поступала непосредственно в курьерскую службу посредством прочих типов оплаты -01 19таких как:53:00"вебмани, яденьги, "location":"RU"картой на сайте,прочие платежные системы и т.д.) "content"* Атрибуты контейнера '''paytype''':"Departure" }, { "time":"2016-06** '''''code''''' -01 17:38:00(integer) внутренний код типа оплаты заказа в системном справочнике ", Типы оплаты корреспонденции"location":"RU",. Не обязательный элемент. "content":"Departuring" }, { "time":"2016-05-30 10:20:00"* атрибут '''''code''''' контейнера '''item''' — внутренний код строки заказа в системе,применяется для некоторых внутренних операций. "location":"RU"* '''''returns''''' — количество данного товара, "content":"New" } ]}</pre>от которого отказался получатель. Не нулевое только в случае частичного отказа.

Функция ищет последний заказ по номеру среди заказов всех клиентов* атрибут '''''got''''' контейнера '''package''' — признак принятого места YES / NO. Выдает неперсонализированную информацию о текущем состоянии заказа.<br />Описание контейнеров ответа аналогично описанию [[API#.D0.97.D0.B0.D0.BF.D1.80.D0.BE.D1.81_.D1.81.D1.82.D0.B0.D1.82.D1.83.D1.81.D0.B0_.D0.B7.D0.B0.D0.BA.D0.B0.D0.B7.D0.BE.D0:* '''''returns''''' — количество данного товара, от которого отказался получатель.B2|Запроса статусов заказов]]Не нулевое только в случае частичного отказа.

== Изменение * '''''area''''' в контейнере '''receiver''' — район/метро получателя.* '''''coords''''' в контейнере '''receiver''' — координаты получателя.* '''''deliveryPIN''''' в контейнере '''receiver''' — Пин-код.* '''pickup''' — признак оформления забора, возможные значения: '''YES''', '''NO'''. Если указано '''YES''', то весь заказ считается заданием на забор груза, а не на доставку.* '''currcoords''' — текущие координаты заказа ==. Атрибуты::* '''''lat''''' — широта:* '''''lon''''' — долгота:* '''''accuracy''''' — точность в метрах:* '''''RequestDateTime''''' — дата/время последнего обновления координат.

Запрос предназначен для изменения заказов* '''courier''' — Данные курьера, находящихся в статусах "Ожидает синхронизации" или "Новый", а также по которым которому выдан заказ. Если заказ не было произведено изменений - статуса корреспонденциивыдан, времени доставки - то есть заказов, которые ещё не находятся выводятся данные запланированного курьера.* '''waittime ''' — Время ожидания курьера.* '''deliveryprice''' — Стоимость услуг в работевалюте расчетов с клиентом.Атрибуты::* '''''total''''' — общая стоимость услуг:* '''''delivery''''' — стоимость доставки «Туда»:* '''''return''''' — стоимость доставки «Обратно» (если order->return=YES)Тэг '''deliveryprice''' включает список дополнительных услуг (только для тарифа «Премиум»)::* '''''advprice''''' — наименование дополнительной услуги:* '''''code''''' — код дополнительной услуги:* '''''price''''' — стоимость дополнительной услуги

<div style="color* '''status''' — статус доставки (список статусов см. ниже). Атрибуты (заполняются начиная с версии системы 2008.0.0.670): #a94442; background-color: #f2dede; border: 1px solid #ebccd1; padding: 3px 10px 10px;">* '''''eventstore''Обратите внимание!''' — филиал, к которому относится текущий статус# Данные запроса изменения указываются :* '''полностью''eventtime', как если бы заказ создавался впервые'''' — время события по часовому поясу места его наступления.# При отсутствии вложения в запросе изменения данное вложение :* '''''createtimegmt''не удаляется''' из заказа — время по GMT создания записи о смене статуса в БД. Используется для сортировки записей, но его количество становится равным 0чтобы соблюсти хронологическую последовательность.# При одновременном изменении заказа <spoiler text="Подробнее">Большинство событий фиксируются в API полях eventtime и системе курьерской службы приоритет отдается данным системы курьерской службыcreatetimegmt на основании одного действия, тогда они отличаются только сдвигом от GMT. Однако, если курьер доставил отправление 10.10. То есть изменения 2010 в API приняты 20:00, по какой-то причине не будут!внес это в мобильное приложение, на следующий день сдал накладную, и в 9 утра оператор внесла, что он доставил вчера в 20:00. Тогда в createtimegmt будет сегодня 6 утра (для Москвы), а в eventtime — вчера в 20:00. При этом оператор по каким-то причинам может внести время вручения раньше, чем какое-то предыдущее событие, т.о. нарушится последовательность времени в eventtime, но при сортировке по createtimegmt все-равно все будет правильно.</divspoiler><br />:* '''''message''''' — наименование филиала-получателя, при передаче между филиалами:* '''''title''''' — русское наименование статуса

=== Описание полей запроса изменения ===* '''statushistory''' — история статусов доставки. Содержит список контейнеров '''status'''. Заполняется только для тарифа «Премиум» начиная с версии системы 2008.0.0.670.* '''customstatecode''' — код внутреннего статуса курьерской службы. Значения уточняйте в курьерской службе. Назначаются курьерской службой в разделе «Справочники» — «Статусы» — «15 Статусы корреспонденции». Справочник не передается через API клиенту по причине возможного наличия в нем внутренних технологических статусов курьерской службы.* '''clientstatecode''' — код статуса клиента. Используется, если клиент предлагает свои коды статусов доставки/причин недоставки.Все * '''deliveredto''' — данные из поля запроса соответствуют структуре order при создании заказа за исключением:«Инфо. о доставке» (может быть информация о доставке, причина недоставки и т. п.).* вместо корневого тэга '''neworderdelivereddate''' указывается  — дата вручения.* '''editorderdeliveredtime''' — время вручения. В случае недоставки может быть пустым.* тэг штрих-кода '''barcodearrival''' не указывается — плановая дата прибытия в формате гггг-мм-дд чч: мм: сс. Заполняется только при использовании автоматических систем планирования (Максоптра, Яндекс доставка), поскольку присваивается при создании заказаво всех остальных случаях - пустое.* для вложений '''itemoutstrbarcode''' указывается внутренний  — код у подрядчика (код вложения заказа во внешней системе). Используется в атрибуте интеграциях с внешними системами.* '''partner''' — текущий филиал/подрядчик.* '''return_message''' — информация о возврате* '''codedepartment''' — Подразделение, который можно получить при получении статуса заказав котором оформляется заказ.

=== Описание полей ответа изменения ===Контейнер '''status''' может принимать следующие значения:Все поля ответа соответствуют ответу при создании : AWAITING_SYNC — Ожидает синхронизации. Данные заказа за исключением корневого тэга - вместо пока не появились в службе доставки.: '''NEW''' — Успешно создан, передан в службу доставки.: NEWPICKUP — Создан забор.: PICKUP — Забран у отправителя.: WMSASSEMBLED — Скомплектован на складе фулфилмента.: WMSDISASSEMBLED — Разукомплектован на склад фулфилмента.: '''neworderACCEPTED''' возвращается  — Получен складом.: CUSTOMSPROCESS — Производится таможенный контроль.: CUSTOMSFINISHED — Таможенный контроль произведен.: CONFIRM — Согласована доставка.: UNCONFIRM — Не удалось согласовать доставку.: DEPARTURING — Планируется отправка со склада на другой склад.: DEPARTURE — Отправлено со склада на другой склад.: INVENTORY — Инвентаризация. Убедились в наличии отправления на складе.: PICKUPREADY — Готов к выдаче в ПВЗ.: '''editorderDELIVERY''' — Выдан курьеру на доставку.: COURIERDELIVERED — Доставлен (предварительно, ожидает подтверждения менеджером, чтобы перейти в статус COMPLETE).: COURIERPARTIALLY — Частично доставлен (предварительно, ожидает подтверждения менеджером, чтобы перейти в статус PARTIALLY).: COURIERCANCELED — Отказ (предварительно, после этого ожидается COURIERRETURN).: COURIERRETURN — Возвращено курьером. Курьер не смог доставить до получателя и вернул заказ обратно на склад. Это промежуточный статус, после которого менеджер выясняет, нужно ли повторно доставлять (статусы DATECHANGE/DELIVERY) или это окончательная недоставка (CANCELED).: DATECHANGE — Перенос даты доставки.

== : '''COMPLETE''' — Доставлен.: '''PARTIALLY''' — Доставлен частично.: '''CANCELED''' — Не доставлен (Возврат/Отмена заказа ==). После этого статуса отправление должны вернуть заказчику, будут статусы RETURNING и RETURNED

Запрос отмены предназначен для отмены тех заказов, по которым не было произведено изменений - статуса доставки, статуса корреспонденции, времени доставки - то есть заказов, которые ещё не находятся в работе: RETURNING — Планируется возврат заказчику (после CANCELED).: RETURNED — Возвращен заказчику.Возможность отмены заказа есть только у курьерских служб с тарифом "Премиум" и по-умолчанию она выключена, ее нужно отдельно включить: [[Личный кабинет курьерской службы#Дополнительные настройки]]LOST — Утрачен/утерян.

При отмене заказа поле "Инфо о доставке" получает значение "Отменено заказчиком", поле "Дата доставки" - текущую дату, а "Вручил курьер" - системную запись "ОТМЕНА": PARTLYRETURNING — Планируется возврат остатков.: PARTLYRETURNED — Остаток возвращен.: TRANSACCEPTED — Прибыл на склад перевозчика.: PICKUPTRANS — Забран у перевозчика.

'''Пример запроса отмены заказа:Примечание.'''<source lang="xml"><?xml version="1В будущем возможно дополнение используемого набора статусов.0" encoding="UTF-8" ?><cancelorder> <auth extra="8" login="login" pass="pass" /> <order orderno="" ordercode="123456" /> <order orderno="123aaa" ordercode="" /></cancelorder></source>

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

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

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

<cancelorderstatusreq> <order ordernoauth extra="123test8" ordercodelogin="123456login" errorpass="0" errormsg="OK" errormsgru="Успешноpass" ></auth> <changes>ONLY_LAST</changes> <order orderno="123aaa" ordercode="" error="52" errormsg="order not found" errormsgru="Заказ не найден" streamid>1234</streamid></cancelorderstatusreq>

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

<addattachmentscommitlaststatus> <auth extra="8" login="login" pass="pass" ></auth> <ordernoclient>1234567CLIENT</ordernoclient> <attachmentsstreamid>1234</streamid> <item name="photo1.jpg"/commitlaststatus></source>JVBERi0xLjMN1wb25lbnQgMQ JUBQREYwMTIzNDU2Nzg5IDI NMyAwIG9iag08PA0vVHlwZSA U3VidHlwZSAvSW1hZ2UNL1d pZHRoIDE4MDgNL0hlaWdodCA'''Описание полей запроса''' ggNCAwIFINL0JpdHNQZXJDb 21wb25lbnQgMQ0vRGVjb2RlU ENL0NvbHVtbnMgMTgwOA0+P g0vSW1hZ2VNYXNrIHRydWUNL* '''auth''' — авторизация. Обязательный элемент. XhEZWNvZGUNPj4Nc3RyZWFt DQ</item>* '''streamid''' — идентификатор потока. Если у вас несколько интеграций и каждая нуждается в получении статусов, вы можете передавать данный параметр и тем самым разделять получение и отметку об успешном получении статусов по заказам. Значение должно входить в промежуток от 100 до 10000, включительно. Необязательный элемент. <item name="photo2* '''client''' — признак клиента или агента. Необязательный элемент.jpg">VBERi0xLjMNAwIG9iag0HRoJ JUBQREYwMTIzNDU2Nzg5IDI NMyAwIG9iag08PA0vVHlwZSA:* CLIENT — признак клиента, значение по умолчанию vWE9iamVjdA0vU3VidHlwZS AvSW1hZ2UNL1dpZHRoIDEzNj :* AGENT — признак агента. В ответ отдается информация по заказам, переданным агенту на доставку gNL0hlaWdodCAxMzMzDS9MZ W5ndGggNCAwIFINL0JpdHNQZ XJDb21wb25lbnQgMQ0vRGVj b2RlUGFybXMgPDwNL0sgLTEN В случае успеха вы получите ответ: L0NvbHVtbnMgMTM2OA0+Pg0 vSW</itemsource lang="xml"> </attachments?xml version="1.0" encoding="UTF-8" ?><commitlaststatus error="0">OK</addattachmentscommitlaststatus>

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

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

<addattachmentstracking> <attachmentsorder orderno="111111"> <barcode>111111</barcode> <AWB>111111</AWB> <item namesender> <town code="photo1.jpg1" errorcountry="0RU" errormsg>Москва город</town> <date>2014-03-22</date> <time_min>09:00</time_min> <time_max>14:00</time_max> </sender> <receiver> <town code="OK1" errormsgrucountry="УспешноRU" >Москва город</town> <zipcode>125480</zipcode> <date>2014-03-22</date> <time_min>09:00</time_min> <time_max>14:00</time_max> </receiver> <price>387.5</price> <inshprice>387.5</inshprice> <paytype>CASH</paytype> <weight>5.1</weight> <quantity>2</quantity> <service>2</service> <type>3</type> <return>NO</return> <return_service>2</return_service> <return_date></return_date> <return_time></return_time> <return_message></return_message> <waittime>12<item name/waittime> <enclosure>Детские игрушки</enclosure> <instruction>Проверить при покупателе, подписать акт</instruction> <deliveryprice total="photo2158.jpg6" errordelivery="0100.00" errormsgreturn="OK" errormsgru="Успешно58.6" /> <courier> <code>26</attachmentscode> <name>Иванов Владимир Петрович</addattachmentsname> <phone>+79161234567</sourcephone> </courier> <currcoords lat="55.680327" lon= Получение вложений к накладной "37.604456" accuracy="50" RequestDateTime="2014-04-21 18:07:45" /> <status eventstore="филиал в Санкт-Петербурге" eventtime="2016-06-02 17:22:00" createtimegmt="2016-06-03 16:14:44" message="" title="Доставлен">COMPLETE</status>'''Пример запроса:''' <statushistory> <source langstatus eventstore="Офис в Москве" eventtime="2016-05-30 10:20:00" createtimegmt="2016-06-03 16:14:44" message="" title="xmlНовый">NEW</status> <?xml versionstatus eventstore="Офис в Москве" eventtime="2016-06-01 17:38:00" createtimegmt="1.02016-06-03 16:14:44" encodingmessage="UTFфилиал в Санкт-8Петербурге" title="Планируется отправка" ?>DEPARTURING<attachments/status> <auth extrastatus eventstore="Офис в Москве" eventtime="2016-06-01 19:53:00" createtimegmt="82016-06-03 16:14:44" loginmessage="loginфилиал в Санкт-Петербурге" passtitle="passОтправлено со склада" >DEPARTURE</status> <ordernostatus eventstore="филиал в Санкт-Петербурге" eventtime="2016-06-02 07:41:00" createtimegmt="2016-06-03 16:14:44" message="" title="Получен складом">1234567ACCEPTED</ordernostatus> <status eventstore="филиал в Санкт-Петербурге" eventtime="2016-06-02 09:17:00" createtimegmt="2016-06-03 16:14:44" message="" title="Выдан курьеру на доставку">DELIVERY</attachmentsstatus> <status eventstore="филиал в Санкт-Петербурге" eventtime="2016-06-02 17:22:00" createtimegmt="2016-06-03 16:14:44" message="" title="Доставлен (предварительно)">COURIERDELIVERED</sourcestatus> '''Описание полей <status eventstore="филиал в Санкт-Петербурге" eventtime="2016-06-02 17:22:00" createtimegmt="2016-06-03 16:14:'''44" message="" title="Доставлен">COMPLETE</status> </statushistory>'''attachments''' - Корневой контейнер. Обязательный элемент <deliveredto>Иванова, секр.</deliveredto>*'''auth''' <delivereddate>2016- Авторизация. Обязательный элемент.*'''orderno''' 06- Номер02</код заказа. Обязательный элемент.delivereddate> <deliveredtime>17:22</deliveredtime> <outstrbarcode>EXT123456</outstrbarcode>'''Пример ответа:''' <items> <source langitem code="34533" extcode="xmlabc123"><?xml versionquantity="1" mass="0.2" retprice="37.5" VATrate="0" barcode="2345625213125" article="1" returns="0" origincountry="040" GTD="" excise="0.0" encodinggovernmentCode="UTF-811223311" suppcompany="Поставщик" suppINN="1112223334" suppphone="79161234567"?>Мяч<attachments/item> <item namecode="34456" extcode="abc124" quantity="2" mass="2" retprice="100" VATrate="10" barcode="4645625213138" article="2" returns="doc1.docx0" sizegovernmentCode="35654">JVBERi0xLjMN JUBQREYwMTIzNDU2Nzg5IDI NMyAwIG9iag08PA0vVHlwZSA U3VidHlwZSAvSW1hZ2UNL1d pZHRoIDE4MDgNL0hlaWdodCA ggNCAwIFINL0JpdHNQZXJDb 21wb25lbnQgMQ0vRGVjb2RlU ENL0NvbHVtbnMgMTgwOA0+P g0vSW1hZ2VNYXNrIHRydWUNL XhEZWNvZGUNPj4Nc3RyZWFt DQОбруч</item> <item namecode="34421" extcode="abc125" quantity="3" mass="photo20.jpg3" sizeretprice="50" VATrate="18" barcode="2345625213126" article="3" returns="0" governmentCode="74861">VBERi0xLjMN Погремушка желтая</item> JUBQREYwMTIzNDU2Nzg5IDI NMyAwIG9iag08PA0vVHlwZSA vWE9iamVjdA0vU3VidHlwZS AvSW1hZ2UNL1dpZHRoIDEzNj </items> gNL0hlaWdodCAxMzMzDS9MZ W5ndGggNCAwIFINL0JpdHNQZ XJDb21wb25lbnQgMQ0vRGVj b2RlUGFybXMgPDwNL0sgLTEN L0NvbHVtbnMgMTM2OA0+Pg0 vSW </itemorder></attachmentstracking></source> В тегах item возвращаются бинарные данные (файлы), закодированные в base64. == Изменение статуса агентом ==

Кроме этого, устанавливается дата и время (при необходимости) изменения статуса, а также сообщение '''Получение информации в поле 'формате 17 TRACK'Инфо о доставке''.

При необходимости к заказу можно прикрепить изображения.  '''Пример запроса изменения статуса:'''

<?xml version="1.0" encoding="UTF-8" ?><setorderinfotracking17> <auth extra=">8" login="login" pass="pass" /> <order ordercode="123456"> <message>Получил Иванов</message> </orderextra> <order ordercode="234567"> <status>PICKUPREADY</status> <eventtime>2016-05-30 10:20:00</eventtime> <message>Клиент отказался от покупки</message> <paytypeorderno>CASH</paytype> <items> <item code="34533" quantity="1" reason="0" /> <item code="34456" quantity="0" reason="0" /> <item code="34421" quantity="2" reason="0" /> </items> <image filename="filename1.jpg"> /9j/4AAQSkZJRgA BAQAAAQABAAD/2wBDAA0JCg sKCA0LCgsODg0PEyAVExISEy ccHhcgLikxMC4pLSwzOko+M zZGNywtQFdBRkxOUlNSMj5aY VpQYEpRUk//2wBDAQ4ODhMR EyYVFSZPNS01T09PT09PT09P T09PT09PT09PT09PT09PT09 PT09PT09PT09PT09PT09PT09 PT09PT0//wAARCAYACAADAS IA</image> 1234</orderorderno></setorderinfotracking17>

'''Описание полей запроса статуса:''' '''setorderinfo''' - Корневой контейнер. Обязательный элемент.*'''auth''' - Авторизация. Обязательный элемент.*'''order''' - Контейнер заказа. Обязательный элемент. Запрос может содержать более одного контейнера '''order'''. Атрибут '''''ordercode''''' - внутренний код заказа.*'''status''' - Новый статус заказа. Доступны статусы из раздела [[#Описание полей ответа статусов]], кроме AWAITING_SYNC и NEW.*'''eventtime''' - Дата и время изменения статуса. Обязательно при указании статуса.*'''message''' - Текст сообщения ''Инфо о доставке''.*'''paytype''' - Тип оплаты заказа. Допустимые значения CASH/CARD.*'''items''' - Контейнер для описания вложений '''item''' . Атрибуты::* '''''code''''' - Код вложения.:* '''''quantity''''' - Количество доставленных единиц вложения.:* '''''reason''''' - Причина недоставки, выбирается из соответствующего списка статусов.*'''image''' - Контейнер прикрепляемого изображения. Содержит текст файла изображения, закодированный по стандарту ''base64''. Контейнер '''order''' может содержать более одного контейнера '''image'''. Атрибут::* '''''filename''''' - Имя файла.   '''Пример ответа:'''<source lang="xml"><?xml version="1.0" encodingИзменение заказа ="UTF-8"?><setorderinfo> <order ordercode="123456" error="0" errormsg="OK" errormsgru="Успешно" /> <order ordercode="234567" error="59" errormsg="value [date_put] is already set" errormsgru="Значение [Дата доставки] уже указано" /></setorderinfo></source> == Получение документов Запрос предназначен для печати == '''Пример запроса получения печатных форм:'''<source lang="xml"><?xml version="1.0" encoding="UTF-8" ?><waybill> <auth extra="8" login="login" pass="pass" /> <orders> <order orderno="1234567" ordercode="33331" /> <order orderno="1234568" ordercode="33332" /> </orders> <form>1</form></waybill></source> '''Описание полей:''' '''waybill''' - Корневой контейнер. Обязательный элемент*'''auth''' - Авторизация. Обязательный элемент*'''orders''' - Список изменения заказов для получения печатных форм. Содержит тэги '''order''' с атрибутами::* '''''orderno''''' - шифр заказа:* '''''ordercode''''' - внутренний код заказа. Указывать необходимо один из атрибутов для всех заказов. Приоритет имеет атрибут '''''ordercode'''''*'''form''' - Формат накладной. Не обязательный элемент. Принимает значения::* 1 - Подробная накладная (по-умолчанию):* 2 - Наклейки Zebra:* 3 - Наклейки на страницу формата А4:* 4 - Акты приема-передачи

<div style="color: #a94442; background-color: #f2dede; border: 1px solid #ebccd1; padding: 3px 10px 10px;">'''Обратите внимание!'''# Данные запроса изменения указываются '''полностью''', как если бы заказ создавался впервые.# При отсутствии вложения в запросе изменения данное вложение '''Пример ответа:не удаляется'''из заказа, но его количество становится равным 0.# При одновременном изменении заказа в API и системе курьерской службы приоритет отдается данным системы курьерской службы. То есть изменения в API приняты не будут.<source lang="xml"/div> При редактировании заказа может быть отменен запланированный курьер. Это зависит от значения переменной '''Справочники''' > '''Переменные''' > '''Корреспонденция''' >'''Автоматически устанавливать заплан. курьера по району''':* '''Нет''' — при редактировании заказа по АПИ курьер не изменяется;* '''Район''' — если изменен адрес доставки, курьер сбрасывается;* '''Район или дата план. доставки''' — если изменен адрес доставки или плановая дата вручения, курьер сбрасывается.<?xml version=== Описание полей запроса изменения =="1.0" encoding="UTF-8"?><waybill>Все поля запроса соответствуют структуре order при создании заказа за исключением: <content>EODIcaI8KSBlwQ 4MnEOR7Px8U8EBAyGICBnwpw IZhQgz0ZxuPs8EBM/GcbjzB AwhBl8hwQYIO00GmEwg1CeEG * значение '''orderno''' данным методом изменить нельзя. mqYTChNU0wqf8l8nz4zgc+K fCno+zwU5GjOZmzXGcbEQYIM * значение '''barcode''' изменяется в случае явного его указания. В случае отсутствия или пустого значения - остается прежним. 4zkegRE40zWzONyoNNMIOIa cWnp6aDCGEGE9NQmoQd2mg00 * вместо корневого тэга '''neworder''' указывается '''editorder'''; 79U4f3hPTwnfp6Sdrafeqpa JDpFw/1aYT077VNNNdO00G3q * тэг курьера '''courier''' можно изменить только при включенной настройке '''Разрешить изменение курьера по АПИ''';* для вложений '''item''' указывается внутренний код вложения в атрибуте '''code''', который можно получить при получении статуса заказа.* для мест '''package''' указывается внутренний код вложения в атрибуте '''code''', который можно получить при получении статуса заказа. mqqvp9p2E7T0/wiFemv8uG6 OM</content></waybill></source>Необходимо иметь в виду, что:

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

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

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

<?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" size="235654">JVBERi0xLjMN JUBQREYwMTIzNDU2Nzg5IDI NMyAwIG9iag08PA0vVHlwZSA <city>U3VidHlwZSAvSW1hZ2UNL1d pZHRoIDE4MDgNL0hlaWdodCA <code>80</code> ggNCAwIFINL0JpdHNQZXJDb 21wb25lbnQgMQ0vRGVjb2RlU <country> ENL0NvbHVtbnMgMTgwOA0+P g0vSW1hZ2VNYXNrIHRydWUNL <code>1 XhEZWNvZGUNPj4Nc3RyZWFt DQ</codeitem> <item name="photo2.jpg" size="74861">Россия</name>VBERi0xLjMN <id>643</id> JUBQREYwMTIzNDU2Nzg5IDI NMyAwIG9iag08PA0vVHlwZSA <ShortName1>RU</ShortName1> vWE9iamVjdA0vU3VidHlwZS AvSW1hZ2UNL1dpZHRoIDEzNj <ShortName2>RUS</ShortName2> gNL0hlaWdodCAxMzMzDS9MZ W5ndGggNCAwIFINL0JpdHNQZ </country> <name>Агинский Бурятский автономный округ</name> XJDb21wb25lbnQgMQ0vRGVj b2RlUGFybXMgPDwNL0sgLTEN L0NvbHVtbnMgMTM2OA0+Pg0 vSW</city> <cityitem> <code>1</code> <countryattachments> <code>1</codesource> <name>Россия</name> <id>643</id>В тегах item возвращаются бинарные данные (файлы), закодированные в base64. <ShortName1>RU</ShortName1> <ShortName2>RUS</ShortName2>== Изменение статуса агентом == <Запрос изменения статуса заказа позволяет установить окончательный статус заказа — «Доставлен» или «Не доставлен (Возврат/country>Отмена)». <name>Адыгея республика</name> </city>Кроме этого, устанавливается дата и время (при необходимости) изменения статуса, а также сообщение в поле ''Инфо о доставке''.</regionlist></source>При необходимости к заказу можно прикрепить изображения.

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

<?xml version="1.0" encoding="UTF-8"?><streetlistsetorderinfo> <conditionsauth extra="8" login="login" pass="pass" /> <order ordercode="123456"> <townmessage>Москва городПолучил Иванов</townmessage> <outstrbarcode>7654312</outstrbarcode> <// ОБЯЗАТЕЛЬНОЕ ПОЛЕ!order> <order ordercode="234567"> <namecontainsstatus>ХохлоPICKUPREADY</namecontainsstatus> <namestartseventtime>Академика Х2016-05-30 10:20:00</namestartseventtime> <namemessage>Академика ХохловаКлиент отказался от покупки</namemessage> <fullnamepaytype>Академика Хохлова ул.CASH</fullnamepaytype> <storeprice>123</conditionsstoreprice> <limititems> <limitfromitem code="34533" quantity="1" reason="0" governmentCode="11223311" />30 <item code="34456" quantity="0" reason="0" /limitfrom> <limitcountitem code="34421" quantity="2" reason="0" />10 </limitcountitems> <countallimage filename="filename1.jpg">YES/9j/4AAQSkZJRgA BAQAAAQABAAD/2wBDAA0JCg sKCA0LCgsODg0PEyAVExISEy ccHhcgLikxMC4pLSwzOko+M zZGNywtQFdBRkxOUlNSMj5aY VpQYEpRUk//2wBDAQ4ODhMR EyYVFSZPNS01T09PT09PT09P T09PT09PT09PT09PT09PT09 PT09PT09PT09PT09PT09PT09 PT09PT0//wAARCAYACAADAS IA</countallimage> </limitorder></streetlistsetorderinfo></source>  '''Описание полей запроса статуса:''' '''setorderinfo''' — Корневой контейнер. Обязательный элемент.*'''conditionsauth''' - Задает условия поиска — Авторизация. Все вложенные элементы одновременно накладывают условие "И"Обязательный элемент.:* '''townorder''' — Контейнер заказа. Обязательный элемент. Запрос может содержать более одного контейнера '''order''' - Обязательное поле. Название или Атрибут '''''ordercode''''' — внутренний код населенного пунктазаказа.:* '''namecontainsstatus''' - Поиск населенных пунктов — Новый статус заказа. Доступны статусы из раздела [[#Описание полей ответа статусов]], название которых содержит указанный тексткроме AWAITING_SYNC и NEW.:* '''namestartseventtime''' - Поиск населенных пунктов, название которых начинается с указанного текста — Дата и время изменения статуса. Обязательно при указании статуса.:* '''namemessage''' - Поиск населенных пунктов, название которых соответствует указанному тексту — Текст сообщения ''Инфо о доставке''.:* '''fullnameoutstrbarcode''' - Поиск населенных пунктов, название вместе  — код у подрядчика (код заказа во внешней системе). Используется в интеграциях с типом населенного пункта которых соответствует указанному текстувнешними системами.* '''paytype''' — Тип оплаты заказа. Допустимые значения CASH/CARD.*'''limitstoreprice''' — Агентское вознаграждение.* '''items''' — Контейнер для описания вложений '''item''' - Ограничивает вывод результата.Атрибуты::* '''limitfrom''code' - Задает номер записи результата, начиная с которой выдавать ответ'''' — Код вложения. По-умолчанию - 0:* '''''quantity''''' — Количество доставленных единиц вложения.:* '''limitcount''reason'''- Задает количество записей результата'' — Причина недоставки, которые нужно вернутьвыбирается из соответствующего списка статусов. По-умолчанию - 10000:* '''''governmentCode''''' — Указание кода ТН для вложения при необходимости.:* '''countallimage''' — Контейнер прикрепляемого изображения. Содержит текст файла изображения, закодированный по стандарту ''base64'' - YES указывает на необходимость подсчета общего количества найденных совпадений. Это Контейнер '''order''' может замедлять выполнение запросасодержать более одного контейнера '''image'''. Если отключено - в ответе не указываются totalcount и totalpagesАтрибут::* '''''filename''''' — Имя файла.  

<streetlist countsetorderinfo> <order ordercode="1123456" pageerror="10" totalcounterrormsg="3OK" totalpageserrormsgru="1Успешно"> <street> <name>Академика Хохлова ул.</name> <shortname>Академика Хохлова</shortname> <typename>ул.</typename> <order ordercode="234567" error="59" errormsg="value [date_put] is already set" errormsgru="Значение [Дата доставки] уже указано" /street></streetlistsetorderinfo>

В ответе улицы сортируются по алфавиту== Получение документов для печати =='''Пример запроса получения печатных форм:'''<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> <start>5</start></waybill></source> '''Описание полей:''' '''waybill''' — Корневой контейнер. Обязательный элемент* '''auth''' — Авторизация. Обязательный элемент* '''orders''' — Список заказов для получения печатных форм. Содержит тэги '''order''' с атрибутами::* '''''orderno''''' — шифр заказа:* '''''ordercode''''' — внутренний код заказа. Указывать необходимо один из атрибутов для всех заказов. Приоритет имеет атрибут '''''ordercode'''''* '''form''' — Формат накладной. Не обязательный элемент. Принимает значения::* 1 — Подробная накладная (по-умолчанию):* 2 — Наклейки Zebra:* 3 — Наклейки на страницу формата А4:* 4 — Акты приема-передачи* '''start''' — Имеет смысл только для form = 3. Начальная позиция первой наклейки. Используется для пропуска наклеек на листе для их экономии. 

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

<?xml version="1.0" encoding="UTF-8" ?><itemlistwaybill> <auth extra="8" login="login" pass="pass"></authcontent>EODIcaI8KSBlwQ 4MnEOR7Px8U8EBAyGICBnwpw <codesearch> <code>123456< IZhQgz0ZxuPs8EBM/code>GcbjzB AwhBl8hwQYIO00GmEwg1CeEG <article>FD343</article> mqYTChNU0wqf8l8nz4zgc+K fCno+zwU5GjOZmzXGcbEQYIM <barcode>2345625213125</barcode> 4zkegRE40zWzONyoNNMIOIa cWnp6aDCGEGE9NQmoQd2mg00 < 79U4f3hPTwnfp6Sdrafeqpa JDpFw/codesearch>1aYT077VNNNdO00G3q <conditions> <namecontains>телевизор</namecontains> <namestarts>sony</namestarts> <name>Sony KDL-55W905 ЖК-телевизор< mqqvp9p2E7T0/name> <quantity>EXISTING_ONLY</quantity> <store>2</store> </conditions> <except> <code>123478</code> </except> <limit> <limitfrom>30</limitfrom> <limitcount>10</limitcount> <countall>YES</countall> wiFemv8uG6 OM</limitcontent></itemlistwaybill>

*'''conditions''' - Задает условия поиска. Все вложенные элементы одновременно накладывают условие "И".:* '''namecontains''' - Поиск товаровВ тэге content возвращаются бинарные данные (файл pdf), название которых содержит указанный текст.:* '''namestarts''' - Поиск товаров, название которых начинается с указанного текстазакодированные в base64.:* '''name''' - Поиск товаров, название которых соответствует указанному тексту.:* '''quantity''' - Наличие на складе. Принимает значения EXISTING_ONLY - Только При записи в наличии, NOT_EXISTING_ONLY - Только не в наличии, ALL - Все. ''Это поле может быть недоступным в некоторых установках.'':* '''store''' - Поиск товаров по определенному складу.файл необходимо использовать двоичный формат записи!

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

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

<itemlist count="3" totalcount="3" page="1" totalpages="1"waybill> <itemerror> <code>123456</code> <article>FD343Текст ошибки</articleerror> <barcode>2345625213125</barcode> <name>Sony KDL-55W905 ЖК-телевизор</name> <retprice>65000</retprice> <purchprice>50000</purchprice> <weight>5.1</weight> <length>50</length> <width>30</width> <height>40</height> <CountInPallet>30</CountInPallet> <HasSerials>1</HasSerials> <CountryOfOrigin>Малайзия</CountryOfOrigin> (not yet supported) <Message>Хороший телевизор</Message> <Message2>Снова хороший телевизор</Message2> <quantity>12</quantity> <reserved>3</reserved> <item> ...</itemlistwaybill>

== Справочник городов =='''Описание полейПример запроса справочника городов:'''*'''code''' <source lang="xml"><?xml version="1.0" encoding="UTF- Внутренний идентификатор, присвоенный системой.8"?><townlist> <auth extra="8" /> <codesearch> <zipcode>110000</zipcode> <kladrcode>0100000100800</kladrcode>*'''article''' <fiascode>bd21979d-46f8- Артикул, назначенный клиентом (поставщиком).*'''barcode''' 49d0- Штрих9105-код производителя.e8d65172a983</fiascode> <code>123</code>*'''name''' - Наименование. </codesearch>*'''retprice''' - Розничная цена по-умолчанию. При оформлении заказа цена используется та, которая указана в заказе. <conditions>*'''purchprice''' - Закупочная цена. <city>Краснодарский край</city>*'''weight''' - Масса в килограммах. <namecontains>новгород</namecontains>*'''length''' - Длина в сантиметрах. <namecontainsparts>молоково моск</namecontainsparts>*'''width''' - Ширина в сантиметрах. <namestarts>Моск</namestarts>*'''height''' - Высота в сантиметрах. <name>Москва</name>*'''CountInPallet''' - Количество штук в паллете. <fullname>Москва город</fullname>*'''HasSerials''' - Требует учета серийных номеров. Принимает значения <country>1 - да, 0 - нет.</country> </conditions> <limit> <limitfrom>30</limitfrom> <limitcount>10</limitcount> <countall>YES</countall>*'''CountryOfOrigin''' - Наименование страны происхождения на русском языке. </limit>*'''Message''' - Комментарий.</townlist>*'''Message2''' - Дополнительный комментарий.</source>*'''quantity''' - Количество на складе. Товары, уже собранные в заказы в этом количестве не присутствуют, считаются покинувшими товарный склад. ''Это поле может быть недоступным в некоторых установках.''*'''reserved''' - Количество зарезервированного товара. Может превышать остаток на складеВнутри контейнера townlist все элементы могут как отсутствовать, если покупатели ждут следующей поставкитак и комбинироваться. ''Это поле может быть недоступным в некоторых установкахПоиск не чувствителен к регистру.'' == Движение номенклатуры ==

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

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

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

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

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

<tariffsregionlist> <codesearch> <code>77</code> </codesearch> <conditions> <namecontains>край<auth extra="8" login="login" pass="pass" /namecontains> <townfromnamestarts>МоскваМоск</townfromnamestarts> <servicefullname>1Московская область</servicefullname> <mainonlycountry>1RU</country> </mainonlyconditions> </tariffsregionlist>

*'''auth''' — атрибут '''extra''' обязателен, по нему определяется курьерская служба.*'''townfrom''' — город-отправитель. Если не передан, то городом будет «Москва».*'''service''' — режим доставки. Обязательный элемент.*'''mainonly''' — необязательный элемент. Если передан, то в ответе будут данные только по городам из справочника '''Межгород''' > '''Зоны'''.  '''Пример ответа справочника тарифов по городам:'''<source lang="jsonxml">{ <?xml version="townfrom1.0": encoding="0c5b2444UTF-70a0-4932-980c-b4dc0d3f02b58",?> <regionlist count="service2": 1,> <city> <code>80</code> "tariffs": [<country> { <code>1</code> "towntofias": "7339e834-2cb4-4734-a4c7-1fca2c66e562", <name>Россия</name> "towntocode": "482", <id>643</id> "towntoname": "Уфа город", <ShortName1>RU</ShortName1> "pricesnew": { <ShortName2>RUS</ShortName2> "before": [ </country> { <name>Агинский Бурятский автономный округ</name> "price": "100", </city> "every": "0", <city> "mass": " <code>1"</code> }, <country> { "price": "200", "every": " <code>1",</code> "mass": "2" <name>Россия</name> } <id>643</id> ], <ShortName1>RU</ShortName1> "after": [ <ShortName2>RUS</ShortName2> { </country> "price": "300", <name>Адыгея республика</name> "every": "1", </city> "mass": "3"</regionlist> }</source> ] },== Справочник улиц == "prices"'''Пример запроса справочника улиц: {''' <source lang="beforexml": {> <?xml version="mass1.0": encoding="3UTF-8",?><streetlist> "price": "202.5" <conditions> }, <town>Москва город</town> // ОБЯЗАТЕЛЬНОЕ ПОЛЕ! "after": { <namecontains>Хохло</namecontains> "mass": "3", <namestarts>Академика Х</namestarts> "every": "1", <name>Академика Хохлова</name> "price": "18 <fullname>Академика Хохлова ул.75"</fullname> } </conditions> }, <limit> "deliveryPeriodMin": 4, <limitfrom>30</limitfrom> "deliveryPeriodMax": 5 <limitcount>10</limitcount> } <countall>YES</countall> ] </limit>}</streetlist>

''' Описание полей ответа '''* '''townfromconditions''' — код ФИАС города-отправителя — Задает условия поиска.* '''service''' — режим доставки.*'''tariffs''' — cписок тарифов по городуВсе вложенные элементы одновременно накладывают условие «И».:* '''towntofiastown''' — код ФИАС города-получателя — Обязательное поле.:* '''towntocode''' — внутренний Название или код города-получателянаселенного пункта.:* '''towntonamenamecontains''' — наименование города-получателя — Поиск улиц, название которых содержит указанный текст.:* '''pricesnew''' — ваши настройки тарифов из справочника '''Межгород''' > '''Тарифы по зонамnamestarts''' — Поиск улиц, название которых начинается с указанного текста.::* '''pricename''' — цена.::* '''every''' — за каждые.::* '''mass''' — масса — Поиск улиц, название которых соответствует указанному тексту.:* '''pricesfullname''' — устаревший элемент — Поиск улиц, не используется.:* '''deliveryPeriodMin''' — минимальный срок доставки.:* '''deliveryPeriodMax''' — максимальный срок доставкидля которых название вместе с типом соответствует указанному тексту.

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

<?xml version="1.0" encoding="UTF-8" ?><itemdoc> <auth extrastreetlist count="1" page="81" logintotalcount="login3" passtotalpages="pass1"> </authstreet> <code>21991124</code> <name>Академика Хохлова ул.</name> <shortname>Академика Хохлова</shortname> <typename>ул.</typename> </street></itemdocstreetlist>

*'''code''' - внутренний код документа приходной накладной (см. предыдущий запрос)В ответе улицы сортируются по алфавиту.

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

<itemdocitemlist> <auth extra="8" login="login" pass="pass"></auth> <codesearch> <code>21991123456</code> <article>FD343</article> <barcode>2345625213125</barcode> </codesearch> <conditions> <namecontains>телевизор</namecontains> <numbernamestarts>318sony</numbernamestarts> <datename>2017Sony KDL-0555W905 ЖК-26телевизор</name> <quantity>EXISTING_ONLY</datequantity> <messagestore>2</messagestore> <items/conditions> <item except> <code>123478</code="4259" quantity="1" barcode="200300" article="123555">Настольная игра Дженга </except> <limit> <limitfrom>30</limitfrom> <limitcount>10</limitcount> <countall>YES</itemcountall> </itemslimit></itemdocitemlist>

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

*'''itemexcept''' - контейнер товара — Описание исключений для корректного определения количества зарезервированной номенклатуры.:* '''code''' - внутренний код товара:* '''barcode''' - штрих-код товара:* '''article''' - артикул товара:* '''quantity''' - количество поступившего товара — Код заказа.

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

<?xml version="1.0" encoding="UTF-8" ?><storelistitemlist count="3" totalcount="3" page="1" totalpages="1"> <item> <auth extra="8"code>123456</authcode> <jsonarticle>YESFD343</jsonarticle> <client_codebarcode>78902345625213125</client_codebarcode> <name>Sony KDL-55W905 ЖК-телевизор</storelistname> <retprice>65000</sourceretprice> <purchprice>50000</purchprice>*'''auth''' - Атрибут '''extra''' - обязателен, по нему определяется курьерская служба <weight>5.1</weight>*'''json''' - Признак вывода ответа в виде JSON YES <length>50</NOlength>*'''client_code''' - Код клиента курьерской службы <width>30</width> <height>40</height>'''Пример ответа:''' <VATrate>20</VATrate> <source lang="xml"CountInPallet>30<?xml version="1.0" encoding="UTF-8" ?/CountInPallet> <storelist count="CountInBox>2"</CountInBox> <storeHasSerials>1</HasSerials> <codeCountryOfOrigin>123Малайзия</codeCountryOfOrigin> (not yet supported) <nameMessage>ABCХороший телевизор</nameMessage> </storeMessage2> Снова хороший телевизор<store/Message2> <codequantity>45612</codequantity> <namereserved>Филиал 23</namereserved> </storeitem> ...</storelistitemlist>

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

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

<pvzlistitemmovements>

<code>12344259</code> <client_codedatefrom>78902020-10-01</client_codedatefrom> <towndateto>Нижний Тагил2020-10-02</town> <parentcode>6</parentcode> <acceptcash>YES</acceptcash> <acceptcard>YES</acceptcard> <acceptfitting>YES</acceptfitting> <maxweight>30</maxweight> <acceptindividuals>YES</acceptindividuals> <lt>57.924737</lt> <lg>59.940019</lg> <rt>57.905682</rt> <rg>59.984669</rg> <json>YES</jsondateto></pvzlistitemmovements>

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

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

<pvzlist itemmovements count="216"> <pvzitemmovement> <code>126151500</code> <clientcodedate>32017-05-26</clientcodedate> <nameretprice>Нижний Тагил0</nameretprice> <parentcodequantity>61</parentcodequantity> <parentnamedelivered>Интеграция0</parentnamedelivered> <town code="124267" regioncode="66" regionname="Свердловская область">Нижний Тагил город</townitem> <addresscode>622036, г. Нижний Тагил, ул. Циолковского, д. 174259</addresscode> <phonename>+73435417709, +73435254989Настольная игра Дженга</phonename> <comment>Новый пункт доставки</commentitem> <worktime>Вс 10:00-16:00, Сб 10:00-16:00, Пн-Пт 10:00-20:00</worktimestatus> <traveldescriptioncode>Жилое 5-ти этажное здание, торцом к дороге, второе здание от перекрестка Пархоменко-Циолковского</traveldescriptioncode> <maxweightname>10Возврат от покупателя</maxweightname> <acceptcash>YES</acceptcashstatus> <acceptcard>YES</acceptcardstore> <acceptfittingcode>YES1</acceptfittingcode> <acceptindividualsname>YESофис в Москве</acceptindividualsname> <latitude>57.93457</latitudestore> <longitude>59.95131</longitude> </pvz> <pvzorder> <codeordercode>2453374830</codeordercode> <clientcodenumber>NTG1123660-0</clientcodenumber> <namedate>На Красноармейской2017-05-24</namedate> <parentcodeorderno>614123</parentcodeorderno> <parentnamebarcode>Интеграция0000000670</parentnamebarcode> <town code="124267" regioncode="66" regionname="Свердловская область"company>Нижний Тагил городТОВАР</towncompany> <address>КРАСНОАРМЕЙСКАЯКравченко ул., д.791</address> <phonedelivereddate>+7(3435)3792017-04405-29</phonedelivereddate> <commentdeliveredtime>Возможность примерки отсутствует</comment> <worktime>Вс 10:00-16:00, Сб 10:00-16:00, Пн-Пт 1012:00-20:00</worktimedeliveredtime> <traveldescription>Напротив ТЦ Пирамида <deliveredto /traveldescription> <maxweight>20</maxweightorder> <acceptcash>YES</acceptcashdocument> <acceptcardcode>YES21991</acceptcardcode> <acceptfittingnumber>NO318</acceptfittingnumber> <acceptindividualsdate>YES2017-05-26</acceptindividualsdate> <latitudemessage>57.93468</latitudemessage> <longitude>60.55476</longitudedocument> </pvzitemmovements></pvzlistitemlist>

*'''codeОписание полей ответа ''' - Код ПВЗ в системе. Используется в запросе [[API#Оформление заказа|оформления заказов]]*'''clientcodecode''' - Код ПВЗ используемый компанией-подрядчиком. — внутренний код операции движения*'''namedate''' - Наименование ПВЗ. — дата операции*'''parentcoderetprice''' - Код родительского элемента. — цена товара*'''parentnamequantity''' - Наименование родительского элемента. — количество товара операции*'''towndelivered''' - Населенный пункт с кодом из [[#Справочник городов|справочника городов]], а также с кодом и наименованием региона. — количество доставленного товара*'''address''' - Адрес ПВЗ.*'''phoneitem''' - Телефоны ПВЗ. — контейнер товара:*'''commentcode''' - Дополнительная информация. — внутренний код товара:*'''worktime''' - Режим работы ПВЗ.*'''traveldescription''' - Описание местонахождения ПВЗ или пути к нему.*'''maxweight''' - Максимальный вес, с которым работает ПВЗ.*'''acceptcash''' - Признак приема наличных*'''acceptcard''' - Признак приема банковских карт*'''acceptfitting''' - Наличие примерки*'''latitude''' - Широта*'''longitudename''' - Долгота — наименование товара

* '''Пример запроса получения фискальных данныхstore''' — контейнер филиала, к которому относится операция:* '''code''' — код филиала<source lang="xml"><?xml version="1.0" encoding="UTF-8"?><receiptdata> <auth extra="8" login="test" pass="testm" /> <orders> <order orderno="123456" /> <order orderno="890111C" /> </orders></receiptdata>:* '''name''' — наименование филиала

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

'''Пример ответа справочника тарифов по городам'''<?xml versionsource lang="1.0json">{ "townfrom" encoding=: "UTF0c5b2444-870a0-4932-980c-b4dc0d3f02b5"?>,<receipts count= "service": 1, ">tariffs": [ <receipt> { <orderno>123456</orderno> <fdDatetime>2020 "towntofias": "0c5b2444-70a0-4932-06980c-07 12b4dc0d3f02b5", "towntocode": 1, "towntoname":14"Москва город", "townregion":00</fdDatetime>"Город Москва", "distance": 0, "pricedistance": 0, <fdValue>123</fdValue> "pricesnew": { <fdNum>456</fdNum> "before": [ <fnSn>789</fnSn> { <kktNum> "price": 100</kktNum>, "every": 0, "mass": 1 }, { "price": 150, "every": 0, "mass": 5 <inn>222</inn> } <ofdUrl>gate.ofd.ru</ofdUrl> ], <fullUrl>https "after"://check.ofd.ru/123</fullUrl>[ { < "price>12345</price>": 0, <lines count= "every": 1, "mass">: 38.01 <line> }, <item>1111764</item> { <name>Сапоги</name> "price": 15, <qty> "every": 1, "mass": 51.1</qty> <price>1000</price> } <vatRate>20</vatRate> ] <governmentCode>Z16513LK2</governmentCode>}, <itemType>"deliveryPeriodMin": 1</itemType>, </line> "deliveryPeriodMax": 2 </lines> } </receipt> ]</receipts>}

Параметры ''' Описание полей ответа:'''*'''ordernotownfrom'''  — код ФИАС города- Номер заказаотправителя.*'''fdDatetimeservice''' - Дата и время пробития фискального чека — режим доставки.*'''fdValuetariffs''' - ФПД (фискальный признак документа) — cписок тарифов по городу.:*'''fdNumtownregion'''  — регион города- ФИСКАЛЬНЫЙ ДОКУМЕНТ (фискальный номер чека)получателя.:*'''fnSntowntofias'''  — код ФИАС города- ФН (номер фискального накопителя)получателя.:*'''kktNumtowntocode'''  — внутренний код города- РН (регистрационный номер кассы)получателя.:*'''inntowntoname'''  — наименование города- ИННполучателя.:*'''ofdUrldistance''' - URL адрес (доменное имя) ОФД — дистанция в км до города от МКАД, если в запросе townfrom — Москва.:*'''pricepricedistance''' - Сумма чека — сумма за километраж до города от МКАД, если в запросе townfrom — Москва.:*'''fullUrlpricesnew''' - URL чека для просмотра онлайн* — ваши настройки тарифов из справочника '''Межгород''' > '''linesТарифы по зонам''' - Позиции чека.::*'''itembefore/after''' - код товара — контейнеры ДО/ОТ.:::*'''nameprice''' - наименование товара — цена. Если ответ идет по «before», то в цену также плюсуется сумма pricedistance:::*'''qtyevery''' - количество товара — за каждые.:::*'''pricemass''' - цена товара — масса.:*'''governmentCodeprices''' - считанная последовательность — устаревший элемент, которая в дальнейшем преобразуется по алгоритму тега 1162не используется.:*'''vatRatedeliveryPeriodMin''' - НДС товара — минимальный срок доставки.:*'''itemTypedeliveryPeriodMax''' - тип товара (товар, доставка и т.д — максимальный срок доставки.)

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

<servicesitemdoc> <auth extra="8"login="login" pass="pass"></auth> <code>21991</code></servicesitemdoc>

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

<services count="2"itemdoc> <service> <code>121991</code> <namenumber>Эконом318</namenumber> <date>2017-05-26</servicedate> <servicemessage> <code/message>2 </codeitems> <nameitem code="4259" quantity="1" barcode="200300" article="123555">СрочноНастольная игра Дженга</nameitem> </serviceitems></servicesitemdoc>

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

<?xml version="1.0" encoding="UTF-8"?><advpricesstorelist> <auth extra="8" login="login" pass="pass" ></auth> <json>YES</json> <visibleclient_code>NO7890</visibleclient_code></advpricesstorelist>

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

Уникальные запросы списка ПВЗ кешируются на стороне личного кабинета и хранятся до 7 часов утра по московскому времени следующего дня. Например, если уникальный запрос с массой 2 кг был отправлен сегодня в 10 часов, то завтра в 7 утра он сбросится. Если сегодня в 18 часов в этом же запросе вы укажете массу 2 кг, в ответе вернется тот же список ПВЗ. Если передадите массу 3 кг, список может быть другим. Обратите внимание, что если в выборке количество ПВЗ больше '''10000''' и не указаны параметры '''code''', '''json''' или '''limitcount''', то будет возвращаться ошибка. В этом случае необходимо использовать блок '''limit'''. '''Пример ответа справочника дополнительных услугзапроса пунктов самовывоза:'''

<advpricespvzlist> <advpriceauth extra="8" login="login" pass="pass"></auth> <code>11234</code> <client_code>7890</client_code> <city>Свердловская область</city> <town regioncode="66" country="RU">Нижний Тагил</town> <address>Щёлковское шоссе</address> <house>77</house> <parentcode>6</parentcode> <acceptcash>YES</acceptcash> <nameacceptcard>Этажей в домеYES</nameacceptcard> <typeacceptfitting>intYES</typeacceptfitting> <maxweight>30</advpricemaxweight> <advpriceacceptindividuals>YES</acceptindividuals> <lt>57.924737<code/lt> <lg>59.940019</lg> <rt>257.905682</codert> <namerg>Коэффициент надбавки59.984669</namerg> <typejson>floatYES</typejson> <with_coords>YES</advpricewith_coords> <advpricelimit> <codelimitfrom>330</codelimitfrom> <namelimitcount>Расписаться на упаковке2</namelimitcount> <typecountall>boolYES</typecountall> </advpricelimit></advpricespvzlist>

Параметры:*'''codeauth''' — Атрибут '''extra''' — обязателен, по нему определяется курьерская служба, '''login''' - внутренний код услуги*и '''namepass''' - наименование услуги. Если поле "название в ЛК" в настройках услуги не пустопозволяют авторизоваться под клиентом: для отдельного клиента могут быть ограничения по доступности некоторых ПВЗ, то возвращает значение поля "название и в ЛК"этом случае они будут учтены.*'''hinecode''' - подсказка по доп услуге для пользователя — Внутренний код.*'''typeclient_code''' - тип услуги — Код клиента курьерской службы. Может иметь значения::*'''boolcity''' - для услуг вида "чекбокс", "Да" — Регион получателя. Можно указать код региона или полное наименование региона из [[#Справочник регионов|справочника регионов]].:*'''floattown''' - для числа с плавающей точкой — Город получателя.:*Для тега города '''town''' можно указать код региона в атрибуте '''''regioncode''int''' - для целого числа == Расчет стоимости доставки ==из [[#Справочник регионов|справочника регионов]]. Поиск будет производиться в указанном регионе.

Также можно указать страну получателя в атрибуте '''Пример запроса стоимости доставки:''country'''''<source lang="xml"><?xml version="в соответствии с [https://ru.wikipedia.org/wiki/ISO_3166-1.0" encoding="UTFстандартом ISO_3166-8" ?><calculator> <auth extra="8" login="login" pass="pass" /> <calc pricetype="CLIENT" townfrom="Москва" addressfrom="Ленинский проспект1], например, «RU», 95" zipcode="664000" townto="3800000300000" addressto="Ленина ул«RUS» или «643» для России., 10" pvz="123" l="10" w="20" h="30" mass="3Для формата запроса JSON фильтрация по городу работает только в связке с фильтром по адресу.7" service="1" price="1200" inshprice="1200" paytype="CASH" /></calculator></source>

Параметры:* '''address''' — Фильтр по адресу, работает только в связке с фильтром по городу*'''pricetypehouse''' - тип требуемой цены. Возможные значения: "CLIENT" ( — Фильтр по номеру дома, работает только в связке с фильтрами по-умолчанию) - цена для клиента. "CUSTOMER" - цена для конечного получателя. (пока не поддерживается)адресу и городу*'''townfromparentcode''' - Город отправления — Фильтр по родительскому [[#Справочник филиалов|филиалу]]*'''addressfromacceptcash''' - Адрес отправления — Фильтр по приему наличных YES/NO*'''zipcodeacceptcard''' - Почтовый индекс города назначения — Фильтр по приему банковских карт YES/NO*'''towntoacceptfitting''' - Город назначения — Фильтр по наличию примерки YES/NO*'''addresstomaxweight''' - Адрес назначения — Фильтр по максимальному весу, с которым работает ПВЗ*'''pvzacceptindividuals''' - Код пункта самовывоза  — Фильтр по справочникудоступности физическим лицам YES/NO* '''lt''' — Широта левого верхнего угла* '''lg''' — Долгота левого верхнего угла*'''lrt''' - Длина в сантиметрах (не обязательный параметр) — Широта правого нижнего угла*'''wrg''' - Ширина в сантиметрах (не обязательный параметр) — Долгота правого нижнего угла*'''hjson''' - Высота  — Признак вывода ответа в сантиметрах (не обязательный параметр)виде JSON YES/NO*'''masswith_coords''' - Масса в килограммах — Признак вывода ПВЗ только с наличием координат YES/NO*'''servicelimit''' - Режим доставки - число, указывающее на запись в справочнике [[#Справочник Видов срочности|видов срочности]]. Если этот параметр опустить, система выдаст расчет для всех доступных видов срочности, передав много контейнеров <calc> в ответе — Ограничивает вывод результата.:*'''pricelimitfrom'''  — Задает номер записи результата, начиная с которой выдавать ответ. По- Сумма наложенного платежаумолчанию — 0.:*'''inshpricelimitcount''' - Сумма объявленной ценностиЗадает количество записей результата, которые нужно вернуть. По-умолчанию — 100.:*'''paytypecountall''' - Тип оплаты — YES указывает на необходимость подсчета общего количества найденных совпадений. Это может замедлять выполнение запроса. Если отключено — в ответе не указываeтся totalcount.

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

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

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

<?xml version="1.0" encoding="UTF-8" ?><clientreceiptdata> <auth extra="8" login="testlogin" pass="testmpass" /> <orders> <order orderno="123456" /> <order orderno="890111C" /> </clientorders></sourcereceiptdata>

*'''codeПример ответа получения фискальных данных:''' - Код клиента<source lang="xml">

<?xml version="1.0" encoding="UTF-8"?><receipts count="1"> <receipt> <orderno>123456</orderno> <fdDatetime>2020-06-07 12:14:00</fdDatetime> <fdValue>123</fdValue> <fdNum>456</fdNum> <fnSn>789</fnSn> <kktNum>100</kktNum> <inn>222</inn> <ofdUrl>gate.ofd.ru</ofdUrl> <fullUrl>https://check.ofd.ru/123</fullUrl> <price>12345</price> <lines count="1"> <line> <item>1111764</item> <name>Сапоги</name> <qty>1</qty> <price>1000</price> <vatRate>20</vatRate> <governmentCode>Z16513LK2</governmentCode> <itemType>1</itemType> </line> </lines> </receipt></receipts></source> Параметры ответа:* '''orderno''' — Номер заказа* '''fdDatetime''' — Дата и время пробития фискального чека* '''fdValue''' — ФПД (фискальный признак документа)* '''fdNum''' — ФИСКАЛЬНЫЙ ДОКУМЕНТ (фискальный номер чека)* '''fnSn''' — ФН (номер фискального накопителя)* '''kktNum''' — РН (регистрационный номер кассы)* '''inn''' — ИНН* '''ofdUrl''' — URL адрес (доменное имя) ОФД* '''price''' — Сумма чека* '''fullUrl''' — URL чека для просмотра онлайн* '''lines''' — Позиции чека:* '''item''' — код товара:* '''name''' — наименование товара:* '''qty''' — количество товара:* '''price''' — цена товара:* '''governmentCode''' — считанная последовательность, которая в дальнейшем преобразуется по алгоритму тега 1162:* '''vatRate''' — НДС товара:* '''itemType''' — тип товара (товар, доставка и т. д.) == Справочник Виды срочности =='''Пример запроса списка актов передачи денегвидов срочности:'''<source lang="xml">

<smalistservices> <auth extra="8" login="login" pass="pass" /> <datefrom>2016-02-10</datefrom> <dateto>2016-03-10</dateto></smalistservices>

'''smalistПример ответа справочника видов срочности:''' - Корневой контейнер. Обязательный элемент.*'''auth''' - Авторизация<source lang="xml"><?xml version="1. Обязательный элемент.*'''datefrom''' 0" encoding="UTF- Дата 8"с". Необязательный элемент.?>*'''dateto''' - Дата <services count="по2". Необязательный элемент.> <service> <code>1</code> <name>Эконом</name> </service> <service> <code>2</code> <name>Срочно</name> </service></services>Если интервал дат не указан, то возвращаются акты передачи денег за последний месяц.</source>

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

<smalist countadvprices> <auth extra="8" login="login" pass="1pass"> <sma> <code>6278</code> <number>3992</number> <actdate>2016-02-12</actdate> <datepay></datepay> <dateto>2016-02-12</dateto> <promiseddatepay></promiseddatepay> <price>637.00</price> <pricecorr>113.00</pricecorr> <rur>13430.00</rur> <pricekur>570.00</pricekur> <priceag>67.00</priceag> <payno>42423</payno> <paytype>1</paytype> <paytypename>Безнал</paytypename> <signedcopyreceived>NO</signedcopyreceived> </sma></smalistadvprices>

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

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

<smadetailadvprices> <advprice> <code>1</code> <name>Этажей в доме<auth extra="8" login="login" pass="pass" /name> <type>int</type> </advprice> <advprice> <code>62782</code> <name>Коэффициент надбавки</name> <type>float</type> </advprice> <advprice> <code>3</code> <name>Расписаться на упаковке</name> <type>bool</type> </advprice></smadetailadvprices>

Параметры:* '''code''' — внутренний код услуги* '''smadetailname''' - Корневой контейнер — наименование услуги. Обязательный элементЕсли поле «название в ЛК» в настройках услуги не пусто, то возвращает значение поля «название в ЛК».*'''authhine''' — подсказка по доп услуге для пользователя* '''type''' - Авторизация. Обязательный элемент — тип услуги.Может иметь значения::* '''bool''' — для услуг вида «чекбокс», «Да»:* '''float''' — для числа с плавающей точкой:*'''codeint''' - Код акта передачи денег (см. запрос списка АПД). Обязательный элемент. — для целого числа

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

<?xml version="1.0" encoding="UTF-8" ?><calculator> <auth extra="8" login="login" pass="pass" /> <order> <pricetype>CUSTOMER</pricetype> <sender> <town>Санкт-Петербург</town> <address>Петровка 38 офис 35</address> <coords lat="55.680327" lon="37.604456"></coords> </sender> <receiver> <zipcode>125480</zipcode> <town regioncode="78" country="RU">Санкт-Петербург</town> <address>Петровка 38 офис 35</address> <pvz>124</pvz> <coords lat="55.680327" lon="37.604456"></coords> </receiver> <weight>5.1</weight> <service>2</service> <paytype>CASH</paytype> <price>387.5</price> <deliveryprice>150</deliveryprice> <inshprice>387.5</inshprice> <packages> <package mass="1" quantity="5"></package> <package mass="2.5" length="10" width="20" height="30"></package> </packages> <userid>user123</userid> <groupid>customer</groupid> </order></calculator></source>  Параметры:Структура данных и заполнение полей аналогичны и совместимы с [[#Оформление заказа]]. Дополнительные поля:* '''pricetype''' — тип требуемой цены. Возможные значения: «CUSTOMER» (по-умолчанию) — [[Личный кабинет клиента#Цена доставки для получателя|цена для конечного получателя]], «CLIENT» — цена курьерской службы для клиента.* '''userid''' — Идентификатор пользователя, строковый или числовой тип. Виртуальное поле. Необязательное. Данное поле используется совместно с настройками «Цена доставки для получателя», определяя приоритет правила. Можно использовать в различных CMS/CRM системах, настраивая цены для определенного покупателя.* '''groupid''' — Идентификатор группы пользователя, строковый или числовой тип. Виртуальное поле. Необязательное. Данное поле используется совместно с настройками «Цена доставки для получателя», определяя приоритет правила. Можно использовать в различных CMS/CRM системах, настраивая цены для определенной группы покупателей. Суммы НП и ОЦ, а также тип оплаты CARD имеют значение при настроенных в тарифе на вкладке Прочее долях (в процентах) от данных сумм. В авторизации можно опустить параметры login и pass, тогда расчет будет производиться по стандартному тарифу курьерской службы, без учета возможных отличий для конкретного клиента.<br>Объемный вес будет учитываться только при условии указания всех габаритов: длины, ширины и высоты.<br>В полях город-отправитель и город-получатель можно указывать название города (не рекомендуется!), либо код города из нашего справочника, либо 13-ти значный код КЛАДР, либо 36-ти значный код адресной системы ФИАС (AOID).  '''Пример ответа стоимости доставки:'''<source lang="xml"><?xml version="1.0" encoding="UTF-8"?><calculator> <calc> <townfrom code="1">Москва город</townfrom> <townto code="56603">Иркутск город</townto> <mass>3.7</mass> <service name="Экспресс">1</service> <zone>2</zone> <price>1113</price> <mindeliverydays>1</mindeliverydays> <maxdeliverydays>3</maxdeliverydays> <mindeliverydate>2020-05-13</mindeliverydate> <intervals> <workdays> <interval>10:00-16:00</interval> <interval>16:00-22:00</interval> </workdays> <holidays> <interval>12:00-16:00</interval> </holidays> </intervals> <deliveryprice> <advprice code="1" price="1000">База</advprice> <advprice code="4" price="100">Процент от суммы руб</advprice> <advprice code="5" price="63">Процент от объявленной стоимости</advprice> <advprice code="6" price="-50">Скидка при доставке</advprice> </deliveryprice> </calc></calculator></source> Параметры:* '''townfrom''' — Город-отправитель так, как система его распознала и привязала к справочнику. Атрибут '''code''' — код из справочника городов системы.* '''townto''' — Город-получатель так, как система его распознала и привязала к справочнику. Атрибут '''code''' — код из справочника городов системы.* '''mass''' — Масса в килограммах* '''service''' — Режим доставки — число, указывающее на запись в справочнике видов срочности (см описание на этой странице).* '''zone''' — номер тарифной зоны, по которой рассчиталась стоимость. В зависимости от зоны выбирается тарифная сетка. Так же к цене могут применяться повышающие или понижающие коэффициенты при доставке не из/в региональный центр.* '''price''' — рассчитанная стоимость доставки в валюте прайс-листа курьерской службы. Рекомендуется к использованию в отличие от одноименного атрибута родительского контейнера.* '''maxdeliverydays''' — максимальный срок доставки в рабочих днях.* '''mindeliverydate''' — минимальная дата доставки в учетом выходных дней.* '''intervals''' — список интервалов доставки для соответствующей зоны и режима срочности.* '''deliveryprice''' — Данные по составляющим ценам доставки '''''Обратите внимание:''''' В реальном ответе сервера в теге calc присутствует атрибут «price». Он оставлен для обратной совместимости, не используйте его. Пользуйтесь вложенным тегом price. == Получение информации о клиенте =='''Пример запроса получения информации о клиенте:'''<source lang="xml"><?xml version="1.0" encoding="UTF-8" ?><client> <auth extra="8" login="login" pass="pass" /> </client></source> '''client''' — Корневой контейнер. Обязательный элемент.* '''auth''' — Авторизация. Обязательный элемент. '''Пример ответа на запрос получения информации о клиенте:'''<source lang="xml"><?xml version="1.0" encoding="UTF-8" ?><client> <code>1082</code></client></source> * '''code''' — Код клиента == Список актов передачи денег =='''Пример запроса списка актов передачи денег:'''<source lang="xml"><?xml version="1.0" encoding="UTF-8" ?><smalist> <auth extra="8" login="login" pass="pass" /> <datefrom>2016-02-10</datefrom> <dateto>2016-03-10</dateto></smalist></source> '''smalist''' — Корневой контейнер. Обязательный элемент.* '''auth''' — Авторизация. Обязательный элемент.* '''datefrom''' — Дата «с». Необязательный элемент.* '''dateto''' — Дата «по». Необязательный элемент.Если интервал дат не указан, то возвращаются акты передачи денег за последний месяц. '''Пример ответа на запрос списка актов передачи денег:'''<source lang="xml"><?xml version="1.0" encoding="UTF-8"?><smalist count="1"> <sma> <code>6278</code> <number>3992</number> <actdate>2016-02-12</actdate> <datepay></datepay> <dateto>2016-02-12</dateto> <promiseddatepay></promiseddatepay> <price>637.00</price> <pricecorr>113.00</pricecorr> <rur>13430.00</rur> <pricekur>570.00</pricekur> <priceag>67.00</priceag> <payno>42423</payno> <paytype>1</paytype> <paytypename>Безнал</paytypename> <signedcopyreceived>NO</signedcopyreceived> </sma></smalist></source> * '''code''' — Код акта* '''number''' — Номер акта в системе* '''actdate''' — Дата акта* '''datepay''' — Дата оплаты по акту* '''dateto''' — Дата конечного периода для формирования АПД* '''promiseddatepay''' — Плановая дата оплаты* '''price''' — Стоимость услуг* '''pricecorr''' — Сумма корректировки* '''rur''' — Сумма заказа* '''pricekur''' — Стоимость курьерской доставки* '''priceag''' — Агентское вознаграждение* '''payno''' — Номер платежного поручения* '''paytype''' — Тип оплаты: 1 — безнал, 2 — наличными курьером, 3 — наличными в офисе, 4 — перевод на карту* '''paytypename''' — Строковое представление типа оплаты* '''signedcopyreceived''' — Признак факта возврата акта YES/NO == Детализация актов передачи денег =='''Пример запроса детализации актов передачи денег:'''<source lang="xml"><?xml version="1.0" encoding="UTF-8" ?><smadetail> <auth extra="8" login="login" pass="pass" /> <code>6278</code></smadetail></source> '''smadetail''' — Корневой контейнер. Обязательный элемент.* '''auth''' — Авторизация. Обязательный элемент.* '''code''' — Код акта передачи денег (см. запрос списка АПД). Обязательный элемент. '''Пример ответа на запрос детализации актов передачи денег:'''<source lang="xml"><?xml version="1.0" encoding="UTF-8"?><smadetail count="2"> <specialsma> <code>42494</code> <ordercode>14424</ordercode> <orderno>11111</orderno>

<delivereddate>2018-10-01</delivereddate> <company>Компания</company> <price>314.00</price> <rur>8800.00</rur> <inshprice>314.00</inshprice> <pricekur>270.00</pricekur> <priceag>44.00</priceag> <pricecalc>8486.00</pricecalc> <paytype>2</paytype> <paytypename>наличными курьером</paytypename> <weight>0.400</weight> <distance>0.0</distance> <status>Доставлено</status> </specialsma></smadetail></source> * '''code''' — Код записи.* '''ordercode''' — Код заказа.* '''orderno''' — Шифр заказа.* '''orderdate''' — Дата заказа.* '''delivereddate''' — Дата доставки.* '''company''' — Получатель.* '''price''' — Стоимость услуг.* '''rur''' — Сумма заказа.* '''inshprice''' — Стоимость заказа.* '''pricekur''' — Стоимость курьерской доставки.* '''priceag''' — Агентское вознаграждение.* '''pricecalc''' — Сумма для передачи агенту.* '''paytype''' — Тип оплаты: 1 — безнал, 2 — наличными курьером, 3 — наличными в офисе, 4 — перевод на карту.* '''paytypename''' — Строковое представление типа оплаты* '''weight''' — Вес заказа.* '''distance''' — Дистанция по заказу* '''status''' — Статус заказа. == Генерация коротких ссылок ==В некоторых случаях, например, при использовании в СМС, может потребоваться использование коротких ссылок на ЛК.Для этого, необходимо отправить запрос с полной ссылкой, в ответ на который придёт хэш-код для ссылки. '''Пример запроса генерации коротких ссылок:'''<source lang="xml"><?xml version="1.0" encoding="UTF-8" ?><shortlink> <link short="0"> https://home.courierexe.ru/8/site/orders </link></shortlink></source> '''shortlink''' — Корневой контейнер. Обязательный элемент.* '''link''' — Полная ссылка, для которой необходимо получить код. Обязательный элемент. Если атрибут '''short''' равен 1, то ответ не будет содержать XML, а только хэш-код. '''Пример ответа на запрос генерации коротких ссылок:'''<source lang="xml"><?xml version="1.0" encoding="UTF-8"?><shortlink> <hash>35AF350C</hash></shortlink></source> * '''hash''' — Хэш-код ссылки. Далее, можно использовать ссылку на ЛК: <nowiki>https://home.courierexe.ru/35AF350C или curie.ru/35AF350C</nowiki>  '''Примечание!''' Сервис коротких ссылок работает только для ресурсов компании MeaSoft. == Проверка надежности покупателя ==Проверка надежности работает только для тарифа «Максимум» личного кабинета. <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>

== Генерация коротких ссылок Размещение страниц на своем сайте (iframe) ==

В некоторых случаях, например, при использовании в СМС, может потребоваться использование коротких ссылок имеет смысл разметить те или иные страницы на ЛК.Для этого, необходимо отправить запрос с полной ссылкой, в ответ на который придёт хэш-код для ссылкисвоем сайте.

Например, чтобы клиенты могли рассчитать стоимость доставки не переходя по внешней ссылке, а там же, на сайте, калькулятор можно разместить прямо на странице такого сайта посредством так называемого фрейма — '''Пример запроса генерации коротких ссылок:iframe'''<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''' - Корневой [https://ya.ru/search/?text=iframe Фрейм] — контейнер. Обязательный элемент.*'''link''' - Полная ссылка, для которой необходимо получить код. Обязательный элемент. Если атрибут '''short''' равен 1, то ответ не будет содержать XMLвнутри обычной страницы, а только хэш-кодкоторый позволяет загружать сторонние страницы.Пример загрузки калькулятора:

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

*'''hash''' - Хэш-код ссылки. Далее, Для удобства пользователей вашего сайта можно использовать ссылку указать язык интерфейса (который переключается непосредственно на ЛК: <nowiki>https://home.courierexe.ru/35AF350C или curie.ru/35AF350C</nowiki>  сайте) параметром '''Примечание!lang''' Сервис коротких ссылок работает только для ресурсов компании MeaSoft. == Проверка надежности покупателя == Проверка надежности работает только для тарифа "Максимум" личного кабинета.:

<source lang="xmlhtml"><?xml versioniframe id="1.0frame" encodingsrc="UTF-https://home.courierexe.ru/8" /calculator?><mcheck> <auth extra="8" loginlang=2"login" pass="pass" /> <phones> <phone>89161147992</phone> </phones>Здесь должен отобразиться калькулятор</mcheckiframe>

<source lang="xml">Поддерживаемые языки и их коды:<?xml version=":'''1.0" encoding="UTF-8" ?>''' — русский<mcheck>:'''2''' — английский <phones> <phone rate="90">89161147992</phone> </phones></mcheck></source>:'''4''' — узбекский