Изменения

Перейти к: навигация, поиск

API

67 458 байт добавлено, 24 ноябрь
м
Установка статуса согласования заказа
<div style="font-size: 24px; color: #2424a9; background-color: #deffde; border: 1px solid #ebccd1; padding: 3px 10px 10px; text-align: center">
'''English version is [[API documentationDocumentation|HERE!]]'''
</div>
Вы можете настроить интегацию интеграцию с MeaSoft средствами XML API по протоколу HTTP POST.
API предназначено для интеграции клиентов (интернет-магазинов и прочих компаний-заказчиков доставки) с [http://courierexe.ru/our_clients.htm курьерскими службами], работающими под управлением системы [https://curie.ru/ MeaSoft].
Если вы '''агрегатор''', передающий данные от клиентов, возможно, вам придется последовательно подключаться под разными пользователями, если курьерская служба должна вести раздельный учет взаиморасчетов по клиентам.
== Готовые интеграции ==
Для работы с популярными CMS и CRM-системами разработаны модули интеграции, перечисленные в таблице ниже.
Для работы с популярными CMS и CRM-системами разработаны модули интеграции, перечисленные в таблице ниже.  '''Модули распространяются бесплатно, без гарантий со стороны разработчика''', и не являются средством полной автоматизации взаимодействия с курьерской службой. Модули — Модули — это помощь разработчикам интернет-магазинов в построении интеграции с курьерскими службами. '''Ответственность за корректность передачи данных лежит на интернет-магазине.'''Модули сторонних разработчиков обслуживаются и разрабатываются сторонними компаниями. Все вопросы по их приобретению и поддержке необходимо задавать им.
Сообщайте нам свои пожелания по работе наших модулей. Мы учтем их в новых версиях.
|-
|[[Файл:bitrix.png|center|x44px]]
|style="text-align: center;" |<!--[https://marketplace.1c-bitrix.ru/solutions/measoft.courier/ Установить] <!--> [https://courierexe.ru/download/api/bitrixmeasoft.courier.zip Скачать] -->|Поддерживает версии 1420.5 .0 и выше. Подробнее см. [[Интеграция с другими системами#1C-Битрикс|описание]].
|-
|[[Файл:prestashop.png|center|x60px]]
|style="text-align: center;"|[https://courierexe.ru/download/api/prestashop.zip Скачать]
|Поддерживает версии 1.5.2.0 и выше. Подробнее см. [[PrestaShop|описание]].
|-
|[[Файл:OpencartOCStore.png|center|x60px]]
|style="text-align: center;"|[https://courierexe.ru/download/api/opencart.zip Скачать для версии 1.5.5.1]<br>[https://courierexe.ru/download/api/measoft_oc2.ocmod.zip Скачать для версии 2.0]<br>[https://courierexe.ru/download/api/measoft_oc2.3.ocmod.zip Скачать для версии 2.3]<br>[https://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/ Альтернативный модуль сторонних разработчиков]
|-
|[[Файл:webasyst-shopscript.png|center|x44px]]
|style="text-align: center;"|[https://www.webasyst.ru/store/plugin/shop/measoftcourier/ Установить модуль]<br>[https://www.webasyst.ru/store/plugin/shipping/measoftcourier/ Установить плагин]
|Модуль предназначен для отправки заявок в КС, а плагин для расчета стоимости доставки при оформлении заказа.Инструкции в маркете
|-
<!--|[[Файл:advantshop.png|center|x44px]]
|style="text-align: center;"|[https://promo-z.ru/ Сайт компании PROMO]
|Компания PROMO разработала этот модуль и настраивает интеграцию MeaSoft с ADVANTSHOP своим клиентам.
|- -->
|[[Файл:insales.png|center|x80px]]
|style="text-align: center;"|Настраивается в [[Личный кабинет клиента|ЛК пользователя]]
|[[InSales|Инструкция по настройке]]
|-
|[[Файл:insalesiiko.pngjpg|center|x80px]]
|style="text-align: center;"|Настраивается в [[Личный кабинет клиента|ЛК пользователя]]
|[[Интеграция с другими системами#InSalesIiko|Инструкция по настройке]]
|-
|[[Файл:Leadvertex.png|center|x44px]]
|style="text-align: center;"|[https://blog.leadvertex.ru/news/2110-integraciya-s-kurerkami-na-platforme-measoft Настраивается] в ЛК [https://Leadvertex.ru Leadvertex]
|[[Интеграция с другими системами#LeadVertex|Инструкция по настройке]]<br>Модуль разработан и поддерживается компанией LeadVertex.
|-
|[[Файл:Retailcrm.png|center|x30px]]
|style="text-align: center;"|[https://www.retailcrm.ru/ RetailCRM]
|[https://wiki.courierexe.ru/index.php?title=Интеграция_с_другими_системами#[RetailCRM |Настраивается]] в ЛК пользователя в системе
|-
|[[Файл:1C.jpg|center|x44px]]
|style="text-align: center;"|-
|[https://infostart.ru/public/692790/ Альтернативный модуль сторонних разработчиков(1 версия)] [https://infostart.ru/public/1531484/ Альтернативный модуль сторонних разработчиков (2 версия)]
|-
|[[Файл:Joomla2.jpg|center|x60px]]
|style="text-align: center;"|[https://courierexe.ru/download/api/com_measoft.zip Скачать]
|Работает только с компонентом Virtuemart.Инструкция в архиве
|-
|[[Файл:Amocrm.png|center|x44px]]
|style="text-align: center;"|[https://www.amocrm.ru/extensions/courier2008 Установитьmeasoft Описание на сайте amoCRM]|Подробнее см. Подробное описание настроек читайте [[Интеграция с другими системами#amoCRM|описаниетут]].
|-
|rowspan="2"|[[Файл:MoySclad.jpg|center|x30px]]
|style="height:50px; text-align: center;"|[https://home.courierexe.ru/moysklad/step1 Настроить интеграцию с MeaSoft]|[[Интеграция с другими системами#МойСклад|Инструкция]]
|-
|style="height:50px; text-align: center;"|[https://itmdev.ru/ms/shipping/ Скачать модуль сторонних разработчиков]
|-
|[[Файл:wordpress.jpg|center|x80px]]
|style="text-align: center;"|[https://courierexe.ru/download/apiwordpress/wordpress.zip php Скачать]|[[Интеграция с другими системами#Wordpress|Инструкция]]
|-
|[[Файл:Cscart.png|center|x60px]]
|style="text-align: center;"|[https://marketplace.cs-cart.com/measoft-en.html Установить]
|Поддерживает версии 4.10 и выше.<br>[[Интеграция с другими системами#CS-Cart|Инструкция]]|-|[[Файл:webhooks.jpg|center|x100px]]|style="text-align: center;"|Читайте описание [[Webhook|на этой странице]]|Передача информации о статусах и заказах в вашу систему|-|[[Файл:Logo_tilda_black.png|center|x100px]]|style="text-align: center;"|Читайте описание [[Tilda|на этой странице]]|Работает только на платных тарифах
|-
|}
'''Обратите внимание!''' В модулях систем PrestaShop и Joomla для отправки заказа в курьерскую службу зайдите в карточку заказа. В карточке отображается специальная форма отправки заказа, а если заказ отправлен, она позволяет проверить его статус:[[Файл:Form.png|400 px|Форма отправки заказа|none]]
Для отображения списка пунктов выдачи есть [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], логин: login пароль: pass.
== Рабочий аккаунт для подключения ==
Строка подключения выглядит следующим образом:
Для подключения к площадке Вашего клиента необходимо иметь три параметра: <source lang=xml><auth extra="8" login="login" pass="pass"></auth></source>
1. Описание параметров:* '''Параметр extra''' (Цифровой  — экстра-код, уникальный идентификатор компании. Запросите этот параметр у компании, с которой Вы вы интегрируетесь). Посмотреть этот код можно в интерфейсе программы КС2008 через основное меню * '''login''' — логин клиента;* '''pass''' — пароль клиента;* '''"Справочники - Дополнительные возможности"measoftid''' — системная переменная, используемая системой. Цифровое значение будет указано во второй гиперссылке (на скриншоте ниже отмечено "звездочкой"):
Запросите эти данные у курьерской службы, к которой вы подключаетесь. Курьерская служба передает временный пароль, его нужно сменить после первого входа в [[Файл:extra1.pngЛичный кабинет клиента|750pxЛК клиента]].
2. '''Логин''' - параметр учетной записи для ЛК клиента и API== Авторизация курьерской службы ==Если курьерской службе требуется подключение под своими учетным данными, указывается в карточке клиента на вкладке '''"Прочее"''' в поле '''"Имя пользователя"'''. Возможно, что в программе КС2008 понадобится создать новую карточку клиента (на скриншоте ниже).используйте строку вида:
3. '''Пароль''' - параметр учетной записи для ЛК клиента и API, указывается в карточке клиента на вкладке '''<source lang=xml><auth extra="Прочее8"''' в поле '''login="Парольlogin"''' (на скриншоте ниже).pass="pass" clientcode="123"></auth></source>
Описание:* '''extra''' — уникальный идентификатор компании;* '''login''' — логин курьерской службы;* '''pass''' — пароль курьерской службы;* '''clientcode''' — внутренний код клиента (вкладка '''Клиенты''', столбец «Внутренний код»). Вы можете узнать код экстра, логин и пароль курьерской службы в офисном приложении MeaSoft в справочнике '''Дополнительные возможности'''. Подробнее см. раздел «[[Файл:33_client.pngЛичный кабинет курьерской службы#Подключение|500pxПодключение]]».
== Общие понятия ==
На стороне курьерской службы имеется веб-сервис по адресу: https://home.courierexe.ru/api/. <rspoiler text="Еще есть порт 8443.">Некоторые маршрутизаторы, используемые провайдерами, РНК и прочее, в попытке глубокого анализа могут повреждать трафик на стандартный порт 443. Сделано по тикету 10964.</rspoiler> Обратите внимание на символ '''"«/"»''' (slash) в конце адреса! . Тестовые авторизационные данные: логин: login пароль: pass, параметр extra: 8. Обратите внимание, что тестовая площадка для всех одна. Не нужно передавать в нее заказы с конфиденциальными данными, их смогут увидеть другие участники.
Для использования интеграции в «боевом» режиме, запросите '''логин''', '''пароль''', и параметр '''extra''' у той компании, с которой интегрируетесь.
== Ограничения ==
С целью защиты от нецелевого использования сервисов и DDoS-атак действуют следующие ограничения:
*30 запросов tracking с одного IP-адреса за 1 минуту (используйте statusreq!);*150 запросов с одного IP-адреса/акаунта за 1 минуту;*1500 запросов с одного IP-адреса/акаунта за 20 минут;*3000 запросов с одного аккаунта за 1 час;*200 Мб скачанных текстовых данных за 3 часа.* Превышение количества запросов статусов несуществующих заказов над существующими
В случае превышения IP-адрес или аккаунт блокируется на время до 3-х часов.
Чтобы не происходило блокировок:
* не нужно «бомбить» наше API запросами статусов, последовательно перебирая номера всех ваших заказов, особенно запросами "tracking"«tracking», они предназначены не для этого (смотрите описание). Особенно ровно в 00 минут каждого часа;
* не нужно каждые 5 минут делать запросы «Покажите статусы всех заказов за последние 3 месяца»;
* для проверки статусов заказов лучше всего использовать запросы [[#Передача только изменившихся статусов|измененных статусов changes=ONLY_LAST]];
* при запросе измененных статусов ОБЯЗАТЕЛЬНО нужно подтверждать успешное получение запросом [[#Передача только изменившихся статусов|commitlaststatus]].
* вы должны знать номера заказов, которые вы отправили. Не нужно перебирать номера всех заказов или брутфорсом перебирать все возможные номера.
* нужно проверять с каким ответом возвращаются ваши АПИ-запросы. Если мы отвечаем ошибкой, то даже запрос на создание нового заказа учитывается в количестве запросов.
Мы абсолютно уверены, что данные ограничения на порядки превосходят необходимые объемы предоставления сервиса для решения любых задач. Если у вас возникают проблемы, вы не знаете, как уложиться в эти рамки — рамки — спросите у нас, мы обязательно поможем!
== Оформление заказа ==
 
=== Пример оформления заказа ===
 
<source lang=xml>
<?xml version="1.0" encoding="UTF-8"?>
<coords lat="55.680327" lon="37.604456"></coords>
</receiver>
<returnprice>NO387.5</returnprice> <inshprice>387.5</inshprice> <deliveryprice VATrate="20">150</deliveryprice> <discount>120</discount> <paytype>CASH</paytype>
<weight>5.1</weight>
<return_weight>5.1</return_weight>
<quantity>2</quantity>
<paytype>CASH</paytype>
<service>2</service>
<type>3</type>
<return>NO</return>
<return_service>1</return_service>
<type>3</type>
<return_type>3</return_type>
<return_weight>5.1</return_weight>
<courier>22</courier>
<price>387.5</price> <deliveryprice VATrate="20">150</deliveryprice> <inshprice>387.5</inshprice> <receiverpays>NO</receiverpays> <discount>120</discount>
<enclosure>Детские игрушки</enclosure>
<instruction>Проверить при покупателе, подписать акт</instruction>
<acceptpartially>NO</acceptpartially>
<costcode>cc12345</costcode>
<respstore>4</respstore>
<uid>af11c7c6-6645-4a20-9604-be911a75722d</uid>
<items>
<item extcode="abc123" quantity="1" mass="0.2" retprice="37.5" VATrate="0" barcode="2345625213125" textArticle="1" article="1" volume="3" origincountry="AUT" GTD="321546654" excise="15.20" suppcompany="ООО &quot;Рога и копыта&quot;" suppphone="79161234567" suppINN="1112223334" govType="2" governmentCode="11223311" extraTags="">Мяч</item>
<item extcode="abc124" quantity="2" mass="2" retprice="100" inshprice="100" VATrate="10" barcode="4645625213138" article="2" length="10" width="20" height="30" origincountry="004">Обруч</item>
<item extcode="abc125" quantity="3" mass="0.3" retprice="50" inshprice="50" barcode="2345625213126" itemcode="44123" article="3" type="1">Погремушка желтая</item>
</items>
<packages>
<package strbarcode="ORD0000001" mass="1" message="" quantity="3"></package>
<package strbarcode="ORD0000002" mass="2.5" message="" length="10" width="20" height="30"></package>
</packages>
</advprice>
</advprices>
<extrafields>
<extrafield>
<name>courier_car</name>
<value>ВАЗ 2106, бежевый</value>
</extrafield>
</extrafields>
<overall_volume>81</overall_volume>
<userid>user123</userid>
<groupid>customer</groupid>
</order>
</neworder>
'''Описание полей'''
*'''neworder''' -  — Корневой контейнер, обязательный элемент. :* '''''newfolder''''' — Признак нового заказа YES/NO. Если стоит YES, то в системе курьерской службы для данной корреспонденции создастся новый заказ. Необязательный элемент. * '''order''' — Контейнер для описания одного заказа, обязательный элемент. В одном контейнере '''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''' -  — Информация о отправителе заказа. Необязательный контейнер.
<source lang="xml">
<sender>
</source>
*'''receiver''' -  — Информация о получателе заказа. Обязательный контейнер.
<source lang="xml">
<receiver>
</source>
*'''company''' -  — Компания-получатель.*'''person''' -  — Контактное лицо. ''Должно быть заполнено хотя бы одно из полей - полей — company или person!''*'''phone''' -  — Телефон. Можно указывать несколько телефонов, E-mail в этом поле.*'''town''' -  — Город.* '''pvz''' — Код пункта самовывоза по справочнику. Кроме того, ПВЗ можно указать в строке '''''address''''' в виде::* код ПВЗ в нашей системе:* код ПВЗ в системе подрядчика:* наименование ПВЗ в виде строки "ПВЗ " + «Наименование ПВЗ».  При указании ПВЗ в поле адреса необходимо проверять значение поля город получателя (он должен соответствовать данным ПВЗ) либо не передавать его вообще.
Для тега города '''town''' можно указать код региона в атрибуте '''''regioncode''''' из [[#Справочник регионов|справочника регионов]]. Поиск будет производиться в указанном регионе.
Также можно указать страну получателя в атрибуте '''''country''''' в соответствии с [https://ru.wikipedia.org/wiki/ISO_3166-1 стандартом ISO_3166-1], например, "RU"«RU», "RUS" «RUS» или "643" «643» для России.
Кроме того, поиск города осуществляется с учетом почтового индекса, указанного в теге '''zipcode'''.
:* код населенного пункта из [[#Справочник городов|справочника городов]]
:* 13-ти значный код адресного классификатора КЛАДР
:* 36-ти значный код адресной системы <rspoiler text="ФИАС">Федеральная информационная адресная система — система — единый российский государственный адресный реестр</rspoiler> (AOID)
:* название города (не рекомендуется!)
*'''coords''' -  — Координаты получателя. Если не указаны, система будет геокодировать самостоятельно. * '''zipcode''' — Почтовый индекс.* '''price''' — Сумма заказа (наложенный платеж) - денежные средства, которые курьер должен забрать у получателя в пользу заказчика. В случае наличия контейнера items значение этого параметра будет проигнорировано и рассчитано автоматически.* '''inshprice''' — Объявленная ценность. Если явно не указана сумма — автоматически считается как сумма по товарам.* '''deliveryprice''' — Стоимость доставки, которая устанавливается заказчиком и будет взиматься с получателя в пользу заказчика. Не имеет отношения к стоимости доставки самой курьерской службы, которая рассчитывается в соответствии с тарифамии, не указывается при оформлении заказа и добавляется в заказ автоматически при его обработке курьерской службой. В случае наличия контейнера items в него будет добавлено вложение «Доставка».:* '''''VATrate''''' — Ставка НДС — целое число процентов.* '''discount''' — Сумма скидки. Скидка «размазывается» по товарным вложениям, сумма НП уменьшается на сумму скидки. При этом вложение Скидка не создается. ВНИМАНИЕ, при использовании этого тега общая сумма может расходиться на копейки из-за округления! Старайтесь не использовать этот тег, а указывать цену товаров уже с учетом скидок.* '''paytype''' — Тип оплаты заказа получателем. Принимает значения::* CASH — Наличными при получении (по-умолчанию):* CARD — Картой при получении:* NO — Без оплаты. Этот тип оплаты передается, если заказ уже оплачен и не требует инкассации. API добавит к товарам строку предоплаты в сумму заказа, чтобы общая сумма была 0, однако в кассовом чеке будут все товары с ценами, и оплата предоплатой, как того требует 54-ФЗ.:* OTHER — Прочее (Предусмотрен для того, чтобы оплата поступала непосредственно в курьерскую службу посредством прочих типов оплаты — таких как: вебмани, яденьги, картой на сайте, прочие платежные системы и т. д.):* 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''' - Универсальный идентификатор заказа на стороне отправителя. Не обязательный параметр, ограниченного по времени действия. Время хранения в системе, - сутки. * '''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''''' — Ставка НДС — целое число процентов. Если товар хранится в КС (смотрите '''article''' ниже), значение берется из номенклатуры. Иначе, если значение указано, берется указанное значение, если нет - значение из настроек фирмы КС. Значение «0» означает ставку «Без НДС», ставка «0%» на данный момент не поддерживается.:* '''''barcode''''' — Штрихкод вложения.:* '''''article''''' — Артикул вложения. ''Внимание!'' Указание артикула используется только тогда, когда товар хранится на ответственном хранении в службе доставки, и необходима комплектация. В этом случае система пытается привязать товар к [[API#Справочник номенклатуры|справочнику номенклатуры]]. Если товар в справочнике не найден — система выдаст соответствующую ошибку. Если по артикулу найдено несколько товаров — система выберет один из них случайным образом, что может привести к ошибочной комплектации! Если товар НЕ на ответственном хранении — артикул указывать НЕ нужно. Позиция попадет в систему просто текстом.:* '''''itemcode''''' — Внутренний код товара, может использоваться вместо артикула. ''Внимание!'' Указание кода товара используется только тогда, когда товар хранится на ответственном хранении в службе доставки, и необходима комплектация. В этом случае система пытается привязать товар к [[API#Справочник номенклатуры|справочнику номенклатуры]]. Если товар в справочнике не найден — система выдаст соответствующую ошибку. Если товар НЕ на ответственном хранении — код товара указывать НЕ нужно.:* '''''type''''' — Тип вложения. Принимает значения::: 1 — Товар. По-умолчанию.:: 2 — Доставка. Такое вложение добавится автоматически, если заполнить order->deliveryprice:: 3 — Услуга:: 4 — Предоплата. Указывается сумма. Поле quantity игнорируется, всегда «1». В заказе сумма будет отрицательной независимо от знака в запросе. Такое вложение добавится автоматически при указании order->paytype=NO.:: 6 — Оплата кредитом. Указывается сумма. Поле quantity игнорируется, всегда «1». В заказе сумма будет отрицательной независимо от знака в запросе.:: 7 — Забор товара. Если товар нужно у получателя забрать, возможно — вернуть деньги, или его стоимость вычтется из суммы других товаров. У такого товара в заказе будет отрицательное количество независимо от знака в запросе.:* '''''extcode''''' — Внешний код строки. Используется для идентификации строк заказов при получении статусов. Необязательное поле.:* '''''origincountry''''' — Код страны-производителя в соответствии со [https://ru.wikipedia.org/wiki/ISO_3166-1 стандартом ISO_3166-1], например, «RU», «RUS» или «643» для России.:* '''''GTD''''' — Номер ГТД.:* '''''excise''''' — Сумма акциза.:* '''''suppcompany''''' — Наименование компании поставщика, если отличается от заказчика.:* '''''suppphone''''' — Номер телефона компании поставщика, если отличается от заказчика.:* '''''suppINN''''' — ИНН компании поставщика, если отличается от заказчика.:* '''''governmentCode''''' — Код товарной номенклатуры. Используется для [[Маркировка|маркированных товаров, например («Честный знак»)]]. Для кода '''Честный знак''' Нужно указывать все данные из нанесенного QR-кода кроме не читаемых символов (#29). Если код не известен — укажите знак вопроса «?», тогда курьер отсканирует код фактически передаваемого покупателю товара. Для некоторых процессов может использоваться значение «!» — в этом случае курьер сканирует серийный номер товара, но это не считается кодом маркировки. При этом, если указано значение «?» или «!» и quantity больше 1, то такое вложение растиражируется quantity раз.:* '''''govType''''' — Тип маркировки товара. В данный момент существуют следующие типы маркировки::: 1 — Честный знак. По-умолчанию.:: 2 — ГИИС ДМДК.:: 3 — Серийный номер.:* '''''message''''' — Строка сообщения.:* '''''extraTags''''' — Строка в формате JSON для отправки в ОФД. :: Тэг 1265 - значение отраслевого реквизита = код места деятельности аптеки :: Тэг 1262 – идентификатор ФОИВ = "020" (константа ФОИВ МИНЗДРАВа) :: Тэг 1263 - дата нормативного акта федерального органа исполнительной власти = "14.12.2018" (константа) :: Тэг 1264 - номер нормативного акта федерального органа исполнительной власти = "1556"(константа) :: Тэг 1212 - Признак предмета расчета :: Пример: <source lang="json">"item_industry_props":{"tag1262":"020","tag1263":"14.12.2018","tag1264":"1556","tag1265":"tm=mdlp&sid=00000000XXXXXX"},"tag1212": "1"</source>  Для клиентов из '''Узбекистана''' необходимо указывать код ИКПУ и код упаковки в следующем формате:<source lang="json">"ikpu":"123123123","packageCode":"123456"</source>
*'''paytype''' - Тип оплаты заказа получателем. Принимает значения:
:* CASH - Наличными при получении (по-умолчанию)
:* CARD - Картой при получении
:* NO - Без оплаты. Этот тип оплаты передается, если заказ уже оплачен и не требует инкассации. API добавит к товарам строку предоплаты в сумму заказа, чтобы общая сумма была 0, однако в кассовом чеке будут все товары с ценами, и оплата предоплатой, как того требует 54-ФЗ.
:* OTHER - Прочее (Предусмотрен для того, чтобы оплата поступала непосредственно в курьерскую службу посредством прочих типов оплаты - таких как: вебмани, яденьги, картой на сайте, прочие платежные системы и т.д.)
:* OPTION - На выбор получателя. Этот тип оплаты нельзя передавать с заказом. Он выставляется автоматически в зависимости от настройки клиента.
*'''zipcode''' - Почтовый индекс.
*'''weight''' - Общий вес заказа в килограммах.
*'''return_weight''' - Общий вес возврата заказа в килограммах.
*'''quantity''' - Количество мест.
*'''service''' - Режим доставки (тип услуги) передается код из справочника [[#Справочник Видов срочности|"Виды срочности"]].
*'''return_service''' - Режим возврата (тип услуги) передается код из справочника "Виды срочности".
*'''type''' - Тип корреспонденции (отправления) передается код из справочника "Типы корреспонденции".
*'''return_type''' - Тип возвратной корреспонденции (отправления) передается код из справочника "Типы корреспонденции".
*'''price''' - Сумма заказа. В случае наличия контейнера items значение данного параметра будет проигнорировано, и рассчитано автоматически.
*'''deliveryprice''' - Сумма доставки. В случае наличия контейнера items, в него будет добавлено вложение "Доставка".
:* '''''VATrate''''' - Ставка НДС - целое число процентов.
*'''return''' - Признак необходимости возврата.
*'''return_service''' - Режим возврата (тип услуги) передается код из справочника "Виды срочности".
*'''discount''' - Сумма скидки. Скидка "размазывается" по товарным вложениям, сумма НП уменьшается на сумму скидки. При этом вложение Скидка не создается. ВНИМАНИЕ, при использовании этого тега общая сумма может расходиться на копейки из-за округления! Старайтесь не использовать этот тег, а указывать цену товаров уже с учетом скидок.
*'''enclosure''' - Вложение.
*'''inshprice''' - Объявленная ценность. Если явно не указана сумма - автоматически считается как сумма по товарам.
*'''instruction''' - Поручение - Примечание.
*'''courier''' - Запланированный курьер. Согласно коду курьера в КС2008.
*'''receiverpays''' - Признак оплаты стоимости доставки - услуг службы доставки получателем, а не заказчиком YES/NO.
*'''department''' - Подразделение, в котором оформляется заказ.
*'''pickup''' - Признак оформления забора YES/NO. Если стоит YES, то весь заказ считается заданием на забор груза, а не на доставку! Применяется для вызова курьера к отправителю для забора других отправлений.
*'''acceptpartially''' - Признак возможности частичного выкупа товаров отправления YES/NO.
*'''itemspackages''' -  — Контейнер для описания вложениймест. <rspoiler text="Необязательный контейнер">Если для поставщика товара в системе MeaSoft не указаны полное наименование компании и ИНН в карточке клиента, заполните параметры <code>suppcompany</code> и <code>suppINN</code> в этом контейнере. Отсутствие информации о поставщике приведет к [[Настройка модуля печати кассовых чеков#Ошибка фискализации (ошибка программирования реквизита 1226)|ошибке фискализации]].</rspoiler>. Атрибуты::* '''''itempackage''''' -  — Название вложенияместа.:* '''''quantitycode''''' - Количество единиц товара — Внутренний код строки.:* '''''massstrbarcode''''' - Масса единицы товара в килограммах — Штрихкод места.:* '''''volumemass''''' - Объемный вес единицы товара  — Масса места в килограммах. При указании объемного веса значение подставляется вместо массы:* '''''lengthmessage''''' - Длина единицы товара (в сантиметрах) — Строка сообщения.:* '''''widthlength''''' - Ширина единицы товара  — Длина товарного места (в сантиметрах).:* '''''heightwidth''''' - Высота единицы товара  — Ширина товарного места (в сантиметрах).:* '''''retpriceheight''''' - Цена единицы товара. Округляется до копеек. Должна быть с учетом всех скидок и наценок. Для вложений типов 1, 2, 3 не может быть отрицательной. <!-- , либо мы сами посчитаем скидку при указании тега order->discount -->:* '''''inshprice''''' - Объявленная ценность единицы товара. Округляется до копеек. Если не указана принимается равной '''''retprice'''''.:* '''''VATrate''''' - Ставка НДС - целое число процентов. Если значение не указано, подставляется значение "20". Значение "0" означает ставку "Без НДС", ставка "0%" на данный момент не поддерживается.:* '''''barcode''''' - Штрих-код вложения. [[Файл:Article.png|thumb|100px|right]]:* '''''article''''' - Артикул вложения. ''Внимание!'' Указание артикула используется только тогда, когда товар хранится на ответственном хранении  — Высота товарного места (в службе доставки, и необходима комплектация. В этом случае система пытается привязать товар к [[API#Справочник номенклатуры|справочнику номенклатуры]]. Если товар в справочнике не найден - система выдаст соответствующую ошибку. Если по артикулу найдено несколько товаров - система выберет один из них случайным образом, что может привести к ошибочной комплектации! Если товар НЕ на ответственном хранении - артикул указывать НЕ нужно. Позиция попадет в систему просто текстомсантиметрах).:* '''''itemcodequantity''''' - Внутренний код товара, может использоваться вместо артикула — Количество мест с данным набором параметров. ''Внимание!'' Указание кода товара используется только тогда, когда товар хранится Действует ограничение на ответственном хранении в службе доставки, и необходима комплектация. В этом случае система пытается привязать товар к [[API#Справочник номенклатуры|справочнику номенклатуры]]. Если товар в справочнике не найден - система выдаст соответствующую ошибку. Если товар НЕ на ответственном хранении - код товара указывать НЕ нужно.:* '''''type''''' - Тип вложения. Принимает значения::: 1 - Товар. По-умолчанию.:: 2 - Доставка. Такое вложение добавится автоматически, если заполнить order->deliveryprice:: 3 - Услуга:: 4 - Предоплата. Указывается сумма. Поле quantity игнорируется, всегда "1". В заказе сумма будет отрицательной независимо от знака общее количество мест в запросе. Такое вложение добавится автоматически при указании order->paytype=NO.:: 6 - Оплата кредитом. Указывается сумма. Поле quantity игнорируется, всегда "1". В заказе сумма будет отрицательной независимо от знака в запросе.:: 7 - Забор товара. Если товар нужно у получателя забрать, возможно - вернуть деньги, или его стоимость вычтется из суммы других товаров. У такого товара Общее количество мест в заказе будет отрицательное количество независимо от знака в запросе.:* '''''extcode''''' - Внешний код строки. Используется для идентификации строк заказов при получении статусов. Необязательное поле.:* '''''origincountry''''' - Код страны-производителя в соответствии со [https://ru.wikipedia.org/wiki/ISO_3166-1 стандартом ISO_3166-1], например, "RU", "RUS" или "643" для России.:* '''''GTD''''' - Номер ГТД.:* '''''excise''''' - Сумма акциза.:* '''''suppcompany''''' - Наименование компании поставщика, если отличается от заказчика.:* '''''suppphone''''' - Номер телефона компании поставщика, если отличается от заказчика.:* '''''suppINN''''' - ИНН компании поставщика, если отличается от заказчика.:* '''''governmentCode''''' - Код товарной номенклатуры. Используется для [[Маркировка | маркированных товаров ("Честный знак")]]. Нужно указывать все данные из нанесенного QR-кода кроме не читаемых символов (#29). Если код не известен - укажите знак вопроса "?", тогда курьер отсканирует код фактически передаваемого покупателю товара. Для некоторых процессов может использоваться значение "!" - в этом случае курьер сканирует серийный номер товара, но это не считается кодом маркировки. Если поле заполнено - поле quantity должно содержать только "1", иначе вернется ошибкабыть больше 1000.
*'''packagesdeliveryset''' - Контейнер для описания мест. Необязательный контейнер — настройка [[Дифференцированная стоимость доставки|дифференцированной стоимости доставки]]. Атрибуты::* '''''package''''' - Название места.:* '''''code''''' - Внутренний код строки.:* '''''strbarcode''''' - Штрих-код места.:* '''''massabove_price''''' - Масса места  — стоимость в килограммах.:* '''''message''''' - Строка сообщения.:* '''''length''''' - Длина товарного места случае полного выкупа заказа (действует как «сумма от» последней границы, указанной в сантиметрахтеге below_sum).:* '''''widthreturn_price''''' - Ширина товарного места ( — стоимость в сантиметрах).случае возврата заказа:* '''''heightVATrate''''' - Высота товарного места (в сантиметрах) — Ставка НДС — целое число процентов.
* '''deliverysetbelow''' - настройка [[Дифференциальная стоимость доставки | дифференциальной  — граница стоимости доставки]]. Атрибуты:настроек:* '''''above_pricebelow_sum''''' - стоимость в случае полного выкупа  — граница стоимости выкупаемого заказа (действует как "сумма от" последней границы, указанной в теге below_sum):* '''''return_priceprice''''' -  — стоимость в случае возврата выкупаемого заказа:* '''''VATrate''''' - Ставка НДС - целое число процентов.до соответствующей границы
* '''belowadvprices''' - граница стоимости настроек — Контейнер для описания дополнительных услуг. Необязательный элемент. <span style="color: red;>Для обработки в API включите дополнительные услуги в настройках полей [[Личный кабинет курьерской службы#Настройка личного кабинета клиента|заказов и заборов]]</span>:* '''''below_sumcode''''' - граница стоимости выкупаемого заказа — код услуги.:* '''''pricevalue''''' - стоимость выкупаемого заказа до соответствующей границы — значение услуги. Если тип услуги bool, то в значении передаем true.
* '''advpricesextrafields''' -  — Контейнер для описания дополнительных услуграсширенных полей. Необязательный элемент. <span style="color: red;>Для обработки в API включите дополнительные услуги в настройках полей [[Личный_кабинет_курьерской_службы#Настройка личного кабинета клиента|заказов и заборов]]</span>Может содержать несколько элементов extrafield* '''extrafield''' — Контейнер для описания расширенного поля.:* '''''codename'''''  — наименование переменной. Может содержать только латинские буквы, цифры и знак подчеркивания "_", но начинаться может только с буквы. Максимальная длина - код услуги20 символов.:* '''''value''''' -  — значение услугипеременной. Если тип услуги bool, то в значении передаем trueМаксимальная длина - 250 символов.
*'''costcodeoverall_volume''' - Кост-код сотрудника — Общий объем, м3. Виртуальное поле. Необязательное. Из этого поля рассчитывается длина/высота/ширина места. Расчет срабатывает только если в каждом месте есть нулевые значения длины или высоты или ширины.
*'''overall_volumeuserid''' - Общий объем — Идентификатор пользователя, м3строковый или числовой тип. Виртуальное поле. Необязательное. Из этого поля рассчитывается длина/высота/ширина местаДанное поле используется совместно с настройками «Цена доставки для получателя», определяя приоритет правила. Расчет срабатывает только если Можно использовать в каждом месте есть нулевые значения длины или высоты или шириныразличных 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 - barcode — штрихкод заказа.
'''Пример успешного ответа'''
</source>
== Запрос статуса заказов =Коды и описание ошибок =  === Пример запроса статуса заказа =={|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> <orderno2>5678</orderno2> <ordercode>34234</ordercode>|3||Specify a valid «Price» field value.||Укажите корректное значение поля «Сумма». <givencode>234534</givencode>|- <datefrom>2016-07-21</datefrom>|4||Specify a valid «Weight» field value.||Укажите корректное значение поля «Вес». <dateto>2016|-07-21</dateto> <target>Автозавод</target> <done>ONLY_NOT_DONE<|5||Recepient city/done>town not found.||Город назначения не найден. <changes>ONLY_LAST</changes>|-<|6||Sender city/statusreq>town not found.||Город отправления не найден.</source>|- === Описание полей запроса статуса === '''statusreq''' - Корневой контейнер|7||Specify the «Recipient address» field value. Обязательный элемент||Укажите значение поля «Адрес получателя».*'''auth''' - Авторизация. Обязательный элемент.|-*'''client''' - Признак клиента или агента|8||Specify the «Recipient phone» field value. Необязательный элемент||Укажите значение поля «Телефон получателя».:* CLIENT |- Признак клиента, значение по умолчанию:* AGENT - Признак агента|9||Specify the «Recipient name» field value.||Укажите значение поля «ФИО получателя». В ответ отдается информация по заказам, переданным агенту на доставку*'''orderno''' |- Номер заказа. Необязательный элемент.*'''ordercode''' - Внутренний код заказа|10||Specify a valid «Quantity» field value. Необязательный элемент||Укажите корректное значение поля «Количество».*'''orderno2''' |- Номер заказа из срочных|11||Specify a valid «Declared value» field value. Необязательный элемент||Укажите корректное значение поля «Объявленная ценность».*'''datefrom''' |- Дата заказа "с"|12||Supplier SKU ID not found. Необязательный элемент||Артикул не найден.*'''dateto''' |- Дата |17||Order number already exists in the database.||Такой номер заказа "по". Необязательный элементуже есть в базе.*'''target''' |- Строка поиска|18||Order code already exists in the database. Позволяет указать текст, который содержится ||Такой код заказа уже есть в названии компании или адресе получателябазе.*'''done''' |- Может принимать значения: :* ONLY_DONE |19||The delivery date format is not valid. Specify a date in YYYY- Только доставленные (имеются в виду успешные статусы, например, '''Доставлен''' или '''Частично доставлен''')MM-DD format.||Укажите значение поля «Дата доставки» в формате гггг-мм-дд.:* ONLY_NOT_DONE |- Только не доставленные (заказы, которые не являются доставленными, например, '''Не доставлен''' или '''Утерян'''):* ONLY_NEW |20||Specify a valid «Delivery mode» field value.||Укажите корректное значение поля «Режим доставки».|- Только новые:* ONLY_DELIVERY - Только заказы в обработке - заказы, находящиеся в любом статусе, кроме конечных: Доставлено, Не доставлено, Отменён и т|21||Specify a valid «Return trip mode» field value.д||Укажите корректное значение поля «Режим возврата».:* ''Пусто'' |- все корреспонденции *'''changes''' - может принимать |22||Specify a valid «Delivery type» field value.||Укажите корректное значение только ONLY_LASTполя «Тип доставки». Если указан этот параметр, все остальные игнорируются|-|23||Specify a valid «Return shipment type» field value. Описание данного режима приведено здесь: [[#Передача только изменившихся статусов|Передача только изменившихся статусов]]|Укажите корректное значение поля «Тип возврата».|-|30||Specify the «Order number» field value.||Укажите значение поля «Номер заказа».<div style="color: #a94442; background|-color: #f2dede; border: 1px solid #ebccd1; padding: 3px 10px 10px;">'''Обратите внимание!'''|31||Specify the «Barcode» field value.||Укажите значение поля «Штрихкод».|-# Периода запроса статусов (контейнеры '''datefrom''' и '''dateto''') ограничивается двумя месяцами &mdash; два месяца до даты '''"по"'''|32||Specify the «Sender company» field value.||Укажите значение поля «Компания-отправитель».# Если не указаны обе даты &mdash; '''dateto''' принимается равной текущей дате|-|33||Specify the «Sender name» field value.||Укажите значение поля «ФИО отправителя».# Если не указана дата '''dateto''' &mdash; она принимается равной '''datefrom''' плюс 2 месяца|-|34||Specify the «Sender phone» field value.||Укажите значение поля «Телефон отправителя».# Если не указана дата '''datefrom''' &mdash; она принимается равной '''dateto''' минус 2 месяца|-|35||Specify the «Sender city/town» field value.||Укажите значение поля «Город отправителя».</div>|-<br />|36||Specify the «Sender address» field value.||Укажите значение поля «Адрес отправителя».|-=== Примеры ответов === |37||Specify the «Pickup date» field value.||Укажите значение поля «Дата забора».|-'''Пример успешного ответа'''|38||Specify the «Pickup time from» field value.||Укажите значение поля «Время забора с».|-<source lang="xml"><?xml version="1|39||Specify the «Pickup time to» field value.0" encoding="UTF||Укажите значение поля «Время забора до».|-8"?><statusreq count="23">|40||Specify the «Recipient company» field value.||Укажите значение поля «Компания-получатель». <order orderno="111111" awb="qwerty" orderno2="123123" ordercode="34534234" givencode="2345334">|- <barcode>111111</barcode> <sender> <company>МВД</company> <person>Иванов И|41||Specify the «Recipient name» field value.И||Укажите значение поля «ФИО получателя».</person> <phone>123-45|-67</phone> <contacts>|42||Specify the «Recipient phone» field value.||Укажите значение поля «Телефон получателя». <phone>+74951234567</phone>|- <|43||Specify the «Recipient city/contacts>town» field value.||Укажите значение поля «Город получателя». <town code="23432">Санкт|-Петербург</town> <address>Петровка 38 офис 35</address>|44||Specify the «Recipient address» field value.||Укажите значение поля «Адрес получателя». <date>2014|-03-22</date> <time_min>09:00</time_min> <time_max>14:00</time_max> </sender> <receiver> <company>МВД</company> <person>Иванов И|45||Specify the «Delivery date» field value.И||Укажите значение поля «Дата доставки».</person> <phone>123|-45-67 - Иван (916)234|46||Specify the «Delivery time from» field value.45||Укажите значение поля «Время доставки с».21 Петр,mvd@mail.ru</phone> <contacts>|- <phone>+74951234567</phone> <phone>+79162344521</phone> <email>mvd@mail|47||Specify the «Delivery time to» field value.||Укажите значение поля «Время доставки до».ru</email> </contacts>|- <inn>1112223335</inn>|48||Specify the «Recipient postcode» field value.||Укажите значение поля «Индекс получателя». <zipcode>125480</zipcode>|- <town code="153361" regioncode="78" regionname="Санкт|49||Specify the «Weight» field value.||Укажите значение поля «Вес».|-Петербург город">Санкт-Петербург город</town> <address>Петровка 38 офис 35</address>|50||Specify the «Payment type» field value.||Укажите значение поля «Тип оплаты». <pvz>|- <code>126</code>|51||Specify the «Quantity» field value.||Укажите значение поля «Количество». <clientcode>QWERTY</clientcode>|- </pvz> <date>2014|52||Specify the «Amount» field value.||Укажите значение поля «Сумма».|-03-22</date> <time_min>09:00</time_min>|53||Specify the «Declared value» field value.||Укажите значение поля «Объявленная стоимость». <time_max>14:00</time_max>|- <coords lat="55|54||Specify the «Description» field value.680327" lon="37||Укажите значение поля «Описание».604456"></coords> <deliveryPIN>1234</deliveryPIN>|- </receiver> <pickup>NO</pickup>|55||Specify the «Instruction» field value.||Укажите значение поля «Поручение».|- <weight>5|56||Specify the «Delivery mode» field value.||Укажите значение поля «Режим доставки».1</weight> <return_weight>5.1</return_weight>|- <quantity>2</quantity>|57||Specify the «Shipment type» field value.||Укажите значение поля «Тип отправления». <paytype>CASH</paytype>|- <service>2</service> <return_service>2</service>|58||Specify whether return trip is required.||Укажите значение поля «Необходимость возврата». <type>3</type>|- <return_type>3</return_type>|59||Specify the «Return trip mode» field value.||Укажите значение поля «Режим возврата» <waittime>12</waittime>|- <price>387|60||Specify the «Return shipment type» field value.||Укажите значение поля «Тип возврата».5</price> <print_check>YES</print_check>|- <inshprice>387|61||Specify barcode.||Укажите штрихкод.5</inshprice> <enclosure>Детские игрушки</enclosure>|- <instruction>Проверить при покупателе, подписать акт</instruction> <currcoords lat="55|62||Specify item weight.680327" lon="37||Укажите массу единицы товара.604456" accuracy="50" RequestDateTime="2014|-04|63||Specify item quantity.||Укажите количество товара.|-21 18:07:45"></currcoords> <courier>|64||Specify item price.||Укажите цену единицы товара. <code>26</code>|- <|65||Specify item name>Иванов Владимир Петрович</name>.||Укажите название товара. <phone>+79161234567</phone>|- </courier>|66||Wrong XLS file||Некорректный файл XLS. <deliveryprice total="158|-|67||Order barcode already exists in the database.6" delivery="100||Такой штрихкод заказа уже есть в базе.00" return="58.6"> <advprice code="1" price="150">База</advprice>|- <advprice code="2" price="0">% от объявленной стоимости</advprice>|68||Select the «Payment by recipient» field value.||Укажите значение поля «Оплата получателем».|- <advprice code="3" price="8|69||Specify department.6">Топливный сбор</advprice>||Укажите отдел.|- <advprice |70||Specify service partner code="4" price="0">Округление</advprice>.||Укажите значение поля «Код подрядчика». </deliveryprice>|- <receiverpays>NO</receiverpays>|71||Date cannot be earlier than tomorrow.||Дата не может быть раньше чем завтра. <acceptpartially>NO</acceptpartially>|- <status eventstore="филиал в Санкт-Петербурге" eventtime="2016|72||Date cannot be later than 15 days from now.||Дата не может быть позже чем через 15 дней.|-06|73||Date cannot be earlier than today.||Дата не может быть раньше чем сегодня.|-02 17:22:00" createtimegmt="2016|74||Date cannot be later than {0} days from now.||Дата не может быть позже, чем через {0} дней.|-06|75||Specify a valid «Item weight» field value.||Укажите корректное значение поля «Масса единицы товара».|-03 16:14:44" message="" title="Доставлен">COMPLETE</status> <statushistory>|76||Specify a valid «Quantity» field value.||Укажите корректное значение поля «Количество товара». <status eventstore="Офис в Москве" eventtime="2016|-05|77||Specify a valid «Item price» field value.||Укажите корректное значение поля «Цена единицы товара».|-30 10:20:00" createtimegmt="2016-06-03 16:14:44" message="" title="Новый">NEW</status> <status eventstore="Офис в Москве" eventtime="2016|78||Specify a valid «Delivery time from» field value.||Укажите корректное значение поля «Время доставки с».|-06-01 17:38:00" createtimegmt="2016|79||Specify a valid «Delivery time to» field value.||Укажите корректное значение поля «Время доставки до».|-06|80||Specify a valid «Pickup time from» field value.||Укажите корректное значение поля «Время забора с».|-03 16:14:44" message="филиал в Санкт-Петербурге" title="Планируется отправка">DEPARTURING</status> <status eventstore="Офис в Москве" eventtime="2016|81||Specify a valid «Pickup time to» field value.||Укажите корректное значение поля «Время забора до».|-06-01 19:53:00" createtimegmt="2016|82||Specify a valid «Pickup point» field value.||Укажите корректное значение поля «ПВЗ».|-06-03 16:14:44" message="филиал |83||Duplicate number in the registry.||Дублирование номера в Санктреестре.|-Петербурге" title="Отправлено со склада">DEPARTURE</status> <status eventstore="филиал |84||Duplicate barcode in the registry.||Дублирование штрихкода в Санктреестре.|-Петербурге" eventtime="2016-06|85||Specify a valid «Weight at return trip» field value.||Укажите корректное значение поля «Вес возврата».|-02 07:41:00" createtimegmt="2016-06|86||Specify the «Weight at return trip» field value.||Укажите значение поля «Вес возврата».|-03 16:14:44" message="" title="Получен складом">ACCEPTED</status> <status eventstore="филиал в Санкт|87||Order weight exceeds the allowed maximum for the pickup point.||Вес превышает допустимое значение для этого ПВЗ.|-Петербурге" eventtime="2016|88||Pickup date cannot be earlier than today.||Дата забора не может быть раньше чем сегодня.|-06|89||Specify a later delivery date.||Укажите более позднюю дату доставки.|-02 09:17:00" createtimegmt="2016|90||Inappropriate «Weight» or «Pay type» field value for the selected city or town. Please review and correct the values.||Значение поля «Масса» или «Тип оплаты» для выбранного города указано некорректно или отсутствует. Проверьте значения и исправьте.|-06-03 16:14:44" message="" title="Выдан курьеру на доставку">DELIVERY</status> <status eventstore="филиал в Санкт|91||{deliverytype} {deliverydate} is {holidaytype}. Select another date.||{deliverytype} {deliverydate} является {holidaytype}. Выберите другую дату.|-Петербурге" eventtime="2016|92||{deliverytype} {deliverydate} is {holidaytype}. Select another date.||{deliverytype} {deliverydate} является {holidaytype}. Выберите другую дату.|-06|93||Add items.||Добавьте товары.|-02 17:22:00" createtimegmt="2016|95||The selected pickup point only allows paid orders.||Выбранный ПВЗ выдает только предоплаченные заказы.|-06-03 16:14:44" message="" title="Доставлен |96||Order barcode exceeds the allowed maximum (предварительно25)">COURIERDELIVERED</status>symbols.||Длина штрихкода заказа превышает максимально допустимую (25 символов). <status eventstore="филиал в Санкт|-Петербурге" eventtime="2016|97||The pickup date format is not valid. Specify a date in YYYY-06MM-02 17:22:00" createtimegmt="2016DD format.||Укажите значение поля «Дата забора» в формате гггг-06мм-03 16:14:44" message="" title="Доставлен">COMPLETE</status>дд. </statushistory>|- <customstatecode>2<customstatecode> <clientstatecode></clientstatecode>|98||Specify the cost code.||Укажите значение поля «Кост-код». <costcode>cc12345</costcode>|- <receipt fdNum="124555" fnSn="9289000100295555" kktNum="0001611984048555" inn="7722756555" fdValue="2899551555" summ="387|99||The item is not in stock.||Товар отсутствует на складе.|-|100||Set the quantity of the item marked with Chestny ZNAK to one.5" ofdUrl="gate||Укажите количество товара, маркированного кодом «Честный ЗНАК», равным единице.ofd.ru">https://ofd.ru/rec/7722756555/0001611984048555/9289000100295555/124555/2899551555</receipt> <deliveredto>Иванова, секр.</deliveredto> <delivereddate>2016|-06-02</delivereddate> <deliveredtime>17:22</deliveredtime>|101||Quantity of item Delivery cannot be greater than 1||Количество вложений типа «Доставка» не может быть более 1. <arrival>2016-05|-02 23:21</arrival> <outstrbarcode>EXT123456</outstrbarcode>|102||А database error occurred. Please try later again.||Ошибка базы данных. Попробуйте позже. <return_message>Доставлено в целости</return_message>|- <department>Отдел</department>|103||Order not found.||Заказ не найден. <items>|- <item code="34533" extcode="abc123" quantity="1" mass="0|104||Cannot edit order in the current status.||Невозможно изменить заказ в текущем статусе.|-|105||Discount cannot be greater than the order amount.2" retprice="37Specify a smaller value.5" VATrate="0" barcode="2345625213125" article="1" returns="0" origincountry="040" GTD="" excise="0||Размер скидки не может превышать сумму заказа. Укажите меньшее значение скидки.|-|106||Specify the correct additional service code.||Укажите корректный код дополнительной услуги.00" governmentCode="11223311" suppcompany="Поставщик" suppINN="1112223334" suppphone="79161234567">Мяч</item> <item code="34456" extcode="abc124" quantity="2" mass="2" retprice="100" VATrate="10" barcode="4645625213138" article="2" returns="0" governmentCode="">Обруч</item>|-|107||Specify the correct additional service name.||Укажите корректное значение поля [advprice][value].|-|108||Specify the «Additional services» field value.||Укажите значение поля «Дополнительные услуги». <item code="34421" extcode="abc125" quantity="3" mass="0|-|110||Specify the correct TIN.||Укажите корректный ИНН.|-|111||Specify the correct IIN (KZ).||Укажите корректный ИИН (КЗ).3" retprice="50" VATrate="18" barcode="2345625213126" itemcode="44123" article="3" returns="0" governmentCode="">Погремушка желтая</item> </items>|- <packages>|112||Specify the overall volume.||Укажите общий объем. <package code="33331" strbarcode="ORD0000001" mass="1" message="" got="YES"></package>|- <package code="33332" strbarcode="ORD0000002" mass=|113||Cannot apply the delivery mode. Select another delivery mode.||Режим доставки не подходит для заказа. Выберите другой режим.|-|114||The pickup point does not support the selected delivery mode. Specify another pickup point.||ПВЗ не подходит для выбранного режима доставки. Укажите другой ПВЗ.|-|115||Specify a valid recipient phone number.||Укажите корректный телефон получателя.|-|116||Specify recipient PIN code.||Укажите пин-код получателя.|-|117||Order date cannot be earlier than {0}. Specify another date.||Дата заказа не может быть раньше {0}. Укажите другую дату.|-|118||Pickup date cannot be earlier than {0}. Specify another date.||Дата забора не может быть раньше {0}. Укажите другую дату.|-|119||Specify the correct item type.||Укажите корректный тип вложения.|-|120||The pickup point does not accept payment by card.||В выбранном ПВЗ оплата картой не принимается.|-|121||Invalid item code format||Неверный формат кода товарной номенклатуры|-|122||Pickup time cannot be earlier than {0} hours.||Время забора не может быть раньше чем через {0} часа.|-|123||Pickup interval cannot be less than {0} minutes.||Интервал времени забора не может быть менее {0} минут. Укажите корректный интервал.|-|124||Specify a valid "Payment type"2.5" messagefield value.||Укажите корректное значение поля «Тип оплаты».|-|125||Recepient city/town by postcode not found.||Город получателя по его индексу не найден.|-|126||Incorrect items prepayment and pickup.||Заказ не может содержать только вложения «Предоплата» и «Забор».|-|127||Package limit exceeded||Превышен лимит количества мест|-|128||Quantity of item Prepayment cannot be greater than 1||Количество вложений типа «Предоплата» не может быть больше 1.|-|129||Sum of cod must be equal sum of items||Объявленная стоимость должна быть равна сумме вложений.|-|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.||Дублирование кода дополнительной услуги в заказе|-|144||Incorrect extrafields.||Некорректные расширенные поля.|-|} === Передача значений полей в форме создания заказа в Личном Кабинете через GET параметры ===Если вам требуется передавать значения полей в форме создания заказа в Личном Кабинете через GET параметры, то вы можете подробно ознакомиться с этим на данной странице - [[Личный_кабинет_клиента#Передача и подстановка значений полей формы создания заказа через GET параметры]] == Запрос статуса заказов ="" got="NO"></package> </packages> </order></statusreq> </source> '''Пример ответа если нет заказов'''
=== Пример запроса статуса заказа ===
<source lang="xml">
<?xml version="1.0" encoding="utfUTF-8"?><statusreq count> <auth extra="08"login="login" pass="pass"></auth> <client>CLIENT</statusreqclient> <orderno>1234</sourceorderno> <orderno2>5678</orderno2>'''Пример ответа при ошибке авторизации''' <ordercode>34234</ordercode> <givencode>234534</givencode> <source lang="xml"uid>af11c7c6-6645-4a20-9604-be911a75722d</uid> <datefrom>2016-07-21</datefrom> <?xml version="1.0" encoding="utfdateto>2016-07-8"?21</dateto> <target>Автозавод</target> <done>ONLY_NOT_DONE</done> <changes>ONLY_LAST</changes> <conditions> <namecontains/> <namestarts/> <request/conditions> <error error="1" errormsg="authorization error"limit>500</errorlimit></requeststatusreq>
</source>
=== Описание полей запроса статуса ==='''Пример ответа 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* '''changes''' — может принимать значение только ONLY_LAST.0" encoding="UTF-8"?><request> <error>columnЕсли указан этот параметр, все остальные игнорируются. Описание данного режима приведено здесь:1 line:11 message:expected '>'</error></request></source>[[#Передача только изменившихся статусов|Передача только изменившихся статусов]]
=== Описание полей ответа статусов ===* '''conditions''' — Задает условия фильтрации по «orderno». Все вложенные элементы одновременно накладывают условие «И». Минимум 5 символов!:* '''namecontains''' — Поиск по номеру заказа(шифр), который содержит «orderno».Все поля ответа соответствуют структуре order при создании :* '''namestarts''' — Поиск по номеру заказа(шифр), который начинается с некоторыми добавлениями:«orderno».
* Атрибуты контейнера '''orderlimit'''::* '''''awb''''' - Номер накладной в системе курьерской службы — Необязательный параметр.:* '''''orderno2''''' Дает возможность получить не все измененные заказы, а только какое- Номер накладной в подсистеме срочной доставки курьерской службыто определенное количество.:* '''''ordercode''''' - внутренний код заказа в системеПомогает на случай, применяется для некоторых внутренних операцийесли у вас скопилось очень много измененных заказов и нужно их грузить лимитировано.:* '''''givencode''''' - внутренний код заказа в системеПосле каждой итерации нужно вызывать commitlaststatus с контейнером списка обработанных кодов, применяется для некоторых внутренних операций.[[#Лимитирование запросов|читать подробнее]]
* атрибут <div style="color: #a94442; background-color: #f2dede; border: 1px solid #ebccd1; padding: 3px 10px 10px;">'''Обратите внимание!'''# Периода запроса статусов (контейнеры '''datefrom''' и '''dateto''') ограничивается двумя месяцами — два месяца до даты 'code''«по»''' контейнера .# Если не указаны обе даты — '''itemdateto''' - внутренний код строки заказа в системе, применяется для некоторых внутренних операцийпринимается равной текущей дате.# Если не указана дата '''dateto''' — она принимается равной '''datefrom''' плюс 2 месяца.:* # Если не указана дата '''datefrom''' — она принимается равной 'returns''dateto''' - количество данного товара, от которого отказался получательминус 2 месяца. Не нулевое # Поиск по '''conditions''' работает только для «Номер заказа(шифр)» и только в случае частичного отказа.от 4 символов</div><br>
* атрибут '''''got''''' контейнера '''package''' - признак принятого места YES / NO.:* '''''returns''''' - количество данного товара, от которого отказался получатель. Не нулевое только в случае частичного отказа. * '''''coords''''' в контейнере '''receiver''' - координаты получателя.* '''''deliveryPIN''''' в контейнере '''receiver''' - Пин-код.* '''pickup''' - признак оформления забора, возможные значения: '''YES''', '''NO'''. Если указано '''YES''', то весь заказ считается заданием на забор груза, а не на доставку.* '''currcoords''' - текущие координаты заказа. Атрибуты::* '''''lat''''' - широта:* '''''lon''''' - долгота:* '''''accuracy''''' - точность в метрах:* '''''RequestDateTime''''' - дата/время последнего обновления координат. * '''courier''' - Данные курьера, которому выдан заказ. Если заказ не выдан, то выводятся данные запланированного курьера.* '''waittime ''' - Время ожидания курьера.* '''deliveryprice''' - Стоимость услуг в валюте расчетов с клиентом. Атрибуты::* '''''total''''' - общая стоимость услуг:* '''''delivery''''' - стоимость доставки "Туда":* '''''return''''' - стоимость доставки "Обратно" (если order->return=YES)Тэг '''deliveryprice''' включает список дополнительных услуг (только для тарифа "Премиум")::* '''''advprice''''' - наименование дополнительной услуги:* '''''code''''' - код дополнительной услуги:* '''''price''''' - стоимость дополнительной услуги * '''status''' - статус доставки (список статусов см. ниже). Атрибуты (заполняются начиная с версии системы 2008.0.0.670)::* '''''eventstore''''' - филиал, к которому относится текущий статус:* '''''eventtime''''' - время события по часовому поясу места его наступления.:* '''''createtimegmt''''' - время по GMT создания записи о смене статуса в БД. Используется для сортировки записей, чтобы соблюсти хронологическую последовательность. <spoiler text="Подробнее">Большинство событий фиксируются в полях eventtime и createtimegmt на основании одного действия, тогда они отличаются только сдвигом от GMT. Однако, если курьер доставил отправление 10.10.2010 в 20:00, по какой-то причине не внес это в мобильное приложение, на следующий день сдал накладную, и в 9 утра оператор внесла, что он доставил вчера в 20:00. Тогда в createtimegmt будет сегодня 6 утра (для Москвы), а в eventtime - вчера в 20:00. При этом оператор по каким-то причинам может внести время вручения раньше, чем какое-то предыдущее событие, т.о. нарушится последовательность времени в eventtime, но при сортировке по createtimegmt все-равно все будет правильно.</spoiler>:* '''''message''''' - наименование филиала-получателя, при передаче между филиалами:* '''''title''''' - русское наименование статуса * '''statushistory''' - история статусов доставки. Содержит список контейнеров '''status'''. Заполняется только для тарифа "Премиум" начиная с версии системы 2008.0.0.670.* '''customstatecode''' - код внутреннего статуса курьерской службы. Значения уточняйте в курьерской службе. Назначаются курьерской службой в разделе "Справочники" - "Статусы" - "15 Статусы корреспонденции". Справочник не передается через API клиенту по причине возможного наличия в нем внутренних технологических статусов курьерской службы.* '''clientstatecode''' - код статуса клиента. Используется, если клиент предлагает свои коды статусов доставки/причин недоставки.* '''deliveredto''' - данные о вручении, либо причина недоставки.* '''delivereddate''' - дата вручения.* '''deliveredtime''' - время вручения. В случае недоставки может быть пустым.* '''arrival''' - плановая дата прибытия в формате гггг-мм-дд чч:мм:сс* '''outstrbarcode''' - код у подрядчика (код заказа во внешней системе). Используется в интеграциях с внешними системами.* '''return_message''' - информация о возврате* '''department''' - Подразделение, в котором оформляется заказ. Контейнер '''status''' может принимать следующие значения:: AWAITING_SYNC — Ожидает синхронизации. Данные заказа пока не появились в службе доставки.: '''NEW''' — Успешно создан, передан в службу доставки.: NEWPICKUP — Создан забор.: PICKUP — Забран у отправителя.: WMSASSEMBLED — Скомплектован на складе фулфилмента.: WMSDISASSEMBLED — Разукомплектован на склад фулфилмента.: '''ACCEPTED''' — Получен складом.: CUSTOMSPROCESS — Производится таможенный контроль.: CUSTOMSFINISHED — Таможенный контроль произведен.: CONFIRM — Согласована доставка.= Примеры ответов ===: UNCONFIRM — Не удалось согласовать доставку.: DEPARTURING — Планируется отправка со склада на другой склад.: DEPARTURE — Отправлено со склада на другой склад.: INVENTORY — Инвентаризация. Убедились в наличии отправления на складе.: PICKUPREADY — Готов к выдаче в ПВЗ.: '''DELIVERYПример успешного ответа''' — Выдан курьеру на доставку.: COURIERDELIVERED — Доставлен (предварительно, ождает подтверждения менеджером, чтобы перейти в статус COMPLETE).: COURIERPARTIALLY — Частично доставлен (предварительно, ождает подтверждения менеджером, чтобы перейти в статус PARTIALLY).: COURIERCANCELED — Отказ (предварительно, после этого ожидается COURIERRETURN).: COURIERRETURN — Возвращено курьером. Курьер не смог доставить до получателя и вернул заказ обратно на склад. Это промежуточный статус, после которого менеджер выясняет, нужно ли повторно доставлять (статусы DATECHANGE/DELIVERY) или это окончательная недоставка (CANCELED).: DATECHANGE — Перенос даты доставки.
: '''COMPLETE''' — Доставлен.
: '''PARTIALLY''' — Доставлен частично.
: '''CANCELED''' — Не доставлен (Возврат/Отмена). После этого статуса отправление должны вернуть заказчику, будут статусы RETURNING и RETURNED
 
: RETURNING — Планируется возврат заказчику (после CANCELED).
: RETURNED — Возвращен заказчику.
: LOST — Утрачен/утерян.
 
'''Примечание.''' В будущем возможно дополнение используемого набора статусов.
 
<div style="color: #a94442; background-color: #f2dede; border: 1px solid #ebccd1; padding: 3px 10px 10px;">
'''Обратите внимание!'''
 
# Контейнер '''statushistory''' и '''deliveryprice''' заполняется для тарифов [[Личный кабинет курьерской службы#Функции личного кабинета|Премиум и Максимум]].
# Система никогда не гарантирует последовательность прохождения заказом набора статусов. Т.е. Вы можете получить статус "COMPLETE", а следующим запросом - "NEW" - такое может произойти, например, если оператор ошибочно отметил заказ выполненным, а затем исправил ошибку.
</div>
<br />
 
=== Передача только изменившихся статусов ===
В нашем API предусмотрено очень удобное средство получения статусов всех заказов, без необходимости "бомбить" сервер запросами статусов по каждому заказу. Работает это так: раз в какое-то время, например, в 10 минут, вы посылаете запрос "А покажите все изменившиеся статусы". Пример запроса ниже. Система вам отдает ВСЕ заказы, статусы (или некоторые другие поля, см ниже) которых изменились с момента последнего запроса. Вы разбираете полученный документ, по каждому заказу сохраняете его актуальный статус в своей системе, и если все хорошо, у вас все получилось, ваша система неожиданно не упала от наплыва информации, посылаете нам запрос подтверждения получения статусов (commitlaststatus). Мы у себя отмечаем, что эти статусы вами получены, и их не надо передавать повторно. Т.о. сколько бы заказов у вас не было, статусы по ним всем почти в реальном времени вы можете получать всего 2-мя запросами.
 
Для получения только изменившихся статусов отправьте запрос
<source lang="xml">
<?xml version="1.0" encoding="UTF-8" ?><statusreqcount="23"> <auth extraorder orderno="8111111" awb="qwerty" orderno2="123123" loginordercode="login34534234" passgivencode="pass2345334"></auth> <changesbarcode>ONLY_LAST111111</changesbarcode> </statusreqsender> <company>МВД</sourcecompany> <person>Иванов И.И.</person>Система выдает все заказы, в которых, с момента последнего запроса в этом режиме, изменилось хотя бы одно из полей: <phone>123-45-67</phone> orderno <contacts> status <phone>+74951234567</phone> delivereddate deliveredtime deliveredto receiver->date receiver->address price После успешной обработки ответа необходимо отметить полученные статусы успешно полученными, отправив запрос </contacts> <source langtown code="xml23432">Санкт-Петербург</town> <?xml version="1.0" encoding="UTF-8" ?address>Петровка 38 офис 35<commitlaststatus/address> <auth extra="8" login="login" pass="pass">date>2014-03-22</authdate> <clienttime_min>CLIENT09:00</clienttime_min> <time_max>14:00</commitlaststatustime_max> </sourcesender> <receiver>'''Описание полей запроса''' <company>МВД</company> <person>Иванов И.И.</person>*'''auth''' <phone>123-45- Авторизация. Обязательный элемент.*'''client''' 67 - Признак клиента или агентаИван (916)234. Необязательный элемент45.:* CLIENT - Признак клиента21 Петр, значение по умолчанию:* AGENT - Признак агентаmvd@mail. В ответ отдается информация по заказам, переданным агенту на доставкуru</phone> <contacts>В случае успеха Вы получите ответ <phone>+74951234567<source lang="xml"/phone> <?xml version="1.0" encoding="UTF-8" ?phone>+79162344521</phone> <commitlaststatus error="0"email>OKmvd@mail.ru</commitlaststatusemail> </sourcecontacts> <inn>1112223335</inn>Данный способ передачи статусов гарантирует полную корректную передачу статусов, даже в случае, если в нашей системе статус изменился в промежутке времени между запросом статусов и подтверждением их получения. Если система не получила подтверждение успешной передачи статуса, она будет считать информацию не переданной, и выдаст ее при повторном запросе. <zipcode>125480</zipcode> <div styletown code="color: #a94442; background153361" regioncode="78" regionname="Санкт-color: #f2dede; border: 1px solid #ebccd1; padding: 3px 10px 10px;Петербург город">'''Обратите внимание!''' # При данном способе передачи (<changes>ONLY_LASTСанкт-Петербург город</changestown> <address>Петровка 38 офис 35</address>) система просматривает заказы, оформленные за последние 3 месяца. Если заказ сделан ранее - изменение статуса по нему не попадет в результат выполнения данного запроса.# Система всегда выдает текущий статус. Т.е. Вы можете одним запросом получить статус "NEW", а следующим - "COMPLETE". В промежутке между запросами отправление могло пройти через несколько промежуточных статусов. Если нужна гарантия получения всех промежуточных статусов, нужно анализировать блок statushistory (может не заполняться в следствии ограничений версии или тарифа конкретной службы доставки). <area>Район 1</area> <pvz># Система никогда не гарантирует последовательность прохождения заказом набора статусов. Т.е. Вы можете получить статус "COMPLETE", а следующим запросом - "NEW" - такое может произойти, например, если оператор ошибочно отметил заказ выполненным, а затем исправил ошибку. <code>126</code> <clientcode>QWERTY</divclientcode> <br /pvz> <date>2014-03-22</date> <time_min>09:00</time_min> <time_max>14:00</time_max> <coords lat== Трекинг заказа по номеру == Запрос трекинга по номеру предназначен для выдачи минимальной обезличенной информации о конкретном заказе не авторизованному пользователю"55. Наша система имеет для этого интерфейс по адресу 680327" lon="home37.courierexe.ru604456"></{код экстра}coords> <deliveryPIN>1234</tracking". Вы можете либо сделать ссылку на такую страницу на своем сайте, либо разместить ее iframe'ом у себя, либо сделать свою и пользоваться нашим API. Этот интерфейс создан специально для выдачи информации живому пользователю сайта. Для получения статусов заказов в свою информационную систему нужно использовать запрос "statusreq", желательно с параметром changes=ONLY_LAST! '''Пример запроса:'''deliveryPIN> <source lang="xml"/receiver> <?xml version="1price>387.0" encoding="UTF-8"?>5<tracking/price> <extrainshprice>8387.5</extrainshprice> <ordernopaytype code="1">1234CASH</ordernopaytype> <weight>5.1</trackingweight> </sourcequantity>2</quantity'''Пример ответа:''' <source lang="xml"service>2</service> <?xml version="1.0" encoding="UTF-8"?type>3<tracking/type> <order orderno="111111"return>NO</return> <barcodereturn_service>1111112</barcodeservice> <AWBreturn_type>1111113</AWBreturn_type> <senderreturn_weight>5.1</return_weight> <return_message>Доставлено в целости<town code="1" country="RU"/return_message> <pickup>Москва городNO</townpickup> <dateprint_check>2014-03-22YES</dateprint_check> <time_minwaittime>09:0012</time_minwaittime> <time_maxenclosure>14:00Детские игрушки</time_maxenclosure> </senderinstruction> Проверить при покупателе, подписать акт<receiver/instruction> <town codecurrcoords lat="155.680327" countrylon="RU37.604456" accuracy=">Москва город<50" RequestDateTime="2014-04-21 18:07:45"></towncurrcoords> <zipcodecourier>125480 </zipcodecode> <date>2014-03-2226</datecode> <time_minname>09:00Иванов Владимир Петрович</time_minname> <time_maxphone>14:00+79161234567</time_maxphone> </receivercourier> <price>387deliveryprice total="158.5</price> 6" delivery="100.00" return="58.6"> <inshpriceadvprice code="1" price="150">387.5База</inshpriceadvprice> <paytypeadvprice code="2" price="0">CASH% от объявленной стоимости</paytypeadvprice> <weight>5advprice code="3" price="8.16">Топливный сбор</weightadvprice> <quantityadvprice code="4" price="0">2Округление</quantityadvprice> <service>2</servicedeliveryprice> <typereceiverpays>3NO</typereceiverpays> <returnacceptpartially>NO</returnacceptpartially> <return_service>2</service> <return_date></return_date> <return_time></return_time> <return_message></return_messagestatus eventstore="филиал в Санкт-Петербурге" eventtime="2016-06-02 17:22:00" createtimegmt="2016-06-03 16:14:44" message="" title="Доставлен" eventtown="Санкт-Петербург город" color="16777215"> <waittime>12COMPLETE</waittimestatus> <enclosure>Детские игрушки</enclosurestatushistory> <instruction>Проверить при покупателе, подписать акт</instruction> <deliveryprice total=status eventstore="Офис в Москве"158.6" deliveryeventtime="100.002016-05-30 10:20:00" returncreatetimegmt="58.62016-06-03 16:14:44" /> <courier message="" title="Новый" eventtown="Москва город" country="RU"> <code>26NEW</codestatus> <name>Иванов Владимир Петрович</name> <phone>+79161234567</phone> </courier> <currcoords lat=status eventstore="Офис в Москве" eventtime="2016-06-01 17:38:00"55.680327" loncreatetimegmt="37.604456" accuracy="50" RequestDateTime="20142016-0406-21 1803 16:0714:4544" /> <status eventstore message="филиал в Санкт-Петербурге" eventtimetitle="2016-06-02 17:22:00Планируется отправка" createtimegmteventtown="2016-06-03 16:14:44Москва город" messagecountry="" title="ДоставленRU">COMPLETEDEPARTURING</status> <statushistory> <status eventstore="Офис в Москве" eventtime="2016-0506-30 1001 19:2053:00" createtimegmt="2016-06-03 16:14:44" message="филиал в Санкт-Петербурге" title="НовыйОтправлено со склада" eventtown="Москва город" country="RU">NEWDEPARTURE</status> <status eventstore="Офис филиал в МосквеСанкт-Петербурге" eventtime="2016-06-01 1702 07:3841:00" createtimegmt="2016-06-03 16:14:44" message="филиал в " title="Получен складом" eventtown="Санкт-ПетербургеПетербург город" titlecountry="Планируется отправкаRU">DEPARTURINGACCEPTED</status> <status eventstore="Офис филиал в МосквеСанкт-Петербурге" eventtime="2016-06-01 1902 09:5317:00" createtimegmt="2016-06-03 16:14:44" message="филиал в " title="Выдан курьеру на доставку" eventtown="Санкт-ПетербургеПетербург город" titlecountry="Отправлено со складаRU">DEPARTUREDELIVERY</status> <status eventstore="филиал в Санкт-Петербурге" eventtime="2016-06-02 0717:4122:00" createtimegmt="2016-06-03 16:14:44" message="" title="Получен складомДоставлен (предварительно)" eventtown="Санкт-Петербург город" country="RU">ACCEPTEDCOURIERDELIVERED</status> <status eventstore="филиал в Санкт-Петербурге" eventtime="2016-06-02 0917:1722:00" createtimegmt="2016-06-03 16:14:44" message="" title="Выдан курьеру на доставкуДоставлен" eventtown="Санкт-Петербург город" country="RU">DELIVERYCOMPLETE</status> </statushistory> <status eventstore="филиал в Санкт-Петербурге" eventtime="2016-06-02 17:22:00" createtimegmt="customstatecode>2<customstatecode> <clientstatecode></clientstatecode> <deliveredto>Иванова, секр.</deliveredto> <delivereddate>2016-06-03 16:1402</delivereddate> <deliveredtime>17:44" message="" title="Доставлен (предварительно)">COURIERDELIVERED22</statusdeliveredtime> <status eventstore="филиал в Санкт-Петербурге" eventtime="2016-06department>Отдел</department> <costcode>cc12345</costcode> <outstrbarcode>EXT123456</outstrbarcode> <respstore>14</respstore> <partner>Офис на Ленина</partner> <arrival>2016-02 1705-02 23:22:0021</arrival> <receipt fdNum="124555" createtimegmtfnSn="2016-06-03 16:14:449289000100295555" messagekktNum="0001611984048555" titleinn="Доставлен7722756555" fdValue="2899551555" summ="387.5" ofdUrl="gate.ofd.ru">COMPLETEhttps://ofd.ru/rec/7722756555/0001611984048555/9289000100295555/124555/2899551555</statusreceipt> </statushistoryitems> <deliveredto>Иванова, секрitem code="34533" extcode="abc123" quantity="1" mass="0.</deliveredto> <delivereddate>2016-06-02</delivereddate> <deliveredtime>17:22</deliveredtime> <outstrbarcode>EXT123456</outstrbarcode> <items> <item code2" retprice="37.5" VATrate="0" barcode="2345625213125" article="1" returns="0" origincountry="34533040" extcodeGTD="abc123" quantity="1" massexcise="0.200" retpricegovernmentCode="37.511223311" VATrategovType="01" barcodesuppcompany="2345625213125Поставщик" articlesuppINN="11112223334" returnssuppphone="079161234567" origincountry>Мяч</item> <item code="04034456" GTDextcode="abc124" excisequantity="0.002" governmentCodemass="112233112" suppcompanyretprice="Поставщик100" VATrate="10" barcode="4645625213138" article="2" returns="0" suppINNgovernmentCode="1112223334" suppphonegovType="791612345671">МячОбруч</item> <item code="3445634421" extcode="abc124abc125" quantity="23" mass="20.3" retprice="10050" VATrate="1018" barcode="46456252131382345625213126" itemcode="44123" article="23" returns="0" governmentCode="" govType="1">ОбручПогремушка желтая</item> </items> <packages> <item package code="3442133331" extcodestrbarcode="abc125" quantity="3ORD0000001" mass="0.31" retpricemessage="50" VATrategot="18YES" barcode></package> <package code="234562521312633332" strbarcode="ORD0000002" articlemass="32.5" returnsmessage="0" governmentCodegot="NO">Погремушка желтая</itempackage> </itemspackages> <extrafields> <extrafield> <name>courier_car</ordername> <value>ВАЗ 2106, бежевый</value> </extrafield> </trackingextrafields> </sourceorder></statusreq> </source> '''Пример ответа если нет заказов''' <source lang="xml"><?xml version="1.0" encoding="utf-8"?><statusreq count="0"></statusreq> </source> '''Пример ответа при ошибке авторизации''' <source lang="xml"><?xml version="1.0" encoding="utf-8"?><request><error error="1" errormsg="authorization error"></error></request></source> '''Пример ответа при ошибке синтаксиса'''
 
'''Получение информации в формате 17 TRACK'''
 
'''Пример запроса:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<tracking17request> <extraerror>8</extra> <ordernocolumn:1 line:11 message:expected '>1234'</ordernoerror></tracking17request>
</source>
=== Описание полей ответа статусов ===Все поля ответа соответствуют структуре order при создании заказа, с некоторыми добавлениями: * Атрибуты контейнера '''Пример ответаorder'''::* '''''awb''''' — Номер накладной в системе курьерской службы.<pre>{:* '''''orderno2''''' — Номер накладной в подсистеме срочной доставки курьерской службы.:* '''''ordercode''''' — внутренний код заказа в системе, применяется для некоторых внутренних операций. "number":"ExtNumber"* '''''givencode''''' — внутренний код заказа в системе,применяется для некоторых внутренних операций. *'''paytype''' - Тип оплаты заказа получателем. Принимает значения::: CASH - Наличными при получении (по-умолчанию):: CARD - Картой при получении:: NO - Без оплаты. "oriNumber":"1234": OTHER - Прочее (Предусмотрен для того, чтобы оплата поступала непосредственно в курьерскую службу посредством прочих типов оплаты - таких как: вебмани, яденьги, картой на сайте,прочие платежные системы и т.д.) "oriCountry"* Атрибуты контейнера '''paytype''':** '''''code''''' - (integer) внутренний код типа оплаты заказа в системном справочнике "RUТипы оплаты корреспонденции". Не обязательный элемент.  * атрибут '''''code''''' контейнера '''item''' — внутренний код строки заказа в системе,применяется для некоторых внутренних операций. "destCountry":"RU"* '''''returns''''' — количество данного товара,от которого отказался получатель. Не нулевое только в случае частичного отказа. * атрибут '''''got''''' контейнера '''package''' — признак принятого места YES / NO. "status":"Complete"* '''''returns''''' — количество данного товара,от которого отказался получатель. Не нулевое только в случае частичного отказа. * '''''area''''' в контейнере '''receiver''' — район/метро получателя. "events"* '''''coords''''' в контейнере '''receiver''' — координаты получателя.* '''''deliveryPIN''''' в контейнере '''receiver''' — Пин-код.* '''pickup''' — признак оформления забора, возможные значения:['''YES''', '''NO'''. Если указано '''YES''', то весь заказ считается заданием на забор груза, а не на доставку. {* '''currcoords''' — текущие координаты заказа. Атрибуты: "time":"2016-06-02 17* '''''lat''''' — широта:22* '''''lon''''' — долгота:00",* '''''accuracy''''' — точность в метрах "location":"RU"* '''''RequestDateTime''''' — дата/время последнего обновления координат. * '''courier''' — Данные курьера, которому выдан заказ. Если заказ не выдан,то выводятся данные запланированного курьера.* '''waittime ''' — Время ожидания курьера. "content"* '''deliveryprice''' — Стоимость услуг в валюте расчетов с клиентом. Атрибуты:"Complete" },:* '''''total''''' — общая стоимость услуг {:* '''''delivery''''' — стоимость доставки «Туда» "time":"2016* '''''return''''' — стоимость доставки «Обратно» (если order-06-02 17>return=YES)Тэг '''deliveryprice''' включает список дополнительных услуг (только для тарифа «Премиум»)::22* '''''advprice''''' — наименование дополнительной услуги:00",* '''''code''''' — код дополнительной услуги "location":"RU",* '''''price''''' — стоимость дополнительной услуги  "content"* '''status''' — статус доставки (список статусов см. ниже). Атрибуты (заполняются начиная с версии системы 2008.0.0.670):"Courierdelivered" }:* '''''eventstore''''' — филиал,к которому относится текущий статус {:* '''''eventtime''''' — время события по часовому поясу места его наступления. :* '''''createtimegmt''''' — время по GMT создания записи о смене статуса в БД. Используется для сортировки записей, чтобы соблюсти хронологическую последовательность. <spoiler text="timeПодробнее">Большинство событий фиксируются в полях eventtime и createtimegmt на основании одного действия, тогда они отличаются только сдвигом от GMT. Однако, если курьер доставил отправление 10.10.2010 в 20:"201600, по какой-06-02 09то причине не внес это в мобильное приложение, на следующий день сдал накладную, и в 9 утра оператор внесла, что он доставил вчера в 20:1700. Тогда в createtimegmt будет сегодня 6 утра (для Москвы), а в eventtime — вчера в 20:00". При этом оператор по каким-то причинам может внести время вручения раньше, чем какое-то предыдущее событие, т.о. нарушится последовательность времени в eventtime,но при сортировке по createtimegmt все-равно все будет правильно.</spoiler> "location":"RU"* '''''message''''' — наименование филиала-получателя,при передаче между филиалами "content":"Delivery"* '''''title''''' — русское наименование статуса * '''statushistory''' — история статусов доставки. Содержит список контейнеров '''status'''. Заполняется только для тарифа «Премиум» начиная с версии системы 2008.0.0.670.* '''customstatecode''' — код внутреннего статуса курьерской службы. Значения уточняйте в курьерской службе. Назначаются курьерской службой в разделе «Справочники» — «Статусы» — «15 Статусы корреспонденции». Справочник не передается через API клиенту по причине возможного наличия в нем внутренних технологических статусов курьерской службы.* '''clientstatecode''' — код статуса клиента. Используется, если клиент предлагает свои коды статусов доставки/причин недоставки. }* '''deliveredto''' — данные из поля «Инфо. о доставке» (может быть информация о доставке,причина недоставки и т. п.).* '''delivereddate''' — дата вручения. {* '''deliveredtime''' — время вручения. В случае недоставки может быть пустым. "time":"2016* '''arrival''' — плановая дата прибытия в формате гггг-06мм-02 07дд чч:41мм:00"сс. Заполняется только при использовании автоматических систем планирования (Максоптра, Яндекс доставка), во всех остальных случаях - пустое.* '''outstrbarcode''' — код у подрядчика (код заказа во внешней системе). Используется в интеграциях с внешними системами.* '''partner''' — текущий филиал/подрядчик.* '''return_message''' — информация о возврате* '''department''' — Подразделение,в котором оформляется заказ. Контейнер '''status''' может принимать следующие значения:: AWAITING_SYNC — Ожидает синхронизации. Данные заказа пока не появились в службе доставки. "location":"RU"'''NEW''' — Успешно создан,передан в службу доставки.: NEWPICKUP — Создан забор.: PICKUP — Забран у отправителя. "content":"Accepted"WMSASSEMBLED — Скомплектован на складе фулфилмента. },: WMSDISASSEMBLED — Разукомплектован на склад фулфилмента. {: '''ACCEPTED''' — Получен складом. "time":"2016-06-01 19CUSTOMSPROCESS — Производится таможенный контроль.:53CUSTOMSFINISHED — Таможенный контроль произведен.:00",CONFIRM — Согласована доставка. "location":"RU",UNCONFIRM — Не удалось согласовать доставку. "content":"Departure"DEPARTURING — Планируется отправка со склада на другой склад. },: DEPARTURE — Отправлено со склада на другой склад. {: INVENTORY — Инвентаризация. Убедились в наличии отправления на складе. "time":"2016-06-01 17PICKUPREADY — Готов к выдаче в ПВЗ.:38'''DELIVERY''' — Выдан курьеру на доставку.:00"COURIERDELIVERED — Доставлен (предварительно, ожидает подтверждения менеджером,чтобы перейти в статус COMPLETE). "location":"RU"COURIERPARTIALLY — Частично доставлен (предварительно, ожидает подтверждения менеджером,чтобы перейти в статус PARTIALLY). "content":"Departuring"COURIERCANCELED — Отказ (предварительно, после этого ожидается COURIERRETURN). }: COURIERRETURN — Возвращено курьером. Курьер не смог доставить до получателя и вернул заказ обратно на склад. Это промежуточный статус, после которого менеджер выясняет,нужно ли повторно доставлять (статусы DATECHANGE/DELIVERY) или это окончательная недоставка (CANCELED).: DATECHANGE — Перенос даты доставки. { "time":"2016-05-30 10'''COMPLETE''' — Доставлен.:20'''PARTIALLY''' — Доставлен частично.:00"'''CANCELED''' — Не доставлен (Возврат/Отмена). После этого статуса отправление должны вернуть заказчику,будут статусы RETURNING и RETURNED  "location":"RU",RETURNING — Планируется возврат заказчику (после CANCELED). "content":"New"RETURNED — Возвращен заказчику. } ]}<: LOST — Утрачен/pre>утерян.
Функция ищет последний заказ по номеру среди заказов всех клиентов: PARTLYRETURNING — Планируется возврат остатков. Выдает неперсонализированную информацию о текущем состоянии заказа: PARTLYRETURNED — Остаток возвращен.<br />Описание контейнеров ответа аналогично описанию [[API#: TRANSACCEPTED — Прибыл на склад перевозчика.D0.97.D0.B0.D0.BF.D1.80.D0.BE.D1.81_.D1.81.D1.82.D0.B0.D1.82.D1.83.D1.81.D0.B0_.D0.B7.D0.B0.D0.BA.D0.B0.D0.B7.D0.BE.D0.B2|Запроса статусов заказов]]: PICKUPTRANS — Забран у перевозчика.
== Изменение заказа ==
Запрос предназначен для изменения заказов, по которым не было произведено изменений статуса корреспонденции, времени доставки — то есть заказов, которые ещё не в работе.
Изменять заказы могут курьерские службы с тарифами «Премиум» и «Максимум». Чтобы разрешить изменение заказов, в личном кабинете курьерской службы перейдите в '''Параметры''' > '''Расширенные''' и установите флажок '''Разрешить отмену и изменение заказовПримечание.'''В будущем возможно дополнение используемого набора статусов.
<div style="color: #a94442; background-color: #f2dede; border: 1px solid #ebccd1; padding: 3px 10px 10px;">
'''Обратите внимание!'''
 # Данные запроса изменения указываются Контейнер '''statushistory''' и '''полностьюdeliveryprice''', как если бы заказ создавался впервыезаполняется для тарифов [[Личный кабинет курьерской службы#Функции личного кабинета|Премиум и Максимум]].# При отсутствии вложения в запросе изменения данное вложение Контейнер '''не удаляетсяpackages''' из заказа, но его количество становится равным 0не возвращает более 1000 элементов.# При одновременном изменении заказа в API и системе курьерской службы приоритет отдается данным системы курьерской службыСистема никогда не гарантирует последовательность прохождения заказом набора статусов. То есть изменения в API приняты не будут!Вы можете получить статус «COMPLETE», а следующим запросом — «NEW» — такое может произойти, например, если оператор ошибочно отметил заказ выполненным, а затем исправил ошибку.
</div>
<br>
=== Описание полей запроса изменения Передача только изменившихся статусов ===Все В нашем API предусмотрено удобное средство получения статусов всех заказов, без необходимости «бомбить» сервер запросами статусов по каждому заказу. Работает это так: раз, например, в 10 минут, вы посылаете запрос «покажите все изменившиеся статусы». Пример запроса ниже. Система вам отдает ВСЕ заказы, статусы (или некоторые другие поля , см. ниже) которых изменились с момента последнего запроса соответствуют структуре order при создании заказа за исключением:* вместо корневого тэга '''neworder''' указывается '''editorder'''* тэг штрих-кода '''barcode''' . Вы разбираете полученный документ, по каждому заказу сохраняете его актуальный статус в своей системе, и если все хорошо, у вас все получилось, ваша система неожиданно не указываетсяупала от наплыва информации, поскольку присваивается при создании заказапосылаете нам запрос подтверждения получения статусов (commitlaststatus).* для вложений '''item''' указывается внутренний код вложения Мы у себя отмечаем, что эти статусы вами получены и их не надо передавать повторно. Таким образом, сколько бы заказов у вас ни было, статусы по ним всем почти в атрибуте '''code''', который можно получить при получении статуса заказареальном времени вы можете получать всего двумя запросами.
=== Описание полей ответа изменения ===Все поля ответа соответствуют ответу при создании заказа за исключением корневого тэга — вместо '''neworder''' возвращается '''editorder'''. == Отмена заказа ==Запрос предназначен для отмены заказов, по которым не было произведено изменений статуса доставки, статуса корреспонденции, времени доставки, то есть заказов, которые ещё не в работе. Отменять заказы могут курьерские службы с тарифами «Премиум» и «Максимум». Чтобы разрешить отмену заказов, в личном кабинете курьерской службы перейдите в '''Параметры''' > '''Расширенные''' и установите флажок '''Разрешить отмену и изменение заказов'''. При отмене заказа поле «Инфо о доставке» получает значение «Отменено заказчиком», поле «Дата доставки» — текущую дату, а «Вручил курьер» — системную запись «ОТМЕНА».  '''Пример запроса отмены заказаДля получения только изменившихся статусов отправьте запрос:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8" ?>
<cancelorderstatusreq> <auth extra="8" login="login" pass="pass" ></auth> <order orderno="" ordercode="123456" changes>ONLY_LAST</changes> <order orderno="123aaa" ordercode="" streamid>1234</streamid></cancelorderstatusreq>
</source>
Система выдает все заказы, в которых с момента последнего запроса в этом режиме изменилось хотя бы одно из полей:
orderno
status
delivereddate
deliveredtime
deliveredto
receiver->date
receiver->address
price
'''Описание полейПосле успешной обработки ответа необходимо отметить полученные статусы успешно полученными, отправив запрос:'''<source lang="xml"><?xml version="1.0" encoding="UTF-8" ?><commitlaststatus> <auth extra="8" login="login" pass="pass"></auth> <client>CLIENT</client> <streamid>1234</streamid></commitlaststatus></source>
'''cancelorderОписание полей запроса''' — Корневой контейнер. Обязательный элемент.* '''auth''' — Авторизация. Обязательный элемент.* '''order''' — Контейнер отменяемого заказа. Обязательный элемент. Запрос может содержать более одного контейнера '''order'''. Атрибуты::* '''''orderno''''' — Шифр заказа.:* '''''ordercode''''' — Внутренний код заказа.Обратите внимание, что должен быть указан хотя бы один из атрибутов ''orderno'' или ''ordercode''!
* '''auth''' — авторизация. Обязательный элемент.
* '''streamid''' — идентификатор потока. Если у вас несколько интеграций и каждая нуждается в получении статусов, вы можете передавать данный параметр и тем самым разделять получение и отметку об успешном получении статусов по заказам. Значение должно входить в промежуток от 100 до 10000, включительно. Необязательный элемент.
* '''client''' — признак клиента или агента. Необязательный элемент.
:* CLIENT — признак клиента, значение по умолчанию
:* AGENT — признак агента. В ответ отдается информация по заказам, переданным агенту на доставку
'''Пример ответаВ случае успеха вы получите ответ:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8" ?>
<cancelorder> <order orderno="123test" ordercode="123456" commitlaststatus error="0" errormsg=">OK" errormsgru="Успешно" /> <order orderno="123aaa" ordercode="" error="52" errormsg="order not found" errormsgru="Заказ не найден" /></cancelordercommitlaststatus>
</source>
== Добавление вложений к накладной ==Такой способ передачи статусов гарантирует полную корректную передачу статусов, даже если в нашей системе статус изменился между запросом статусов и подтверждением их получения. Если система не получила подтверждение передачи статуса, она будет считать информацию непереданной и выдаст ее при повторном запросе.
'''Пример запроса:'''<source langdiv style="xml"><?xml version="1.0" encoding="UTFcolor: #a94442; background-8color: #f2dede; border: 1px solid #ebccd1; padding: 3px 10px 10px;" ?># При этом способе передачи (<addattachmentschanges> ONLY_LAST<auth extra="8" login="login" pass="pass" /changes>) система просматривает заказы, оформленные за последние 3 месяца. Если заказ сделан ранее, изменение статуса по нему не попадет в результат выполнения запроса. <orderno>1234567</orderno> <attachments># Система всегда выдает текущий статус. Вы можете одним запросом получить статус «NEW», а следующим — «COMPLETE». Между запросами отправление могло пройти через несколько промежуточных статусов. Если нужна гарантия получения всех промежуточных статусов, нужно анализировать блок statushistory (может не заполняться вследствие ограничений версии или тарифа конкретной службы доставки). <item name="photo1# Система не гарантирует последовательность прохождения заказом набора статусов.jpg">JVBERi0xLjMN1wb25lbnQgMQ JUBQREYwMTIzNDU2Nzg5IDI NMyAwIG9iag08PA0vVHlwZSA U3VidHlwZSAvSW1hZ2UNL1d pZHRoIDE4MDgNL0hlaWdodCA ggNCAwIFINL0JpdHNQZXJDb 21wb25lbnQgMQ0vRGVjb2RlU ENL0NvbHVtbnMgMTgwOA0+P g0vSW1hZ2VNYXNrIHRydWUNL XhEZWNvZGUNPj4Nc3RyZWFt DQ</item> <item name="photo2Вы можете получить статус «COMPLETE», а следующим запросом «NEW» — такое может произойти, например, если оператор ошибочно отметил заказ выполненным, а затем исправил ошибку.jpg">VBERi0xLjMNAwIG9iag0HRoJ JUBQREYwMTIzNDU2Nzg5IDI NMyAwIG9iag08PA0vVHlwZSA vWE9iamVjdA0vU3VidHlwZS AvSW1hZ2UNL1dpZHRoIDEzNj gNL0hlaWdodCAxMzMzDS9MZ W5ndGggNCAwIFINL0JpdHNQZ XJDb21wb25lbnQgMQ0vRGVj b2RlUGFybXMgPDwNL0sgLTEN L0NvbHVtbnMgMTM2OA0+Pg0 vSW</itemdiv> </attachments></addattachments></sourcebr>
=== Лимитирование запросов ===Дает возможность получить не все измененные заказы, а только какое-то определенное количество. Помогает на случай, если у вас скопилось очень много измененных заказов и нужно их грузить лимитировано. После успешной обработки получнных заказов, '''Описание полей:обязательно'''нужно вызвать commitlaststatus с кодами обработанных заказов.
'''addattachments''' - Корневой контейнер. Обязательный элемент.
*'''auth''' - Авторизация. Обязательный элемент.
*'''orderno''' - Номер заказа. Обязательный элемент. Может использоваться тэг <ordercode> с указанием внутреннего кода заказа.
*'''attachments''' - Обязательный элемент, в котором перечисляются передаваемые данные файлов.
**'''item''' - Бинарные данные (файл), закодированные в base64. Обязательный элемент.
***'''name''' - Атрибут элемента '''item''', в котором передается имя файла. Обязательный элемент.
'''Пример'''
'''Пример ответаДля получения ограниченного числа изменившихся заказов отправьте запрос:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?><addattachmentsstatusreq> <attachments> <item nameauth extra="photo1.jpg8" errorlogin="0login" errormsgpass="OK" errormsgru="Успешноpass" ></auth> <changes>ONLY_LAST<item name="photo2.jpg" error="0" errormsg="OK" errormsgru="Успешно" /changes> <limit>5</attachmentslimit></addattachmentsstatusreq>
</source>
== Получение вложений к накладной == '''Пример запросаПосле успешной обработки ответа необходимо отметить полученные статусы успешно полученными, отправив запрос:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8" ?>
<attachmentscommitlaststatus> <auth extra="8" login="login" pass="pass" ></auth> <ordernoacs> <ac>11111</ac> <ac>123456722222</ac> <ac>33333</ac> <ac>44444</ac> <ac>55555</ac> </ordernoacs></attachmentscommitlaststatus>
</source>
'''Описание полей:'''
* '''attachmentsacs''' - Корневой  — контейнер. Обязательный элемент.*'''authac''' — атрибут''' ordercode''' контейнера '''order''' полученного на этапе запроса '''statusreq''' - Авторизация. Обязательный элемент.*Помимо приведенных в примере параметров, вы также можете передавать и остальные, описанные ранее, например '''ordernostreamid''' - Номер/код заказа. Обязательный элемент.
== Трекинг заказа по номеру ==
Запрос трекинга по номеру предназначен для выдачи минимальной обезличенной информации о конкретном заказе не авторизованному пользователю. Наша система имеет для этого интерфейс по адресу «home.courierexe.ru/{код экстра}/tracking». Вы можете либо сделать ссылку на такую страницу на своем сайте, либо разместить ее [[#Размещение страниц на своем сайте (iframe)|iframe’ом]] у себя, либо сделать свою и пользоваться нашим API. Этот интерфейс создан специально для выдачи информации живому пользователю сайта. Для получения статусов заказов в свою информационную систему нужно использовать запрос «statusreq», желательно с параметром changes=ONLY_LAST!
'''Пример ответазапроса:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<attachmentstracking> <item name="doc1.docx" size="35654"extra>JVBERi0xLjMN JUBQREYwMTIzNDU2Nzg5IDI NMyAwIG9iag08PA0vVHlwZSA U3VidHlwZSAvSW1hZ2UNL1d pZHRoIDE4MDgNL0hlaWdodCA ggNCAwIFINL0JpdHNQZXJDb 21wb25lbnQgMQ0vRGVjb2RlU ENL0NvbHVtbnMgMTgwOA0+P g0vSW1hZ2VNYXNrIHRydWUNL XhEZWNvZGUNPj4Nc3RyZWFt DQ8</itemextra> <item name="photo2.jpg" size="74861"orderno>VBERi0xLjMN JUBQREYwMTIzNDU2Nzg5IDI NMyAwIG9iag08PA0vVHlwZSA vWE9iamVjdA0vU3VidHlwZS AvSW1hZ2UNL1dpZHRoIDEzNj gNL0hlaWdodCAxMzMzDS9MZ W5ndGggNCAwIFINL0JpdHNQZ XJDb21wb25lbnQgMQ0vRGVj b2RlUGFybXMgPDwNL0sgLTEN L0NvbHVtbnMgMTM2OA0+Pg0 vSW1234</itemorderno></attachmentstracking>
</source>
В тегах item возвращаются бинарные данные (файлы), закодированные в base64. == Изменение статуса агентом == Запрос изменения статуса заказа позволяет установить окончательный статус заказа - "Доставлен" или "Не доставлен (Возврат/Отмена)". Кроме этого, устанавливается дата и время (при необходимости) изменения статуса, а также сообщение в поле ''Инфо о доставке''. При необходимости к заказу можно прикрепить изображения.  '''Пример запроса изменения статусаответа:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8" ?><setorderinfotracking> <auth extraorder orderno="8111111" loginordercode="login12345" pass> <barcode>111111</barcode> <AWB>111111</AWB> <sender> <town code="1" country="passRU" >Москва город</town> <date>2014-03-22<order ordercode="123456"/date> <messagetime_min>Получил Иванов09:00</messagetime_min> <outstrbarcodetime_max>765431214:00</outstrbarcodetime_max> </ordersender> <receiver> <order ordercodetown code="1" country="234567RU">Москва город</town> <statuszipcode>PICKUPREADY125480</statuszipcode> <eventtimedate>20162014-0503-30 1022</date> <time_min>09:2000</time_min> <time_max>14:00</eventtimetime_max> </receiver> <price>387.5</price> <messageinshprice>Клиент отказался от покупки387.5</messageinshprice> <paytype>CASH</paytype> <itemsweight>5.1</weight> <quantity>2</quantity> <service>2</service> <type>3</type> <return>NO</return> <return_service>2</return_service> <return_date></return_date> <return_time></return_time> <return_message></return_message> <waittime>12</waittime> <enclosure>Детские игрушки</enclosure> <instruction>Проверить при покупателе, подписать акт</instruction> <item codedeliveryprice total="34533158.6" quantitydelivery="1100.00" reasonreturn="058.6" /> <courier> <code>26<item /code> <name>Иванов Владимир Петрович</name> <phone>+79161234567</phone> </courier> <currcoords lat="55.680327" lon="3445637.604456" quantityaccuracy="050" reasonRequestDateTime="02014-04-21 18:07:45" /> <item codestatus eventstore="филиал в Санкт-Петербурге" eventtime="2016-06-02 17:22:00" createtimegmt="344212016-06-03 16:14:44" quantitymessage="2" reasontitle="0Доставлен" >COMPLETE</status> </itemsstatushistory> <image filenamestatus eventstore="Офис в Москве" eventtime="2016-05-30 10:20:00" createtimegmt="2016-06-03 16:14:44" message="filename1.jpg" title="Новый"> NEW</9j/4AAQSkZJRgAstatus> BAQAAAQABAAD <status eventstore="Офис в Москве" eventtime="2016-06-01 17:38:00" createtimegmt="2016-06-03 16:14:44" message="филиал в Санкт-Петербурге" title="Планируется отправка">DEPARTURING</2wBDAA0JCg sKCA0LCgsODg0PEyAVExISEy ccHhcgLikxMC4pLSwzOko+M zZGNywtQFdBRkxOUlNSMj5aY VpQYEpRUk//2wBDAQ4ODhMR EyYVFSZPNS01T09PT09PT09P T09PT09PT09PT09PT09PT09 PT09PT09PT09PT09PT09PT09status> PT09PT0//wAARCAYACAADAS IA </imagestatus eventstore="Офис в Москве" eventtime="2016-06-01 19:53:00" createtimegmt="2016-06-03 16:14:44" message="филиал в Санкт-Петербурге" title="Отправлено со склада"> DEPARTURE</orderstatus> </setorderinfostatus eventstore="филиал в Санкт-Петербурге" eventtime="2016-06-02 07:41:00" createtimegmt="2016-06-03 16:14:44" message="" title="Получен складом">ACCEPTED</sourcestatus>  '''Описание полей запроса статуса:''' '''setorderinfo''' <status eventstore="филиал в Санкт-Петербурге" eventtime="2016- Корневой контейнер. Обязательный элемент.*'''auth''' 06- Авторизация. Обязательный элемент.*'''order''' 02 09:17:00" createtimegmt="2016- Контейнер заказа. Обязательный элемент. Запрос может содержать более одного контейнера '''order'''. Атрибут '''''ordercode''''' 06- внутренний код заказа.03 16:14:44" message="" title="Выдан курьеру на доставку">DELIVERY</status>*''' <status''' eventstore="филиал в Санкт- Новый статус заказа. Доступны статусы из раздела [[#Описание полей ответа статусов]], кроме AWAITING_SYNC и NEW.*'''Петербурге" eventtime''' ="2016- Дата и время изменения статуса. Обязательно при указании статуса.*'''message''' 06-02 17:22:00" createtimegmt="2016- Текст сообщения ''Инфо о доставке''.*'''outstrbarcode''' 06- код у подрядчика 03 16:14:44" message="" title="Доставлен (код заказа во внешней системепредварительно). Используется ">COURIERDELIVERED</status> <status eventstore="филиал в интеграциях с внешними системами.*'''paytype''' Санкт-Петербурге" eventtime="2016- Тип оплаты заказа. Допустимые значения CASH/CARD.*'''items''' 06- Контейнер для описания вложений '''item''' . Атрибуты02 17:22:* '''''code''''' 00" createtimegmt="2016-06- Код вложения.03 16:14:44" message="" title="Доставлен">COMPLETE</status>:* '''''quantity''''' - Количество доставленных единиц вложения. </statushistory>:* '''''reason''''' - Причина недоставки <deliveredto>Иванова, выбирается из соответствующего списка статусовсекр.</deliveredto>*'''image''' <delivereddate>2016-06- Контейнер прикрепляемого изображения. Содержит текст файла изображения, закодированный по стандарту ''base64''. Контейнер '''order''' может содержать более одного контейнера '''image'''. Атрибут:02</delivereddate> <deliveredtime>17:* '''''filename''''' - Имя файла.22</deliveredtime> <outstrbarcode>EXT123456</outstrbarcode> <items> '''Пример ответа:''' <source langitem code="34533" extcode="abc123" quantity="1" mass="0.2" retprice="37.5" VATrate="0" barcode="2345625213125" article="1" returns="0" origincountry="040" GTD="" excise="0.00" governmentCode="11223311" suppcompany="Поставщик" suppINN="1112223334" suppphone="xml79161234567">Мяч</item> <?xml versionitem code="34456" extcode="abc124" quantity="2" mass="2" retprice="100" VATrate="10" barcode="4645625213138" article="2" returns="1.0" encodinggovernmentCode="UTF-8"?>Обруч<setorderinfo/item> <order ordercodeitem code="34421" extcode="abc125" quantity="3" mass="0.3" retprice="50" VATrate="18" barcode="2345625213126" article="1234563" errorreturns="0" errormsggovernmentCode="">Погремушка желтая</item> </items> <acquirers> <acquirer code="OK2" errormsgruname="УспешноIbox" /> <order ordercodeacquirer code="2345675" errorname="59Payme" errormsg/> <acquirer code="value [date_put] is already set6" errormsgruname="Значение [Дата доставки] уже указаноClick" /> </acquirers> </order></setorderinfotracking>
</source>
== где,* '''acquirers''' / '''acquirer''' - эквайринг, доступный для получения ссылки на оплату заказа** '''acquirers''' / '''acquirer''' / ''code'' - внутренний код эквайринга** '''acquirers''' / '''acquirer''' / ''name'' - наименование эквайринга  '''Получение документов для печати ==информации в формате 17 TRACK'''
'''Пример запроса получения печатных форм:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8" ?><waybilltracking17> <auth extra=">8" login="login" pass="pass" </extra> <ordersorderno> 1234<order orderno="1234567" ordercode="33331" /> <order orderno="1234568" ordercode="33332" /> </orders> <form>1</form></waybilltracking17>
</source>
 
'''Описание полей:'''
 
'''waybill''' - Корневой контейнер. Обязательный элемент
*'''auth''' - Авторизация. Обязательный элемент
*'''orders''' - Список заказов для получения печатных форм. Содержит тэги '''order''' с атрибутами:
:* '''''orderno''''' - шифр заказа
:* '''''ordercode''''' - внутренний код заказа. Указывать необходимо один из атрибутов для всех заказов. Приоритет имеет атрибут '''''ordercode'''''
*'''form''' - Формат накладной. Не обязательный элемент. Принимает значения:
:* 1 - Подробная накладная (по-умолчанию)
:* 2 - Наклейки Zebra
:* 3 - Наклейки на страницу формата А4
:* 4 - Акты приема-передачи
 
'''Пример ответа:'''
<source lang=pre>{ "number":"xmlExtNumber">, "oriNumber":"1234", "oriCountry":"RU", "destCountry":"RU", "status":"Complete", "events":[ { "time":"2016-06-02 17:22:00", "location":"RU", "town":"Москва", "store":"Москва Главный", "content":"Complete" }, { "time":"2016-06-02 17:22:00", "location":"RU", "town":"Москва", "store":"Москва Главный", "content":"Courierdelivered" }, { "time":"2016-06-02 09:17:00", "location":"RU", "town":"Москва", "store":"Москва Главный", "content":"Delivery" }, {<?xml version= "1.0time" encoding=:"UTF2016-06-802 07:41:00", "location":"RU", "town"?>:"Москва",<waybill> "store":"Москва Главный", < "content>EODIcaI8KSBlwQ 4MnEOR7Px8U8EBAyGICBnwpw ":"Accepted" IZhQgz0ZxuPs8EBM/GcbjzB AwhBl8hwQYIO00GmEwg1CeEG }, mqYTChNU0wqf8l8nz4zgc+K fCno+zwU5GjOZmzXGcbEQYIM { 4zkegRE40zWzONyoNNMIOIa cWnp6aDCGEGE9NQmoQd2mg00 "time":"2016-06-01 19:53:00", 79U4f3hPTwnfp6Sdrafeqpa JDpFw/1aYT077VNNNdO00G3q "location":"RU", "town":"Горький", "store":"Горький Автозавод", mqqvp9p2E7T0/wiFemv8uG6 OM</ "content>":"Departure" }, {</waybill> "time":"2016-06-01 17:38:00",</source> "location":"RU", "town":"Горький", "store":"Горький Автозавод",В тэге "content возвращаются бинарные данные (файл pdf)":"Departuring" }, { "time":"2016-05-30 10:20:00", закодированные в base64. "location":"RU", "town":"Горький",'''Обратите внимание''' "store":"Горький Автозавод", что печатные формы для заборов не формируются. "content":"New" } ]}</pre> Функция ищет последний заказ по номеру среди заказов всех клиентов. Выдает неперсонализированную информацию о текущем состоянии заказа.<br>== Справочник городов ==Описание контейнеров ответа аналогично описанию [[API#.D0.97.D0.B0.D0.BF.D1.80.D0.BE.D1.81 .D1.81.D1.82.D0.B0.D1.82.D1.83.D1.81.D0.B0 .D0.B7.D0.B0.D0.BA.D0.B0.D0.B7.D0.BE.D0.B2|Запроса статусов заказов]].
'''Пример запроса справочника городов:'''<source lang="xml"><?xml version="1.0" encoding="UTF-8"?>Получение ссылки для оплаты заказа ===<townlist> <auth extradiv style="8color: #a94442; background-color: #f2dede; border: 1px solid #ebccd1; padding: 3px 10px 10px;" /> <codesearch>'''Обратите внимание!''' <zipcode>110000</zipcode> <kladrcode>0100000100800</kladrcode> <fiascode>bd21979d-46f8-49d0-9105-e8d65172a983</fiascode> <code>123</code> </codesearch> <conditions> <city>Краснодарский край</city> <namecontains>новгород</namecontains> <namestarts>Моск</namestarts> <name>Москва</name> <fullname>Москва город</fullname> <country>1</country> </conditions> <limit> <limitfrom>30</limitfrom> <limitcount>10</limitcount> <countall>YES</countall> </limit></townlist>Этим методом вы можете только получить ссылку на оплату. Фискализация этого платежа идет отдельным процессом. По его возможности уточняйте в службе поддержки.</sourcediv>
Внутри контейнера townlist все элементы могут как отсутствоватьЗаказ доступен для оплаты, так и комбинироватьсяесли:* тип оплаты заказа не наличными, а например картой или по договору, альтернативой может стать установка параметра "Спрашивать тип оплаты" в карточке клиента. Поиск * заказ имеет наложенный платеж* не чувствителен к региструоплачен* активен (не доставлен, не возвращен в т.ч.курьером)
*'''authПример запроса:''' - Авторизация, необязательный элемент. Используется в случае включенного и настроенного ограничения по населенным пунктам в конкретной курьерской службе.<source lang="xml">*'''codesearch''' - Поиск по кодам<?xml version="1. В случае использования 0" encoding="UTF- контейнеры conditions и limit игнорируются.8"?><acqlink> <extra>8</extra> <acq>:* '''zipcode''' - Поиск по индексу. Обратите внимание на то, что один почтовый индекс может распространяться на несколько населенных пунктов. В этом случае система вернет несколько записей. <code>2</code>:* '''kladrcode''' - Поиск по 13-ти значному коду КЛАДР. </acq>:* '''fiascode''' - Поиск по коду ФИАС (AOGUID). <order>:* ''' <code>12345</code''' - Поиск по коду в системе.> </order></acqlink></source>
где*'''conditionsextra''' - Задает условия поиска. Все вложенные элементы одновременно накладывают условие "И"код экстраклиента в системе Measoft.:* acq.'''citycode''' - Поиск по всем населенным пунктам регионавнутренний код платформы эквайринга в системе Measoft.(известен в МП из [https:* '''namecontains''' - Поиск населенных пунктов, название которых содержит указанный текст//wiki.courierexe.ru/index.php/API#.D0.A2.D1.80.D0.B5.D0.BA.D0.B8.D0.BD.D0.B3_.D0.B7.D0.B0.D0.BA.D0.B0.D0.B7.D0.B0_.D0.BF.D0.BE_.D0.BD.D0.BE.D0.BC.D0.B5.D1.80.D1.83 Трекинга]) :* '''namestarts''' - Поиск населенных пунктов, название которых начинается с указанного текстаorder.:* '''nameordercode''' - Поиск населенных пунктоввнутренний код заказа, название которых соответствует указанному тексту.:* типа ''int'fullname''' - Поиск населенных пунктов, название вместе с типом населенного пункта которых соответствует указанному тексту.:* '''country''' - Поиск только по стране с указанным кодом.уникальный в пределах экстраклиента
*'''limitПример ответа:''' - Ограничивает вывод результата.:* '''limitfrom''' - Задает номер записи результата, начиная с которой выдавать ответ<source lang="xml"><?xml version="1. По-умолчанию 0" encoding="UTF- 8"?><acqlink error="0." amount="2000" extid="161083231">https:* '''limitcount'''- Задает количество записей результата, которые нужно вернуть//qr. По-умолчанию - 10000nspk.ru/AD10001A7GLVGA9YDO2I0789SIOPV3?type=02&amp;bank=1000011&amp;sum=2000&amp;cur=RUB&amp;crc=7E9C</acqlink>:* '''countall''' - YES указывает на необходимость подсчета общего количества найденных совпадений. Это может замедлять выполнение запроса. Если отключено - в ответе не указываются totalcount и totalpages.</source>
где*'''Пример ответа:acqlink''' - ссылка на оплату заказа*acqlink.'''amount''' - тип integer сумма платежа в копейках в общем случае, в других случаях в соответствии с типом валюты*acqlink.'''extid''' - идентификатор счета на стороне платежной системы*acqlink.'''error''- код ошибки, если отличается от 0, означает невозможность получения ссылки на оплату, в этом случае ссылки на оплату не будет и ответ будет выглядеть так:
<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<townlist countacqlink error="32" pagemessage="1Ошибка авторизации: Invalid token" totalcountamount="32000" totalpagesextid="1"/> <town> <code>26379</codesource> <city> <code>23</code>где <name>Краснодарский край</name>*acqlink.'''message''' - текст ошибки возвращаемой эквайрингом </city> <name>Сочи город</name>Возможные типы ошибок получения ссылки: <fiascode>79da737a* '''1''' -603bне настроен эквайринг, либо не найден заказ* '''2''' -4c19ошибка на стороне эквайринга* '''3''' -9b54запрещающий статус курьера (заказ доставлен, частично доставлен)* '''4''' -9114c96fb912</fiascode>оплата заказа не разрешена == Изменение заказа ==Запрос предназначен для изменения заказов. <kladrcode>2300000700000</kladrcode> <shortname /Изменять заказы могут курьерские службы с тарифами «Премиум» и «Максимум». Чтобы разрешить изменение заказов, в личном кабинете курьерской службы перейдите в '''Настройки''' > '''Заказы''' и в разделе '''Отмена и редактирование''' установите флажок '''Разрешить отмену и изменение заказов'''. Вы также можете пометить в списке '''Статусы для отмены и редактирования заказов''' галками статусы корреспонденции, для которых возможны отмена и изменение заказов. По умолчанию (not yet supportedкогда в этом списке ничего не выбрано)редактирование и отмена разрешены для статуса «Новый» <typename /> (not yet supported) <coords latdiv style="43.5855" lon="39.7231color: #a94442; background-color: #f2dede; border: 1px solid #ebccd1; padding: 3px 10px 10px;" /> </town>'''Обратите внимание!''' <town># Данные запроса изменения указываются '''полностью''', как если бы заказ создавался впервые. <code>40331</code># При отсутствии вложения в запросе изменения данное вложение '''не удаляется''' из заказа, но его количество становится равным 0. <city># При одновременном изменении заказа в API и системе курьерской службы приоритет отдается данным системы курьерской службы. То есть изменения в API приняты не будут. <code>32</codediv> <name>Брянская область</name> </cityПри редактировании заказа может быть отменен запланированный курьер. Это зависит от значения переменной '''Справочники''' > <name'''Переменные''' >Сочилов хутор</name'''Корреспонденция''' >'''Автоматически устанавливать заплан. курьера по району''': <fiascode>c9c96c67-2cc9-4f10-afde-fd32417ea216</fiascode>* '''Нет''' — при редактировании заказа по АПИ курьер не изменяется; <kladrcode>3201900011100</kladrcode>* '''Район''' — если изменен адрес доставки, курьер сбрасывается; <shortname />* '''Район или дата план. доставки''' — если изменен адрес доставки или плановая дата вручения, курьер сбрасывается. <typename /> <coords lat="52== Описание полей запроса изменения ===Все поля запроса соответствуют структуре order при создании заказа за исключением: * значение '''orderno''' данным методом изменить нельзя.* значение '''barcode''' изменяется в случае явного его указания.6407" lon="33В случае отсутствия или пустого значения - остается прежним.1724" /> </town>* вместо корневого тэга '''neworder''' указывается '''editorder'''; <town>* тэг курьера '''courier''' можно изменить только при включенной настройке '''Разрешить изменение курьера по АПИ'''; <* для вложений '''item''' указывается внутренний код вложения в атрибуте '''code>114016</''', который можно получить при получении статуса заказа.* для мест '''package''' указывается внутренний код вложения в атрибуте '''code>''', который можно получить при получении статуса заказа. <city> <code>60</code> <name>Псковская область</name>Необходимо иметь в виду, что: </city> <name>Сочихино деревня</name># Заказ нельзя изменить, пока он не синхронизирован с системой (пока предыдущие изменения не переданы в бэк-офис) <fiascode>10df7588# Удаление вложений и мест выполняется не моментально, а в процессе синхронизации с бэк-19c1-49d1-a387-9de1cf3eb26f</fiascode>офисом (для записей указываются метки Удалено)  <kladrcode>6001900015400</kladrcode>=== Описание полей ответа изменения === <shortname />Все поля ответа соответствуют ответу при создании заказа за исключением корневого тэга — вместо '''neworder''' возвращается '''editorder'''. <typename /> <coords lat="56.6003" lon="29Отмена заказа ==Запрос предназначен для отмены заказов.3542" /> </town></townlist></source>Отменять заказы могут курьерские службы с тарифами «Премиум» и «Максимум». Разрешения для отмены заказов и статусы в которых заказы можно отменять описаны в разделе '''Изменение заказов'''
В ответе города сортируются по популярностиПри отмене заказа поле «Инфо о доставке» получает значение «Отменено заказчиком», важности (районные центры и т.д.)поле «Дата доставки» — текущую дату, и только затем - по алфавитуа «Вручил курьер» — системную запись «ОТМЕНА».
== Справочник регионов ==
'''Пример запроса справочникаотмены заказа:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?><regionlistcancelorder> <codesearch> <code>77<auth extra="8" login="login" pass="pass" /code> <order orderno="" ordercode="123456" /codesearch> <conditions> <namecontains>край</namecontains> <namestarts>Моск</namestarts> <fullname>Московская область</fullname> <country>1</country> <order orderno="123aaa" ordercode="" /conditions></regionlistcancelorder>
</source>
 
 
'''Описание полей:'''
 
'''cancelorder''' — Корневой контейнер. Обязательный элемент.
* '''auth''' — Авторизация. Обязательный элемент.
* '''order''' — Контейнер отменяемого заказа. Обязательный элемент. Запрос может содержать более одного контейнера '''order'''. Атрибуты:
:* '''''orderno''''' — Шифр заказа.
:* '''''ordercode''''' — Внутренний код заказа.
Обратите внимание, что должен быть указан хотя бы один из атрибутов ''orderno'' или ''ordercode''!
 
'''Пример ответа:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?><regionlist count="2"cancelorder> <city> <code>80</code> <country> <code>1</code> <name>Россия</name> <id>643<order orderno="123test" ordercode="123456" error="0" errormsg="OK" errormsgru="Успешно" /id> <ShortName1>RU</ShortName1> <ShortName2>RUS</ShortName2> </country> <name>Агинский Бурятский автономный округ</name> </city> <city> <code>1</code> <country> <code>1</code> <name>Россия</name> <id>643</id> <ShortName1>RU</ShortName1> <ShortName2>RUS</ShortName2> </country> <name>Адыгея республика</name> <order orderno="123aaa" ordercode="" error="52" errormsg="order not found" errormsgru="Заказ не найден" /city></regionlistcancelorder>
</source>
== Справочник улиц Добавление вложений к накладной == Метод позволяет прикрепить файлы к корреспонденции.Размер загружаемого файла не должен превышать 1 Мб.
'''Пример запроса справочника улиц:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?><streetlistaddattachments> <conditionsauth extra="8" login="login" pass="pass" /> <townorderno>Москва город1234567</townorderno> // ОБЯЗАТЕЛЬНОЕ ПОЛЕ!<attachments> <namecontains>Хохло</namecontainsitem name="photo1.jpg">JVBERi0xLjMN1wb25lbnQgMQ JUBQREYwMTIzNDU2Nzg5IDI NMyAwIG9iag08PA0vVHlwZSA U3VidHlwZSAvSW1hZ2UNL1d pZHRoIDE4MDgNL0hlaWdodCA ggNCAwIFINL0JpdHNQZXJDb 21wb25lbnQgMQ0vRGVjb2RlU <namestarts>Академика Х</namestarts>ENL0NvbHVtbnMgMTgwOA0+P g0vSW1hZ2VNYXNrIHRydWUNL <name>Академика ХохловаXhEZWNvZGUNPj4Nc3RyZWFt DQ</nameitem> <fullname>Академика Хохлова улitem name="photo2.</fullnamejpg">VBERi0xLjMNAwIG9iag0HRoJ </conditions> JUBQREYwMTIzNDU2Nzg5IDI NMyAwIG9iag08PA0vVHlwZSA <limit> vWE9iamVjdA0vU3VidHlwZS AvSW1hZ2UNL1dpZHRoIDEzNj <limitfrom>30</limitfrom>gNL0hlaWdodCAxMzMzDS9MZ W5ndGggNCAwIFINL0JpdHNQZ <limitcount>10</limitcount>XJDb21wb25lbnQgMQ0vRGVj b2RlUGFybXMgPDwNL0sgLTEN <countall>YESL0NvbHVtbnMgMTM2OA0+Pg0 vSW</countallitem> </limitattachments></streetlistaddattachments>
</source>
*'''conditions''' - Задает условия поиска. Все вложенные элементы одновременно накладывают условие "И".
:* '''town''' - Обязательное поле. Название или код населенного пункта.
:* '''namecontains''' - Поиск улиц, название которых содержит указанный текст.
:* '''namestarts''' - Поиск улиц, название которых начинается с указанного текста.
:* '''name''' - Поиск улиц, название которых соответствует указанному тексту.
:* '''fullname''' - Поиск улиц, для которых название вместе с типом соответствует указанному тексту.
'''Описание полей:''' '''addattachments''' — Корневой контейнер. Обязательный элемент.*'''limitauth''' - Ограничивает вывод результата — Авторизация. Обязательный элемент.:* '''limitfromorderno''' - Задает номер записи результата, начиная  — Номер заказа. Обязательный элемент. Может использоваться тэг <ordercode> с которой выдавать ответуказанием внутреннего кода заказа. По-умолчанию - 0* '''attachments''' — Обязательный элемент, в котором перечисляются передаваемые данные файлов.:** '''limitcountitem'''- Задает количество записей результата — Бинарные данные (файл), которые нужно вернутьзакодированные в base64. По-умолчанию - 10000Обязательный элемент.:* ** '''name''' — Атрибут элемента ''countall'item''' - YES указывает на необходимость подсчета общего количества найденных совпадений. Это может замедлять выполнение запроса. Если отключено, в ответе не указываются totalcount и totalpagesкотором передается имя файла.Обязательный элемент. 
'''Пример ответа:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<streetlist countaddattachments> <attachments> <item name="1photo1.jpg" pageerror="10" totalcounterrormsg="3OK" totalpageserrormsgru="1Успешно"/> <street> <item name>Академика Хохлова ул="photo2.</name> <shortname>Академика Хохлова</shortname> <typename>ул.<jpg" error="0" errormsg="OK" errormsgru="Успешно" /typename> </streetattachments></streetlistaddattachments>
</source>
В ответе улицы сортируются по алфавиту== Получение вложений к накладной =='''Пример запроса:'''<source lang="xml"><?xml version="1.0" encoding="UTF-8" ?><attachments> <auth extra="8" login= Справочник номенклатуры ="login" pass="pass" /> <orderno>1234567</orderno></attachments></source> '''Описание полей:''' '''attachments''' — Корневой контейнер. Обязательный элемент.* '''auth''' — Авторизация. Обязательный элемент.* '''orderno''' — Номер/код заказа. Обязательный элемент. 
'''Пример запроса справочника номенклатурыответа:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8" ?><itemlistattachments> <auth extraitem name="8doc1.docx" logintimestamp="login2025-01-01 12:00:00" passsize="pass35654"></auth>JVBERixLjMN <codesearch> UwLJdLwIDKxTn+AScMjKqor7Xm3sp1yj1k6BzlPdX2Qsiit6yg3g1fCI4YVAgclUOIY5tDra2LvAcIS <code>123456< 5/+8PsL/sXb0+aoper/9kL/4Ov/code>YE9QsHwyg7YZTtKICy0YVIYb4Nt7L1tPUMfaX9NpuTsvFCtBAvYG eJVZoZ2tm6+fZVqAavZpeLizVLtct1a+xvG0+bTSkw3Ac8PhdNfL4smrT2hSgPJLfyaVGyA2ndyW22t <article>FD343< sFtTP5knktPNumSZ56QsFRPJkaU8ExDxAcMYMDIoBiIoR4/article> <barcode>2345625213125<dDjHMbMW/barcode>EW4fiB1pvWmV2ONWIl1Xdub < Xg1ob0qWX9W4qagsqzGhjRLsEGeJGVXg9oVC+XkJa9esrhGUmC0tuKEla+AplVO/codesearch>OtHwXcW0FWui1z7 <conditions> 6KHrtobuWV0xa9sCEiSvb91w3ePHOvfcveo5xt9o4ZevHF7ZOeKxV5qmVx2MI44a1L+Mhk5YuGT12xd <namecontains>телевизор< Ibsb7r+j9bff/unQlv0al6HBnoD5G89q4+tkjgDtvwwARmqm2aa2Jgvmth8mrXquTNtl2u467vbF/namecontains>5r <namestarts>sony< vnMt9uesu21Me1bjeNJGlVfAaCtw+/namestarts> <name>Sony KDL-55W905 ЖК-телевизор<jfenJ/name>fWjqa7ygExx+L0BcTGroxrKexQXIQ1ImfEW7ZRJZa+O <quantity>EXISTING_ONLY< ip7xJmmNESMxrgu/quantity>dquBbGypjJpFDJVRH1rVPR1Ifl4aFS5IEdDWZFSdyBBWKWhVSVu517ZgzOCFAwp <store>2< wwbFph29g4fTaxnvn/store>3X78x+Tt56ZNffArgULt+HByvy7+yz6U6XWMawCi3+6gJXN0S+jf4t+HT34wg < km7/conditions>HDp55YTSWMoCMgZsvZkBrXtIv4WA7xgkT4YpYpxjwLvnsWKkGE+pDbxER0UUWlpVFRY4oilTfM4 <except> MIzgCPgxjOlZ87ceA7ceRJrgpipFGyugPQ4OTI2S8lWJoqTpHJlJbNOeYM7zTcoVxSNyJXiYWSAMklT <code>123478< q/xd+3fd3/code>USq2V1rJ7RyBLHsuDSiLwgaOFc5LUCRGI+QWuBAsIwPlZrgRpSMseJyTzD15PKiIRE7bc </except> Rggk5ijXAPpqISetD4wVm0AD2LHuBZdaxmK3HOKIZoG0QLmiZdVqspXnFIJwVyCKhWiDCI4bzH8Y76w <limit> TAnwM67HIqMISOkmJXY8mlYhpiNa7g2oTBkKxo4wgnvETQIUUrlFOn9KdOreDiKQx071rN4N61yRAi1 <limitfrom>30< 7EGRhSOgoeLYv+k41+KZ1SVBXAuDjB+xuxnQmm8wJDcP5IRn+5penzbR/limitfrom>ivm7qleHK5o790w8ejXchI <limitcount>10 vOHIPWtWwYhtAO34LdDXqFqWxZEBLNstMCwwITBTWirxk12zuUppp</limitcountitem> <countall>YES</countallattachments> </limitsource></itemlist><В тегах item возвращаются бинарные данные (файлы), закодированные в base64. == Изменение статуса агентом ==Запрос изменения статуса заказа позволяет установить окончательный статус заказа — «Доставлен» или «Не доставлен (Возврат/source>Отмена)».
Внутри контейнера itemlist все элементы могут как отсутствоватьКроме этого, так устанавливается дата и комбинироваться. Поиск не чувствителен к регистру.*'''codesearch''' - Поиск по кодам. В случае использования - контейнеры conditions и limit игнорируются.:* '''code''' - Поиск по внутреннему коду системы.:* '''article''' - Поиск по артикулу.:* ''время (при необходимости) изменения статуса, а также сообщение в поле 'barcode'Инфо о доставке'' - Поиск по штрих-коду.
*'''conditions''' - Задает условия поиска. Все вложенные элементы одновременно накладывают условие "И".:* '''namecontains''' - Поиск товаров, название которых содержит указанный текст.:* '''namestarts''' - Поиск товаров, название которых начинается с указанного текста.:* '''name''' - Поиск товаров, название которых соответствует указанному тексту.:* '''quantity''' - Наличие на складе. Принимает значения EXISTING_ONLY - Только в наличии, NOT_EXISTING_ONLY - Только не в наличии, ALL - Все. ''Это поле может быть недоступным в некоторых установках.'':* '''store''' - Поиск товаров по определенному складуПри необходимости к заказу можно прикрепить изображения.
*'''except''' - Описание исключений для корректного определения количества зарезервированной номенклатуры.
:* '''code''' - Код заказа.
*'''limit''' - Ограничивает вывод результата.:* '''limitfrom''' - Задает номер записи результата, начиная с которой выдавать ответ.:* '''limitcount''' - Задает количество записей результата, которые нужно вернуть. '''Пример ответазапроса изменения статуса:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?><itemlist countsetorderinfo> <auth extra="38" totalcountlogin="3login" pagepass="1" totalpages="1pass"/> <itemorder ordercode="123456"> <codemessage>123456Получил Иванов</codemessage> <articleoutstrbarcode>FD3437654312</articleoutstrbarcode> <barcode/order>2345625213125 </barcodeorder ordercode="234567"> <namestatus>Sony KDL-55W905 ЖК-телевизорPICKUPREADY</namestatus> <retpriceeventtime>650002016-05-30 10:20:00</retpriceeventtime> <purchpricemessage>50000Клиент отказался от покупки</purchpricemessage> <weightpaytype>5.1CASH</weightpaytype> <lengthstoreprice>50123</lengthstoreprice> <widthitems>30 <item code="34533" quantity="1" reason="0" governmentCode="11223311" /width> <heightitem code="34456" quantity="0" reason="0" />40 <item code="34421" quantity="2" reason="0" /height> <VATrate>20</VATrateitems> <CountInPalletattachments>30 <attachment filename="filename1.jpg"> /CountInPallet>9j/4AAQSkZJRgA BAQAAAQABAAD/2wBDAA0JCg sKCA0LCgsODg0PEyAVExISEy ccHhcgLikxMC4pLSwzOko+M zZGNywtQFdBRkxOUlNSMj5aY VpQYEpRUk//2wBDAQ4ODhMR EyYVFSZPNS01T09PT09PT09P T09PT09PT09PT09PT09PT09 PT09PT09PT09PT09PT09PT09 <HasSerials>1 PT09PT0//wAARCAYACAADAS IA</HasSerialsattachment> <CountryOfOriginattachment filename="filename2.jpg">Малайзия</CountryOfOrigin> (not yet supported)9j/4AAQSkZJRgA <Message>Хороший телевизор< BAQAAAQABAAD/Message>2wBDAA0JCg sKCA0LCgsODg0PEyAVExISEy ccHhcgLikxMC4pLSwzOko+M zZGNywtQFdBRkxOUlNSMj5aY <Message2>Снова хороший телевизор< VpQYEpRUk//Message2>2wBDAQ4ODhMR EyYVFSZPNS01T09PT09PT09P T09PT09PT09PT09PT09PT09 PT09PT09PT09PT09PT09PT09 <quantity>12 PT09PT0//wAARCAYACAADAS IA</quantityattachment> <reserved>3</reservedattachments> <item/order> ...</itemlistsetorderinfo>
</source>
'''Описание полей:'''
*'''code''' - Внутренний идентификатор, присвоенный системой.
*'''article''' - Артикул, назначенный клиентом (поставщиком).
*'''barcode''' - Штрих-код производителя.
*'''name''' - Наименование.
*'''retprice''' - Розничная цена по-умолчанию. При оформлении заказа цена используется та, которая указана в заказе.
*'''purchprice''' - Закупочная цена.
*'''weight''' - Масса в килограммах.
*'''length''' - Длина в сантиметрах.
*'''width''' - Ширина в сантиметрах.
*'''height''' - Высота в сантиметрах.
*'''VATrate''' - Ставка НДС, целое число процентов.
*'''CountInPallet''' - Количество штук в паллете.
*'''HasSerials''' - Требует учета серийных номеров. Принимает значения 1 - да, 0 - нет.
*'''CountryOfOrigin''' - Наименование страны происхождения на русском языке.
*'''Message''' - Комментарий.
*'''Message2''' - Дополнительный комментарий.
*'''quantity''' - Количество на складе. Товары, уже собранные в заказы в этом количестве не присутствуют, считаются покинувшими товарный склад. ''Это поле может быть недоступным в некоторых установках.''
*'''reserved''' - Количество зарезервированного товара. Может превышать остаток на складе, если покупатели ждут следующей поставки. ''Это поле может быть недоступным в некоторых установках.''
== Движение номенклатуры =='''Описание полей запроса статуса:'''
'''Пример запроса движения номенклатуры:setorderinfo''' — Корневой контейнер. Обязательный элемент.* '''auth''' — Авторизация. Обязательный элемент.* '''order''' — Контейнер заказа. Обязательный элемент. Запрос может содержать более одного контейнера '''order'''. Атрибут '''''ordercode''''' — внутренний код заказа.* '''status''' — Новый статус заказа. Доступны статусы из раздела [[#Описание полей ответа статусов]], кроме AWAITING_SYNC и NEW.<source lang="xml">* '''eventtime''' — Дата и время изменения статуса. Обязательно при указании статуса.<?xml version="1* '''message''' — Текст сообщения ''Инфо о доставке''.0" encoding="UTF-8" ?><itemmovements>* '''outstrbarcode''' — код у подрядчика (код заказа во внешней системе). Используется в интеграциях с внешними системами. <auth extra="8" login="login" pass="pass"><* '''paytype''' — Тип оплаты заказа. Допустимые значения CASH/auth>CARD.* '''storeprice''' — Агентское вознаграждение.* '''items''' — Контейнер для описания вложений '''item''' . Атрибуты: <:* '''''code>4259</code>''''' — Код вложения.:* '''''quantity''''' — Количество доставленных единиц вложения.:* '''''reason''''' — Причина недоставки, выбирается из соответствующего списка статусов. <datefrom>2020-10-01</datefrom>:* '''''governmentCode''''' — Указание кода ТН для вложения при необходимости. <dateto>2020-10-02</dateto>* '''attachments''' — Контейнер прикрепляемых изображений. Может содержать несколько контейнеров '''attachment'''</itemmovements>:* '''attachment''' — Контейнер изображения. Содержит текст файла изображения, закодированный по стандарту ''base64''. Атрибут:</source>::* '''''filename''''' — Имя файла.
*'''code''' - внутренний код товара в справочнике номенклатуры.
*'''datefrom''' - дата начала периода.
*'''dateto''' - дата окончания периода.
Может быть указан или код, или период, или код и период одновременно.
'''Пример ответа движения номенклатуры:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8" ?><itemmovements count="16"setorderinfo> <itemmovement> <code>151500</code> <date>2017-05-26</date> <retprice>order ordercode="123456" error="0<" errormsg="OK" errormsgru="Успешно" /retprice> <quantity>1 <order ordercode="234567" error="59" errormsg="value [date_put] is already set" errormsgru="Значение [Дата доставки] уже указано" /quantity> <delivered>0</delivered> <itemsetorderinfo> <code>4259</codesource> <name>Настольная игра Дженга</name> </item>== Получение документов для печати == <status>'''Пример запроса получения печатных форм:''' <code>5</codesource lang="xml"> <name>Возврат от покупателя</name?xml version="1.0" encoding="UTF-8" ?> </statuswaybill> <store> <code>1 <auth extra="8" login="login" pass="pass" /code> <nameclient>офис в МосквеCLIENT</nameclient> </storeorders> <order> <orderno="1234567" ordercode>3374830<="33331" /ordercode> <number>123660-0</number> <date>2017-05-24</date> <order orderno>14123<="1234568" ordercode="33332" /orderno> <barcode>0000000670 </barcodeorders> <company>ТОВАР</company> <addressform>Кравченко ул., 1</addressform> <delivereddatestart>2017-05-295</delivereddatestart> <deliveredtime>12:00:00</deliveredtime> <deliveredto /> </orderintegration> <document> <code>21991</code> <number>318</number> <date>2017-05-26</date> <message></message> </document> 21</itemmovementsintegration></itemlistwaybill>
</source>
''' Описание полей ответа :'''*'''code''' - внутренний код операции движения*'''date''' - дата операции*'''retprice''' - цена товара*'''quantity''' - количество товара операции*'''delivered''' - количество доставленного товара
'''waybill''' — Корневой контейнер. Обязательный элемент* '''auth''' — Авторизация. Обязательный элемент*'''itemclient''' - контейнер товара — Признак клиента или агента. Необязательный элемент.:* CLIENT — Признак клиента, значение по умолчанию:* AGENT — Признак агента. В ответ отдается информация по заказам, переданным агенту на доставку* '''orders''' — Список заказов для получения печатных форм. Содержит тэги '''order''' с атрибутами::* '''''orderno''''' — шифр заказа:* '''code''ordercode''' - '' — внутренний код товаразаказа. Указывать необходимо один из атрибутов для всех заказов. Приоритет имеет атрибут '''''ordercode'''''* '''form''' — Формат накладной. Не обязательный элемент. Принимает значения::* 1 — Подробная накладная (по-умолчанию):* 2 — Наклейки Zebra:* 3 — Наклейки на страницу формата А4:* 4 — Акты приема-передачи* '''namestart'''  — Имеет смысл только для form = 3. Начальная позиция первой наклейки. Используется для пропуска наклеек на листе для их экономии.* '''integration''' - Получение наклеек от подрядчика. Не обязательный элемент, имеет смысл при наличии кода подрядчика в карточке заказа. Принимает значение::* 21 - наименование товараподрядчик GTD
*'''status''' - контейнер статуса операции
:* '''code''' - код статуса
:* '''name''' - наименование
*'''storeПример ответа:''' <source lang="xml"><?xml version="1.0" encoding="UTF- контейнер филиала, к которому относится операция8"?><waybill> <integration code="21"> <order code="33331"> <content>JVBERi0xLjYNJeLjz9MNC...</content> </order>:* ''' <order code''' - код филиала="33332"> <content>JVBERi0xLjYNJeLjz9MNC...</content> </order> </integration> <content>EODIcaI8KSBlwQ 4MnEOR7Px8U8EBAyGICBnwpw IZhQgz0ZxuPs8EBM/GcbjzB AwhBl8hwQYIO00GmEwg1CeEG mqYTChNU0wqf8l8nz4zgc+K fCno+zwU5GjOZmzXGcbEQYIM 4zkegRE40zWzONyoNNMIOIa cWnp6aDCGEGE9NQmoQd2mg00 79U4f3hPTwnfp6Sdrafeqpa JDpFw/1aYT077VNNNdO00G3q mqqvp9p2E7T0/wiFemv8uG6 OM</content></waybill>:* '''name''' - наименование филиала</source>
*'''order''' - контейнер корреспонденции
:* '''ordercode''' - внутренний код заказа
:* '''number''' - номер заказа
:* '''date''' - дата заказа
:* '''orderno''' - шифр
:* '''barcode''' - штрих-код
:* '''company''' - компания
:* '''address''' - адрес
:* '''delivereddate''' - дата вручения
:* '''deliveredtime''' - время вручения
:* '''deliveredto''' - данные о вручении, либо причина недоставки
*'''document''' - контейнер документа операцииВ тэге content возвращаются бинарные данные (файл pdf), закодированные в base64.:* '''code''' - внутренний код документа:* '''number''' - номер документа:* '''extnumber''' - внешний номер документа:* '''date''' - дата документа:* '''message''' - комментарийПри записи в файл необходимо использовать двоичный формат записи!
== Получение справочника тарифов по городам ==
'''Пример запроса справочника тарифов по городам'''<source lang="xml"><?xml version="1Блок integration содержит отдельные наклейки для заказов, предоставленные подрядчиком, так же закодированные в base64.0" encoding="UTF-8"?><tariffs> <auth extra="8" login="login" pass="pass" /> <townfrom>Москва</townfrom> <service>1</service> <mainonly>1</mainonly> </tariffs></source>
*'''authОбратите внимание''' — атрибут '''extra''' обязателен, по нему определяется курьерская служба.*'''townfrom''' — город-отправитель. Если что печатные формы для заборов не передан, то городом будет «Москва».*'''service''' — режим доставки. Обязательный элемент.*'''mainonly''' — необязательный элемент. Если передан, то в ответе будут данные только по городам из справочника '''Межгород''' > '''Зоны'''формируются.
'''Пример ответа справочника тарифов по городамс ошибкой:'''<source lang="jsonxml">{ "townfrom": "0c5b2444-70a0-4932-980c-b4dc0d3f02b5", "service<?xml version=": 1, .0"tariffs": [ { encoding="towntofias": "7339e834-2cb4-4734-a4c7UTF-1fca2c66e5628",?> "towntocode": "482",<waybill> "towntoname": "Уфа город", <error>Текст ошибки</error> "pricesnew": { "before": [ { "price": "100", "every": "0", "mass": "1" }, { "price": "200", "every": "1", "mass": "2" } ], "after": [ { "price": "300", "every": "1", "mass": "3" } ] }, "prices": { "before": { "mass": "3", "price": "202.5" }, "after": { "mass": "3", "every": "1", "price": "18.75" } }, "deliveryPeriodMin": 4, "deliveryPeriodMax": 5 } ]}</waybill>
</source>
== Справочник городов ==''' Описание полей ответа Пример запроса справочника городов:'''* '''townfrom''' — код ФИАС города<source lang="xml"><?xml version="1.0" encoding="UTF-отправителя.8"?><townlist> <auth extra="8" /> <codesearch>* '''service''' — режим доставки. <zipcode>110000</zipcode>*'''tariffs''' — cписок тарифов по городу. <kladrcode>0100000100800</kladrcode>:* '''towntofias''' — код ФИАС города <fiascode>bd21979d-46f8-49d0-9105-получателя.e8d65172a983</fiascode> <code>123</code> </codesearch> <conditions> <city>Краснодарский край</city> <namecontains>новгород</namecontains> <namecontainsparts>молоково моск</namecontainsparts> <namestarts>Моск</namestarts> <name>Москва</name> <fullname>Москва город</fullname>:* '''towntocode''' — внутренний код города-получателя. <country>1</country>:* '''towntoname''' — наименование города-получателя. </conditions>:* '''pricesnew''' — ваши настройки тарифов из справочника '''Межгород''' <limit> '''Тарифы по зонам'''.::* '''price''' — цена. <limitfrom>30</limitfrom>::* '''every''' — за каждые. <limitcount>10</limitcount>::* '''mass''' — масса. <countall>YES</countall>:* '''prices''' — устаревший элемент, не используется. </limit>:* '''deliveryPeriodMin''' — минимальный срок доставки.</townlist>:* '''deliveryPeriodMax''' — максимальный срок доставки.</source> == Номенклатура приходной накладной ==Внутри контейнера townlist все элементы могут как отсутствовать, так и комбинироваться. Поиск не чувствителен к регистру.
* '''Пример запроса номенклатуры приходной накладной:auth'''<source lang="xml"><?xml version="1 — Авторизация, необязательный элемент. Используется в случае включенного и настроенного ограничения по населенным пунктам в конкретной курьерской службе.0" encoding="UTF-8" ?><itemdoc> <auth extra="8" login="login" pass="pass"></auth> <code>21991</code></itemdoc></source>
*'''codecodesearch''' — Поиск по кодам. В случае использования — контейнеры conditions и limit игнорируются.:* '''zipcode''' — Поиск по индексу. Обратите внимание на то, что один почтовый индекс может распространяться на несколько населенных пунктов. В этом случае система вернет несколько записей.:* '''kladrcode'''  — Поиск по 13- внутренний код документа приходной накладной ти значному коду КЛАДР.:* '''fiascode''' — Поиск по коду ФИАС (смAOGUID). предыдущий запрос):* '''code''' — Поиск по коду в системе.
* '''conditions''' — Задает условия поиска. Все вложенные элементы одновременно накладывают условие «И».
:* '''city''' — Поиск по всем населенным пунктам региона.
:* '''namecontainsparts''' — Поиск населенных пунктов, название которых содержит все указанные слова, с разбиением поисковой фразы через пробел. Например "моск моло" найдет деревню "Молоково" в Московской области.
:* '''namecontains''' — Поиск населенных пунктов, название которых содержит указанный текст.
:* '''namestarts''' — Поиск населенных пунктов, название которых начинается с указанного текста.
:* '''name''' — Поиск населенных пунктов, название которых соответствует указанному тексту.
:* '''fullname''' — Поиск населенных пунктов, название вместе с типом населенного пункта которых соответствует указанному тексту.
:* '''country''' — Поиск только по стране с указанным внутренним кодом или текстовым кодом в соответствии [https://ru.wikipedia.org/wiki/ISO_3166-1 стандартом ISO_3166-1], например, «RU», «RUS» для России.
* '''Пример ответа движения номенклатурыlimit''' — Ограничивает вывод результата.:* '''limitfrom'<source lang="xml"><?xml version="1'' — Задает номер записи результата, начиная с которой выдавать ответ.По-умолчанию — 0" encoding="UTF-8" ?>.<itemdoc> <code>21991</code> <number>318</number> <date>2017:* '''limitcount'''-05Задает количество записей результата, которые нужно вернуть. По-26</date>умолчанию — 10000. <message></message> <items> <item code="4259" quantity="1" barcode="200300" article="123555">Настольная игра Дженга</item> </items></itemdoc></source>:* '''countall''' — YES указывает на необходимость подсчета общего количества найденных совпадений. Это может замедлять выполнение запроса. Если отключено — в ответе не указываются totalcount и totalpages.
''' Описание полей Пример ответа '''* '''code''' - внутренний код приходной накладной* '''number''' - номер документа* '''date''' - дата документа* '''message''' - комментарий *'''item''' - контейнер товара:* '''code''' - внутренний код товара:* '''barcode''' - штрих-код товара:* '''article''' - артикул товара:* '''quantity''' - количество поступившего товара == Справочник филиалов == '''Пример запроса списка филиалов:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8" ?><storelisttownlist count="3" page="1" totalcount="3" totalpages="1"> <town> <auth extra="8"code>26379</authcode> <city> <jsoncode>YES23</jsoncode> <client_codename>7890Краснодарский край</client_codename> </storelistcity> <name>Сочи город</sourcename*'''auth''' <fiascode>79da737a-603b- Атрибут '''extra''' 4c19- обязателен, по нему определяется курьерская служба*'''json''' 9b54- Признак вывода ответа в виде JSON YES9114c96fb912</NOfiascode>*'''client_code''' - Код клиента курьерской службы <kladrcode>2300000700000</kladrcode> <shortname /> (not yet supported)'''Пример ответа:''' <source lang="xml"typename /> (not yet supported) <?xml versioncoords lat="143.05855" encodinglon="UTF-839.7231" ?/> <storelist count="2"/town> <storetown> <code>12340331</code> <city> <code>32</code> <name>ABCБрянская область</name> </city> <name>Сочилов хутор</name> <fiascode>c9c96c67-2cc9-4f10-afde-fd32417ea216</fiascode> <kladrcode>3201900011100</kladrcode> <shortname /> <typename /> <coords lat="52.6407" lon="33.1724" /> </storetown> <storetown> <code>456114016</code> <city> <code>60</code> <name>Филиал 2Псковская область</name> </storecity> <name>Сочихино деревня</storelistname> <fiascode>10df7588-19c1-49d1-a387-9de1cf3eb26f</sourcefiascode> <kladrcode>6001900015400</kladrcode>*'''code''' - Код филиала. *'''name''' - Наименование филиала. <shortname /> <typename /> <coords lat="56.6003" lon= Справочник пунктов самовывоза =="29.3542" /> </town>Для отображения списка пунктов выдачи (ПВЗ) есть '''готовый JavaScript модуль''': https:</townlist></homesource> В ответе города сортируются по популярности, важности (районные центры и т.courierexe д.ru/js/measoft_map.js Инструкция ), и только затем — по использованию - внутриалфавиту. Посмотреть пример работы можно [https://home.courierexe.ru/pvz_test.html Здесь] == Справочник регионов =='''Пример запроса пунктов самовывозасправочника:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8" ?><pvzlistregionlist> <auth extra="8" login="login" pass="pass"></authcodesearch> <code>123477</code> <client_code>7890 </client_codecodesearch> <town>Нижний Тагил</townconditions> <parentcodenamecontains>6край</parentcode> <acceptcash>YES</acceptcash> <acceptcard>YES</acceptcard> <acceptfitting>YES</acceptfitting> <maxweight>30</maxweight> <acceptindividuals>YES</acceptindividuals> <lt>57.924737</lt> <lg>59.940019</lg> <rt>57.905682</rt> <rg>59.984669</rg> <json>YES</json> <limitnamecontains> <limitfromnamestarts>30Моск</limitfromnamestarts> <limitcountfullname>2Московская область</limitcountfullname> <countallcountry>YESRU</countallcountry> </limitconditions></pvzlistregionlist>
</source>
*'''auth''' - Атрибут '''extra''' - обязателен, по нему определяется курьерская служба, '''login''' и '''pass''' позволяют авторизоваться под клиентом: для отдельного клиента могут быть ограничения по доступности некоторых ПВЗ, и в этом случае они будут учтены.*'''code''' - Внутренний код.*'''client_code''' - Код клиента курьерской службы.*'''town''' - Город получателя.*'''parentcode''' - Фильтр по родительскому [[#Справочник филиалов|филиалу]]*'''acceptcash''' - Фильтр по приему наличных YES/NO*'''acceptcard''' - Фильтр по приему банковских карт YES/NO*'''acceptfitting''' - Фильтр по наличию примерки YES/NO*'''maxweight''' - Фильтр по максимальному весу, с которым работает ПВЗ*'''acceptindividuals''' - Фильтр по доступности физическим лицам YES/NO*'''lt''' - Широта левого верхнего угла*'''lg''' - Долгота левого верхнего угла*'''rt''' - Широта правого нижнего угла*'''rg''' - Долгота правого нижнего угла*'''json''' - Признак вывода ответа в виде JSON YES/NO*'''limit''' - Ограничивает вывод результата.:* '''limitfrom''' - Задает номер записи результата, начиная с которой выдавать ответ. По-умолчанию - 0.:* '''limitcount'''- Задает количество записей результата, которые нужно вернуть. По-умолчанию - 100.:* '''countall''' - YES указывает на необходимость подсчета общего количества найденных совпадений. Это может замедлять выполнение запроса. Если отключено - в ответе не указываeтся totalcount.  '''Пример ответа справочника пунктов самовывоза:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8" ?><pvzlist regionlist count="2" totalcount="40465"> <pvzcity> <code>12680</code> <clientcodecountry>3 <code>1</clientcodecode> <name>Нижний ТагилРоссия</name> <parentcodeid>6643</parentcodeid> <parentnameShortName1>ИнтеграцияRU</parentnameShortName1> <town code="124267" regioncode="66" regionname="Свердловская область"ShortName2>Нижний Тагил городRUS</townShortName2> <address>622036, г. Нижний Тагил, ул. Циолковского, д. 17</addresscountry> <phonename>+73435417709, +73435254989Агинский Бурятский автономный округ</phonename> <comment>Новый пункт доставки </commentcity> <worktime>Вс 10:00-16:00, Сб 10:00-16:00, Пн-Пт 10:00-20:00 </worktimecity> <traveldescriptioncode>Жилое 5-ти этажное здание, торцом к дороге, второе здание от перекрестка Пархоменко-Циолковского1</traveldescriptioncode> <maxweight>10</maxweightcountry> <acceptcashcode>YES1</acceptcashcode> <acceptcardname>YESРоссия</acceptcardname> <acceptfittingid>YES643</acceptfittingid> <acceptindividualsShortName1>YESRU</acceptindividualsShortName1> <latitudeShortName2>57.93457RUS</latitudeShortName2> <longitude>59.95131</longitudecountry> <uidname>40606d00-9c51-11eb-b2c9-cfd6c1111392Адыгея республика</uidname> </pvz> <pvzcity> <code>245</coderegionlist> <clientcode>NTG1</clientcodesource> <name>На Красноармейской</name> <parentcode>6</parentcode>== Справочник улиц == <parentname>Интеграция</parentname>'''Пример запроса справочника улиц:''' <town codesource lang="124267xml" regioncode><?xml version="661.0" regionnameencoding="Свердловская областьUTF-8"?>Нижний Тагил город</townstreetlist> <address>КРАСНОАРМЕЙСКАЯ, д.79 </addressconditions> <phonetown>+7(3435)379-044Москва город</phonetown> <comment>Возможность примерки отсутствует< /comment> <worktime>Вс 10:00-16:00, Сб 10:00-16:00, Пн-Пт 10:00-20:00</worktime>ОБЯЗАТЕЛЬНОЕ ПОЛЕ! <traveldescriptionnamecontains>Напротив ТЦ ПирамидаХохло</traveldescriptionnamecontains> <maxweightnamestarts>20Академика Х</maxweightnamestarts> <acceptcashname>YESАкадемика Хохлова</acceptcashname> <acceptcardfullname>YESАкадемика Хохлова ул.</acceptcardfullname> <acceptfitting>NO </acceptfittingconditions> <acceptindividuals>YES </acceptindividualslimit> <latitudelimitfrom>57.9346830</latitudelimitfrom> <longitudelimitcount>60.5547610</longitudelimitcount> <uidcountall>41116853-9c51-11eb-b2c9-cfd6c1451392YES</uidcountall> </pvzlimit></pvzliststreetlist>
</source>
*'''codeconditions''' - Код ПВЗ в системе — Задает условия поиска. Используется в запросе [[API#Оформление заказа|оформления заказов]]*'''clientcode''' - Код ПВЗ используемый компанией-подрядчикомВсе вложенные элементы одновременно накладывают условие «И».:*'''nametown''' - Наименование ПВЗ — Обязательное поле.*'''parentcode''' - Код родительского элементаНазвание или код населенного пункта.:*'''parentnamenamecontains''' - Наименование родительского элемента — Поиск улиц, название которых содержит указанный текст.:*'''townnamestarts''' - Населенный пункт с кодом из [[#Справочник городов|справочника городов]] — Поиск улиц, а также название которых начинается с кодом и наименованием регионауказанного текста.:*'''addressname''' - Адрес ПВЗ — Поиск улиц, название которых соответствует указанному тексту.:*'''phone''' - Телефоны ПВЗ.*''fullname'comment''' - Дополнительная информация.*'''worktime''' - Режим работы ПВЗ.*'''traveldescription''' - Описание местонахождения ПВЗ или пути к нему.*'''maxweight''' - Максимальный вес — Поиск улиц, для которых название вместе с которым работает ПВЗтипом соответствует указанному тексту.*'''acceptcash''' - Признак приема наличных*'''acceptcard''' - Признак приема банковских карт*'''acceptfitting''' - Наличие примерки*'''latitude''' - Широта*'''longitude''' - Долгота*'''uid''' - Уникальный идентификатор ПВЗ в системе Measoft*'''count''' - Количество записей в ответе*'''totalcount''' - Общее количество записей, отвечающее параметрам запроса
== Получение фискальных данных заказа ==* '''limit''' — Ограничивает вывод результата.:* '''limitfrom''' — Задает номер записи результата, начиная с которой выдавать ответ. По-умолчанию — 0.:* '''limitcount'''- Задает количество записей результата, которые нужно вернуть. По-умолчанию — 10000.:* '''countall''' — YES указывает на необходимость подсчета общего количества найденных совпадений. Это может замедлять выполнение запроса. Если отключено, в ответе не указываются totalcount и totalpages.
'''Пример запроса получения фискальных данныхответа:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<receiptdata> <auth extrastreetlist count="1" page="81" logintotalcount="login3" passtotalpages="pass1" > <street> <code>124</code> <ordersname>Академика Хохлова ул.</name> <shortname>Академика Хохлова</shortname> <typename>ул.<order orderno="123456" /typename> <order orderno="890111C" /street> </ordersstreetlist></receiptdatasource>
В ответе улицы сортируются по алфавиту.
</source>== Справочник номенклатуры =='''Пример ответа получения фискальных данныхзапроса справочника номенклатуры:'''
<source lang="xml">
  <?xml version="1.0" encoding="UTF-8"?><receipts countitemlist> <auth extra="18" login="login" pass="pass"></auth> <receiptcodesearch> <ordernocode>123456</ordernocode> <fdDatetimearticle>2020-06-07 12:14:00FD343</fdDatetimearticle> <fdValuebarcode>1232345625213125</fdValuebarcode> <fdNum>456 </fdNumcodesearch> <fnSn>789</fnSnconditions> <kktNumnamecontains>100телевизор</kktNumnamecontains> <innnamestarts>222sony</innnamestarts> <ofdUrlname>gate.ofd.ruSony KDL-55W905 ЖК-телевизор</ofdUrlname> <fullUrlquantity>https://check.ofd.ru/123EXISTING_ONLY</fullUrlquantity> <pricestore>123452</pricestore> <lines count="1"> <line> <item>1111764 </itemconditions> <name>Сапоги </nameexcept> <qtycode>1123478</qtycode> <price>1000 </priceexcept> <vatRate>20</vatRatelimit> <governmentCodelimitfrom>Z16513LK230</governmentCodelimitfrom> <itemTypelimitcount>110</itemTypelimitcount> </linecountall> YES</linescountall> </receiptlimit></receiptsitemlist>
</source>
Параметры ответа:Внутри контейнера itemlist все элементы могут как отсутствовать, так и комбинироваться. Поиск не чувствителен к регистру.*'''ordernocodesearch''' - Номер заказа*'''fdDatetime''' - Дата  — Поиск по кодам. В случае использования — контейнеры conditions и время пробития фискального чекаlimit игнорируются.:*'''fdValuecode''' - ФПД (фискальный признак документа) — Поиск по внутреннему коду системы.:*'''fdNumarticle''' - ФИСКАЛЬНЫЙ ДОКУМЕНТ (фискальный номер чека) — Поиск по артикулу.:*'''fnSnbarcode''' - ФН (номер фискального накопителя) — Поиск по штрихкоду.*'''kktNum''' - РН (регистрационный номер кассы)*'''innconditions''' - ИНН — Задает условия поиска. Все вложенные элементы одновременно накладывают условие «И».:*'''ofdUrlnamecontains''' - URL адрес (доменное имя) ОФД*'''price''' - Сумма чека*'''fullUrl''' - URL чека для просмотра онлайн*'''lines''' - Позиции чека — Поиск товаров, название которых содержит указанный текст.:*'''itemnamestarts''' - код товара — Поиск товаров, название которых начинается с указанного текста.:*'''name''' - наименование товара — Поиск товаров, название которых соответствует указанному тексту.:*'''qtyquantity''' - количество товара:*'''price''' - цена товара:*'''governmentCode''' - считанная последовательность — Наличие на складе. Принимает значения EXISTING_ONLY — Только в наличии, которая NOT_EXISTING_ONLY — Только не в дальнейшем преобразуется по алгоритму тега 1162:*наличии, ALL — Все. '''vatRateЭто поле может быть недоступным в некоторых установках.''' - НДС товара:*'''itemTypestore''' - тип товара (товар, доставка и т.д — Поиск товаров по определенному складу.)
== Справочник Виды срочности ==* '''except''' — Описание исключений для корректного определения количества зарезервированной номенклатуры.:* '''code''' — Код заказа.
* '''Пример запроса видов срочностиlimit''' — Ограничивает вывод результата.:* '''limitfrom''' — Задает номер записи результата, начиная с которой выдавать ответ.<source lang="xml"><?xml version="1:* '''limitcount''' — Задает количество записей результата, которые нужно вернуть.0" encoding="UTF-8" ?><services><auth extra="8"/></services></source>
'''Пример ответа справочника видов срочности:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8" ?><services itemlist count="23" totalcount="3" page="1" totalpages="1"> <serviceitem> <code>1123456</code> <article>FD343</article> <barcode>2345625213125</barcode> <name>ЭкономSony KDL-55W905 ЖК-телевизор</name> <retprice>65000</retprice> <purchprice>50000</purchprice> <weight>5.1</weight> <length>50</length> <width>30</width> <height>40</height> <VATrate>20</serviceVATrate> <CountInPallet>30<service/CountInPallet> <codeCountInBox>2</codeCountInBox> <HasSerials>1</HasSerials> <CountryOfOrigin>Малайзия</CountryOfOrigin> (not yet supported) <Message>Хороший телевизор</Message> <Message2>Снова хороший телевизор</Message2> <quantity>12</quantity> <namereserved>Срочно3</namereserved> </serviceitem> ...</servicesitemlist></source> == Справочник дополнительных услуг =='''Описание полей:'''* '''code''' — Внутренний идентификатор, присвоенный системой.* '''article''' — Артикул, назначенный клиентом (поставщиком).* '''barcode''' — Штрихкод производителя.* '''name''' — Наименование.* '''retprice''' — Розничная цена по-умолчанию. При оформлении заказа цена используется та, которая указана в заказе.* '''purchprice''' — Закупочная цена.* '''weight''' — Масса в килограммах.* '''length''' — Длина в сантиметрах.* '''width''' — Ширина в сантиметрах.* '''height''' — Высота в сантиметрах.* '''VATrate''' — Ставка НДС, целое число процентов.* '''CountInPallet''' — Количество штук в паллете.* '''CountInBox''' — Количество штук в упаковке.* '''HasSerials''' — Требует учета серийных номеров. Принимает значения 1 — да, 0 — нет.* '''CountryOfOrigin''' — Наименование страны происхождения на русском языке.* '''Message''' — Комментарий.* '''Message2''' — Дополнительный комментарий.* '''quantity''' — Количество на складе. Товары, уже собранные в заказы в этом количестве не присутствуют, считаются покинувшими товарный склад. ''Это поле может быть недоступным в некоторых установках.''* '''reserved''' — Количество зарезервированного товара. Может превышать остаток на складе, если покупатели ждут следующей поставки. ''Это поле может быть недоступным в некоторых установках.''
== Движение номенклатуры =='''Пример запроса дополнительных услугдвижения номенклатуры:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?><advpricesitemmovements> <auth extra="8" login="login" pass="pass" ></auth> <code>4259</code> <datefrom>2020-10-01</datefrom> <visibledateto>NO2020-10-02</visibledateto></advpricesitemmovements>
</source>
* '''advpricescode''' - Корневой контейнер. Обязательный элемент — внутренний код товара в справочнике номенклатуры. *'''visibledatefrom''' - Признак возврата  — дата начала периода.* '''толькоdateto''' тех услуг — дата окончания периода.Может быть указан или код, что доступны для отображения в ЛК YES/NO. Необязательный элементили период, или код и период одновременно. По-умолчанию NO
'''Пример ответа справочника дополнительных услугдвижения номенклатуры:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8" ?>
<advpricesitemmovements count="16"> <advpriceitemmovement> <code>151500</code> <date>2017-05-26</date> <retprice>0</retprice> <quantity>1</quantity> <delivered>0</delivered> <item> <code>4259</code> <name>Этажей в домеНастольная игра Дженга</name> </item> <status> <code>5</code> <typename>intВозврат от покупателя</typename> </advpricestatus> <advpricestore> <code>21</code> <name>Коэффициент надбавкиофис в Москве</name> </store> <order> <ordercode>3374830</ordercode> <number>123660-0</number> <date>2017-05-24</date> <orderno>14123</orderno> <barcode>0000000670</barcode> <company>ТОВАР</company> <address>Кравченко ул., 1</address> <delivereddate>2017-05-29<type/delivereddate> <deliveredtime>12:00:00</deliveredtime>float <deliveredto /type> </advpriceorder> <advpricedocument> <code>321991</code> <namenumber>318</number> <date>2017-05-26</date> <message></message>Расписаться на упаковке </namedocument> <serials> <serial>123456789<type/serial>bool </typeserials> </advpriceitemmovements></advpricesitemlist>
</source>
Параметры:*'''codeОписание полей ответа ''' - внутренний код услуги*'''namecode''' - наименование услуги. Если поле "название в ЛК" в настройках услуги не пусто, то возвращает значение поля "название в ЛК".*'''hine''' - подсказка по доп услуге для пользователя — внутренний код операции движения*'''typedate''' - тип услуги. Может иметь значения: — дата операции:*'''boolretprice''' - для услуг вида "чекбокс", "Да" — цена товара:*'''floatquantity''' - для числа с плавающей точкой — количество товара операции:*'''intdelivered''' - для целого числа — количество доставленного товара
== Расчет стоимости доставки ==* '''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''' — комментарий * '''serials''' — контейнер серийных номеров:* '''serial''' — серийный номер единицы номенклатуры, участвующей в движении   == Серийные номера =='''Пример запроса стоимости доставкидвижения номенклатуры с серийным номером:'''<source lang="xml"><?xml version="1.0" encoding="UTF-8" ?><serialmovements> <auth extra="8" login="login" pass="pass"></auth> <serial>123456789</serial></serialmovements></source> * '''serial''' — серийный номер единицы номенклатуры.  '''Пример ответа движения номенклатуры с серийным номером:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8" ?>
<calculatorserialmovements count="16"> <serialmovement> <code>151500</code> <serial>123456789<auth extra="8" login="login" pass="pass" /serial> <orderdate>2017-05-26</date> <pricetypedelivered>CUSTOMER0</pricetypedelivered> <item> <code>4259<sender/code> <name>Настольная игра Дженга<town/name>Санкт-Петербург </townitem> <status> <addresscode>Петровка 38 офис 355</addresscode> <coords lat="55.680327" lon="37.604456"name>Возврат от покупателя</coordsname> </senderstatus> <receiverorder> <zipcodeordercode>1254803374830</zipcodeordercode> <town regioncode="78" country="RU"number>Санкт123660-Петербург0</townnumber> <addressdate>Петровка 38 офис 352017-05-24</addressdate> <pvzorderno>12414123</pvzorderno> <coords lat="55.680327" lon="37.604456"barcode>0000000670</coordsbarcode> <company>ТОВАР</receivercompany> <weightaddress>5Кравченко ул., 1</weightaddress> <servicedelivereddate>22017-05-29</servicedelivereddate> <paytypedeliveredtime>CASH12:00:00</paytypedeliveredtime> <pricedeliveredto />387.5 </priceorder> <deliverypricedocument>150 <code>21991</deliverypricecode> <inshpricenumber>387.5318</inshprice> <packagesnumber> <package mass="1"date>2017-05-26</packagedate> <package mass="2.5" length="10" width="20" height="30"message></packagemessage> </packagesdocument> </orderserialmovement></calculatorserialmovements>
</source>
 
''' Описание полей ответа '''
 
Описание аналогично описанию полей [[#Движение номенклатуры|движения номенклатуры]]
Параметры:
*'''pricetype''' - тип требуемой цены. Возможные значения: "CUSTOMER" (по-умолчанию) - [[Личный кабинет клиента#Цена доставки для получателя|цена для конечного получателя]], "CLIENT" - цена курьерской службы для клиента.
*'''townfrom''' - Город отправления
*'''addressfrom''' - Адрес отправления
*'''zipcode''' - Почтовый индекс города назначения
*'''townto''' - Город назначения
*'''addressto''' - Адрес назначения
*'''pvz''' - Код пункта самовывоза по [[#Справочник пунктов самовывоза|справочнику]]
*'''l''' - Длина в сантиметрах (не обязательный параметр)
*'''w''' - Ширина в сантиметрах (не обязательный параметр)
*'''h''' - Высота в сантиметрах (не обязательный параметр)
*'''mass''' - Масса в килограммах
*'''service''' - Режим доставки - число, указывающее на запись в справочнике [[#Справочник Видов срочности|видов срочности]]. Если этот параметр опустить, система выдаст расчет для всех доступных видов срочности, передав много контейнеров <calc> в ответе.
*'''price''' - Сумма наложенного платежа
*'''inshprice''' - Сумма объявленной ценности
*'''paytype''' - Тип оплаты
Суммы НП и ОЦ, а также тип оплаты CARD имеют значение при настроенных в тарифе на вкладке Прочее долях (в процентах) от данных сумм== Серийные номера по заказу =='''Пример запроса движения серийных номеров заказа:'''<source lang="xml"><?xml version="1.0" encoding="UTF-8" ?><orderserials> <auth extra="8" login="login" pass="pass"></auth> <ordercode>123456789</ordercode> <orderno>123456789</orderno> <barcode>123456789</barcode></orderserials></source>
В авторизации можно опустить параметры login и pass, тогда расчет будет производиться по стандартному тарифу курьерской службы, без учета возможных отличий для конкретного клиента* '''ordercode''' — внутренний код заказа.<br>Объемный вес будет учитываться только при условии указания всех габаритов: длины, ширины и высоты* '''orderno''' — шифр заказа.<br>В полях город-отправитель и город* '''barcode''' — штрих-получатель можно указывать название города (не рекомендуется!), либо код города заказа.Указывать необходимо один из нашего справочника, либо 13-ти значный код КЛАДР, либо 36-ти значный код адресной системы ФИАС (AOID)идентификаторов заказа.
'''Пример ответа стоимости доставкидвижения серийных номеров заказа:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?><calculatororderserials> <calcorder> <townfrom code="1">Москва город3374830</townfromcode> <townto code="56603"orderno>Иркутск город14123</towntoorderno> <massbarcode>3.70000000670</massbarcode> <service name="Экспресс"delivereddate>12024-07-20</servicedelivereddate> <zonedeliveredtime>210:04:00</zonedeliveredtime> <priceassemblydate>11632024-07-19 07:05:34</priceassemblydate> <mindeliverydays/order>1 </mindeliverydaysitems> <maxdeliverydaysitem>3 <code>4259</maxdeliverydayscode> <mindeliverydatename>2020-05-13Настольная игра Дженга</mindeliverydatename> <article>123000<deliveryprice/article> <advprice code="1" price="1000"state>БазаDelivered</advpricestate> <advprice code="4" price="100"serials> <serial>Процент от суммы руб123456789</advpriceserial> <advprice code="5" price="63">Процент от объявленной стоимости </advpriceserials> </deliverypriceitem> </calcitems></calculatororderserials>
</source>
Параметры:*'''townfromОписание полей ответа ''' - Город-отправитель так, как система его распознала и привязала к справочнику. Атрибут  * '''codeorder''' - код из справочника городов системы. — блок заказа::*'''townto''' - Город-получатель так, как система его распознала и привязала к справочнику. Атрибут '''code''' -  — код из справочника городов системы.:*'''massorderno''' - Масса в килограммах — шифр:*'''servicebarcode'''  — штрих- Режим доставки - число, указывающее на запись в справочнике видов срочности (см описание на этой странице).код:*'''zonedelivereddate''' - номер тарифной зоны, по которой рассчиталась стоимость. В зависимости от зоны выбирается тарифная сетка. Так же к цене могут применяться повышающие или понижающие коэффициенты при доставке не из/в региональный центр.*'''price''' - рассчитанная стоимость  — дата доставки в валюте прайс-листа курьерской службы. Рекомендуется к использованию в отличие от одноименного атрибута родительского контейнера.факт:*'''maxdeliverydaysdeliveredtime''' - максимальный срок  — время доставки в рабочих днях.факт:*'''mindeliverydateassemblydate''' - минимальная  — дата доставки в учетом выходных дней. *'''deliveryprice''' - Данные по составляющим ценам доставкисборки
* '''item''Обратите внимание' — блок товара::* '''code''' — код:* '''name''' — наименование:* '''article''' — артикул:* '''state''' — статус Доставлено (Delivered) или Возвращено (Returned):* '''serials''' В реальном ответе сервера в теге calc присутствует атрибут "price". Он оставлен для обратной совместимости, не используйте его. Пользуйтесь вложенным тегом price. — блок серийных номеров по заказу
== Получение информации о клиенте справочника тарифов по городам ==
'''Пример запроса получения информации о клиенте:справочника тарифов по городам'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8" ?><clienttariffs> <auth extra="8" login="login" pass="pass" /> <townfrom>Москва</townfrom> <service>1</service> <mainonly>1</mainonly> </clienttariffs>
</source>
* '''auth''' — атрибут '''extra'client''обязателен, по нему определяется курьерская служба.* ' ''townfrom''' — город- Корневой контейнеротправитель. Если не передан, то городом будет «Москва».* '''service''' — режим доставки. Обязательный элемент.*'''authmainonly''' - Авторизация — необязательный элемент. Обязательный элементЕсли передан, то в ответе будут данные только по городам из справочника '''Межгород''' > '''Зоны'''
'''Пример ответа на запрос получения информации о клиенте:'''<source lang=Важно понимать, что в ответе отдаются только тарифы, указанные в разделе "Тарифы по зонам"xmlраздела "><?xml version=Межгород"1в офисной системе курьерской службы, т.е. считающихся междугородними.0" encoding="UTF-8" ?><client> <code>1082</code></client></source>Доставка до городов, рассчитываемая по внутригородским тарифам, в ответе НЕ ОТДАЕТСЯ!
*'''code''' - Код клиента
== Список актов передачи денег ==
'''Пример запроса списка актов передачи денег:ответа справочника тарифов по городам'''<source lang="xmljson"><?xml version={ "townfrom": "0c5b2444-70a0-4932-980c-b4dc0d3f02b5", "service": 1, "tariffs": [ { "towntofias": "0c5b2444-70a0-4932-980c-b4dc0d3f02b5", "towntocode": 1., "towntoname": "Москва город", "townregion": "Город Москва", "distance": 0, "pricedistance": 0, "pricesnew": { "before": [ { "price": 100, "every": 0, "mass": 1 }, { "price": 150, "every": 0, "mass": 5 } ], "after": [ { "price": 0, "every": 1, "mass" encoding=: 38.01 }, { "UTF-8price" ?>: 15,<smalist> "every": 1, <auth extra= "8mass" login=: 51.01 } ] }, "logindeliveryPeriodMin" pass=: 1, "passdeliveryPeriodMax" />: 2 <datefrom>2016-02-10</datefrom> } <dateto>2016-03-10</dateto> ]</smalist>}
</source>
'''smalistОписание полей ответа ''' * '''townfrom''' — код ФИАС города- Корневой контейнеротправителя. Обязательный элемент* '''service''' — режим доставки.* '''tariffs''' — cписок тарифов по городу.:* '''townregion''' — регион города-получателя.:*'''authtowntofias'''  — код ФИАС города- Авторизацияполучателя. Обязательный элемент:* '''towntocode''' — внутренний код города-получателя.:*'''datefromtowntoname'''  — наименование города- Дата "с"получателя. Необязательный элемент:* '''distance''' — дистанция в км до города от МКАД, если в запросе townfrom — Москва.:* '''pricedistance''' — сумма за километраж до города от МКАД, если в запросе townfrom — Москва.:*'''datetopricesnew''' - Дата " — ваши настройки тарифов из справочника '''Межгород''' > '''Тарифы по"зонам'''. Необязательный элемент::* '''before/after''' — контейнеры ДО/ОТ.:::* '''price''' — цена. Если интервал дат не указанответ идет по «before», то возвращаются акты передачи денег в цену также плюсуется сумма pricedistance:::* '''every''' — за последний месяцкаждые.:::* '''mass''' — масса.:* '''prices''' — устаревший элемент, не используется.:* '''deliveryPeriodMin''' — минимальный срок доставки.:* '''deliveryPeriodMax''' — максимальный срок доставки.
== Номенклатура приходной накладной =='''Пример ответа на запрос списка актов передачи денегзапроса номенклатуры приходной накладной:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?><smalist countitemdoc> <auth extra="18" login="login" pass="pass"> <sma/auth> <code>627821991</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></smalistitemdoc>
</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" ?>
<smadetailitemdoc> <auth extracode>21991</code> <number>318</number> <date>2017-05-26</date> <message></message> <items> <item code="84259" loginquantity="login1" passbarcode="pass200300" article="123555">Настольная игра Дженга</item> <code>6278</codeitems></smadetailitemdoc>
</source>
'''smadetailОписание полей ответа ''' - Корневой * '''code''' — внутренний код приходной накладной* '''number''' — номер документа* '''date''' — дата документа* '''message''' — комментарий * '''item''' — контейнер. Обязательный элемент.товара:* '''code''' — внутренний код товара:*'''authbarcode''' - Авторизация. Обязательный элемент. — штрихкод товара:*'''codearticle''' — артикул товара:* '''quantity''' - Код акта передачи денег (см. запрос списка АПД). Обязательный элемент. — количество поступившего товара
== Справочник филиалов =='''Пример ответа на запрос детализации актов передачи денегзапроса списка филиалов:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8" ?><storelist> <auth extra="8"></auth> <json>YES</json> <client_code>7890</client_code></storelist></source> * '''auth''' — Атрибут '''extra''' — обязателен, по нему определяется курьерская служба* '''json''' — Признак вывода ответа в виде JSON YES/NO* '''client_code''' — Код клиента курьерской службы '''Пример ответа:'''<source lang="xml"><?xml version="1.0" encoding="UTF-8" ?><storelist count="2"> <store> <code>123</code> <name>ABC</name> </store> <store> <code>456</code> <name>Филиал 2</name> </store></storelist></source> * '''code''' — Код филиала.* '''name''' — Наименование филиала. == Справочник пунктов самовывоза ==Для отображения списка пунктов выдачи (ПВЗ) есть '''готовый JavaScript модуль''': https://home.courierexe.ru/js/measoft_map.js Инструкция по использованию — внутри. Посмотреть пример работы можно [https://home.courierexe.ru/pvz_test.html Здесь] Уникальные запросы списка ПВЗ кешируются на стороне личного кабинета и хранятся до 7 часов утра по московскому времени следующего дня. Например, если уникальный запрос с массой 2 кг был отправлен сегодня в 10 часов, то завтра в 7 утра он сбросится. Если сегодня в 18 часов в этом же запросе вы укажете массу 2 кг, в ответе вернется тот же список ПВЗ. Если передадите массу 3 кг, список может быть другим. Обратите внимание, что если в выборке количество ПВЗ больше '''10000''' и не указаны параметры '''code''', '''json''' или '''limitcount''', то будет возвращаться ошибка. В этом случае необходимо использовать блок '''limit'''. '''Пример запроса пунктов самовывоза:'''<source lang="xml"><?xml version="1.0" encoding="UTF-8" ?><pvzlist> <auth extra="8" login="login" pass="pass"></auth> <code>1234</code> <client_code>7890</client_code> <city>Свердловская область</city> <town regioncode="66" country="RU">Нижний Тагил</town> <address>Щёлковское шоссе</address> <house>77</house> <parentcode>6</parentcode> <acceptcash>YES</acceptcash> <acceptcard>YES</acceptcard> <acceptfitting>YES</acceptfitting> <maxweight>30</maxweight> <acceptindividuals>YES</acceptindividuals> <respstores>YES</respstores> <lt>57.924737</lt> <lg>59.940019</lg> <rt>57.905682</rt> <rg>59.984669</rg> <json>YES</json> <with_coords>YES</with_coords> <limit> <limitfrom>30</limitfrom> <limitcount>2</limitcount> <countall>YES</countall> </limit></pvzlist></source> * '''auth''' — Атрибут '''extra''' — обязателен, по нему определяется курьерская служба, '''login''' и '''pass''' позволяют авторизоваться под клиентом: для отдельного клиента могут быть ограничения по доступности некоторых ПВЗ, и в этом случае они будут учтены.* '''code''' — Внутренний код.* '''client_code''' — Код клиента курьерской службы.* '''city''' — Регион получателя. Можно указать код региона или полное наименование региона из [[#Справочник регионов|справочника регионов]].* '''town''' — Город получателя.Для тега города '''town''' можно указать код региона в атрибуте '''''regioncode''''' из [[#Справочник регионов|справочника регионов]]. Поиск будет производиться в указанном регионе. Также можно указать страну получателя в атрибуте '''''country''''' в соответствии с [https://ru.wikipedia.org/wiki/ISO_3166-1 стандартом ISO_3166-1], например, «RU», «RUS» или «643» для России.Для формата запроса JSON фильтрация по городу работает только в связке с фильтром по адресу. * '''address''' — Фильтр по адресу, работает только в связке с фильтром по городу* '''house''' — Фильтр по номеру дома, работает только в связке с фильтрами по адресу и городу* '''parentcode''' — Фильтр по родительскому [[#Справочник филиалов|филиалу]]* '''acceptcash''' — Фильтр по приему наличных YES/NO* '''acceptcard''' — Фильтр по приему банковских карт YES/NO* '''acceptfitting''' — Фильтр по наличию примерки YES/NO* '''maxweight''' — Фильтр по максимальному весу, с которым работает ПВЗ* '''acceptindividuals''' — Фильтр по доступности физическим лицам YES/NO* '''respstores''' - Признак вывода ответственных филиалов при значении YES* '''lt''' — Широта левого верхнего угла* '''lg''' — Долгота левого верхнего угла* '''rt''' — Широта правого нижнего угла* '''rg''' — Долгота правого нижнего угла* '''json''' — Признак вывода ответа в виде JSON YES/NO* '''with_coords''' — Признак вывода ПВЗ только с наличием координат YES/NO* '''limit''' — Ограничивает вывод результата.:* '''limitfrom''' — Задает номер записи результата, начиная с которой выдавать ответ. По-умолчанию — 0.:* '''limitcount'''- Задает количество записей результата, которые нужно вернуть. По-умолчанию — 100.:* '''countall''' — YES указывает на необходимость подсчета общего количества найденных совпадений. Это может замедлять выполнение запроса. Если отключено — в ответе не указываeтся totalcount.  '''Пример ответа справочника пунктов самовывоза:'''<source lang="xml"><?xml version="1.0" encoding="UTF-8" ?><pvzlist count="2" totalcount="40465"> <pvz> <code>126</code> <clientcode>3</clientcode> <name>Нижний Тагил</name> <parentcode>6</parentcode> <parentname>Интеграция</parentname> <town code="124267" regioncode="66" regionname="Свердловская область">Нижний Тагил город</town> <address>622036, г. Нижний Тагил, ул. Циолковского, д. 17</address> <phone>+73435417709, +73435254989</phone> <comment>Новый пункт доставки</comment> <worktime>Вс 10:00-16:00, Сб 10:00-16:00, Пн-Пт 10:00-20:00</worktime> <traveldescription>Жилое 5-ти этажное здание, торцом к дороге, второе здание от перекрестка Пархоменко-Циолковского</traveldescription> <maxweight>10</maxweight> <acceptcash>YES</acceptcash> <acceptcard>YES</acceptcard> <acceptfitting>YES</acceptfitting> <acceptindividuals>YES</acceptindividuals> <latitude>57.93457</latitude> <longitude>59.95131</longitude> <uid>40606d00-9c51-11eb-b2c9-cfd6c1111392</uid> </pvz> <pvz> <code>245</code> <clientcode>NTG1</clientcode> <name>На Красноармейской</name> <parentcode>6</parentcode> <parentname>Интеграция</parentname> <town code="124267" regioncode="66" regionname="Свердловская область">Нижний Тагил город</town> <address>КРАСНОАРМЕЙСКАЯ, д.79</address> <phone>+7(3435)379-044</phone> <comment>Возможность примерки отсутствует</comment> <worktime>Вс 10:00-16:00, Сб 10:00-16:00, Пн-Пт 10:00-20:00</worktime> <traveldescription>Напротив ТЦ Пирамида</traveldescription> <maxweight>20</maxweight> <acceptcash>YES</acceptcash> <acceptcard>YES</acceptcard> <acceptfitting>NO</acceptfitting> <acceptindividuals>YES</acceptindividuals> <latitude>57.93468</latitude> <longitude>60.55476</longitude> <uid>41116853-9c51-11eb-b2c9-cfd6c1451392</uid> </pvz></pvzlist></source> * '''code''' — Код ПВЗ в системе. Используется в запросе [[API#Оформление заказа|оформления заказов]]* '''clientcode''' — Код ПВЗ используемый компанией-подрядчиком.* '''name''' — Наименование ПВЗ.* '''parentcode''' — Код родительского элемента.* '''parentname''' — Наименование родительского элемента.* '''town''' — Населенный пункт с кодом из [[#Справочник городов|справочника городов]], а также с кодом и наименованием региона.* '''address''' — Адрес ПВЗ.* '''phone''' — Телефоны ПВЗ.* '''comment''' — Дополнительная информация.* '''worktime''' — Режим работы ПВЗ.* '''traveldescription''' — Описание местонахождения ПВЗ или пути к нему.* '''maxweight''' — Максимальный вес, с которым работает ПВЗ.* '''acceptcash''' — Признак приема наличных* '''acceptcard''' — Признак приема банковских карт* '''acceptfitting''' — Наличие примерки* '''latitude''' — Широта* '''longitude''' — Долгота* '''uid''' — Уникальный идентификатор ПВЗ в системе Measoft. Создается автоматически при получении данных о ПВЗ от агентов.* '''count''' — Количество записей в ответе* '''totalcount''' — Общее количество записей, отвечающее параметрам запроса == Получение фискальных данных заказа =='''Пример запроса получения фискальных данных:'''<source lang="xml"><?xml version="1.0" encoding="UTF-8"?><receiptdata> <auth extra="8" login="login" pass="pass" /> <orders> <order orderno="123456" /> <order orderno="890111C" /> </orders></receiptdata>  </source> '''Пример ответа получения фискальных данных:'''<source lang="xml">  <?xml version="1.0" encoding="UTF-8"?><receipts count="1"> <receipt> <orderno>123456</orderno> <fdDatetime>2020-06-07 12:14:00</fdDatetime> <fdValue>123</fdValue> <fdNum>456</fdNum> <fnSn>789</fnSn> <kktNum>100</kktNum> <inn>222</inn> <ofdUrl>gate.ofd.ru</ofdUrl> <fullUrl>https://check.ofd.ru/123</fullUrl> <price>12345</price> <lines count="1"> <line> <item>1111764</item> <name>Сапоги</name> <qty>1</qty> <price>1000</price> <vatRate>20</vatRate> <governmentCode>Z16513LK2</governmentCode> <itemType>1</itemType> </line> </lines> </receipt></receipts></source> Параметры ответа:* '''orderno''' — Номер заказа* '''fdDatetime''' — Дата и время пробития фискального чека* '''fdValue''' — ФПД (фискальный признак документа)* '''fdNum''' — ФИСКАЛЬНЫЙ ДОКУМЕНТ (фискальный номер чека)* '''fnSn''' — ФН (номер фискального накопителя)* '''kktNum''' — РН (регистрационный номер кассы)* '''inn''' — ИНН* '''ofdUrl''' — URL адрес (доменное имя) ОФД* '''price''' — Сумма чека* '''fullUrl''' — URL чека для просмотра онлайн* '''lines''' — Позиции чека:* '''item''' — код товара:* '''name''' — наименование товара:* '''qty''' — количество товара:* '''price''' — цена товара:* '''governmentCode''' — считанная последовательность, которая в дальнейшем преобразуется по алгоритму тега 1162:* '''vatRate''' — НДС товара:* '''itemType''' — тип товара (товар, доставка и т. д.) == Справочник Виды срочности =='''Пример запроса видов срочности:'''<source lang="xml"><?xml version="1.0" encoding="UTF-8" ?><services><auth extra="8"/></services></source> '''Пример ответа справочника видов срочности:'''<source lang="xml"><?xml version="1.0" encoding="UTF-8" ?><services count="2"> <service> <code>1</code> <name>Эконом</name> </service> <service> <code>2</code> <name>Срочно</name> </service></services></source> == Справочник дополнительных услуг =='''Пример запроса дополнительных услуг:'''<source lang="xml"><?xml version="1.0" encoding="UTF-8"?><advprices> <auth extra="8" login="login" pass="pass" /></advprices></source> '''advprices''' — Корневой контейнер. Обязательный элемент.  '''Пример ответа справочника дополнительных услуг:'''<source lang="xml"><?xml version="1.0" encoding="UTF-8" ?><advprices> <advprice> <code>1</code> <name>Этажей в доме</name> <type>int</type> </advprice> <advprice> <code>2</code> <name>Коэффициент надбавки</name> <type>float</type> </advprice> <advprice> <code>3</code> <name>Расписаться на упаковке</name> <type>bool</type> </advprice></advprices></source> Параметры:* '''code''' — внутренний код услуги* '''name''' — наименование услуги. Если поле «название в ЛК» в настройках услуги не пусто, то возвращает значение поля «название в ЛК».* '''hine''' — подсказка по доп услуге для пользователя* '''type''' — тип услуги. Может иметь значения::* '''bool''' — для услуг вида «чекбокс», «Да»:* '''float''' — для числа с плавающей точкой:* '''int''' — для целого числа == Расчет стоимости доставки =='''Пример запроса стоимости доставки:'''<source lang="xml"><?xml version="1.0" encoding="UTF-8" ?><calculator> <auth extra="8" login="login" pass="pass" /> <order> <pricetype>CUSTOMER</pricetype> <sender> <town>Санкт-Петербург</town> <address>Петровка 38 офис 35</address> <coords lat="55.680327" lon="37.604456"></coords> </sender> <receiver> <zipcode>125480</zipcode> <town regioncode="78" country="RU">Санкт-Петербург</town> <address>Петровка 38 офис 35</address> <pvz>124</pvz> <coords lat="55.680327" lon="37.604456"></coords> </receiver> <weight>5.1</weight> <service>2</service> <paytype>CASH</paytype> <price>387.5</price> <deliveryprice>150</deliveryprice> <inshprice>387.5</inshprice> <packages> <package mass="1" quantity="5"></package> <package mass="2.5" length="10" width="20" height="30"></package> </packages> <userid>user123</userid> <groupid>customer</groupid> </order></calculator></source>  Параметры:Структура данных и заполнение полей аналогичны и совместимы с [[#Оформление заказа]]. Дополнительные поля:* '''pricetype''' — тип требуемой цены. Возможные значения: «CUSTOMER» (по-умолчанию) — [[Личный кабинет клиента#Цена доставки для получателя|цена для конечного получателя]], «CLIENT» — цена курьерской службы для клиента.* '''userid''' — Идентификатор пользователя, строковый или числовой тип. Виртуальное поле. Необязательное. Данное поле используется совместно с настройками «Цена доставки для получателя», определяя приоритет правила. Можно использовать в различных CMS/CRM системах, настраивая цены для определенного покупателя.* '''groupid''' — Идентификатор группы пользователя, строковый или числовой тип. Виртуальное поле. Необязательное. Данное поле используется совместно с настройками «Цена доставки для получателя», определяя приоритет правила. Можно использовать в различных CMS/CRM системах, настраивая цены для определенной группы покупателей. Суммы НП и ОЦ, а также тип оплаты CARD имеют значение при настроенных в тарифе на вкладке Прочее долях (в процентах) от данных сумм. В авторизации можно опустить параметры login и pass, тогда расчет будет производиться по стандартному тарифу курьерской службы, без учета возможных отличий для конкретного клиента.<br>Объемный вес будет учитываться только при условии указания всех габаритов: длины, ширины и высоты.<br>В полях город-отправитель и город-получатель можно указывать название города (не рекомендуется!), либо код города из нашего справочника, либо 13-ти значный код КЛАДР, либо 36-ти значный код адресной системы ФИАС (AOID).  '''Пример ответа стоимости доставки:'''<source lang="xml"><?xml version="1.0" encoding="UTF-8"?><calculator> <calc> <townfrom code="1">Москва город</townfrom> <townto code="56603">Иркутск город</townto> <mass>3.7</mass> <service name="Экспресс">1</service> <zone>2</zone> <price>1113</price> <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. === Коды и описание ошибок ==={|class=wikitable!Код ошибки!Английское описание!Русское описание!Примечание|-|15||tarif not found||Тариф не найден||Ошибка получения тарифов: для клиента не указан тариф|-|19||field [town to] cannot be empty||Поле [город получателя] не может быть пустым||Необходимо указать город получателя или ПВЗ|-|20||field [weight] is incorrect||Некорректное значение [масса]||Значение массы некорректное, например, не является числом. Его необходимо исправить|-|21||town from not found||Город отправителя не найден||Системе не удалось найти указанный населенный пункт отправителя|-|22||town to not found||Город получателя не найден||Системе не удалось найти указанный населенный пункт отправителя|-|23||field [weight] cannot be empty||Поле [масса] не может быть пустым||Необходимо указать значение массы отправления, поле [weight]|-|36||subtown not found||Город в регионе не найден||Не настроено направление доставки до города в регионе: не добавлен регион или указанный город отсутствует в списке региона|-|37||zoneprice not found||Тариф зоны не найден||Отсутствуют зоны тарификации или для них не указаны стоимости|-|38||tarif not found - 1||Тариф не найден 1||Результаты расчета отсутствуют: общая ошибка в случае, если других ошибок нет, но результат пустой |-|39||tarif not found - 2||Тариф не найден 2||Ошибка получения тарифов: для клиента не настроен тариф или тарификация от количества заказов|-|82||field [weight] exceeded limit PVZ||Значение [weight] превышает ограничение ПВЗ||Указанное значение массы больше, чем максимально допустимое для указанного ПВЗ|-|83||attribute [paytype] not allowed PVZ||Значение [paytype] не допустимо для ПВЗ||В ПВЗ не допустим указанный тип оплаты|-|} == Получение информации о клиенте =='''Пример запроса получения информации о клиенте:'''<source lang="xml"><?xml version="1.0" encoding="UTF-8" ?><client> <auth extra="8" login="login" pass="pass" /> </client></source> '''client''' — Корневой контейнер. Обязательный элемент.* '''auth''' — Авторизация. Обязательный элемент. '''Пример ответа на запрос получения информации о клиенте:'''<source lang="xml"><?xml version="1.0" encoding="UTF-8" ?><client> <code>1082</code></client></source> * '''code''' — Код клиента == Список актов передачи денег =='''Пример запроса списка актов передачи денег:'''<source lang="xml"><?xml version="1.0" encoding="UTF-8" ?><smalist> <auth extra="8" login="login" pass="pass" /> <datefrom>2016-02-10</datefrom> <dateto>2016-03-10</dateto></smalist></source> '''smalist''' — Корневой контейнер. Обязательный элемент.* '''auth''' — Авторизация. Обязательный элемент.* '''datefrom''' — Дата «с». Необязательный элемент.* '''dateto''' — Дата «по». Необязательный элемент.Если интервал дат не указан, то возвращаются акты передачи денег за последний месяц. '''Пример ответа на запрос списка актов передачи денег:'''<source lang="xml"><?xml version="1.0" encoding="UTF-8"?><smalist count="1"> <sma> <code>6278</code> <number>3992</number> <actdate>2016-02-12</actdate> <datepay></datepay> <dateto>2016-02-12</dateto> <promiseddatepay></promiseddatepay> <price>637.00</price> <pricecorr>113.00</pricecorr> <rur>13430.00</rur> <pricekur>570.00</pricekur> <priceag>67.00</priceag> <payno>42423</payno> <paytype>1</paytype> <paytypename>Безнал</paytypename> <signedcopyreceived>NO</signedcopyreceived> </sma></smalist></source> * '''code''' — Код акта* '''number''' — Номер акта в системе* '''actdate''' — Дата акта* '''datepay''' — Дата оплаты по акту* '''dateto''' — Дата конечного периода для формирования АПД* '''promiseddatepay''' — Плановая дата оплаты* '''price''' — Стоимость услуг* '''pricecorr''' — Сумма корректировки* '''rur''' — Сумма заказа* '''pricekur''' — Стоимость курьерской доставки* '''priceag''' — Агентское вознаграждение* '''payno''' — Номер платежного поручения* '''paytype''' — Тип оплаты: 1 — безнал, 2 — наличными курьером, 3 — наличными в офисе, 4 — перевод на карту* '''paytypename''' — Строковое представление типа оплаты* '''signedcopyreceived''' — Признак факта возврата акта YES/NO == Детализация актов передачи денег =='''Пример запроса детализации актов передачи денег:'''<source lang="xml"><?xml version="1.0" encoding="UTF-8" ?><smadetail> <auth extra="8" login="login" pass="pass" /> <code>6278</code></smadetail></source> '''smadetail''' — Корневой контейнер. Обязательный элемент.* '''auth''' — Авторизация. Обязательный элемент.* '''code''' — Код акта передачи денег (см. запрос списка АПД). Обязательный элемент. '''Пример ответа на запрос детализации актов передачи денег:'''<source lang="xml"><?xml version="1.0" encoding="UTF-8"?><smadetail count="2"> <specialsma> <code>42494</code> <ordercode>14424</ordercode> <orderno>11111</orderno> <orderdate>2018-01-01</orderdate> <delivereddate>2018-10-01</delivereddate> <company>Компания</company> <price>314.00</price> <rur>8800.00</rur> <inshprice>314.00</inshprice> <pricekur>270.00</pricekur> <priceag>44.00</priceag> <pricecalc>8486.00</pricecalc>
<paytype>2</paytype>
<paytypename>наличными курьером</paytypename> <weight>0.400</weight> <distance>0.0</distance> <status>Доставлено</status> </specialsma></smadetail></source> *'''code''' -  — Код записи.*'''ordercode''' -  — Код заказа.*'''orderno''' -  — Шифр заказа.*'''orderdate''' -  — Дата заказа.*'''delivereddate''' -  — Дата доставки.*'''company''' -  — Получатель.*'''price''' -  — Стоимость услуг.*'''rur''' -  — Сумма заказа.*'''inshprice''' -  — Стоимость заказа.*'''pricekur''' -  — Стоимость курьерской доставки.*'''priceag''' -  — Агентское вознаграждение.*'''pricecalc''' -  — Сумма для передачи агенту.*'''paytype''' -  — Тип оплаты: 1 - 1 — безнал, 2 - 2 — наличными курьером, 3 - 3 — наличными в офисе, 4 - 4 — перевод на карту.*'''paytypename''' -  — Строковое представление типа оплаты*'''weight''' -  — Вес заказа.*'''distance''' -  — Дистанция по заказу*'''status'''  — Статус заказа. == Установка статуса согласования заказа ==Для возможности клиентом установки статуса согласования заказа необходимо включить переменную [[Личный кабинет курьерской службы#Заказы|Разрешить менять статус согласования]] '''Пример запроса установки статуса согласования заказа'''<source lang="xml"><?xml version="1.0" encoding="UTF- Статус 8"?><setapprovalstatus> <auth extra="8" login="login" pass="pass" /> <order ordercode="1234561"> <confirmstate>1</confirmstate> <message>Сообщение статуса</message> </order> <order ordercode="1234562"> <confirmstate>2</confirmstate> <message>Согласовано</message> </order> <order ordercode="1234563"> <confirmstate>3</confirmstate> <message>Не согласовано</message> </order></setapprovalstatus></source> * '''order''' — Контейнер заказа. Обязателен как минимум один элемент.:* '''ordercode''' — Внутренний код заказа.* '''confirmstate''' — Код статуса заказа. Все статусы с кодами можно получить запросом [[#Получение списка статусов согласования заказа|Получение списка статусов согласования заказа]]* '''message''' — Дополнительный комментарий, который отобразится в поле ''Инфо о доставке''. == Получение списка статусов согласования заказа =='''Пример запроса списка статусов согласования заказа'''<source lang="xml"><?xml version="1.0" encoding="UTF-8"?><approvalstatuses> <auth extra="8" login="login" pass="pass" /></approvalstatuses></source> '''Пример ответа списка статусов согласования заказа'''<source lang="xml"><?xml version="1.0" encoding="UTF-8" ?><approvalstatuses count="6"> <status> <code>1</code> <name>Неизвестно</name> </status> <status> <code>2</code> <name>Согласование запрошено</name> </status> <status> <code>3</code> <name>Доставка полностью согласована</name> </status> <status> <code>4</code> <name>Согласовано с изменением времени</name> </status> <status> <code>5</code> <name>Перенос на другую дату</name> </status> <status> <code>6</code> <name>Отказ</name> </status></approvalstatuses></source> == Генерация коротких ссылок == В некоторых случаях, например, при использовании в СМС, может потребоваться использование коротких ссылок на ЛК.Для этого, необходимо отправить запрос с полной ссылкой, в ответ на который придёт хэш-код для ссылки. '''Пример запроса генерации коротких ссылок:'''<source lang="xml"><?xml version="1.0" encoding="UTF-8" ?><shortlink> <link short="0"> https://home.courierexe.ru/8/site/orders </link></shortlink></source> '''shortlink''' -  — Корневой контейнер. Обязательный элемент.*'''link''' -  — Полная ссылка, для которой необходимо получить код. Обязательный элемент. Если атрибут '''short''' равен 1, то ответ не будет содержать XML, а только хэш-код. '''Пример ответа на запрос генерации коротких ссылок:'''<source lang="xml"><?xml version="1.0" encoding="UTF-8"?><shortlink> <hash>35AF350C</hash></shortlink></source> * '''hash''' — Хэш-код ссылки. Далее, можно использовать ссылку на ЛК: <nowiki>https://home.courierexe.ru/35AF350C или curie.ru/35AF350C</nowiki>  '''Примечание!''' Сервис коротких ссылок работает только для ресурсов компании MeaSoft. == Проверка надежности покупателя ==Проверка надежности работает только для тарифа «Максимум» личного кабинета. <source lang="xml"><?xml version="1.0" encoding="UTF-8" ?><mcheck> <auth extra="8" login="login" pass="pass" /> <phones> <phone>89161147992</phone> </phones></mcheck></source> Ответ: <source lang="xml"><?xml version="1.0" encoding="UTF-8" ?><mcheck> <phones> <phone rate="90">89161147992</phone> </phones></mcheck></source>  == Размещение страниц на своем сайте (iframe) == В некоторых случаях имеет смысл разметить те или иные страницы на своем сайте. Например, чтобы клиенты могли рассчитать стоимость доставки не переходя по внешней ссылке, а там же, на сайте, калькулятор можно разместить прямо на странице такого сайта посредством так называемого фрейма — '''iframe'''. [https://ya.ru/search/?text=iframe Фрейм] — контейнер внутри обычной страницы, который позволяет загружать сторонние страницы. Пример загрузки калькулятора: <source lang="html"><iframe id="frame" src="https://home.courierexe.ru/8/calculator"> Здесь должен отобразиться калькулятор</iframe></source> Для удобства пользователей вашего сайта можно указать язык интерфейса (который переключается непосредственно на сайте) параметром '''lang''': <source lang="html"><iframe id="frame" src="https://home.courierexe.ru/8/calculator?lang=2"> Здесь должен отобразиться калькулятор</iframe></source>  <div style="color: #a94442; background-color: #f2dede; border: 1px solid #ebccd1; padding: 3px 10px 10px;">'''Обратите внимание!'''# При использовании iFrame могут не работать некоторые функции, например, подписка на push-уведомления на странице трекинга или отслеживания.# Если язык не указать, то на страницах калькулятора и трекинга отображается свой переключатель языка. Если язык указан, то переключатель не отображается. Поддерживаемые языки и их коды::'''1''' — русский:'''2''' — английский:'''4''' — узбекский</div> == Оформление манифеста == '''Пример запроса на создание манифеста:'''<source lang="xml"><?xml version="1.0" encoding="UTF-8" ?><manifest> <auth extra="8" login="login" pass="pass" /> <store_from>1</store_from> <store_to>2</store_to> <trn_code>3</trn_code> <sentdate>2024-11-07</sentdate> <places> <place> <number>1</number> <seal>7890AABBB</seal> </place> <place> <number>2</number> <seal>123456ABC</seal> </place> </places> <addresses> <address> <code>12345</code> <place>1</place> </address> <address> <code>67890</code> <place>2</place> </address> </addresses></manifest></source>  '''manifest''' - Корневой контейнер. Обязательный элемент.*'''auth''' - Авторизация. Обязательный элемент.*'''store_from''' - код филиала отправителя. Обязательный элемент.*'''store_to''' - код филиала получателя. Обязательный элемент.*'''trn_code''' - код перевозчика. Обязательный элемент.*'''sentdate''' - дата отправки манифеста. Не обязательный элемент.*'''addresses''' - корневой элемент для списка заказов.*:'''address''' - корневой элемент для заказа.*::'''code''' - наш внутренний номер заказа. Обязательный элемент.*::'''place''' - номер места заказа. Обязательный элемент, если переданы места.*'''places''' - корневой элемент для списка мест.*::'''place''' - корневой элемент для места.*::'''number''' - номер места. Обязательный элемент.*::'''seal''' - номер пломбы. Необязательный элемент.  '''Пример успешного ответа'''<source lang="xml"><?xml version="1.0" encoding="UTF-8"?><manifest> <result>OK</result></manifest></source>  '''Пример ответа с ошибкой'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<shortlinkmanifest> <hash>35AF350C</hash></shortlink></source> *'''hash''' - Хэш-код ссылки. Далее, можно использовать ссылку на ЛК: <nowiki>https://home.courierexe.ru/35AF350C или curie.ru/35AF350C</nowiki>  '''Примечание!''' Сервис коротких ссылок работает только для ресурсов компании MeaSoft. result error== Проверка надежности покупателя == Проверка надежности работает только для тарифа "МаксимумТекст ошибки" личного кабинета. <source lang="xml"><?xml version="1.0" encoding="UTF-8" ?><mcheck> <auth extra="8" login="login" pass="pass" /> <phones> <phone>89161147992</phone> ERROR</phonesresult></mcheckmanifest>
</source>
Ответ:'''manifest''' - Корневой контейнер. Обязательный элемент.*'''result ''' - Результат. Принимает значения OK или ERROR.<source lang="xml"><?xml version="1*'''error''' - атрибут с текстом ошибки, если она была.0" encoding="UTF-8" ?><mcheck> <phones> <phone rate="90">89161147992</phone> </phones></mcheck></source>

Навигация