459
правок
Изменения
API
,→Ограничения
<div style="font-size: 24px18px; color: #a92424; background-color: #ffdede; border: 1px solid #ebccd1; padding: 3px 10px 10px;">'''ВНИМАНИЕ! Изменения для 54-ФЗ!'''
Для передачи ставки НДС при оформлении заказа добавлен атрибут items -> item -> VATrate.
При использовании услуги кассового обслуживания необходимо в обязательном порядке передавать состав заказа со ставками НДС!.
'''ВНИМАНИЕ!'''
В ближайшем будущем, при подключенной услуге кассового обслуживания, система '''перестанет''' принимать заказы без состава вложений!.
</div>
<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>
Если вы '''подрядчик''', вы можете забирать заказы, используя значение client=AGENT в запросе [[#Пример запроса статуса заказа|statusreq]], и передавать статусы заказов, используя метод [[#Изменение статуса агентом|setorderinfo]]. Также для интеграций с подрядчиками у Васнас есть специальная платформа, но добавлять подрядчиков в нее можно только на нашей стороне. Присылайте нам коммерческое предложение, описание вашего сервиса, и мы с радостью его рассмотрим. При написании этой документации мы предполагаем, что ее читатель обладает необходимой для понимания квалификацией программиста, владеет XML и средой разработки, в которой он делает интеграцию. Если вы не программист, вам необходимо привлечь к проекту профессионального программиста. Если у вас после прочтения данной документации остались вопросы, Вы можете задайте их задать по почте [mailto:support@courierexe.ru support@courierexe.ru]. Обязательно представьтесь, напишите Ваши ваши контактные данные (телефон, скайп) и название компании, с которой Вы вы хотите интегрироваться.
== Готовые интеграции ==
Для работы с популярными CMS и CRM-системами разработаны модули интеграции, перечисленные в таблице ниже.
'''Модули распространяются бесплатно, без гарантий со стороны разработчика''', и не являются средством полной автоматизации взаимодействия с курьерской службой. Модули — это помощь разработчикам интернет-магазинов в построении интеграции с курьерскими службами. '''Ответственность за корректность передачи данных лежит на интернет-магазине.'''
Модули сторонних разработчиков обслуживаются и разрабатываются сторонними компаниями. Все вопросы по их приобретению и поддержке необходимо задавать им.
{| class="wikitable" align="center" style="width: 80%; margin: auto; background-color: black#ffffff; borederborder: 1px solid #999999;" cellpadding="10" cellspacing="0"
!style="width: 35%;"|Система управления контентом (CMS)
!style="width: 15%;"|Ссылка
!style="width: 35%;"|Примечание
|-
|[[Файл:bitrix.png|center|x44px]]
|-
|[[Файл:prestashop.png|center|x44pxx60px]]|style="text-align: center;"|1.4.5 от 10.10.2018|style="text-align: center;"|[httphttps://courierexe.ru/download/api/prestashop.zip Скачать]|Поддерживает версии 1.5.2.0 и выше (2.x в том числе!)Подробнее см. [[PrestaShop|описание]].
|-
|[[Файл:OpencartOCStore.png|center|x44pxx60px]]|style="text-align: center;"|[https://courierexe.ru/download/api/opencart.zip Скачать для версии 1.75.5 от 10.08.20181]<br>2.0.0 от 01.12.2018<br>3.1.1 от 28.02.2019|style="text-align: center;"|[httphttps://courierexe.ru/download/api/opencartmeasoft_oc2.ocmod.zip Скачатьдля версии 2.0]<br><br>[httphttps://courierexe.ru/download/api/measoft_oc2.3.ocmod.zip Скачатьдля версии 2.3]<br><br>[httphttps://courierexe.ru/download/api/measoft_ос3measoft_oc3.ocmod.zip Скачатьдля версии 3.0]|Поддерживает версии с 1.5.5.1.<br>Версия 2.0.0 поддерживает Скачивайте модули для своей версии с 2OpenCart.0<br>Подробнее см. [https://opencartforum[OpenCart|описание]].com/files/file/2906-avtomatizaciya-otpravki-i-otslezhivanie-dostavok-courierexe-dlya-opencart-15x/ Альтернативный модуль сторонних разработчиков]
|-
|[[Файл:webasyst-shopscript.png|center|x44px]]
|-
<!--|[[Файл:insalesadvantshop.png|center|x44px]]|style="text-align: center;"|1[https://promo-z.2ru/ Сайт компании PROMO]|Компания PROMO разработала этот модуль и настраивает интеграцию MeaSoft с ADVANTSHOP своим клиентам.1 от 06|- -->|[[Файл:insales.09.2017png|center|x80px]]|style="text-align: center;"|Настраивается в [http://www.insales.ru/collection/all/product/kurierskaya-sluzhba[Личный кабинет клиента|ЛК пользователя]]|[[InSales|Инструкция по настройке]]|-2008 Установить]|[http[Файл://wikiiiko.courierexe.ru/index.php?titlejpg|center|x80px]]|style=Интеграция_с_другими_системами#Insales "text-align: center;"|Настраивается] в [[Личный кабинет клиента|ЛК пользователя в системе]]|[[Iiko|Инструкция по настройке]]
|-
|[[Файл:Leadvertex.png|center|x44px]]
|-
|[[Файл:Retailcrm.png|center|x44pxx30px]]|style="text-align: center;"|1.0 от 11.01.2018
|style="text-align: center;"|[https://www.retailcrm.ru/ RetailCRM]
|[http://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|x44pxx60px]]|style="text-align: center;"|1.0.0 от 12.11.2018|style="text-align: center;"|[httphttps://courierexe.ru/download/api/com_measoft.zip Скачать]|Работает только с компонентом Virtuemart. Внимание! Модуль новый, поэтому возможна некорректная передача данных. Проверяйте, если что - сообщайте, исправим!Инструкция в архиве
|-
|[[Файл:Amocrm.png|center|x44px]]
|-
|-
|[[Файл:wordpress.jpg|center|x80px]]
|style="text-align: center;"|WordPress от 5 версии[https://courierexe.ru/wordpress/wordpress.php Скачать]|[[Wordpress|Инструкция]]|-WooCommerce от 3|[[Файл:Cscart.9 версииpng|center|x60px]]|style="text-align: center;"|[httphttps://courierexemarketplace.cs-cart.rucom/download/api/wordpressmeasoft-en.zip Скачатьhtml Установить] |Поддерживает версии 4.10 и выше.<br>[[Интеграция с другими системами#WordpressCS-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|150 400 px|мини|Форма отправки заказа|none]]
== Тестовый аккаунт ==
Для отладки зайдите в тестовый личный кабинет по адресу [https://home.courierexe.ru/8 https://home.courierexe.ru/8], логин: login пароль: pass.
== Тестовый Рабочий аккаунт для подключения ==Строка подключения выглядит следующим образом:
Наше API принципиально работает только по HTTPS, т.к. так как передает конфиденциальные данные. В некоторых системах с этим возникают проблемы. Если ваша система не может полноценно работать с шифрованием, мы рекомендуем развернуть http-сервер у себя локально, установить [http://courierexe.ru/download/api/proxy.zip прокси на PHP]. <spoiler text="Как запустить">Для теста можете запустить его на сервере следующей командой: php -S <IP>:8080 proxy.phpгде <IP> - — это адрес вашего сервера, а 8080 порт, на котором будут приниматься запросы.
Тогда для обмена данными с нашим АПИ необходимо будет использовать адрес <IP>:8080</spoiler>
Доступность функций, описанных в этом разделе, зависит от [[Личный кабинет курьерской службы#Функции личного кабинета|тарифа вашего личного кабинета]].
== Ограничения ==
С целью защиты от не целевого нецелевого использования сервисов, а так же от и DDoS-атак, действуют следующие ограничения:* 30 запросов tracking с одного IP-адреса за 1 минуту (используйте statusreq!);*150 запросов с одного IP-адреса /акаунта за 1 минуту;*1500 запросов с одного IP-адреса /акаунта за 20 минут;*3000 запросов с одного аккаунта за 1 час;*200 Мб скачанных текстовых данных за 3 часа.* Превышение количества запросов статусов несуществующих заказов над существующими
В случае превышения блокируется IP-адрес или аккаунт блокируется на время до 3-х часов.
Чтобы не происходило блокировок:
* Не не нужно "бомбить" «бомбить» наше API запросами статусов , последовательно перебирая номера всех ваших заказов, особенно - запросами "tracking"«tracking», они предназначены не для этого (смотрите описание). Особенно ровно в 0 00 минут каждого часа.;* Не не нужно каждые 5 минут делать запросы "Покажите «Покажите статусы всех заказов за последние 3 месяца".месяца»;* Для для проверки статусов заказов лучше всего использовать запросы [[#Передача только изменившихся статусов|измененных статусов changes=ONLY_LAST]].;* При при запросе измененных статусов ОБЯЗАТЕЛЬНО нужно подтверждать успешное получение запросом [[#Передача только изменившихся статусов|commitlaststatus]].* вы должны знать номера заказов, которые вы отправили. Не нужно перебирать номера всех заказов или брутфорсом перебирать все возможные номера.* нужно проверять с каким ответом возвращаются ваши АПИ-запросы. Если мы отвечаем ошибкой, то даже запрос на создание нового заказа учитывается в количестве запросов. Точного регламента по времени ответа на запросы нет. Запросы имеют разное время выполнения, которое может отличаться:- Запросы режимов срочности или улиц отдаются за десятые доли секунды;- Запросы статусов или ПВЗ могут отдаваться до нескольких секунд;- Запрос оформления заказов может выполняться до нескольких минут. Все зависит от параметров запроса и загруженности сервера.
Мы абсолютно уверены, что данные ограничения на порядки превосходят необходимые объемы предоставления сервиса для решения любых задач. Если у вас возникают проблемы, вы не знаете, как уложиться в эти рамки - рамки — спросите у нас, мы обязательно поможем!
== Оформление заказа ==
=== Пример оформления заказа ===
<source lang=xml>
<?xml version="1.0" encoding="UTF-8"?>
<time_min>09:00</time_min>
<time_max>14:00</time_max>
<deliveryPIN>1234</deliveryPIN>
<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>
<quantity>2</quantity>
<service>2</service>
<type>3</type>
<return>NO</return>
<return_service>1</return_service>
<return_type>3</return_type>
<return_weight>5.1</return_weight>
<courier>22</courier>
<receiverpays>NO</receiverpays>
<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="ООО "Рога и копыта"" 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>
<deliveryset above_price="100" return_price="1000" VATrate="10">
<below below_sum="500" price="500" />
<below below_sum="2000" price="300" />
</deliveryset>
<advprices>
<advprice>
<code>1</code>
<value>123</value>
</advprice>
<advprice>
<code>2</code>
<value>10.5</value>
</advprice>
<advprice>
<code>3</code>
<value>true</value>
</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>
=== Описание элементов для оформления заказа ===
'''Обязательные поля'''
:*'''order''newfolder' - Контейнер для описания одного заказа, обязательный элемент. В одном контейнере '''neworder''' может быть много контейнеров '''order''' — Признак нового заказа YES/NO. Если стоит YES, то в системе курьерской службы для создания нескольких заказов одним запросомданной корреспонденции создастся новый заказ. Необязательный элемент.
:*'''barcode''orderno''''' - Штрих-код — Номер заказа. В случаеЕсли присваивается клиентом — указывается здесь. Если не присваивается — можно оставить пустым, если клиент штрих-кодирует свои отправлениясистема сгенерирует свой номер, и штрих-код отличается от номера заказа, вернет его в этом поле указывается штрих-кодответе. В случае наличия нескольких мест, и раздельной их маркировки, Система проверяет '''у клиента''' наличие заказов с указанным номером в этом поле допустимы маски в виде символов подчеркивания'''пределах текущего календарного года''', говорящие о позициях штрих-кода, переменных для разных мест в рамках одного заказа.<br />которые '''не являются недоставленными'Например'': В заказе номер 123 имеется 20 товарных вложений, которые упакованы и в 3 транспортных места. Клиент формирует 3 штрих-кода на транспортные места: CLNT0012301, CLNT0012302, CLNT0012303, где CLNT - префикс клиентаслучае их существования — заказ создан не будет, 00123 - номер заказа, 01-03 - номер транспортного места а в заказеответе вернется ошибка 17 «Such number exists». В Если не указан штрихкод (поле barcode нужно указать CLNT00123__ (система поймет), что 2 последних символа могут быть любымии значение поля подходит для использования его в качестве штрихкода, и будут отражать штрих-коды к одному заказу)данное значение будет скопировано в поле «Штрихкод». Если вы не сами печатаете накладные с указанным штрих-кодомЭто накладывает ограничения в частности, то указанный штрих-код не должен быть длиннее на длину указанного поля (25 знаков, иначе он не поместится на стандартных печатных формахчтобы работали стандартные печатные формы).
* '''barcode''' — Штрихкод заказа. Если клиент штрихкодирует свои отправления и штрихкод отличается от номера заказа, в этом поле указывается штрихкод. Если ШК содержит кириллицу или малое количество символов, то формируется ШК в формате EAN13. <spoiler text="Заполнение номера заказа (шифра) и штрих-кода">Шифр и штрих-код заполняются исходя из начальных значений: # Если шифр и ШК пустые - оба поля заполняются автоматически значением вида XXX#YYY, а после ШК проверяется на корректность (валидируется)# Если ШК пустой, а шифр заполнен - ШК заполняется значением из шифра и валидируется# Если шифр пустой, а ШК заполнен - шифр заполняется значением из ШК, после чего ШК валидируется# Если оба непустые - валидируется ШК, шифр не проверяется Корректный (валидный) ШК отвечает следующим требованиям:* длина не меньше 5 символов* значение не меньше значения переменной <mparam code="MinPrePrintedNum"/>* содержит символы, которые можно использовать для формирования штрих-код а формате Code128 (т.е.все печатные символы, кроме кириллицы) Если ШК не прошел проверку, то:* если переменная <mparam code="StoreInvLength"/> равна 0, ШК заполняются автоматически значением вида XXX#YYY (или приравнивается шифру в том же формате)* если переменная <mparam code="StoreInvLength"/> больше 0, ШК заполняются автоматически сквозным номером (если шифр в формате XXX#YYY, то шифр приравнивается ШК)</spoiler> В случае наличия нескольких мест и раздельной их маркировки в этом поле допустимы маски в виде символов подчеркивания, говорящие о позициях штрихкода, переменных для разных мест в рамках одного заказа.<br>''Например'': В заказе номер 123 имеется 20 товарных вложений, которые упакованы в 3 транспортных места. Клиент формирует 3 штрихкода на транспортные места: CLNT0012301, CLNT0012302, CLNT0012303, где CLNT — префикс клиента, 00123 — номер заказа, 01-03 — номер транспортного места в заказе. В поле barcode нужно указать CLNT00123__ (система поймет, что 2 последних символа могут быть любыми и будут отражать штрихкоды к одному заказу). Если вы не сами печатаете накладные с указанным штрихкодом, то указанный штрихкод не должен быть длиннее 25 знаков, иначе он не поместится на стандартных печатных формах. *'''sender''' - — Информация о отправителе заказа. Необязательный контейнер.<source lang="xml">
<sender>
<company>Название компании отправителя</company>
</source>
*'''receiver''' - — Информация о получателе заказа. Обязательный контейнер.
<source lang="xml">
<receiver>
<time_min>Желаемое время доставки в формате "HH:MM"</time_min>
<time_max>Желаемое время доставки в формате "HH:MM"</time_max>
<deliveryPIN>Пин-код для подтверждения получателем</deliveryPIN>
<coords lat="55.680327" lon="37.604456"></coords>
</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 - CASH — Наличными при получении (по-умолчанию):* CARD - CARD — Картой при получении:* NO - NO — Без оплаты. Этот тип оплаты передается, если заказ уже оплачен и не требует инкассации. API добавит к товарам строку предоплаты в сумму заказа, чтобы общая сумма была 0, однако в кассовом чеке будут все товары с ценами, и оплата предоплатой, как того требует 54-ФЗ.:* OTHER - OTHER — Прочее (Предусмотрен для того, чтобы оплата поступала непосредственно в курьерскую службу посредством прочих типов оплаты - оплаты — таких как: вебмани, яденьги, картой на сайте, прочие платежные системы и ти т.д д.):* OPTION - OPTION — На выбор получателя. Этот тип оплаты нельзя передавать с заказом. Он выставляется автоматически в зависимости от настройки клиента.* '''weight''' — Общий вес заказа в килограммах.* '''quantity''' — Количество мест.* '''service''' — Режим доставки (тип услуги) передается код из справочника «[[#Справочник Виды срочности|Виды срочности]]».* '''type''' — Тип корреспонденции (отправления) передается код из справочника «Типы корреспонденции».* '''return''' — Признак необходимости возврата. Принимает значения::* NO — Возврат не требуется:* YES — Требуется возврат, например, документов:* ONLY — Требуется забрать отправление у поставщика (см. раздел «[[Личный_кабинет_клиента#Привезти ко мне|Привезти ко мне]]»). * '''return_service''' — Режим возврата (тип услуги) передается код из справочника «Виды срочности».* '''return_type''' — Тип возвратной корреспонденции (отправления) передается код из справочника «Типы корреспонденции».* '''return_weight''' — Общий вес возврата заказа в килограммах.* '''enclosure''' — Вложение.* '''instruction''' — Поручение — Примечание.* '''courier''' — Запланированный курьер. Согласно коду курьера в КС2008.* '''receiverpays''' — Признак оплаты стоимости доставки — услуг службы доставки получателем, а не заказчиком YES/NO.* '''department''' — Подразделение, в котором оформляется заказ.* '''costcode''' — Кост-код сотрудника.* '''respstore''' — Код ответственного филиала. Для ответственного филиала в который передается заказ, требуется включение параметра "Разрешить клиенту передавать заказы в этот филиал"* '''pickup''' — Признак оформления забора YES/NO. Если стоит YES, то весь заказ считается заданием на забор груза, а не на доставку! Применяется для вызова курьера к отправителю для забора других отправлений. ''Внимание!'' при добавлении в забор складских товаров, их тип '''''type''''' всегда должен быть установлен как [7] Забор товара, если будет указан другой тип, то он будет исправлен в момент добавления заказа на [7] Забор товара* '''acceptpartially''' — Признак возможности частичного выкупа товаров отправления YES/NO.* '''uid''' - Универсальный идентификатор заказа на стороне отправителя. Не обязательный параметр, ограниченного по времени действия. Время хранения в системе, - сутки.
*'''zipcodeitems''' — Контейнер для описания вложений. <rspoiler text="Необязательный контейнер">Если для поставщика товара в системе MeaSoft не указаны полное наименование компании и ИНН в карточке клиента, заполните параметры <code>suppcompany</code> и <code>suppINN</code> в этом контейнере. Отсутствие информации о поставщике приведет к [[Настройка модуля печати кассовых чеков#Ошибка фискализации (ошибка программирования реквизита 1226)|ошибке фискализации]].</rspoiler>. Атрибуты::* '''''item''''' - Почтовый индекс — Название вложения.:* '''''quantity''''' — Количество единиц товара.:*'''weight''mass' - Общий вес заказа '''' — Масса единицы товара в килограммах.:*'''return_weight''volume''' - Общий '' — Объемный вес возврата заказа единицы товара в килограммах.При указании объемного веса значение подставляется вместо массы:*'''quantity''length''''' - Количество мест — Длина единицы товара (в сантиметрах).:*'''service''width' - Режим доставки '''' — Ширина единицы товара (тип услугив сантиметрах) передается код из справочника [[#Справочник Видов срочности|"Виды срочности"]].:*'''return_service''height''''' - Режим возврата — Высота единицы товара (тип услугив сантиметрах) передается код из справочника "Виды срочности".:*'''type''retprice''''' — Цена единицы товара. Округляется до копеек. Должна быть с учетом всех скидок и наценок. Для вложений типов 1, 2, 3 не может быть отрицательной. <!-- Тип корреспонденции (отправления) передается код из справочника "Типы корреспонденции", либо мы сами посчитаем скидку при указании тега order->discount -->:* '''''inshprice''''' — Объявленная ценность единицы товара. Округляется до копеек. Если не указана принимается равной '''''retprice'''''.:*'''return_type''VATrate''''' - Тип возвратной корреспонденции — Ставка НДС — целое число процентов. Если товар хранится в КС (отправлениясмотрите '''article''' ниже) передается код , значение берется из номенклатуры. Иначе, если значение указано, берется указанное значение, если нет - значение из справочника "Типы корреспонденции"настроек фирмы КС. Значение «0» означает ставку «Без НДС», ставка «0%» на данный момент не поддерживается.:*'''price''barcode' - Сумма заказа. В случае наличия контейнера items значение данного параметра будет проигнорировано, и рассчитано автоматически'''' — Штрихкод вложения.:*'''deliveryprice''article''''' — Артикул вложения. ''Внимание!' - Сумма ' Указание артикула используется только тогда, когда товар хранится на ответственном хранении в службе доставки, и необходима комплектация. В этом случае наличия контейнера itemsсистема пытается привязать товар к [[API#Справочник номенклатуры|справочнику номенклатуры]]. Если товар в справочнике не найден — система выдаст соответствующую ошибку. Если по артикулу найдено несколько товаров — система выберет один из них случайным образом, что может привести к ошибочной комплектации! Если товар НЕ на ответственном хранении — артикул указывать НЕ нужно. Позиция попадет в него будет добавлено вложение "Доставка"систему просто текстом.:*'''return''itemcode'' - Признак необходимости возврата.*'''return_service — Внутренний код товара, может использоваться вместо артикула. ''Внимание!' - Режим возврата (тип услуги) передается ' Указание кода товара используется только тогда, когда товар хранится на ответственном хранении в службе доставки, и необходима комплектация. В этом случае система пытается привязать товар к [[API#Справочник номенклатуры|справочнику номенклатуры]]. Если товар в справочнике не найден — система выдаст соответствующую ошибку. Если товар НЕ на ответственном хранении — код из справочника "Виды срочности"товара указывать НЕ нужно.:*'''discount''type''''' — Тип вложения. Принимает значения::: 1 — Товар. По-умолчанию.:: 2 — Доставка. Такое вложение добавится автоматически, если заполнить order- Сумма скидки>deliveryprice:: 3 — Услуга:: 4 — Предоплата. Указывается сумма. Скидка "размазывается" по товарным вложениямПоле quantity игнорируется, всегда «1». В заказе сумма НП уменьшается на сумму скидкибудет отрицательной независимо от знака в запросе. При этом Такое вложение Скидка не создаетсядобавится автоматически при указании order->paytype=NO.:: 6 — Оплата кредитом. Указывается сумма. ВНИМАНИЕПоле quantity игнорируется, при использовании этого тега общая всегда «1». В заказе сумма может расходиться на копейки будет отрицательной независимо от знака в запросе.:: 7 — Забор товара. Если товар нужно у получателя забрать, возможно — вернуть деньги, или его стоимость вычтется из-за округления! Старайтесь не использовать этот тегсуммы других товаров. У такого товара в заказе будет отрицательное количество независимо от знака в запросе.:: 9 — Код подтверждения. Используется для вложения, а указывать цену товаров уже с учетом скидокв котором сохраняется регулярное выражение для проверки кодов вложений. См.'''''extraTags''''':*'''enclosure''extcode' - Вложение'''' — Внешний код строки. Используется для идентификации строк заказов при получении статусов. Необязательное поле.:*'''inshprice''origincountry''''' — Код страны- Объявленная ценностьпроизводителя в соответствии со [https://ru.wikipedia. Если явно не указана сумма org/wiki/ISO_3166-1 стандартом ISO_3166- автоматически считается как сумма по товарам1], например, «RU», «RUS» или «643» для России.:*'''instruction''GTD' - Поручение - Примечание'''' — Номер ГТД.:*'''courier''excise''''' - Запланированный курьер — Сумма акциза. Согласно коду курьера в КС2008:* '''''suppcompany''''' — Наименование компании поставщика, если отличается от заказчика.:*'''receiverpays''suppphone' - Признак оплаты стоимости доставки - услуг службы доставки получателем'''' — Номер телефона компании поставщика, а не заказчиком YES/NOесли отличается от заказчика.:*'''department''suppINN''''' - Подразделение — ИНН компании поставщика, в котором оформляется заказесли отличается от заказчика.:*'''pickup''governmentCode''' '' — Код товарной номенклатуры. Используется для [[Маркировка|маркированных товаров, например («Честный знак»)]]. Для кода '''Честный знак''' Нужно указывать все данные из нанесенного QR- Признак оформления забора YES/NOкода кроме не читаемых символов (#29). Если стоит YESкод не известен — укажите знак вопроса «?», то весь заказ тогда курьер отсканирует код фактически передаваемого покупателю товара. Для некоторых процессов может использоваться значение «!» — в этом случае курьер сканирует серийный номер товара, но это не считается заданием на забор грузакодом маркировки. При этом, а не на доставкуесли указано значение «?» или «! Применяется для вызова курьера к отправителю для забора других отправлений» и quantity больше 1, то такое вложение растиражируется quantity раз.:*'''acceptpartially''govType' '''' — Тип маркировки товара. В данный момент существуют следующие типы маркировки::: 1 — Честный знак. По- Признак возможности частичного выкупа товаров отправления YES/NOумолчанию.:: 2 — ГИИС ДМДК.:: 3 — Серийный номер.:* '''''message''''' — Строка сообщения.:* '''''extraTags''''' — Строка в формате JSON для различных целей.
<source lang="xmljson"><?xml version="1.0item_industry_props":{"tag1262":" encoding=020"UTF-8,"?><neworder> <createorder orderno=tag1263"AB23541:" error=14.12.2018"0," errormsg=tag1264"success:"></createorder> <createorder orderno=1556"55_6542," error=tag1265"0:" errormsgtm=mdlp&sid=00000000XXXXXX"},"successtag1212"></createorder> <createorder orderno=: "AB235421" error="0ValidationMask" errormsg=: "success(A-Z0-9){6,8}"></createorder></neworder>
</source>
Для клиентов из '''Узбекистана''' необходимо указывать код ИКПУ и код упаковки в следующем формате:<source lang="xmljson"><?xml version="1.0ikpu" encoding=:"UTF-8123123123"?><neworder> <createorder orderno=,"AB23541packageCode" error=:"17123456" errormsg="Such number exists"></createorder> <createorder orderno="AB23542" error="13" errormsg="empty company"></createorder> <createorder orderno="AB23543" error="14" errormsg="empty person"></createorder></neworder>
</source>
* '''Пример ответа при ошибке синтаксисаpackages''' — Контейнер для описания мест. Необязательный контейнер. Атрибуты::* '''''package''''' — Название места.:* '''''code''''' — Внутренний код строки.:* '''''strbarcode''''' — Штрихкод места.:* '''''mass''''' — Масса места в килограммах.:* '''''message''''' — Строка сообщения.:* '''''length''''' — Длина товарного места (в сантиметрах).:* '''''width''''' — Ширина товарного места (в сантиметрах).:* '''''height''''' — Высота товарного места (в сантиметрах).:* '''''quantity''''' — Количество мест с данным набором параметров. Действует ограничение на общее количество мест в заказе. Общее количество мест в заказе не может быть больше 1000.
<source lang="xml">
<?xml version="1.0" encoding="UTF-8" ?><statusreqrequest> <auth extra="8" login="login" pass="pass"error></auth> <client>CLIENT</client> <orderno>1234</orderno> <orderno2>5678</orderno2> <ordercode>34234</ordercode> <givencode>234534</givencode> <datefrom>2016-07-21</datefrom> <dateto>2016-07-21</dateto> <target>Автозавод</target> <done>ONLY_NOT_DONE</done> <changescolumn:1 line:11 message:expected '>ONLY_LAST'</changeserror></statusreqrequest>
</source>
=== Описание полей запроса статуса Коды и описание ошибок ==={|class=wikitable'''statusreq''' !Код ошибки!Английское описание!Русское описание|- Корневой контейнер. Обязательный элемент.*'''auth''' |0||Success||Успешно|- Авторизация. Обязательный элемент|1||Wrong XML||Некорректный файл XML.*'''client''' |- Признак клиента или агента. Необязательный элемент.:* CLIENT - Признак клиента, значение по умолчанию|2||Lat is empty||Укажите широту.:* AGENT |- Признак агента|3||Specify a valid «Price» field value.||Укажите корректное значение поля «Сумма». В ответ отдается информация по заказам, переданным агенту на доставку*'''orderno''' |- Номер заказа|4||Specify a valid «Weight» field value. Необязательный элемент||Укажите корректное значение поля «Вес».*'''ordercode''' |- Внутренний код заказа. Необязательный элемент.*'''orderno2''' - Номер заказа из срочных|5||Recepient city/town not found. Необязательный элемент||Город назначения не найден.*'''datefrom''' |- Дата заказа "с"|6||Sender city/town not found. Необязательный элемент||Город отправления не найден.*'''dateto''' |- Дата заказа "по". Необязательный элемент.*'''target''' - Строка поиска|7||Specify the «Recipient address» field value. Позволяет указать текст, который содержится в названии компании или адресе получателя||Укажите значение поля «Адрес получателя».*'''done''' |- Может принимать значения: :* ONLY_DONE - Только доставленные (имеются в виду успешные статусы, например, '''Доставлен''' или '''Частично доставлен''')|8||Specify the «Recipient phone» field value.||Укажите значение поля «Телефон получателя».:* ONLY_NOT_DONE - Только не доставленные (заказы, которые не являются доставленными, например, '''Не доставлен''' или '''Утерян'''):* ONLY_NEW |- Только новые:* ONLY_DELIVERY - Только заказы в обработке - заказы, находящиеся в любом статусе, кроме конечных: Доставлено, Не доставлено, Отменён и т|9||Specify the «Recipient name» field value.д||Укажите значение поля «ФИО получателя».:* ''Пусто'' |- все корреспонденции *'''changes''' - может принимать |10||Specify a valid «Quantity» field value.||Укажите корректное значение только ONLY_LASTполя «Количество». Если указан этот параметр, все остальные игнорируются. Описание данного режима приведено здесь: [[#Передача только изменившихся статусов|Передача только изменившихся статусов]]-|11||Specify a valid «Declared value» field value.||Укажите корректное значение поля «Объявленная ценность».|-|12||Supplier SKU ID not found.||Артикул не найден.<div style="color: #a94442; background|-color: #f2dede; border: 1px solid #ebccd1; padding: 3px 10px 10px;">'''Обратите внимание!'''|17||Order number already exists in the database.||Такой номер заказа уже есть в базе.|-# Периода запроса статусов (контейнеры '''datefrom''' и '''dateto''') ограничивается двумя месяцами — два месяца до даты '''"по"'''|18||Order code already exists in the database.||Такой код заказа уже есть в базе.# Если не указаны обе даты — '''dateto''' принимается равной текущей дате|-|19||The delivery date format is not valid.# Если не указана дата '''dateto''' — она принимается равной '''datefrom''' плюс 2 месяцаSpecify a date in YYYY-MM-DD format.||Укажите значение поля «Дата доставки» в формате гггг-мм-дд.# Если не указана дата '''datefrom''' — она принимается равной '''dateto''' минус 2 месяца|-|20||Specify a valid «Delivery mode» field value.||Укажите корректное значение поля «Режим доставки».</div>|-<br /> === Примеры ответов === |21||Specify a valid «Return trip mode» field value.||Укажите корректное значение поля «Режим возврата».|-'''Пример успешного ответа'''|22||Specify a valid «Delivery type» field value.||Укажите корректное значение поля «Тип доставки». <source lang="xml"><?xml version="1.0" encoding="UTF|-8"?><statusreq count="|23">||Specify a valid «Return shipment type» field value.||Укажите корректное значение поля «Тип возврата». <order orderno="111111" awb="qwerty" orderno2="123123" ordercode="34534234" givencode="2345334">|- <barcode>111111</barcode>|30||Specify the «Order number» field value.||Укажите значение поля «Номер заказа». <sender>|- <company>МВД</company> <person>Иванов И|31||Specify the «Barcode» field value.И||Укажите значение поля «Штрихкод».</person> <phone>123-45|-67</phone> <contacts>|32||Specify the «Sender company» field value.||Укажите значение поля «Компания-отправитель». <phone>+74951234567</phone>|- </contacts>|33||Specify the «Sender name» field value.||Укажите значение поля «ФИО отправителя». <town code="23432">Санкт|-Петербург</town> <address>Петровка 38 офис 35</address>|34||Specify the «Sender phone» field value.||Укажите значение поля «Телефон отправителя». <date>2014|-03-22</date> <time_min>09:00<|35||Specify the «Sender city/time_min>town» field value.||Укажите значение поля «Город отправителя». <time_max>14:00</time_max>|- </sender> <receiver> <company>МВД</company> <person>Иванов И|36||Specify the «Sender address» field value.И||Укажите значение поля «Адрес отправителя».</person> <phone>123|-45-67 - Иван (916)234|37||Specify the «Pickup date» field value.45.21 Петр,mvd@mail||Укажите значение поля «Дата забора».ru</phone> <contacts>|- <phone>+74951234567</phone>|38||Specify the «Pickup time from» field value.||Укажите значение поля «Время забора с». <phone>+79162344521</phone>|- <email>mvd@mail|39||Specify the «Pickup time to» field value.||Укажите значение поля «Время забора до».ru</email> </contacts>|- <inn>1112223335</inn> <zipcode>125480</zipcode>|40||Specify the «Recipient company» field value.||Укажите значение поля «Компания-получатель». <town code="153361" regioncode="78" regionname="Санкт|-Петербург город">Санкт-Петербург город</town> <address>Петровка 38 офис 35</address>|41||Specify the «Recipient name» field value.||Укажите значение поля «ФИО получателя». <pvz>|- <code>126</code>|42||Specify the «Recipient phone» field value.||Укажите значение поля «Телефон получателя». <clientcode>QWERTY</clientcode>|- <|43||Specify the «Recipient city/pvz>town» field value.||Укажите значение поля «Город получателя». <date>2014-03|-22</date> <time_min>09:00</time_min>|44||Specify the «Recipient address» field value.||Укажите значение поля «Адрес получателя». <time_max>14:00</time_max>|- <coords lat="55|45||Specify the «Delivery date» field value.680327" lon="37||Укажите значение поля «Дата доставки».604456"></coords> </receiver>|- <weight>5|46||Specify the «Delivery time from» field value.1</weight> <return_weight>5||Укажите значение поля «Время доставки с».1</return_weight> <quantity>2</quantity>|- <paytype>CASH</paytype>|47||Specify the «Delivery time to» field value.||Укажите значение поля «Время доставки до». <service>2</service>|- <return_service>2</service>|48||Specify the «Recipient postcode» field value.||Укажите значение поля «Индекс получателя». <type>3</type>|- <return_type>3</return_type> <waittime>12</waittime> <price>387|49||Specify the «Weight» field value.||Укажите значение поля «Вес».5</price> <print_check>YES</print_check>|- <inshprice>387|50||Specify the «Payment type» field value.||Укажите значение поля «Тип оплаты».5</inshprice> <enclosure>Детские игрушки</enclosure>|- <instruction>Проверить при покупателе, подписать акт</instruction> <currcoords lat="55|51||Specify the «Quantity» field value.680327" lon="37||Укажите значение поля «Количество».604456" accuracy="50" RequestDateTime="2014-04-21 18:07:45"></currcoords> <courier>|-|52||Specify the «Amount» field value.||Укажите значение поля «Сумма». <code>26</code>|- <name>Иванов Владимир Петрович</name>|53||Specify the «Declared value» field value.||Укажите значение поля «Объявленная стоимость». <phone>+79161234567</phone>|- </courier> <deliveryprice total="158|54||Specify the «Description» field value.6" delivery="100||Укажите значение поля «Описание».|-|55||Specify the «Instruction» field value.00" return="58||Укажите значение поля «Поручение».6"> <advprice code="1" price="150">База</advprice>|- <advprice code="2" price="0">% от объявленной стоимости</advprice>|56||Specify the «Delivery mode» field value.||Укажите значение поля «Режим доставки». <advprice code="3" price="8.6">Топливный сбор</advprice>|- <advprice code="4" price="0">Округление</advprice>|57||Specify the «Shipment type» field value.||Укажите значение поля «Тип отправления». </deliveryprice>|- <receiverpays>NO</receiverpays>|58||Specify whether return trip is required.||Укажите значение поля «Необходимость возврата». <status eventstore="филиал в Санкт|-Петербурге" eventtime="2016-06-02 17:22:00" createtimegmt="2016|59||Specify the «Return trip mode» field value.||Укажите значение поля «Режим возврата»|-06|60||Specify the «Return shipment type» field value.||Укажите значение поля «Тип возврата».|-03 16:14:44" message="" title="Доставлен">COMPLETE</status> <statushistory>|61||Specify barcode.||Укажите штрихкод. <status eventstore="Офис в Москве" eventtime="2016|-05-30 10:20:00" createtimegmt="2016-06|62||Specify item weight.||Укажите массу единицы товара.|-03 16:14:44" message="" title="Новый">NEW</status> <status eventstore="Офис в Москве" eventtime="2016|63||Specify item quantity.||Укажите количество товара.|-06-01 17:38:00" createtimegmt="2016|64||Specify item price.||Укажите цену единицы товара.|-06|65||Specify item name.||Укажите название товара.|-03 16:14:44" message="филиал в Санкт-Петербурге" title="Планируется отправка">DEPARTURING</status> <status eventstore="Офис в Москве" eventtime="2016|66||Wrong XLS file||Некорректный файл XLS.|-06-01 19:53:00" createtimegmt="2016-06-03 16:14:44" message="филиал |67||Order barcode already exists in the database.||Такой штрихкод заказа уже есть в Санктбазе.|-Петербурге" title="Отправлено со склада">DEPARTURE</status> <status eventstore="филиал в Санкт|68||Select the «Payment by recipient» field value.||Укажите значение поля «Оплата получателем».|-Петербурге" eventtime="2016|69||Specify department.||Укажите отдел.|-06|70||Specify service partner code.||Укажите значение поля «Код подрядчика».|-02 07:41:00" createtimegmt="2016-06-03 16:14:44" message="" title="Получен складом">ACCEPTED</status> <status eventstore="филиал в Санкт|71||Date cannot be earlier than tomorrow.||Дата не может быть раньше чем завтра.|-Петербурге" eventtime="2016|72||Date cannot be later than 15 days from now.||Дата не может быть позже чем через 15 дней.|-06|73||Date cannot be earlier than today.||Дата не может быть раньше чем сегодня.|-02 09:17:00" createtimegmt="2016|74||Date cannot be later than {0} days from now.||Дата не может быть позже, чем через {0} дней.|-06-03 16:14:44" message="" title="Выдан курьеру на доставку">DELIVERY</status> <status eventstore="филиал в Санкт|75||Specify a valid «Item weight» field value.||Укажите корректное значение поля «Масса единицы товара».|-Петербурге" eventtime="2016-06-02 17:22:00" createtimegmt="2016|76||Specify a valid «Quantity» field value.||Укажите корректное значение поля «Количество товара».|-06|77||Specify a valid «Item price» field value.||Укажите корректное значение поля «Цена единицы товара».|-03 16:14:44" message="" title="Доставлен (предварительно)">COURIERDELIVERED</status> <status eventstore="филиал в Санкт|78||Specify a valid «Delivery time from» field value.||Укажите корректное значение поля «Время доставки с».|-Петербурге" eventtime="2016|79||Specify a valid «Delivery time to» field value.||Укажите корректное значение поля «Время доставки до».|-06|80||Specify a valid «Pickup time from» field value.||Укажите корректное значение поля «Время забора с».|-02 17:22:00" createtimegmt="2016|81||Specify a valid «Pickup time to» field value.||Укажите корректное значение поля «Время забора до».|-06|82||Specify a valid «Pickup point» field value.||Укажите корректное значение поля «ПВЗ».|-03 16:14:44" message="" title="Доставлен">COMPLETE</status> </statushistory>|83||Duplicate number in the registry.||Дублирование номера в реестре. <customstatecode>2<customstatecode>|- <clientstatecode></clientstatecode> <costcode>cc12345</costcode> <receipt fdNum="124555" fnSn="9289000100295555" kktNum="0001611984048555" inn="7722756555" fdValue="2899551555" summ="387|84||Duplicate barcode in the registry.5" ofdUrl="gate||Дублирование штрихкода в реестре.ofd|-|85||Specify a valid «Weight at return trip» field value.ru">https://ofd||Укажите корректное значение поля «Вес возврата».ru/rec/7722756555/0001611984048555/9289000100295555/124555/2899551555</receipt> <deliveredto>Иванова, секр.</deliveredto>|- <delivereddate>2016-06|86||Specify the «Weight at return trip» field value.||Укажите значение поля «Вес возврата».|-02</delivereddate> <deliveredtime>17:22</deliveredtime>|87||Order weight exceeds the allowed maximum for the pickup point.||Вес превышает допустимое значение для этого ПВЗ. <outstrbarcode>EXT123456</outstrbarcode>|-|88||Pickup date cannot be earlier than today.||Дата забора не может быть раньше чем сегодня. <items>|- <item code="34533" extcode="abc123" quantity="1" mass="0|89||Specify a later delivery date.2" retprice="37||Укажите более позднюю дату доставки.5" VATrate="0" barcode="2345625213125" article="1" returns="0" origincountry="040" GTD="" excise="0|-|90||Inappropriate «Weight» or «Pay type» field value for the selected city or town. Please review and correct the values.||Значение поля «Масса» или «Тип оплаты» для выбранного города указано некорректно или отсутствует. Проверьте значения и исправьте.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>|-|91||{deliverytype} {deliverydate} is {holidaytype}. Select another date.||{deliverytype} {deliverydate} является {holidaytype}. Выберите другую дату.|-|92||{deliverytype} {deliverydate} is {holidaytype}. Select another date.||{deliverytype} {deliverydate} является {holidaytype}. Выберите другую дату.|- <item code="34421" extcode="abc125" quantity="3" mass="0|93||Add items.||Добавьте товары.3" retprice="50" VATrate="18" |-|95||The selected pickup point only allows paid orders.||Выбранный ПВЗ выдает только предоплаченные заказы.|-|96||Order barcode="2345625213126" article="3" returns="0" governmentCode="">Погремушка желтая</item>exceeds the allowed maximum (25) symbols.||Длина штрихкода заказа превышает максимально допустимую (25 символов). </items>|- <packages> <package |97||The pickup date format is not valid. Specify a date in YYYY-MM-DD format.||Укажите значение поля «Дата забора» в формате гггг-мм-дд.|-|98||Specify the cost code="33331" strbarcode="ORD0000001" mass="1" message="" got="YES"></package>.||Укажите значение поля «Кост-код».|- <package code="33332" strbarcode="ORD0000002" mass="2|99||The item is not in stock.||Товар отсутствует на складе.5" message="" got="NO"></package> </packages>|- </order>|100||Set the quantity of the item marked with Chestny ZNAK to one.||Укажите количество товара, маркированного кодом «Честный ЗНАК», равным единице.</statusreq> |-<|101||Quantity of item Delivery cannot be greater than 1||Количество вложений типа «Доставка» не может быть более 1.|-|102||А database error occurred. Please try later again.||Ошибка базы данных. Попробуйте позже.|-|103||Order not found.||Заказ не найден.|-|104||Cannot edit order in the current status.||Невозможно изменить заказ в текущем статусе.|-|105||Discount cannot be greater than the order amount. Specify a smaller value.||Размер скидки не может превышать сумму заказа. Укажите меньшее значение скидки.|-|106||Specify the correct additional service code.||Укажите корректный код дополнительной услуги.|-|107||Specify the correct additional service name.||Укажите корректное значение поля [advprice][value].|-|108||Specify the «Additional services» field value.||Укажите значение поля «Дополнительные услуги».|-|110||Specify the correct TIN.||Укажите корректный ИНН.|-|111||Specify the correct IIN (KZ).||Укажите корректный ИИН (КЗ).|-|112||Specify the overall volume.||Укажите общий объем.|-|113||Cannot apply the delivery mode. Select another delivery mode.||Режим доставки не подходит для заказа. Выберите другой режим.|-|114||The pickup point does not support the selected delivery mode. Specify another pickup point.||ПВЗ не подходит для выбранного режима доставки. Укажите другой ПВЗ.|-|115||Specify a valid recipient phone number.||Укажите корректный телефон получателя.|-|116||Specify recipient PIN code.||Укажите пин-код получателя.|-|117||Order date cannot be earlier than {0}. Specify another date.||Дата заказа не может быть раньше {0}. Укажите другую дату.|-|118||Pickup date cannot be earlier than {0}. Specify another date.||Дата забора не может быть раньше {0}. Укажите другую дату.|-|119||Specify the correct item type.||Укажите корректный тип вложения.|-|120||The pickup point does not accept payment by card.||В выбранном ПВЗ оплата картой не принимается.|-|121||Invalid item code format||Неверный формат кода товарной номенклатуры|-|122||Pickup time cannot be earlier than {0} hours.||Время забора не может быть раньше чем через {0} часа.|-|123||Pickup interval cannot be less than {0} minutes.||Интервал времени забора не может быть менее {0} минут. Укажите корректный интервал.|-|124||Specify a valid "Payment type" field value.||Укажите корректное значение поля «Тип оплаты».|-|125||Recepient city/source>town by postcode not found.||Город получателя по его индексу не найден.|-|126||Incorrect items prepayment and pickup.||Заказ не может содержать только вложения «Предоплата» и «Забор».|-|127||Package limit exceeded||Превышен лимит количества мест|-|128||Quantity of item Prepayment cannot be greater than 1||Количество вложений типа «Предоплата» не может быть больше 1.|-|129||Sum of cod must be equal sum of items||Объявленная стоимость должна быть равна сумме вложений.|-|130||Specify a valid respstore code.||Укажите код ответственного филиала.|-|131||Cannot edit, order has not been synchronized.||Невозможно изменить заказ пока он не синхронизирован.|-|132||Specify a valid "Recipient city/town" field value.||Укажите город получателя|-|133||Specify a valid "weight" for the town.||Укажите корректный вес для города|-|134||Specify a valid "paytype" for the town.||Укажите тип оплаты для города|-|135||Specify the correct SKU ID/code for item.||Укажите артикул/код вложения|-|136||Specify warehouse goods in the order.||Укажите вложения в заказе|-|137||The order's date of creation is more than 60 days ago.||Заказ создан более 60 дней назад|-|138||Specify a valid "Package dimension" field value.||Укажите корректные габариты места|-|139||Wrong type of XML query||Ошибка запроса|-|140||Duplicate item code in the order.||Дублирование кода вложения в заказе|-|141||Duplicate additional service in the order.||Дублирование кода дополнительной услуги в заказе|-|144||Incorrect extrafields.||Некорректные расширенные поля.|-|}
=== Пример запроса статуса заказа ===
<source lang="xml">
<?xml version="1.0" encoding="utfUTF-8"?><statusreq count> <auth extra="8" login="login" pass="0pass"></auth> <client>CLIENT</client> <orderno>1234</orderno> <orderno2>5678</orderno2> <ordercode>34234</ordercode> <givencode>234534</givencode> <uid>af11c7c6-6645-4a20-9604-be911a75722d</uid> <datefrom>2016-07-21</datefrom> <dateto>2016-07-21</dateto> <target>Автозавод</target> <done>ONLY_NOT_DONE</done> <changes>ONLY_LAST</changes> <conditions> <namecontains/> <namestarts/> </conditions> <limit>500</limit></statusreq>
</source>
=== Описание полей запроса статуса ==='''Пример ответа statusreq''' — Корневой контейнер. Обязательный элемент.* '''auth''' — Авторизация. Обязательный элемент.* '''client''' — Признак клиента или агента. Необязательный элемент.:* CLIENT — Признак клиента, значение по умолчанию:* AGENT — Признак агента. В ответ отдается информация по заказам, переданным агенту на доставку* '''orderno''' — Идентификатор заказа у клиента (шифр). Необязательный элемент.* '''ordercode''' — Внутренний код заказа. Необязательный элемент.* '''orderno2''' — Номер заказа из срочных. Необязательный элемент. * '''uid''' — Уникальный идентификатор, если он был добавлен при ошибке авторизациисоздании заказа. Необязательный элемент. Запрос информации по uid возможен в течении суток после создания заказа* '''datefrom''' — Дата заказа «с». Необязательный элемент.* '''dateto''' — Дата заказа «по». Необязательный элемент.* '''target''' — Строка поиска. Позволяет указать текст, который содержится в названии компании или адресе получателя.* '''done''' — Может принимать значения::* ONLY_DONE — Только доставленные (имеются в виду успешные статусы, например, '''Доставлен''' или '''Частично доставлен'''):* ONLY_NOT_DONE — Только не доставленные (заказы, которые не являются доставленными, например, '''Не доставлен''' или '''Утерян'''):* ONLY_NEW — Только новые:* ONLY_DELIVERY — Только заказы в обработке — заказы, находящиеся в любом статусе, кроме конечных: Доставлено, Не доставлено, Отменён и т. д.:* ''Пусто'' — все корреспонденции * '''changes''' — может принимать значение только ONLY_LAST. Если указан этот параметр, все остальные игнорируются. Описание данного режима приведено здесь: [[#Передача только изменившихся статусов|Передача только изменившихся статусов]]
=== Примеры ответов ==='''Пример успешного ответа при ошибке синтаксиса'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<requeststatusreq count="23"> <order orderno="111111" awb="qwerty" orderno2="123123" ordercode="34534234" givencode="2345334"> <barcode>111111</barcode> <errorsender>column:1 line:11 message:expected ' <company>МВД</company> <person>'Иванов И.И.</errorperson> <phone>123-45-67</requestphone> <contacts> <phone>+74951234567</sourcephone> </contacts> <town code=== Описание полей ответа статусов ==="23432">Санкт-Петербург</town>Все поля ответа соответствуют структуре order при создании заказа, с некоторыми добавлениями: <address>Петровка 38 офис 35</address> <date>2014-03-22</date>* Атрибуты контейнера '''order''' <time_min>09:00</time_min> <time_max>14:* '''''awb''''' - Номер накладной в системе курьерской службы00</time_max> </sender> <receiver> <company>МВД</company> <person>Иванов И.И.</person>:* '''''orderno2''''' <phone>123-45-67 - Номер накладной в подсистеме срочной доставки курьерской службыИван (916)234.45.21 Петр,mvd@mail.ru</phone>:* '''''ordercode''''' - внутренний код заказа в системе, применяется для некоторых внутренних операций <contacts> <phone>+74951234567</phone> <phone>+79162344521</phone> <email>mvd@mail.ru</email>:* '''''givencode''''' </contacts> <inn>1112223335</inn> <zipcode>125480</zipcode> <town code="153361" regioncode="78" regionname="Санкт-Петербург город">Санкт- внутренний код заказа в системе, применяется для некоторых внутренних операций.Петербург город</town> <address>Петровка 38 офис 35</address> <area>Район 1</area>* атрибут ''''' <pvz> <code''''' контейнера '''item''' >126</code> <clientcode>QWERTY</clientcode> </pvz> <date>2014-03- внутренний код строки заказа в системе, применяется для некоторых внутренних операций.22</date> <time_min>09:00</time_min> <time_max>14:* '''''returns''''' - количество данного товара, от которого отказался получатель00</time_max> <coords lat="55. Не нулевое только в случае частичного отказа680327" lon="37.604456"></coords> <deliveryPIN>1234</deliveryPIN>* атрибут '''''got''''' контейнера '''package''' - признак принятого места YES </ NOreceiver> <price>387.5</price>:* '''''returns''''' - количество данного товара, от которого отказался получатель <inshprice>387. Не нулевое только в случае частичного отказа5</inshprice> <paytype code="1">CASH</paytype> <weight>5.1</weight> <quantity>2</quantity>* '''''coords''''' <service>2</service> <type>3</type> <return>NO</return> <return_service>2</service> <return_type>3</return_type> <return_weight>5.1</return_weight> <return_message>Доставлено в контейнере '''receiver''' целости</return_message> <return_date>2026-01- координаты получателя.19</return_date>* '''currcoords''' - текущие координаты заказа. Атрибуты <return_time>13:18:* '''''lat''''' - широта00</return_time>:* '''''lon''''' - долгота <pickup>NO</pickup>:* '''''accuracy''''' - точность в метрах <print_check>YES</print_check>:* '''''RequestDateTime''''' - дата <waittime>12</время последнего обновления координат.waittime> <enclosure>Детские игрушки</enclosure>* '''courier''' - Данные курьера <instruction>Проверить при покупателе, которому выдан заказподписать акт</instruction> <currcoords lat="55. Если заказ не выдан, то выводятся данные запланированного курьера680327" lon="37.* '''waittime ''' 604456" accuracy="50" RequestDateTime="2014- Время ожидания курьера.* '''deliveryprice''' 04- Стоимость услуг в валюте расчетов с клиентом. Атрибуты21 18:07:45"></currcoords>:* ''''' <courier> <code>26</code> <name>Иванов Владимир Петрович</name> <phone>+79161234567</phone> </courier> <deliveryprice total''''' - общая стоимость услуг:* '''''="158.6" delivery''''' - стоимость доставки ="Туда100.00":* '''''return''''' - стоимость доставки ="Обратно58.6" (если order->return <advprice code="1" price=YES)"150">База</advprice>Тэг '''deliveryprice''' включает список дополнительных услуг (только для тарифа <advprice code="2" price="Премиум0"):>% от объявленной стоимости</advprice>:* ''''' <advprice code="3" price="8.6">Топливный сбор</advprice''''' - наименование дополнительной услуги>:* ''''' <advprice code''''' - код дополнительной услуги="4" price="0">Округление</advprice> </deliveryprice>:* '''''price''''' - стоимость дополнительной услуги <receiverpays>NO</receiverpays> <acceptpartially>NO</acceptpartially>* ''' <status''' eventstore="филиал в Санкт- статус доставки (список статусов см. ниже). Атрибуты (заполняются начиная с версии системы 2008.0.0.670)Петербурге" eventtime="2016-06-02 17:22:* '''''eventstore''''' 00" createtimegmt="2016-06- филиал, к которому относится текущий статус03 16:* '''''eventtime''''' - время события по часовому поясу места его наступления.14:* '''''createtimegmt''''' 44" message="" title="Доставлен" eventtown="Санкт- время по GMT создания записи о смене статуса в БД. Используется для сортировки записей, чтобы соблюсти хронологическую последовательность. <spoiler textПетербург город" color="Подробнее16777215">Большинство событий фиксируются COMPLETE</status> <statushistory> <status eventstore="Офис в полях Москве" eventtime и createtimegmt на основании одного действия, тогда они отличаются только сдвигом от GMT. Однако, если курьер доставил отправление ="2016-05-30 10.10.2010 в :20:00, по какой" createtimegmt="2016-06-то причине не внес это в мобильное приложение, на следующий день сдал накладную, и в 9 утра оператор внесла, что он доставил вчера в 2003 16:14:00. Тогда в createtimegmt будет сегодня 6 утра (для Москвы), а 44" message="" title="Новый" eventtown="Москва город" country="RU">NEW</status> <status eventstore="Офис в Москве" eventtime ="2016- вчера в 2006-01 17:38:00. При этом оператор по каким" createtimegmt="2016-то причинам может внести время вручения раньше, чем какое06-то предыдущее событие, т.о. нарушится последовательность времени 03 16:14:44" message="филиал в eventtime, но при сортировке по createtimegmt всеСанкт-равно все будет правильно.Петербурге" title="Планируется отправка" eventtown="Москва город" country="RU">DEPARTURING</spoilerstatus>:* '''''message''''' <status eventstore="Офис в Москве" eventtime="2016- наименование филиала06-получателя, при передаче между филиалами01 19:53:* '''''title''''' 00" createtimegmt="2016- русское наименование статуса * '''statushistory''' 06- история статусов доставки. Содержит список контейнеров '''status'''. Заполняется только для тарифа 03 16:14:44"Премиум message=" начиная с версии системы 2008.0.0.670.* '''customstatecode''' филиал в Санкт- код внутреннего статуса курьерской службы. Значения уточняйте в курьерской службе. Назначаются курьерской службой в разделе Петербурге" title="СправочникиОтправлено со склада" - eventtown="СтатусыМосква город" - country="15 Статусы корреспонденцииRU". Справочник не передается через API клиенту по причине возможного наличия в нем внутренних технологических статусов курьерской службы.* '''clientstatecode''' - код статуса клиента. Используется, если клиент предлагает свои коды статусов доставки>DEPARTURE</причин недоставки.status>* '''deliveredto''' <status eventstore="филиал в Санкт- данные о вручении, либо причина недоставки.* '''delivereddate''' - дата вручения.* '''deliveredtime''' Петербурге" eventtime="2016- время вручения. В случае недоставки может быть пустым.* '''outstrbarcode''' 06- код у подрядчика (код заказа во внешней системе). Используется в интеграциях с внешними системами. Значения контейнеров '''status''' могут принимать следующие значения02 07:41: AWAITING_SYNC 00" createtimegmt="2016-06- Ожидает синхронизации. Данные заказа пока не появились в бэкофисе03 16: NEW - Новый14: PICKUP - Забран у отправителя44": ACCEPTED - message="" title="Получен складом" eventtown="Санкт-Петербург город" country="RU">ACCEPTED</status> <status eventstore="филиал в Санкт-Петербурге" eventtime="2016-06-02 09:17: INVENTORY 00" createtimegmt="2016-06- Инвентаризация03 16: DEPARTURING - Планируется отправка14: DEPARTURE - Отправлено со склада44": DELIVERY - message="" title="Выдан курьеру на доставку" eventtown="Санкт-Петербург город" country="RU">DELIVERY</status> <status eventstore="филиал в Санкт-Петербурге" eventtime="2016-06-02 17:22: COURIERDELIVERED 00" createtimegmt="2016-06- 03 16:14:44" message="" title="Доставлен (предварительно)" eventtown="Санкт-Петербург город" country="RU">COURIERDELIVERED</status>: COMPLETE <status eventstore="филиал в Санкт-Петербурге" eventtime="2016-06- Доставлен02 17: PARTIALLY - Доставлен частично22: COURIERRETURN 00" createtimegmt="2016- Возвращено курьером. Курьер не смог доставить до получателя, и вернул заказ обратно на склад. Это промежуточный статус, после которого менеджер выясняет, нужно ли пытаться заново доставить заказ, или это окончательная недоставка.: CANCELED 06- Не доставлен (Возврат/Отмена)03 16: RETURNING - Планируется возврат14: RETURNED - Возвращен44": WMSASSEMBLED message="" title="Доставлен" eventtown="Санкт- Скомплектован на складеПетербург город" country="RU">COMPLETE</status>: WMSDISASSEMBLED - Разукомплектован </statushistory>: CONFIRM - Согласована доставка <customstatecode>2<customstatecode>: DATECHANGE - Перенос <clientstatecode></clientstatecode>: NEWPICKUP - Создан забор <deliveredto>Иванова, секр.</deliveredto>: UNCONFIRM <delivereddate>2016- Не удалось согласовать доставку: PICKUPREADY 06- Готов к выдаче02</delivereddate> <deliveredtime>17: LOST - Утрачен22</утерянdeliveredtime>: COURIERPARTIALLY - Частично со слов курьера <department>Отдел</department>: COURIERCANCELED - Отказ со слов курьера <costcode>cc12345</costcode> <outstrbarcode>EXT123456</outstrbarcode>''Примечание:'' В будущем возможно расширение и изменение используемого набора статусов. <respstore>14</respstore> <partner>Офис на Ленина</partner> <div style="color: #a94442; backgroundarrival>2016-05-color02 23: #f2dede; border: 1px solid #ebccd1; padding: 3px 10px 10px;"21</arrival>'''Обратите внимание!''' # Атрибуты контейнера '''status''' заполняются для версий системы '''2008.0.0.670''' и новее.# Контейнер '''statushistory''' заполняется для тарифа <receipt fdNum="124555" fnSn="9289000100295555" kktNum="0001611984048555" inn="7722756555" fdValue="2899551555" summ="[[Личный_кабинет#.D0.9F.D0.BE.D0.B4.D0.BA.D0.BB.D1387.8E.D1.87.D0.B5.D0.BD.D0.B8.D0.B5|Премиум]]5" и версий системы '''2008.0.0.670''' и новее.# Контейнер '''deliveryprice''' заполняется для тарифа ofdUrl="[[Личный_кабинет#.D0.9F.D0.BE.D0.B4.D0.BAgate.D0ofd.BB.D1.8E.D1.87.D0.B5.D0.BD.D0.B8.D0.B5|Премиум]]ru">https://ofd.ru/rec/7722756555/0001611984048555/9289000100295555/124555/2899551555</divreceipt> <br /items> <item code="34533" extcode="abc123" quantity="1" mass="0.2" retprice="37.5" VATrate="0" barcode= Передача только изменившихся статусов "2345625213125" article="1" returns="0" origincountry=В нашем API предусмотрено очень удобное средство получения статусов всех заказов, без необходимости "бомбить040" GTD=" сервер запросами статусов по каждому заказу. Работает это так: раз в какое-то время, например, в 10 минут, вы посылаете запрос "А покажите все изменившиеся статусыexcise="0. Пример запроса ниже. Система вам отдает ВСЕ заказы, статусы (или некоторые другие поля, см ниже) которых изменились с момента последнего запроса. Вы разбираете полученный документ, по каждому заказу сохраняете его актуальный статус в своей системе, и если все хорошо, у вас все получилось, ваша система неожиданно не упала от наплыва информации, посылаете нам запрос подтверждения получения статусов (commitlaststatus). Мы у себя отмечаем, что эти статусы вами получены, и их не надо передавать повторно. Т.о. сколько бы заказов у вас не было, статусы по ним всем почти в реальном времени вы можете получать всего 2-мя запросами. Для получения только изменившихся статусов отправьте запрос<source lang00" governmentCode="xml11223311"><?xml versiongovType="1.0" encodingsuppcompany="Поставщик" suppINN="1112223334" suppphone="UTF-879161234567" ?>Мяч<statusreq/item> <auth extraitem code="34456" extcode="abc124" quantity="2" mass="2" retprice="100" VATrate="10" barcode="4645625213138" article="82" returns="0" logingovernmentCode="login" passgovType="pass1">Обруч</authitem> <changesitem code="34421" extcode="abc125" quantity="3" mass="0.3" retprice="50" VATrate="18" barcode="2345625213126" itemcode="44123" article="3" returns="0" governmentCode="" govType="1">ONLY_LASTПогремушка желтая</changesitem> </statusreqitems> </source> Система выдает все заказы, в которых, с момента последнего запроса в этом режиме, изменилось хотя бы одно из полей: orderno status delivereddate deliveredtime deliveredto receiver-packages>date receiver->address price После успешной обработки ответа необходимо отметить полученные статусы успешно полученными, отправив запрос <source langpackage code="33331" strbarcode="xmlORD0000001"><?xml versionmass="1.0" encodingmessage="" got="UTF-8YES" ?><commitlaststatus/package> <auth extrapackage code="833332" strbarcode="ORD0000002" mass="2.5" loginmessage="login" passgot="passNO"></authpackage> <client/packages>CLIENT </clientextrafields> </commitlaststatusextrafield> <name>courier_car</sourcename> '''Описание полей запроса''' *'''auth''' - Авторизация. Обязательный элемент.*'''client''' - Признак клиента или агента. Необязательный элемент.:* CLIENT - Признак клиента <value>ВАЗ 2106, значение по умолчанию:* AGENT - Признак агента. В ответ отдается информация по заказам, переданным агенту на доставку В случае успеха Вы получите ответ бежевый</value> <source lang="xml"/extrafield> <?xml version="1.0" encoding="UTF-8" ?/extrafields> <commitlaststatus error="0"/order>OK</commitlaststatusstatusreq></source> Данный способ передачи статусов гарантирует полную корректную передачу статусов, даже в случае, если в нашей системе статус изменился в промежутке времени между запросом статусов и подтверждением их получения. Если система не получила подтверждение успешной передачи статуса, она будет считать информацию не переданной, и выдаст ее при повторном запросе.
'''Пример ответа при ошибке авторизации'''
<source lang="xml"><?xml version= Трекинг заказа по номеру "1.0" encoding="utf-8"?><request><error error="1" errormsg="authorization error"></error></request></source>
<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<trackingrequest> <extraerror>8</extra> <ordernocolumn:1 line:11 message:expected '>1234'</ordernoerror></trackingrequest>
</source>
* '''''area''''' в контейнере '''receiver''' — район/метро получателя.
* '''''coords''''' в контейнере '''receiver''' — координаты получателя.
* '''''deliveryPIN''''' в контейнере '''receiver''' — Пин-код.
* '''pickup''' — признак оформления забора, возможные значения: '''YES''', '''NO'''. Если указано '''YES''', то весь заказ считается заданием на забор груза, а не на доставку.
* '''currcoords''' — текущие координаты заказа. Атрибуты:
:* '''''lat''''' — широта
:* '''''lon''''' — долгота
:* '''''accuracy''''' — точность в метрах
:* '''''RequestDateTime''''' — дата/время последнего обновления координат.
* '''Получение информации courier''' — Данные курьера, которому выдан заказ. Если заказ не выдан, то выводятся данные запланированного курьера.* '''waittime ''' — Время ожидания курьера.* '''deliveryprice''' — Стоимость услуг в формате 17 TRACKвалюте расчетов с клиентом. Атрибуты::* '''''total''''' — общая стоимость услуг:* '''''delivery''''' — стоимость доставки «Туда»:* '''''return''''' — стоимость доставки «Обратно» (если order->return=YES)Тэг '''deliveryprice''' включает список дополнительных услуг (только для тарифа «Премиум»)::* '''''advprice''''' — наименование дополнительной услуги:* '''''code''''' — код дополнительной услуги:* '''''price''''' — стоимость дополнительной услуги
* '''Пример запросаstatus''' — статус доставки (список статусов см. ниже). Атрибуты (заполняются начиная с версии системы 2008.0.0.670)::* '''''eventstore''''' — филиал, к которому относится текущий статус:* '''''eventtime''''' — время события по часовому поясу места его наступления.:* '''''createtimegmt''''' — время по GMT создания записи о смене статуса в БД. Используется для сортировки записей, чтобы соблюсти хронологическую последовательность. <source langspoiler text="xmlПодробнее"><?xml version="1Большинство событий фиксируются в полях eventtime и createtimegmt на основании одного действия, тогда они отличаются только сдвигом от GMT. Однако, если курьер доставил отправление 10.10.2010 в 20:00, по какой-то причине не внес это в мобильное приложение, на следующий день сдал накладную, и в 9 утра оператор внесла, что он доставил вчера в 20:00. Тогда в createtimegmt будет сегодня 6 утра (для Москвы), а в eventtime — вчера в 20:00. При этом оператор по каким-то причинам может внести время вручения раньше, чем какое-то предыдущее событие, т.о.0" encoding="UTFнарушится последовательность времени в eventtime, но при сортировке по createtimegmt все-8"?><tracking17> <extra>8равно все будет правильно.</extraspoiler> <orderno>1234</orderno>:* '''''message''''' — наименование филиала-получателя, при передаче между филиалами</tracking17></source>:* '''''title''''' — русское наименование статуса
* '''Пример ответа:statushistory''' — история статусов доставки. Содержит список контейнеров '''status'''. Заполняется только для тарифа «Премиум» начиная с версии системы 2008.0.0.670.<pre>{* '''customstatecode''' — код внутреннего статуса курьерской службы. Значения уточняйте в курьерской службе. Назначаются курьерской службой в разделе «Справочники» — «Статусы» — «15 Статусы корреспонденции». Справочник не передается через API клиенту по причине возможного наличия в нем внутренних технологических статусов курьерской службы. "number":"ExtNumber"* '''clientstatecode''' — код статуса клиента. Используется,если клиент предлагает свои коды статусов доставки/причин недоставки. "oriNumber":"1234"* '''deliveredto''' — данные из поля «Инфо. о доставке» (может быть информация о доставке,причина недоставки и т. п.). "oriCountry"* '''delivereddate''' — дата вручения.* '''deliveredtime''' — время вручения. В случае недоставки может быть пустым.* '''arrival''' — плановая дата прибытия в формате гггг-мм-дд чч: мм:"RU"сс. Заполняется только при использовании автоматических систем планирования (Максоптра, Яндекс доставка),во всех остальных случаях - пустое.* '''outstrbarcode''' — код у подрядчика (код заказа во внешней системе). Используется в интеграциях с внешними системами.* '''partner''' — текущий филиал/подрядчик.* '''return_message''' — информация о возврате* '''return_date''' - дата возврата* '''return_time''' - время возврата "destCountry":"RU"* '''department''' — Подразделение,в котором оформляется заказ. "Контейнер '''status"''' может принимать следующие значения:: AWAITING_SYNC — Ожидает синхронизации. Данные заказа пока не появились в службе доставки.:"Complete"'''NEW''' — Успешно создан,передан в службу доставки. "events":[NEWPICKUP — Создан забор. {: PICKUP — Забран у отправителя. "time":"2016-06-02 17WMSASSEMBLED — Скомплектован на складе фулфилмента.:22WMSDISASSEMBLED — Разукомплектован на склад фулфилмента.:00",'''ACCEPTED''' — Получен складом. "location":"RU",CUSTOMSPROCESS — Производится таможенный контроль. "content":"Complete"CUSTOMSFINISHED — Таможенный контроль произведен. },: CONFIRM — Согласована доставка. {: UNCONFIRM — Не удалось согласовать доставку. "time":"2016-06-02 17DEPARTURING — Планируется отправка со склада на другой склад.:22DEPARTURE — Отправлено со склада на другой склад.:00",INVENTORY — Инвентаризация. Убедились в наличии отправления на складе. "location":"RU",PICKUPREADY — Готов к выдаче в ПВЗ. "content":"Courierdelivered"'''DELIVERY''' — Выдан курьеру на доставку. }: COURIERDELIVERED — Доставлен (предварительно,ожидает подтверждения менеджером, чтобы перейти в статус COMPLETE). {: COURIERPARTIALLY — Частично доставлен (предварительно, ожидает подтверждения менеджером, чтобы перейти в статус PARTIALLY). "time":"2016-06-02 09COURIERCANCELED — Отказ (предварительно, после этого ожидается COURIERRETURN).:17COURIERRETURN — Возвращено курьером. Курьер не смог доставить до получателя и вернул заказ обратно на склад. Это промежуточный статус, после которого менеджер выясняет, нужно ли повторно доставлять (статусы DATECHANGE/DELIVERY) или это окончательная недоставка (CANCELED).:00",DATECHANGE — Перенос даты доставки. "location":"RU",'''COMPLETE''' — Доставлен. "content":"Delivery"'''PARTIALLY''' — Доставлен частично. }: '''CANCELED''' — Не доставлен (Возврат/Отмена). После этого статуса отправление должны вернуть заказчику,будут статусы RETURNING и RETURNED { "time":"2016-06-02 07RETURNING — Планируется возврат заказчику (после CANCELED).:41RETURNED — Возвращен заказчику.:00",LOST — Утрачен/утерян. "location":"RU",PARTLYRETURNING — Планируется возврат остатков. "content":"Accepted"PARTLYRETURNED — Остаток возвращен. },: TRANSACCEPTED — Прибыл на склад перевозчика. {: PICKUPTRANS — Забран у перевозчика. "time":"2016WITHDRAWN_FROM_PICKUP_POINT -06Изъят.: CUSTOMSDELAY -01 19Задержка отправления таможенным органом.:53:00",DEPARTUREDELAY - Задержка отправления перевозчиком. "location":"RU",STORETAKE - Принят в работу на складе. "content":"Departure" },'''Примечание.''' В будущем возможно дополнение используемого набора статусов. { "time<div style="color:"2016#a94442; background-06-01 17color: #f2dede; border:381px solid #ebccd1; padding:003px 10px 10px;">'''Обратите внимание!''' # Контейнер '''statushistory''' и '''deliveryprice''' заполняется для тарифов [[Личный кабинет курьерской службы#Функции личного кабинета|Премиум и Максимум]].# Контейнер '''packages''' не возвращает более 1000 элементов.# Система никогда не гарантирует последовательность прохождения заказом набора статусов. То есть Вы можете получить статус «COMPLETE»,а следующим запросом — «NEW» — такое может произойти, например, если оператор ошибочно отметил заказ выполненным, а затем исправил ошибку. "location"</div><br> === Передача только изменившихся статусов ===В нашем API предусмотрено удобное средство получения статусов всех заказов, без необходимости «бомбить» сервер запросами статусов по каждому заказу. Работает это так:"RU"раз, например, в 10 минут, вы посылаете запрос «покажите все изменившиеся статусы». Пример запроса ниже. Система вам отдает ВСЕ заказы, статусы (или некоторые другие поля, см. ниже) которых изменились с момента последнего запроса. Вы разбираете полученный документ, по каждому заказу сохраняете его актуальный статус в своей системе, и если все хорошо, у вас все получилось, ваша система неожиданно не упала от наплыва информации, посылаете нам запрос подтверждения получения статусов (commitlaststatus). Мы у себя отмечаем, что эти статусы вами получены и их не надо передавать повторно. Таким образом, сколько бы заказов у вас ни было,статусы по ним всем почти в реальном времени вы можете получать всего двумя запросами. "content"Для получения только изменившихся статусов отправьте запрос:<source lang="Departuringxml"> }, { <?xml version="time1.0":encoding="2016UTF-05-30 10:20:008",?><statusreq> <auth extra="location8":login="RUlogin", pass="content":"Newpass"></auth> } <changes>ONLY_LAST</changes> ] <streamid>1234</streamid></statusreq>}</presource> Система выдает все заказы, в которых с момента последнего запроса в этом режиме изменилось хотя бы одно из полей: orderno status delivereddate deliveredtime deliveredto receiver->date receiver->address price
'''Описание полей запроса'''
* '''auth''' — авторизация. Обязательный элемент.* '''streamid''' — идентификатор потока. Если у вас несколько интеграций и каждая нуждается в получении статусов, вы можете передавать данный параметр и тем самым разделять получение и отметку об успешном получении статусов по заказам. Значение должно входить в промежуток от 100 до 10000, включительно. Необязательный элемент.* '''client''' — признак клиента или агента. Необязательный элемент.:* CLIENT — признак клиента, значение по умолчанию:* AGENT — признак агента. В ответ отдается информация по заказам, переданным агенту на доставку В случае успеха вы получите ответ:<source lang="xml"><?xml version= Изменение заказа "1.0" encoding="UTF-8" ?><commitlaststatus error="0">OK</commitlaststatus></source>Запрос предназначен для изменения заказовТакой способ передачи статусов гарантирует полную корректную передачу статусов, находящихся даже если в статусах "Ожидает синхронизации" или "Новый", а также по которым нашей системе статус изменился между запросом статусов и подтверждением их получения. Если система не было произведено изменений - получила подтверждение передачи статуса корреспонденции, времени доставки - то есть заказов, которые ещё не находятся в работеона будет считать информацию непереданной и выдаст ее при повторном запросе.
<div style="color: #a94442; background-color: #f2dede; border: 1px solid #ebccd1; padding: 3px 10px 10px;">
</div>
<br />
=== Описание полей ответа изменения Лимитирование запросов ===Все поля ответа соответствуют ответу при создании заказа за исключением корневого тэга Дает возможность получить не все измененные заказы, а только какое- вместо то определенное количество. Помогает на случай, если у вас скопилось очень много измененных заказов и нужно их грузить лимитировано. После успешной обработки получнных заказов, '''neworder''' возвращается '''editorderобязательно'''нужно вызвать commitlaststatus с кодами обработанных заказов.
<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="" limit>5</limit></cancelorderstatusreq>
</source>
После успешной обработки ответа необходимо отметить полученные статусы успешно полученными, отправив запрос:
<source lang="xml">
<?xml version="1.0" encoding="UTF-8" ?>
<commitlaststatus>
<auth extra="8" login="login" pass="pass"></auth>
<acs>
<ac>11111</ac>
<ac>22222</ac>
<ac>33333</ac>
<ac>44444</ac>
<ac>55555</ac>
</acs>
</commitlaststatus>
</source>
* '''acs''' — контейнер. Обязательный элемент.
* '''ac''' — атрибут''' ordercode''' контейнера '''order''' полученного на этапе запроса '''statusreq'''.
Помимо приведенных в примере параметров, вы также можете передавать и остальные, описанные ранее, например '''Пример ответа:streamid'''<source lang="xml"><?xml version="1.0" encoding="UTF-8" ?><cancelorder> <order orderno="123test" ordercode="123456" error="0" errormsg="OK" errormsgru="Успешно" /> <order orderno="123aaa" ordercode="" error="52" errormsg="order not found" errormsgru="Заказ не найден" /></cancelorder></source>
== Добавление вложений к накладной Трекинг заказа по номеру ==Запрос трекинга по номеру предназначен для выдачи минимальной обезличенной информации о конкретном заказе не авторизованному пользователю. Наша система имеет для этого интерфейс по адресу «home.courierexe.ru/{код экстра}/tracking». Вы можете либо сделать ссылку на такую страницу на своем сайте, либо разместить ее [[#Размещение страниц на своем сайте (iframe)|iframe’ом]] у себя, либо сделать свою и пользоваться нашим API. Этот интерфейс создан специально для выдачи информации живому пользователю сайта. Для получения статусов заказов в свою информационную систему нужно использовать запрос «statusreq», желательно с параметром changes=ONLY_LAST!
'''Пример запроса:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8" ?><addattachmentstracking> <auth extra=">8" login="login" pass="pass" </extra> <orderno>12345671234</orderno> <attachments> <item name="photo1.jpg">JVBERi0xLjMN1wb25lbnQgMQ JUBQREYwMTIzNDU2Nzg5IDI NMyAwIG9iag08PA0vVHlwZSA U3VidHlwZSAvSW1hZ2UNL1d pZHRoIDE4MDgNL0hlaWdodCA ggNCAwIFINL0JpdHNQZXJDb 21wb25lbnQgMQ0vRGVjb2RlU ENL0NvbHVtbnMgMTgwOA0+P g0vSW1hZ2VNYXNrIHRydWUNL XhEZWNvZGUNPj4Nc3RyZWFt DQ</item> <item name="photo2.jpg">VBERi0xLjMNAwIG9iag0HRoJ JUBQREYwMTIzNDU2Nzg5IDI NMyAwIG9iag08PA0vVHlwZSA vWE9iamVjdA0vU3VidHlwZS AvSW1hZ2UNL1dpZHRoIDEzNj gNL0hlaWdodCAxMzMzDS9MZ W5ndGggNCAwIFINL0JpdHNQZ XJDb21wb25lbnQgMQ0vRGVj b2RlUGFybXMgPDwNL0sgLTEN L0NvbHVtbnMgMTM2OA0+Pg0 vSW</item> </attachments></addattachmentstracking></source> '''Описание полей:''' '''addattachments''' - Корневой контейнер. Обязательный элемент.*'''auth''' - Авторизация. Обязательный элемент.*'''orderno''' - Номер заказа. Обязательный элемент. Может использоваться тэг <ordercode> с указанием внутреннего кода заказа.*'''attachments''' - Обязательный элемент, в котором перечисляются передаваемые данные файлов.**'''item''' - Бинарные данные (файл), закодированные в base64. Обязательный элемент.***'''name''' - Атрибут элемента '''item''', в котором передается имя файла. Обязательный элемент.
'''Пример ответа:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<addattachmentstracking> <attachmentsorder orderno="111111" ordercode="12345"> <barcode>111111</barcode> <AWB>111111</AWB> <sender> <item nametown code="photo1.jpg1" errorcountry="0RU" errormsg>Москва город</town> <date>2014-03-22</date> <time_min>09:00</time_min> <time_max>14:00</time_max> </sender> <receiver> <town code="OK1" errormsgrucountry="УспешноRU" >Москва город</town> <zipcode>125480<item name/zipcode> <date>2014-03-22</date> <time_min>09:00</time_min> <time_max>14:00</time_max> </receiver> <price>387.5</price> <inshprice>387.5</inshprice> <paytype>CASH</paytype> <weight>5.1</weight> <quantity>2</quantity> <service>2</service> <type>3</type> <return>NO</return> <return_service>2</return_service> <return_date></return_date> <return_time></return_time> <return_message></return_message> <waittime>12</waittime> <enclosure>Детские игрушки</enclosure> <instruction>Проверить при покупателе, подписать акт</instruction> <deliveryprice total="photo2158.jpg6" errordelivery="0100.00" errormsgreturn="OK" errormsgru="Успешно58.6" /> <courier> <code>26</attachmentscode> <name>Иванов Владимир Петрович</addattachmentsname> <phone>+79161234567</sourcephone> </courier> <currcoords lat="55.680327" lon= Получение вложений к накладной "37.604456" accuracy="50" RequestDateTime="2014-04-21 18:07:45" /> <status eventstore="филиал в Санкт-Петербурге" eventtime="2016-06-02 17:22:00" createtimegmt="2016-06-03 16:14:44" message="" title="Доставлен">COMPLETE</status>'''Пример запроса:''' <statushistory> <source langstatus eventstore="Офис в Москве" eventtime="2016-05-30 10:20:00" createtimegmt="2016-06-03 16:14:44" message="xml"title="Новый">NEW</status> <?xml versionstatus eventstore="Офис в Москве" eventtime="1.02016-06-01 17:38:00" createtimegmt="2016-06-03 16:14:44" encodingmessage="UTFфилиал в Санкт-8Петербурге" title="Планируется отправка" ?>DEPARTURING<attachments/status> <auth extrastatus eventstore="8Офис в Москве" logineventtime="login2016-06-01 19:53:00" passcreatetimegmt="pass2016-06-03 16:14:44" message="филиал в Санкт-Петербурге" title="Отправлено со склада" >DEPARTURE</status> <ordernostatus eventstore="филиал в Санкт-Петербурге" eventtime="2016-06-02 07:41:00" createtimegmt="2016-06-03 16:14:44" message="" title="Получен складом">1234567ACCEPTED</ordernostatus> <status eventstore="филиал в Санкт-Петербурге" eventtime="2016-06-02 09:17:00" createtimegmt="2016-06-03 16:14:44" message="" title="Выдан курьеру на доставку">DELIVERY</attachmentsstatus> <status eventstore="филиал в Санкт-Петербурге" eventtime="2016-06-02 17:22:00" createtimegmt="2016-06-03 16:14:44" message="" title="Доставлен (предварительно)">COURIERDELIVERED</sourcestatus> '''Описание полей <status eventstore="филиал в Санкт-Петербурге" eventtime="2016-06-02 17:22:00" createtimegmt="2016-06-03 16:14:'''44" message="" title="Доставлен">COMPLETE</status> </statushistory>'''attachments''' - Корневой контейнер. Обязательный элемент <deliveredto>Иванова, секр.</deliveredto>*'''auth''' <delivereddate>2016- Авторизация. Обязательный элемент.*'''orderno''' 06- Номер02</код заказа. Обязательный элемент.delivereddate> <deliveredtime>17:22</deliveredtime> <outstrbarcode>EXT123456</outstrbarcode>'''Пример ответа:''' <items> <source langitem code="34533" extcode="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="xml1112223334" suppphone="79161234567">Мяч</item> <?xml versionitem code="34456" extcode="abc124" quantity="2" mass="2" retprice="100" VATrate="10" barcode="4645625213138" article="2" returns="1.0" encodinggovernmentCode="UTF-8"?>Обруч<attachments/item> <item namecode="34421" extcode="abc125" quantity="3" mass="doc10.docx3" sizeretprice="3565450"VATrate="18" barcode="2345625213126" article="3" returns="0" governmentCode="">Погремушка желтая</item>JVBERi0xLjMN JUBQREYwMTIzNDU2Nzg5IDI NMyAwIG9iag08PA0vVHlwZSA </items> U3VidHlwZSAvSW1hZ2UNL1d pZHRoIDE4MDgNL0hlaWdodCA <acquirers> ggNCAwIFINL0JpdHNQZXJDb 21wb25lbnQgMQ0vRGVjb2RlU <acquirer code="2" name="Ibox"/> ENL0NvbHVtbnMgMTgwOA0+P g0vSW1hZ2VNYXNrIHRydWUNL XhEZWNvZGUNPj4Nc3RyZWFt DQ <acquirer code="5" name="Payme"/item> <item nameacquirer code="photo2.jpg6" sizename="74861Click"/>VBERi0xLjMN JUBQREYwMTIzNDU2Nzg5IDI NMyAwIG9iag08PA0vVHlwZSA </acquirers> vWE9iamVjdA0vU3VidHlwZS AvSW1hZ2UNL1dpZHRoIDEzNj gNL0hlaWdodCAxMzMzDS9MZ W5ndGggNCAwIFINL0JpdHNQZ XJDb21wb25lbnQgMQ0vRGVj b2RlUGFybXMgPDwNL0sgLTEN L0NvbHVtbnMgMTM2OA0+Pg0 vSW </itemorder></attachmentstracking>
</source>
</source>
'''Пример ответа:'''
<pre>{
"number":"ExtNumber",
"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"
},
{
"time":"2016-06-02 07:41:00",
"location":"RU",
"town":"Москва",
"store":"Москва Главный",
"content":"Accepted"
},
{
"time":"2016-06-01 19:53:00",
"location":"RU",
"town":"Горький",
"store":"Горький Автозавод",
"content":"Departure"
},
{
"time":"2016-06-01 17:38:00",
"location":"RU",
"town":"Горький",
"store":"Горький Автозавод",
"content":"Departuring"
},
{
"time":"2016-05-30 10:20:00",
"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"?>
<waybillacqlink> <contentextra>8</extra> <acq>EODIcaI8KSBlwQ 4MnEOR7Px8U8EBAyGICBnwpw IZhQgz0ZxuPs8EBM <code>2</GcbjzB AwhBl8hwQYIO00GmEwg1CeEG code> mqYTChNU0wqf8l8nz4zgc+K fCno+zwU5GjOZmzXGcbEQYIM </acq> 4zkegRE40zWzONyoNNMIOIa cWnp6aDCGEGE9NQmoQd2mg00 <order> 79U4f3hPTwnfp6Sdrafeqpa JDpFw <code>12345</1aYT077VNNNdO00G3q code> mqqvp9p2E7T0/wiFemv8uG6 OM </contentorder></waybillacqlink>
</source>
где
*'''extra''' - код экстраклиента в системе Measoft.
*acq.'''code''' - внутренний код платформы эквайринга в системе Measoft. (известен в МП из [https://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 Трекинга])
*order.'''ordercode''' - внутренний код заказа, типа ''int'', уникальный в пределах экстраклиента
где
*acqlink.'''message''' - текст ошибки возвращаемой эквайрингом
Возможные типы ошибок получения ссылки:* '''Обратите внимание1'''- не настроен эквайринг, что печатные формы для заборов либо не найден заказ* '''2''' - ошибка на стороне эквайринга* '''3''' - запрещающий статус курьера (заказ доставлен, частично доставлен)* '''4''' - оплата заказа не формируются.разрешена
== Изменение заказа ==
Запрос предназначен для изменения заказов.
<div style="color: #a94442; background-color: #f2dede; border: 1px solid #ebccd1; padding: 3px 10px 10px;">'''Пример Обратите внимание!'''# Данные запроса справочника городов:изменения указываются '''полностью''', как если бы заказ создавался впервые.<source lang="xml"># При отсутствии вложения в запросе изменения данное вложение '''не удаляется''' из заказа, но его количество становится равным 0.<?xml version="1# При одновременном изменении заказа в API и системе курьерской службы приоритет отдается данным системы курьерской службы. То есть изменения в API приняты не будут.0" encoding="UTF-8"?><townlist> <auth extra="8" /> <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>
=== Описание полей запроса изменения ===Все поля запроса соответствуют структуре order при создании заказа за исключением: *значение '''authorderno''' данным методом изменить нельзя.* значение '''barcode''' изменяется в случае явного его указания. В случае отсутствия или пустого значения - Авторизацияостается прежним.* вместо корневого тэга '''neworder''' указывается '''editorder''';* тэг курьера '''courier''' можно изменить только при включенной настройке '''Разрешить изменение курьера по АПИ''';* для вложений '''item''' указывается внутренний код вложения в атрибуте '''code''', необязательный элементкоторый можно получить при получении статуса заказа. Используется * для мест '''package''' указывается внутренний код вложения в случае включенного атрибуте '''code''', который можно получить при получении статуса заказа. Необходимо иметь в виду, что: # Заказ нельзя изменить, пока он не синхронизирован с системой (пока предыдущие изменения не переданы в бэк-офис)# Удаление вложений и настроенного ограничения по населенным пунктам мест выполняется не моментально, а в конкретной курьерской службепроцессе синхронизации с бэк-офисом (для записей указываются метки Удалено) === Описание полей ответа изменения ===Все поля ответа соответствуют ответу при создании заказа за исключением корневого тэга — вместо '''neworder''' возвращается '''editorder'''. == Отмена заказа ==Запрос предназначен для отмены заказов.
'''Пример ответа:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?><townlist countcancelorder> <order orderno="123test" ordercode="3123456" pageerror="10" totalcounterrormsg="3OK" totalpageserrormsgru="1Успешно"/> <townorder orderno="123aaa" ordercode="" error="52" errormsg="order not found" errormsgru="Заказ не найден" /> <code>26379</codecancelorder> <city/source> <code>23</code> <name>Краснодарский край</name>== Добавление вложений к накладной == </city> <name>Сочи город</name>Метод позволяет прикрепить файлы к корреспонденции. <fiascode>79da737a-603b-4c19-9b54-9114c96fb912</fiascode>Размер загружаемого файла не должен превышать 1 Мб. <kladrcode>2300000700000</kladrcode> <shortname /> (not yet supported)'''Пример запроса:''' <typename /source lang="xml"> (not yet supported) <coords lat?xml version="431.58550" lonencoding="39.7231UTF-8" /?> </townaddattachments> <town> <code>40331<auth extra="8" login="login" pass="pass" /code> <cityorderno> <code>321234567</codeorderno> <name>Брянская область</nameattachments> </cityitem name="photo1.jpg">JVBERi0xLjMN1wb25lbnQgMQ <name>Сочилов хутор</name>JUBQREYwMTIzNDU2Nzg5IDI NMyAwIG9iag08PA0vVHlwZSA <fiascode>c9c96c67-2cc9-4f10-afde-fd32417ea216</fiascode>U3VidHlwZSAvSW1hZ2UNL1d pZHRoIDE4MDgNL0hlaWdodCA <kladrcode>3201900011100</kladrcode>ggNCAwIFINL0JpdHNQZXJDb 21wb25lbnQgMQ0vRGVjb2RlU <shortname />ENL0NvbHVtbnMgMTgwOA0+P g0vSW1hZ2VNYXNrIHRydWUNL XhEZWNvZGUNPj4Nc3RyZWFt DQ<typename /item> <coords latitem name="52photo2.6407jpg" lon="33.1724" /> </town> <town> <code>114016</code> <city> <code>60</code> <name>Псковская область</name>VBERi0xLjMNAwIG9iag0HRoJ </city>JUBQREYwMTIzNDU2Nzg5IDI NMyAwIG9iag08PA0vVHlwZSA <name>Сочихино деревня</name>vWE9iamVjdA0vU3VidHlwZS AvSW1hZ2UNL1dpZHRoIDEzNj <fiascode>10df7588-19c1-49d1-a387-9de1cf3eb26f</fiascode>gNL0hlaWdodCAxMzMzDS9MZ W5ndGggNCAwIFINL0JpdHNQZ <kladrcode>6001900015400</kladrcode>XJDb21wb25lbnQgMQ0vRGVj b2RlUGFybXMgPDwNL0sgLTEN L0NvbHVtbnMgMTM2OA0+Pg0 vSW<shortname /> <typename /> <coords lat="56.6003" lon="29.3542" /item> </townattachments></townlistaddattachments>
</source>
'''Пример запроса справочникаответа:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<regionlistaddattachments> <codesearchattachments> <code>77<item name="photo1.jpg" error="0" errormsg="OK" errormsgru="Успешно" /code> <item name="photo2.jpg" error="0" errormsg="OK" errormsgru="Успешно" /codesearch> <conditions/attachments> <namecontains>край</namecontainsaddattachments> <namestarts>Моск</namestartssource> == Получение вложений к накладной =='''Пример запроса:'''<fullnamesource lang="xml">Московская область</fullname?xml version="1.0" encoding="UTF-8" ?> <countryattachments>1 <auth extra="8" login="login" pass="pass" /country> <orderno>1234567</conditionsorderno></regionlistattachments>
</source>
'''Описание полей:'''
'''attachments''' — Корневой контейнер. Обязательный элемент.
* '''auth''' — Авторизация. Обязательный элемент.
* '''orderno''' — Номер/код заказа. Обязательный элемент.
'''Пример ответа:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<regionlist countattachments> <item name="doc1.docx" timestamp="22025-01-01 12:00:00" size="35654">JVBERixLjMN <city>UwLJdLwIDKxTn+AScMjKqor7Xm3sp1yj1k6BzlPdX2Qsiit6yg3g1fCI4YVAgclUOIY5tDra2LvAcIS <code>80< 5/+8PsL/sXb0+aoper/9kL/4Ov/code>YE9QsHwyg7YZTtKICy0YVIYb4Nt7L1tPUMfaX9NpuTsvFCtBAvYG <country> eJVZoZ2tm6+fZVqAavZpeLizVLtct1a+xvG0+bTSkw3Ac8PhdNfL4smrT2hSgPJLfyaVGyA2ndyW22t <code>1< sFtTP5knktPNumSZ56QsFRPJkaU8ExDxAcMYMDIoBiIoR4/dDjHMbMW/code>EW4fiB1pvWmV2ONWIl1Xdub <name>Россия< Xg1ob0qWX9W4qagsqzGhjRLsEGeJGVXg9oVC+XkJa9esrhGUmC0tuKEla+AplVO/name>OtHwXcW0FWui1z7 <id>643</id> 6KHrtobuWV0xa9sCEiSvb91w3ePHOvfcveo5xt9o4ZevHF7ZOeKxV5qmVx2MI44a1L+Mhk5YuGT12xd <ShortName1>RU< Ibsb7r+j9bff/ShortName1> <ShortName2>RUS<unQlv0al6HBnoD5G89q4+tkjgDtvwwARmqm2aa2Jgvmth8mrXquTNtl2u467vbF/ShortName2>5r < vnMt9uesu21Me1bjeNJGlVfAaCtw+/country> <name>Агинский Бурятский автономный округ<jfenJ/name>fWjqa7ygExx+L0BcTGroxrKexQXIQ1ImfEW7ZRJZa+O <ip7xJmmNESMxrgu/city>dquBbGypjJpFDJVRH1rVPR1Ifl4aFS5IEdDWZFSdyBBWKWhVSVu517ZgzOCFAwp <city> <code>1<wwbFph29g4fTaxnvn/code>3X78x+Tt56ZNffArgULt+HByvy7+yz6U6XWMawCi3+6gJXN0S+jf4t+HT34wg <country> <code>1< km7/code>HDp55YTSWMoCMgZsvZkBrXtIv4WA7xgkT4YpYpxjwLvnsWKkGE+pDbxER0UUWlpVFRY4oilTfM4 <name>Россия</name> MIzgCPgxjOlZ87ceA7ceRJrgpipFGyugPQ4OTI2S8lWJoqTpHJlJbNOeYM7zTcoVxSNyJXiYWSAMklT <id>643< q/id> <ShortName1>RU<xd+3fd3/ShortName1>USq2V1rJ7RyBLHsuDSiLwgaOFc5LUCRGI+QWuBAsIwPlZrgRpSMseJyTzD15PKiIRE7bc <ShortName2>RUS</ShortName2> Rggk5ijXAPpqISetD4wVm0AD2LHuBZdaxmK3HOKIZoG0QLmiZdVqspXnFIJwVyCKhWiDCI4bzH8Y76w </country> TAnwM67HIqMISOkmJXY8mlYhpiNa7g2oTBkKxo4wgnvETQIUUrlFOn9KdOreDiKQx071rN4N61yRAi1 <name>Адыгея республика< 7EGRhSOgoeLYv+k41+KZ1SVBXAuDjB+xuxnQmm8wJDcP5IRn+5penzbR/name>ivm7qleHK5o790w8ejXchI vOHIPWtWwYhtAO34LdDXqFqWxZEBLNstMCwwITBTWirxk12zuUppp</cityitem></regionlistattachments>
</source>
В тегах item возвращаются бинарные данные (файлы), закодированные в base64. == Справочник улиц Изменение статуса агентом ==Запрос изменения статуса заказа позволяет установить окончательный статус заказа — «Доставлен» или «Не доставлен (Возврат/Отмена)».
Кроме этого, устанавливается дата и время (при необходимости) изменения статуса, а также сообщение в поле ''Инфо о доставке'Пример запроса справочника улиц:'''<source lang="xml"><?xml version="1.0" encoding="UTF-8"?><streetlist> <conditions> <town>Москва город</town> // ОБЯЗАТЕЛЬНОЕ ПОЛЕ! <namecontains>Хохло</namecontains> <namestarts>Академика Х</namestarts> <name>Академика Хохлова</name> <fullname>Академика Хохлова ул.</fullname> </conditions> <limit> <limitfrom>30</limitfrom> <limitcount>10</limitcount> <countall>YES</countall> </limit></streetlist></source>
'''Пример ответазапроса изменения статуса:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?><streetlist countsetorderinfo> <auth extra="18" pagelogin="1login" totalcountpass="3pass" totalpages/> <order ordercode="1123456"> <message>Получил Иванов</message> <outstrbarcode>7654312</outstrbarcode> </order> <streetorder ordercode="234567"> <namestatus>Академика Хохлова ул.PICKUPREADY</status> <eventtime>2016-05-30 10:20:00</eventtime> <message>Клиент отказался от покупки</message> <paytype>CASH</paytype> <storeprice>123</storeprice> <items> <item code="34533" quantity="1" reason="0" governmentCode="11223311" /> <item code="34456" quantity="0" reason="0" /name> <shortnameitem code="34421" quantity="2" reason="0" />Академика Хохлова </shortnameitems> <attachments> <attachment filename="filename1.jpg">/9j/4AAQSkZJRgA BAQAAAQABAAD/2wBDAA0JCg sKCA0LCgsODg0PEyAVExISEy ccHhcgLikxMC4pLSwzOko+M zZGNywtQFdBRkxOUlNSMj5aY VpQYEpRUk//2wBDAQ4ODhMR EyYVFSZPNS01T09PT09PT09P T09PT09PT09PT09PT09PT09 PT09PT09PT09PT09PT09PT09 PT09PT0//wAARCAYACAADAS IA<typename/attachment>ул <attachment filename="filename2.jpg"> /9j/4AAQSkZJRgA BAQAAAQABAAD/2wBDAA0JCg sKCA0LCgsODg0PEyAVExISEy ccHhcgLikxMC4pLSwzOko+M zZGNywtQFdBRkxOUlNSMj5aY VpQYEpRUk//2wBDAQ4ODhMR EyYVFSZPNS01T09PT09PT09P T09PT09PT09PT09PT09PT09 PT09PT09PT09PT09PT09PT09 PT09PT0//wAARCAYACAADAS IA</attachment> </typenameattachments> </streetorder></streetlistsetorderinfo>
</source>
'''Пример ответа:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<itemlist countsetorderinfo> <order ordercode="3123456" totalcounterror="30" pageerrormsg="1OK" totalpageserrormsgru="1Успешно"/> <item> <code>123456</code> <article>FD343</article> <barcode>2345625213125</barcode> <name>Sony KDL-55W905 ЖК-телевизор</name> <retprice>65000</retprice> <purchprice>50000</purchprice> <weight>5.1</weight> <length>50</length> <width>30</width> <height>40</height> <CountInPallet>30</CountInPallet> <HasSerials>1<order ordercode="234567" error="59" errormsg="value [date_put] is already set" errormsgru="Значение [Дата доставки] уже указано" /HasSerials> <CountryOfOrigin>Малайзия</CountryOfOrigin> (not yet supported) <Message>Хороший телевизор</Message> <Message2>Снова хороший телевизор</Message2> <quantity>12</quantity> <reserved>3</reserved> <item> ...</itemlistsetorderinfo>
</source>
<source lang="xml">
<?xml version="1.0" encoding="UTF-8" ?>
<itemmovementswaybill> <auth extra="8" login="login" pass="pass"/> <client>CLIENT</client> <orders> <order orderno="1234567" ordercode="33331" /> <order orderno="1234568" ordercode="33332" /> </orders> <form>1</authform> <start>5</start> <codeintegration>425921</codeintegration></itemmovementswaybill>
</source>
'''waybill''' — Корневой контейнер. Обязательный элемент
* '''auth''' — Авторизация. Обязательный элемент
* '''client''' — Признак клиента или агента. Необязательный элемент.
:* CLIENT — Признак клиента, значение по умолчанию
:* AGENT — Признак агента. В ответ отдается информация по заказам, переданным агенту на доставку
* '''orders''' — Список заказов для получения печатных форм. Содержит тэги '''order''' с атрибутами:
:* '''''orderno''''' — шифр заказа
:* '''''ordercode''''' — внутренний код заказа. Указывать необходимо один из атрибутов для всех заказов. Приоритет имеет атрибут '''''ordercode'''''
* '''form''' — Формат накладной. Не обязательный элемент. Принимает значения:
:* 1 — Подробная накладная (по-умолчанию)
:* 2 — Наклейки Zebra
:* 3 — Наклейки на страницу формата А4
:* 4 — Акты приема-передачи
* '''start''' — Имеет смысл только для form = 3. Начальная позиция первой наклейки. Используется для пропуска наклеек на листе для их экономии.
* '''integration''' - Получение наклеек от подрядчика. Не обязательный элемент, имеет смысл при наличии кода подрядчика в карточке заказа. Принимает значение:
:* 21 - подрядчик GTD
'''Пример ответа движения номенклатуры:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8" ?><itemmovements count="16"waybill> <itemmovement> <code>151500</integration code="21"> <date>2017-05-26</date> <retprice>0</retprice> <quantity>1</quantity> <delivered>0</delivered> <item> <code>4259</order code="33331"> <namecontent>Настольная игра ДженгаJVBERi0xLjYNJeLjz9MNC...</namecontent> </itemorder> <status> <code>5</order code="33332"> <namecontent>Возврат от покупателя</name> </status> <store> <code>1JVBERi0xLjYNJeLjz9MNC...</code> <name>офис в Москве</namecontent> </store> <order> <ordercode>3374830 </ordercodeintegration> <number>123660-0 </numbercontent>EODIcaI8KSBlwQ 4MnEOR7Px8U8EBAyGICBnwpw <date>2017-05-24< IZhQgz0ZxuPs8EBM/date>GcbjzB AwhBl8hwQYIO00GmEwg1CeEG <orderno>14123</orderno> mqYTChNU0wqf8l8nz4zgc+K fCno+zwU5GjOZmzXGcbEQYIM <barcode>0000000670</barcode> 4zkegRE40zWzONyoNNMIOIa cWnp6aDCGEGE9NQmoQd2mg00 <company>ТОВАР< 79U4f3hPTwnfp6Sdrafeqpa JDpFw/company>1aYT077VNNNdO00G3q <address>Кравченко ул., 1< mqqvp9p2E7T0/address> <delivereddate>2017-05-29wiFemv8uG6 OM</delivereddatecontent> <deliveredtime>12:00:00</deliveredtimewaybill> <deliveredto /source> </order> <document> <code>21991</code>В тэге content возвращаются бинарные данные (файл pdf), закодированные в base64. <number>318</number>При записи в файл необходимо использовать двоичный формат записи! <date>2017-05-26</date> <message></message> </document> </itemmovements></itemlist></source>Блок integration содержит отдельные наклейки для заказов, предоставленные подрядчиком, так же закодированные в base64.
<source lang="xml">
<?xml version="1.0" encoding="UTF-8" ?><pvzlistwaybill> <auth extra="8" login="login" pass="pass"error>Текст ошибки</auth> <code>1234</code> <town>Нижний Тагил</town> <parentcode>6</parentcode> <acceptcash>YES</acceptcash> <acceptcard>YES</acceptcard> <acceptfitting>YES</acceptfitting> <maxweight>30</maxweight> <acceptindividuals>YES</acceptindividuals> <lt>57.924737</lt> <lg>59.940019</lg> <rt>57.905682</rt> <rg>59.984669</rg> <json>YES</jsonerror></pvzlistwaybill>
</source>
<source lang="xml">
<?xml version="1.0" encoding="UTF-8" ?><pvzlist count="2"townlist> <pvz> <code>126</code> <clientcode>3</clientcode> <name>Нижний Тагил</name> <parentcode>6</parentcode> <parentname>Интеграция</parentname> <town codeauth extra="1242678">Нижний Тагил город</town> <address>622036, г. Нижний Тагил, ул. Циолковского, д. 17</addresscodesearch> <phonezipcode>+73435417709, +73435254989110000</phonezipcode> <commentkladrcode>Новый пункт доставки0100000100800</commentkladrcode> <worktimefiascode>Вс 10:00bd21979d-16:00, Сб 10:0046f8-16:00, Пн49d0-Пт 10:009105-20:00e8d65172a983</worktimefiascode> <traveldescriptioncode>Жилое 5-ти этажное здание, торцом к дороге, второе здание от перекрестка Пархоменко-Циолковского123</traveldescriptioncode> <maxweight>10 </maxweightcodesearch> <acceptcash>YES</acceptcashconditions> <acceptcardcity>YES</acceptcard> <acceptfitting>YESКраснодарский край</acceptfittingcity> <acceptindividualsnamecontains>YESновгород</acceptindividualsnamecontains> <latitudenamecontainsparts>57.93457молоково моск</latitudenamecontainsparts> <longitudenamestarts>59.95131Моск</longitude> </pvz> <pvz> <code>245</code> <clientcode>NTG1</clientcodenamestarts> <name>На КрасноармейскойМосква</name> <parentcodefullname>6Москва город</parentcodefullname> <parentnamecountry>Интеграция1</parentnamecountry> <town code="124267">Нижний Тагил город </townconditions> <address>КРАСНОАРМЕЙСКАЯ, д.79</address> <phone>+7(3435)379-044</phonelimit> <commentlimitfrom>Возможность примерки отсутствует30</commentlimitfrom> <worktimelimitcount>Вс 10:00-16:00, Сб 10:00-16:00, Пн-Пт 10:00-20:00</worktimelimitcount> <traveldescriptioncountall>Напротив ТЦ ПирамидаYES</traveldescriptioncountall> <maxweight>20 </maxweightlimit> <acceptcash>YES</acceptcashtownlist> <acceptcard>YES</acceptcardsource> <acceptfitting>NO</acceptfitting> <acceptindividuals>YES</acceptindividuals> <latitude>57Внутри контейнера townlist все элементы могут как отсутствовать, так и комбинироваться.93468</latitude> <longitude>60Поиск не чувствителен к регистру.55476</longitude> </pvz></pvzlist></source>* '''auth''' — Авторизация, необязательный элемент. Используется в случае включенного и настроенного ограничения по населенным пунктам в конкретной курьерской службе.
*'''codecodesearch''' - Код ПВЗ в системе — Поиск по кодам. Используется в запросе [[API#Оформление заказа|оформления заказов]]*'''clientcode''' - Код ПВЗ используемый компанией-подрядчикомВ случае использования — контейнеры conditions и limit игнорируются.:*'''namezipcode''' - Наименование ПВЗ — Поиск по индексу.*'''parentcode''' - Код родительского элементаОбратите внимание на то, что один почтовый индекс может распространяться на несколько населенных пунктов.*'''parentname''' - Наименование родительского элементаВ этом случае система вернет несколько записей.:*'''townkladrcode''' — Поиск по 13- Населенный пункт с кодом из [[#Справочник городов|справочника городов]]ти значному коду КЛАДР.:*'''addressfiascode''' - Адрес ПВЗ — Поиск по коду ФИАС (AOGUID).:*'''phonecode''' - Телефоны ПВЗ.*'''comment''' - Дополнительная информация.*'''worktime''' - Режим работы ПВЗ.*'''traveldescription''' - Описание местонахождения ПВЗ или пути к нему.*'''maxweight''' - Максимальный вес, с которым работает ПВЗ — Поиск по коду в системе.*'''acceptcash''' - Признак приема наличных*'''acceptcard''' - Признак приема банковских карт*'''acceptfitting''' - Наличие примерки*'''latitude''' - Широта*'''longitude''' - Долгота
* '''Пример запроса Видов срочностиlimit''' — Ограничивает вывод результата.:* '''limitfrom''' — Задает номер записи результата, начиная с которой выдавать ответ. По-умолчанию — 0.<source lang="xml"><?xml version="1:* '''limitcount'''- Задает количество записей результата, которые нужно вернуть.0" encoding="UTFПо-8" ?>умолчанию — 10000.<services><auth extra="8"/></services></source>:* '''countall''' — YES указывает на необходимость подсчета общего количества найденных совпадений. Это может замедлять выполнение запроса. Если отключено — в ответе не указываются totalcount и totalpages.
'''Пример ответа справочника Видов срочности:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8" ?><services townlist count="23" page="1" totalcount="3" totalpages="1"> <servicetown> <code>126379</code> <city> <code>23</code> <name>ЭкономКраснодарский край</name> </city> <name>Сочи город</name> <fiascode>79da737a-603b-4c19-9b54-9114c96fb912</fiascode> <kladrcode>2300000700000</kladrcode> <shortname /> (not yet supported) <typename /> (not yet supported) <coords lat="43.5855" lon="39.7231" /> </servicetown> <servicetown> <code>40331</code> <city> <code>232</code> <name>Брянская область</name> </city> <name>СрочноСочилов хутор</name> <fiascode>c9c96c67-2cc9-4f10-afde-fd32417ea216</servicefiascode> <kladrcode>3201900011100</serviceskladrcode> <shortname /source> <typename /> <coords lat="52.6407" lon= Расчет стоимости доставки "33.1724" /> </town> <town> <code>114016</code> <city> <code>60</code> <name>Псковская область</name> </city> <name>Сочихино деревня</name> <fiascode>10df7588-19c1-49d1-a387-9de1cf3eb26f</fiascode> <kladrcode>6001900015400</kladrcode> <shortname /> <typename /> <coords lat="56.6003" lon="29.3542" /> </town></townlist></source>
В ответе города сортируются по популярности, важности (районные центры и т. д.), и только затем — по алфавиту. == Справочник регионов =='''Пример запроса стоимости доставкисправочника:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8" ?><calculatorregionlist> <auth extra="8" login="login" pass="pass" codesearch> <code>77</code> <calc townfrom="Москва" /codesearch> addressfrom="Ленинский проспект, 95" <conditions> zipcode="664000" <namecontains>край</namecontains> townto="3800000300000" <namestarts>Моск</namestarts> addressto="Ленина ул., 10" <fullname>Московская область</fullname> l="10" <country>RU</country> w="20" h="30" mass="3.7" service="1" rur="1200" inshprice="1200" paytype="CASH" </conditions></calculatorregionlist>
</source>
<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<calculatorregionlist count="2"> <calccity> <townfrom code="1">Москва город80</townfromcode> <townto country> <code="56603">Иркутск город1</code> <name>Россия</name> <id>643</id> <ShortName1>RU</ShortName1> <ShortName2>RUS</towntoShortName2> <mass/country>3.7 <name>Агинский Бурятский автономный округ</name> </masscity> <city> <service name="Экспресс"code>1</servicecode> <zonecountry>2 <code>1</code> <name>Россия</zonename> <priceid>1163643</priceid> <mindeliverydaysShortName1>1RU</mindeliverydaysShortName1> <maxdeliverydaysShortName2>3RUS</maxdeliverydaysShortName2> <mindeliverydate/country>2020-05-13 <name>Адыгея республика</mindeliverydatename> </calccity></calculatorregionlist>
</source>
<source lang="xml">
<?xml version="1.0" encoding="UTF-8" ?><smaliststreetlist> <auth extra="8" login="login" pass="pass" conditions> <town>Москва город</town> //ОБЯЗАТЕЛЬНОЕ ПОЛЕ! <namecontains>Хохло</namecontains> <namestarts>Академика Х</namestarts> <name>Академика Хохлова</name> <fullname>Академика Хохлова ул.</fullname> <datefrom/conditions> <limit> <limitfrom>30</limitfrom> <limitcount>2016-02-10</datefromlimitcount> <countall>YES<dateto/countall>2016-03-10 </datetolimit></smaliststreetlist>
</source>
* '''conditions''' — Задает условия поиска. Все вложенные элементы одновременно накладывают условие «И».:* '''town''' — Обязательное поле. Название или код населенного пункта.:* '''smalistnamecontains''' - Корневой контейнер — Поиск улиц, название которых содержит указанный текст. Обязательный элемент:* '''namestarts''' — Поиск улиц, название которых начинается с указанного текста.:*'''authname''' - Авторизация — Поиск улиц, название которых соответствует указанному тексту.:* '''fullname''' — Поиск улиц, для которых название вместе с типом соответствует указанному тексту. Обязательный элемент * '''limit''' — Ограничивает вывод результата.:*'''datefromlimitfrom''' - Дата " — Задает номер записи результата, начиная с"которой выдавать ответ. Необязательный элементПо-умолчанию — 0.:*'''datetolimitcount''' - Дата "по"Задает количество записей результата, которые нужно вернуть. Необязательный элементПо-умолчанию — 10000.:* '''countall''' — YES указывает на необходимость подсчета общего количества найденных совпадений. Это может замедлять выполнение запроса. Если интервал дат отключено, в ответе не указан, то возвращаются акты передачи денег за последний месяцуказываются totalcount и totalpages.
'''Пример ответа на запрос списка актов передачи денег:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<smalist streetlist count="1" page="1" totalcount="3" totalpages="1"> <smastreet> <code>6278124</code> <numbername>3992</number> <actdate>2016-02-12</actdate> <datepay></datepay> <dateto>2016-02-12</dateto> <promiseddatepay></promiseddatepay> <price>637Академика Хохлова ул.00</pricename> <pricecorrshortname>113.00</pricecorr> <rur>13430.00</rur> <pricekur>570.00Академика Хохлова</pricekurshortname> <priceagtypename>67ул.00</priceag> <payno>42423</payno> <paytype>1</paytype> <paytypename>Безнал</paytypename> <signedcopyreceived>NO</signedcopyreceivedtypename> </smastreet></smaliststreetlist>
</source>
== Детализация актов передачи денег Справочник номенклатуры == '''Пример запроса детализации актов передачи денегсправочника номенклатуры:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8" ?>
<smadetailitemlist> <auth extra="8" login="login" pass="pass" ></auth> <codesearch> <code>123456</code> <article>FD343</article> <barcode>2345625213125</barcode> </codesearch> <conditions> <namecontains>телевизор</namecontains> <namestarts>sony</namestarts> <name>Sony KDL-55W905 ЖК-телевизор</name> <quantity>EXISTING_ONLY</quantity> <store>2</store> </conditions> <except> <code>6278123478</code> </except> <limit> <limitfrom>30</limitfrom> <limitcount>10</limitcount> <countall>YES</countall> </limit></smadetailitemlist>
</source>
Внутри контейнера itemlist все элементы могут как отсутствовать, так и комбинироваться. Поиск не чувствителен к регистру.* '''codesearch''' — Поиск по кодам. В случае использования — контейнеры conditions и limit игнорируются.:* '''code''' — Поиск по внутреннему коду системы.:* '''article''' — Поиск по артикулу.:* '''barcode''' — Поиск по штрихкоду. * '''conditions''' — Задает условия поиска. Все вложенные элементы одновременно накладывают условие «И».:* '''namecontains''' — Поиск товаров, название которых содержит указанный текст.:* '''namestarts''' — Поиск товаров, название которых начинается с указанного текста.:* '''name''' — Поиск товаров, название которых соответствует указанному тексту.:* '''smadetailquantity''' - Корневой контейнер — Наличие на складе. Принимает значения EXISTING_ONLY — Только в наличии, NOT_EXISTING_ONLY — Только не в наличии, ALL — Все. Обязательный элемент''Это поле может быть недоступным в некоторых установках.'':*'''authstore''' - Авторизация — Поиск товаров по определенному складу. Обязательный элемент * '''except''' — Описание исключений для корректного определения количества зарезервированной номенклатуры.:*'''code''' - — Код акта передачи денег (смзаказа. запрос списка АПД) * '''limit''' — Ограничивает вывод результата.:* '''limitfrom''' — Задает номер записи результата, начиная с которой выдавать ответ. Обязательный элемент:* '''limitcount''' — Задает количество записей результата, которые нужно вернуть.
'''Пример ответа на запрос детализации актов передачи денег:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<smadetail itemlist count="23" totalcount="3" page="1" totalpages="1"> <specialsmaitem> <code>42494123456</code> <ordercodearticle>14424FD343</ordercodearticle> <ordernobarcode>111112345625213125</ordernobarcode> <orderdatename>2018Sony KDL-0155W905 ЖК-01телевизор</orderdatename> <delivereddateretprice>2018-10-0165000</delivereddateretprice> <companypurchprice>Компания50000</companypurchprice> <priceweight>3145.001</priceweight> <rurlength>8800.0050</rurlength> <inshpricewidth>314.0030</inshpricewidth> <pricekurheight>270.0040</pricekurheight> <priceagVATrate>44.0020</priceagVATrate> <pricecalcCountInPallet>8486.0030</pricecalcCountInPallet> <paytypeCountInBox>2</paytypeCountInBox> <paytypenameHasSerials>наличными курьером1</paytypenameHasSerials> <statusCountryOfOrigin>ДоставленоМалайзия</statusCountryOfOrigin> (not yet supported) <Message>Хороший телевизор</Message> <Message2>Снова хороший телевизор</Message2> <quantity>12</quantity> <reserved>3</reserved> <item> ...</itemlist></source> '''Описание полей:'''* '''code''' — Внутренний идентификатор, присвоенный системой.* '''article''' — Артикул, назначенный клиентом (поставщиком).* '''barcode''' — Штрихкод производителя.* '''name''' — Наименование.* '''retprice''' — Розничная цена по-умолчанию. При оформлении заказа цена используется та, которая указана в заказе.* '''purchprice''' — Закупочная цена.* '''weight''' — Масса в килограммах.* '''length''' — Длина в сантиметрах.* '''width''' — Ширина в сантиметрах.* '''height''' — Высота в сантиметрах.* '''VATrate''' — Ставка НДС, целое число процентов.* '''CountInPallet''' — Количество штук в паллете.* '''CountInBox''' — Количество штук в упаковке.* '''HasSerials''' — Требует учета серийных номеров. Принимает значения 1 — да, 0 — нет.* '''CountryOfOrigin''' — Наименование страны происхождения на русском языке.* '''Message''' — Комментарий.* '''Message2''' — Дополнительный комментарий.* '''quantity''' — Количество на складе. Товары, уже собранные в заказы в этом количестве не присутствуют, считаются покинувшими товарный склад. ''Это поле может быть недоступным в некоторых установках.''* '''reserved''' — Количество зарезервированного товара. Может превышать остаток на складе, если покупатели ждут следующей поставки. ''Это поле может быть недоступным в некоторых установках.'' == Движение номенклатуры =='''Пример запроса движения номенклатуры:'''<source lang="xml"><?xml version="1.0" encoding="UTF-8" ?><itemmovements> <auth extra="8" login="login" pass="pass"></auth> <code>4259</code> <datefrom>2020-10-01</datefrom> <dateto>2020-10-02</specialsmadateto></smadetailitemmovements>
</source>
*'''code''' - Код записи — внутренний код товара в справочнике номенклатуры.*'''ordercodedatefrom''' - Код заказа — дата начала периода.*'''ordernodateto''' - Шифр заказа — дата окончания периода.*'''orderdate''' - Дата заказаМожет быть указан или код, или период, или код и период одновременно.* '''delivereddateПример ответа движения номенклатуры:''' - Дата доставки.*'''company''' - Получатель<source lang="xml"><?xml version="1.*'''price''' 0" encoding="UTF- Стоимость услуг.8" ?>*'''rur''' <itemmovements count="16"> <itemmovement> <code>151500</code> <date>2017- Сумма заказа.*'''inshprice''' 05- Стоимость заказа.26</date>*'''pricekur''' - Стоимость курьерской доставки. <retprice>0</retprice>*'''priceag''' - Агентское вознаграждение. <quantity>1</quantity>*'''pricecalc''' - Сумма для передачи агенту. <delivered>0</delivered> <item> <code>4259</code> <name>Настольная игра Дженга</name>*'''paytype''' - Тип оплаты: 1 - безнал, 2 - наличными курьером, 3 - наличными в офисе, 4 - перевод на карту. </item>*'''paytypename''' - Строковое представление типа оплаты <status>*'''status''' - Статус заказа. <code>5</code> <name>Возврат от покупателя</name> </status>== Генерация коротких ссылок == <store> <code>1</code>В некоторых случаях, например, при использовании <name>офис в СМС, может потребоваться использование коротких ссылок на ЛК.Москве</name>Для этого, необходимо отправить запрос с полной ссылкой, в ответ на который придёт хэш-код для ссылки. </store> <order>'''Пример запроса генерации коротких ссылок:''' <ordercode>3374830<source lang="xml"/ordercode> <?xml version="1.number>123660-0" encoding="UTF-8" ?</number> <shortlinkdate> 2017-05-24<link short="0"/date> <orderno> https:14123<//home.courierexe.ru/8/site/orders orderno> <barcode>0000000670</linkbarcode> <company>ТОВАР</shortlinkcompany> <address>Кравченко ул., 1</sourceaddress> '''shortlink''' <delivereddate>2017-05- Корневой контейнер. Обязательный элемент.29</delivereddate> <deliveredtime>12:00:00</deliveredtime>*'''link''' - Полная ссылка, для которой необходимо получить код. Обязательный элемент. Если атрибут '''short''' равен 1, то ответ не будет содержать XML, а только хэш-код. <deliveredto /> </order> <document> <code>21991</code> <number>318</number> <date>2017-05-26</date> <message></message> </document> <serials> <serial>123456789</serial> </serials> </itemmovements></itemlist></source> ''' Описание полей ответа '''* '''code''' — внутренний код операции движения* '''date''' — дата операции* '''retprice''' — цена товара* '''quantity''' — количество товара операции* '''delivered''' — количество доставленного товара * '''item''' — контейнер товара:* '''code''' — внутренний код товара'''Пример ответа на запрос генерации коротких ссылок:* '''name''' — наименование товара * '''status''' — контейнер статуса операции:* '''code''' — код статуса:* '''name''' — наименование * '''store''' — контейнер филиала, к которому относится операция:* '''code''' — код филиала:* '''name''' — наименование филиала * '''order''' — контейнер корреспонденции:* '''ordercode''' — внутренний код заказа:* '''number''' — номер заказа:* '''date''' — дата заказа:* '''orderno''' — шифр:* '''barcode''' — штрихкод:* '''company''' — компания:* '''address''' — адрес:* '''delivereddate''' — дата вручения:* '''deliveredtime''' — время вручения:* '''deliveredto''' — данные о вручении, либо причина недоставки * '''document''' — контейнер документа операции:* '''code''' — внутренний код документа:* '''number''' — номер документа:* '''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" ?><serialmovements count="16"> <serialmovement> <code>151500</code> <serial>123456789</serial> <date>2017-05-26</date> <delivered>0</delivered> <item> <code>4259</code> <name>Настольная игра Дженга</name> </item> <status> <code>5</code> <name>Возврат от покупателя</name> </status> <order> <ordercode>3374830</ordercode> <number>123660-0</number> <date>2017-05-24</date> <orderno>14123</orderno> <barcode>0000000670</barcode> <company>ТОВАР</company> <address>Кравченко ул., 1</address> <delivereddate>2017-05-29</delivereddate> <deliveredtime>12:00:00</deliveredtime> <deliveredto /> </order> <document> <code>21991</code> <number>318</number> <date>2017-05-26</date> <message></message> </document> </serialmovement></serialmovements></source> ''' Описание полей ответа ''' Описание аналогично описанию полей [[#Движение номенклатуры|движения номенклатуры]] == Серийные номера по заказу =='''Пример запроса движения серийных номеров заказа:'''<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> * '''ordercode''' — внутренний код заказа.* '''orderno''' — шифр заказа.* '''barcode''' — штрих-код заказа.Указывать необходимо один из идентификаторов заказа. '''Пример ответа движения серийных номеров заказа:'''<source lang="xml"><?xml version="1.0" encoding="UTF-8" ?><orderserials> <order> <code>3374830</code> <orderno>14123</orderno> <barcode>0000000670</barcode> <delivereddate>2024-07-20</delivereddate> <deliveredtime>10:04:00</deliveredtime> <assemblydate>2024-07-19 07:05:34</assemblydate> </order> <items> <item> <code>4259</code> <name>Настольная игра Дженга</name> <article>123000</article> <state>Delivered</state> <serials> <serial>123456789</serial> </serials> </item> </items></orderserials></source> ''' Описание полей ответа ''' * '''order''' — блок заказа::* '''code''' — код:* '''orderno''' — шифр:* '''barcode''' — штрих-код:* '''delivereddate''' — дата доставки факт:* '''deliveredtime''' — время доставки факт:* '''assemblydate''' — дата сборки * '''item''' — блок товара::* '''code''' — код:* '''name''' — наименование:* '''article''' — артикул:* '''state''' — статус Доставлено (Delivered) или Возвращено (Returned):* '''serials''' — блок серийных номеров по заказу == Получение справочника тарифов по городам == '''Пример запроса справочника тарифов по городам'''<source lang="xml"><?xml version="1.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="json">{ "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": 38.01 }, { "price": 15, "every": 1, "mass": 51.01 } ] }, "deliveryPeriodMin": 1, "deliveryPeriodMax": 2 } ]}</source> ''' Описание полей ответа '''* '''townfrom''' — код ФИАС города-отправителя.* '''service''' — режим доставки.* '''tariffs''' — cписок тарифов по городу.:* '''townregion''' — регион города-получателя.:* '''towntofias''' — код ФИАС города-получателя.:* '''towntocode''' — внутренний код города-получателя.:* '''towntoname''' — наименование города-получателя.:* '''distance''' — дистанция в км до города от МКАД, если в запросе townfrom — Москва.:* '''pricedistance''' — сумма за километраж до города от МКАД, если в запросе townfrom — Москва.:* '''pricesnew''' — ваши настройки тарифов из справочника '''Межгород''' > '''Тарифы по зонам'''.::* '''before/after''' — контейнеры ДО/ОТ.:::* '''price''' — цена. Если ответ идет по «before», то в цену также плюсуется сумма pricedistance:::* '''every''' — за каждые.:::* '''mass''' — масса.:* '''prices''' — устаревший элемент, не используется.:* '''deliveryPeriodMin''' — минимальный срок доставки.:* '''deliveryPeriodMax''' — максимальный срок доставки. == Номенклатура приходной накладной =='''Пример запроса номенклатуры приходной накладной:'''<source lang="xml"><?xml version="1.0" encoding="UTF-8" ?><itemdoc> <auth extra="8" login="login" pass="pass"></auth> <code>21991</code></itemdoc></source> * '''code''' — внутренний код документа приходной накладной (см. предыдущий запрос). '''Пример ответа движения номенклатуры:'''<source lang="xml"><?xml version="1.0" encoding="UTF-8" ?><itemdoc> <code>21991</code> <number>318</number> <date>2017-05-26</date> <message></message> <items> <item code="4259" quantity="1" barcode="200300" article="123555">Настольная игра Дженга</item> </items></itemdoc></source> ''' Описание полей ответа '''* '''code''' — внутренний код приходной накладной* '''number''' — номер документа* '''date''' — дата документа* '''message''' — комментарий * '''item''' — контейнер товара:* '''code''' — внутренний код товара:* '''barcode''' — штрихкод товара:* '''article''' — артикул товара:* '''quantity''' — количество поступившего товара == Справочник филиалов =='''Пример запроса списка филиалов:'''<source lang="xml"><?xml version="1.0" encoding="UTF-8" ?><storelist> <auth extra="8"></auth> <json>YES</json> <client_code>7890</client_code></storelist></source> * '''auth''' — Атрибут '''extra''' — обязателен, по нему определяется курьерская служба* '''json''' — Признак вывода ответа в виде JSON YES/NO* '''client_code''' — Код клиента курьерской службы '''Пример ответа:'''<source lang="xml"><?xml version="1.0" encoding="UTF-8" ?><storelist count="2"> <store> <code>123</code> <name>ABC</name> </store> <store> <code>456</code> <name>Филиал 2</name> </store></storelist></source> * '''code''' — Код филиала.* '''name''' — Наименование филиала. == Справочник пунктов самовывоза ==Для отображения списка пунктов выдачи (ПВЗ) есть '''готовый JavaScript модуль''': https://home.courierexe.ru/js/measoft_map.js Инструкция по использованию — внутри. Посмотреть пример работы можно [https://home.courierexe.ru/pvz_test.html Здесь] Уникальные запросы списка ПВЗ кешируются на стороне личного кабинета и хранятся до 7 часов утра по московскому времени следующего дня. Например, если уникальный запрос с массой 2 кг был отправлен сегодня в 10 часов, то завтра в 7 утра он сбросится. Если сегодня в 18 часов в этом же запросе вы укажете массу 2 кг, в ответе вернется тот же список ПВЗ. Если передадите массу 3 кг, список может быть другим. Обратите внимание, что если в выборке количество ПВЗ больше '''10000''' и не указаны параметры '''code''', '''json''' или '''limitcount''', то будет возвращаться ошибка. В этом случае необходимо использовать блок '''limit'''. '''Пример запроса пунктов самовывоза:'''<source lang="xml"><?xml version="1.0" encoding="UTF-8" ?><pvzlist> <auth extra="8" login="login" pass="pass"></auth> <code>1234</code> <client_code>7890</client_code> <city>Свердловская область</city> <town regioncode="66" country="RU">Нижний Тагил</town> <address>Щёлковское шоссе</address> <house>77</house> <advanced_search>Строка поиска</advanced_search> <parentcode>6</parentcode> <acceptcash>YES</acceptcash> <acceptcard>YES</acceptcard> <acceptfitting>YES</acceptfitting> <maxweight>30</maxweight> <acceptindividuals>YES</acceptindividuals> <respstores>YES</respstores> <lt>57.924737</lt> <lg>59.940019</lg> <rt>57.905682</rt> <rg>59.984669</rg> <json>YES</json> <with_coords>YES</with_coords> <limit> <limitfrom>30</limitfrom> <limitcount>2</limitcount> <countall>YES</countall> </limit></pvzlist></source> * '''auth''' — Атрибут '''extra''' — обязателен, по нему определяется курьерская служба, '''login''' и '''pass''' позволяют авторизоваться под клиентом: для отдельного клиента могут быть ограничения по доступности некоторых ПВЗ, и в этом случае они будут учтены.* '''code''' — Внутренний код, целое число.* '''client_code''' — Код клиента курьерской службы.* '''city''' — Регион получателя. Можно указать код региона или полное наименование региона из [[#Справочник регионов|справочника регионов]].* '''town''' — Город получателя.Для тега города '''town''' можно указать код региона в атрибуте '''''regioncode''''' из [[#Справочник регионов|справочника регионов]]. Поиск будет производиться в указанном регионе. Также можно указать страну получателя в атрибуте '''''country''''' в соответствии с [https://ru.wikipedia.org/wiki/ISO_3166-1 стандартом ISO_3166-1], например, «RU», «RUS» или «643» для России.Для формата запроса JSON фильтрация по городу работает только в связке с фильтром по адресу. * '''address''' — Фильтр по адресу, работает только в связке с фильтром по городу* '''house''' — Фильтр по номеру дома, работает только в связке с фильтрами по адресу и городу* '''advanced_search''' — Фильтр по коду агента, наименованию, телефону или комментарию* '''parentcode''' — Фильтр по родительскому [[#Справочник филиалов|филиалу]]* '''acceptcash''' — Фильтр по приему наличных YES/NO* '''acceptcard''' — Фильтр по приему банковских карт YES/NO* '''acceptfitting''' — Фильтр по наличию примерки YES/NO* '''maxweight''' — Фильтр по максимальному весу, с которым работает ПВЗ* '''acceptindividuals''' — Фильтр по доступности физическим лицам YES/NO* '''respstores''' - Признак вывода ответственных филиалов при значении YES* '''lt''' — Широта левого верхнего угла* '''lg''' — Долгота левого верхнего угла* '''rt''' — Широта правого нижнего угла* '''rg''' — Долгота правого нижнего угла* '''json''' — Признак вывода ответа в виде JSON YES/NO* '''with_coords''' — Признак вывода ПВЗ только с наличием координат YES/NO* '''limit''' — Ограничивает вывод результата.:* '''limitfrom''' — Задает номер записи результата, начиная с которой выдавать ответ. По-умолчанию — 0.:* '''limitcount'''- Задает количество записей результата, которые нужно вернуть. По-умолчанию — 100.:* '''countall''' — YES указывает на необходимость подсчета общего количества найденных совпадений. Это может замедлять выполнение запроса. Если отключено — в ответе не указываeтся totalcount. '''Пример ответа справочника пунктов самовывоза:'''<source lang="xml"><?xml version="1.0" encoding="UTF-8" ?><pvzlist count="2" totalcount="40465"> <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> <payType>2</payType> <lines count="1"> <line> <item>1111764</item> <name>Сапоги</name> <extcode>27113415</extcode> <qty>1</qty> <price>1000</price> <vatRate>20</vatRate> <governmentCode>Z16513LK2</governmentCode> <itemType>1</itemType> </line> </lines> </receipt></receipts></source> Параметры ответа:* '''orderno''' — Номер заказа* '''fdDatetime''' — Дата и время пробития фискального чека* '''fdValue''' — ФПД (фискальный признак документа)* '''fdNum''' — ФИСКАЛЬНЫЙ ДОКУМЕНТ (фискальный номер чека)* '''fnSn''' — ФН (номер фискального накопителя)* '''kktNum''' — РН (регистрационный номер кассы)* '''inn''' — ИНН* '''ofdUrl''' — URL адрес (доменное имя) ОФД* '''price''' — Сумма чека* '''paytype''' — Тип оплаты чека. Принимает значения::* CASH — Наличными (по-умолчанию):* CARD — Безналичным способом* '''fullUrl''' — URL чека для просмотра онлайн* '''lines''' — Позиции чека:* '''item''' — код товара:* '''name''' — наименование товара:* '''extcode''' — код товара во внешних системах:* '''qty''' — количество товара:* '''price''' — цена товара:* '''governmentCode''' — считанная последовательность, которая в дальнейшем преобразуется по алгоритму тега 1162:* '''vatRate''' — НДС товара:* '''itemType''' — тип товара (товар, доставка и т. д.) == Справочник Виды срочности =='''Пример запроса видов срочности:'''<source lang="xml"><?xml version="1.0" encoding="UTF-8" ?><services><auth extra="8"/></services></source> '''Пример ответа справочника видов срочности:'''<source lang="xml"><?xml version="1.0" encoding="UTF-8" ?><services count="2"> <service> <code>1</code> <name>Эконом</name> </service> <service> <code>2</code> <name>Срочно</name> </service></services></source> == Справочник дополнительных услуг =='''Пример запроса дополнительных услуг:'''<source lang="xml"><?xml version="1.0" encoding="UTF-8"?><advprices> <auth extra="8" login="login" pass="pass" /></advprices></source> '''advprices''' — Корневой контейнер. Обязательный элемент. '''Пример ответа справочника дополнительных услуг:'''<source lang="xml"><?xml version="1.0" encoding="UTF-8" ?><advprices> <advprice> <code>1</code> <name>Этажей в доме</name> <type>int</type> </advprice> <advprice> <code>2</code> <name>Коэффициент надбавки</name> <type>float</type> </advprice> <advprice> <code>3</code> <name>Расписаться на упаковке</name> <type>bool</type> </advprice></advprices></source> Параметры:* '''code''' — внутренний код услуги* '''name''' — наименование услуги. Если поле «название в ЛК» в настройках услуги не пусто, то возвращает значение поля «название в ЛК».* '''hine''' — подсказка по доп услуге для пользователя* '''type''' — тип услуги. Может иметь значения::* '''bool''' — для услуг вида «чекбокс», «Да»:* '''float''' — для числа с плавающей точкой:* '''int''' — для целого числа == Расчет стоимости доставки =='''Пример запроса стоимости доставки:'''<source lang="xml"><?xml version="1.0" encoding="UTF-8" ?><calculator> <auth extra="8" login="login" pass="pass" /> <order> <pricetype>CUSTOMER</pricetype> <sender> <town>Санкт-Петербург</town> <address>Петровка 38 офис 35</address> <coords lat="55.680327" lon="37.604456"></coords> </sender> <receiver> <zipcode>125480</zipcode> <town regioncode="78" country="RU">Санкт-Петербург</town> <address>Петровка 38 офис 35</address> <pvz>124</pvz> <coords lat="55.680327" lon="37.604456"></coords> </receiver> <weight>5.1</weight> <service>2</service> <paytype>CASH</paytype> <price>387.5</price> <deliveryprice>150</deliveryprice> <inshprice>387.5</inshprice> <packages> <package mass="1" quantity="5"></package> <package mass="2.5" length="10" width="20" height="30"></package> </packages> <userid>user123</userid> <groupid>customer</groupid> </order></calculator></source> Параметры:Структура данных и заполнение полей аналогичны и совместимы с [[#Оформление заказа]]. Дополнительные поля:* '''pricetype''' — тип требуемой цены. Возможные значения: «CUSTOMER» (по-умолчанию) — [[Личный кабинет клиента#Цена доставки для получателя|цена для конечного получателя]], «CLIENT» — цена курьерской службы для клиента.* '''userid''' — Идентификатор пользователя, строковый или числовой тип. Виртуальное поле. Необязательное. Данное поле используется совместно с настройками «Цена доставки для получателя», определяя приоритет правила. Можно использовать в различных CMS/CRM системах, настраивая цены для определенного покупателя.* '''groupid''' — Идентификатор группы пользователя, строковый или числовой тип. Виртуальное поле. Необязательное. Данное поле используется совместно с настройками «Цена доставки для получателя», определяя приоритет правила. Можно использовать в различных CMS/CRM системах, настраивая цены для определенной группы покупателей. Суммы НП и ОЦ, а также тип оплаты CARD имеют значение при настроенных в тарифе на вкладке Прочее долях (в процентах) от данных сумм. В авторизации можно опустить параметры login и pass, тогда расчет будет производиться по стандартному тарифу курьерской службы, без учета возможных отличий для конкретного клиента.<br>Объемный вес будет учитываться только при условии указания всех габаритов: длины, ширины и высоты.<br>В полях город-отправитель и город-получатель можно указывать название города (не рекомендуется!), либо код города из нашего справочника, либо 13-ти значный код КЛАДР, либо 36-ти значный код адресной системы ФИАС (AOID). '''Пример ответа стоимости доставки:'''<source lang="xml"><?xml version="1.0" encoding="UTF-8"?><calculator> <calc> <townfrom code="1">Москва город</townfrom> <townto code="56603">Иркутск город</townto> <mass>3.7</mass> <service name="Экспресс">1</service> <zone>2</zone> <price>1113</price> <mindeliverydays>1</mindeliverydays> <maxdeliverydays>3</maxdeliverydays> <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 — безнал, 2 — наличными курьером, 3 — наличными в офисе, 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> <hashresult error="Текст ошибки">35AF350CERROR</hashresult></shortlinkmanifest>
</source>
