274
правки
Изменения
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 Инструкция в том числе!)архиве
|-
|[[Файл: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/opencart_2measoft_oc2.3.ocmod.zip Скачатьдля версии 2.3]<br><br>[httphttps://courierexe.ru/download/api/opencart_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]]
|style="text-align: center;"|[https://www.amocrm.ru/extensions/courier2008 Установить]
|Внимание! Модуль новый, поэтому возможна некорректная передача данныхПодробнее см. [[amoCRM|описание]]. Проверяйте, если что - сообщайте, исправим!
|-
|rowspan="2"|[[Файл:MoySclad.jpg|center|x44pxx30px]]|style="height:50px; text-align: center;"|[https://home.courierexe.ru/moysklad/step1 Настроить интеграцию с MeaSoft]|[[МойСклад|Инструкция]]|-|style="height:50px; text-align: center;"|[https://home.courierexeitmdev.ru/moyskladms/shipping/step1 ПодключениеСкачать модуль сторонних разработчиков] [[|Интеграция МойСклад с другими системами#Мой Склад|Инструкция]]|Ожидается в ближайшее время в магазине Мой Складкурьерскими службами от сторонних разработчиков
|-
|[[Файл: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|на этой странице]]|Передача информации о статусах и заказах в вашу систему
|-
|}
'''Обратите внимание!''' В модулях систем PrestaShop и Joomla для отправки заказа в курьерскую службу зайдите в карточку заказа. В карточке отображается специальная форма отправки заказа, а если заказ отправлен, она позволяет проверить его статус:[[Файл:Form.png|150 400 px|мини|Форма отправки заказа|none]]
На вкладке '''Интеграция''' > '''Отладка''' вы можете пробовать выполнять запросы к API для отладки, а также видеть историю отправленных запросов. Созданные заказы появятся в пункте основного меню '''Отслеживание'''.
Для отображения списка пунктов выдачи есть '''готовый JavaScript модуль''': упрощения интеграции можно скачать [https://home.courierexe.ru/jsdownload/api/measoft_mapphp_sample.js Инструкция по использованию - внутриzip пример обращения к сервису на PHP].
<source lang=xml><auth extra= Тестовый аккаунт "8" login="login" pass="pass"></auth></source>
== Рабочий аккаунт для подключения Авторизация курьерской службы ==Если курьерской службе требуется подключение под своими учетным данными, используйте строку вида:
Вы можете узнать код экстра, логин и пароль курьерской службы в офисном приложении MeaSoft в справочнике '''Дополнительные возможности'''. Подробнее см. раздел «[[Файл:extra1.pngЛичный кабинет курьерской службы#Подключение|750pxПодключение]]».
Наше 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>
<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>
<overall_volume>81</overall_volume>
<userid>user123</userid>
<groupid>customer</groupid>
</order>
</neworder>
=== Описание элементов для оформления заказа ===
'''Обязательные поля'''
Обязательными на уровне системы являются только 3 поля: receiver->company или receiver->person, receiver->address и receiver->phone. Так же в настройках системы сама курьерская служба может назначить какие-то дополнительные поля обязательными, тогда, если вы их не укажете, получите сообщение об ошибке.
<spoiler text="Пример минимально возможного заказа">
<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<neworder>
<auth extra="8" login="login" pass="pass" />
<order>
<receiver>
<company>МВД</company>
<phone>(495)123-45-67</phone>
<address>Петровка, 38</address>
</receiver>
</order>
</neworder>
</source>
</spoiler>
'''Описание полей'''
* '''neworder''' — Корневой контейнер, обязательный элемент.
:*'''neworder''newfolder' - Корневой контейнер'''' — Признак нового заказа YES/NO. Если стоит YES, обязательный то в системе курьерской службы для данной корреспонденции создастся новый заказ. Необязательный элемент.
:*'''order''orderno' - Контейнер для описания одного заказа, обязательный элемент. В одном контейнере '''neworder''' может быть много контейнеров '''order''' — Номер заказа. Если присваивается клиентом — указывается здесь. Если не присваивается — можно оставить пустым, система сгенерирует свой номер, и вернет его в ответе. Система проверяет наличие заказов с указанным номером в пределах текущего календарного года, и в случае их существования — заказ создан не будет, а в ответе вернется ошибка 17 «Such number exists». Если не указан штрихкод (поле barcode), и значение поля подходит для создания нескольких заказов одним запросомиспользования его в качестве штрихкода, данное значение будет скопировано в поле «Штрихкод». Это накладывает ограничения в частности, на длину указанного поля (25 знаков, чтобы работали стандартные печатные формы).
# Если шифр и ШК пустые - оба поля заполняются автоматически значением вида 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>
<person>Контактное лицо отправителя</person>
<phone>Телефон, Email отправителя</phone>
</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 — Наличными при получении (по-умолчанию):* CARD — Картой при получении:* NO — Без оплаты. Этот тип оплаты передается, если заказ уже оплачен и не требует инкассации. API добавит к товарам строку предоплаты в сумму заказа, чтобы общая сумма была 0, однако в кассовом чеке будут все товары с ценами, и оплата предоплатой, как того требует 54-ФЗ.:* OTHER — Прочее (Предусмотрен для того, чтобы оплата поступала непосредственно в курьерскую службу посредством прочих типов оплаты — таких как: вебмани, яденьги, картой на сайте, прочие платежные системы и т. д.):* OPTION — На выбор получателя. Этот тип оплаты нельзя передавать с заказом. Он выставляется автоматически в зависимости от настройки клиента.* '''weight''' — Общий вес заказа в килограммах.* '''quantity''' — Количество мест.* '''service''' — Режим доставки (тип услуги) передается код из справочника «[[#Справочник Видов срочности|Виды срочности]]».* '''type''' — Тип корреспонденции (отправления) передается код из справочника «Типы корреспонденции».* '''return''' — Признак необходимости возврата. Принимает значения::* NO — Возврат не требуется:* YES — Требуется возврат, например, документов:* ONLY — Требуется забрать отправление у поставщика (см. раздел «[[Личный_кабинет_клиента#Привезти ко мне|Привезти ко мне]]»). * '''return_service''' — Режим возврата (тип услуги) передается код из справочника «Виды срочности».* '''return_type''' — Тип возвратной корреспонденции (отправления) передается код из справочника «Типы корреспонденции».* '''return_weight''' — Общий вес возврата заказа в килограммах.* '''enclosure''' — Вложение.* '''instruction''' — Поручение — Примечание.* '''courier''' — Запланированный курьер. Согласно коду курьера в КС2008.* '''receiverpays''' — Признак оплаты стоимости доставки — услуг службы доставки получателем, а не заказчиком YES/NO.* '''department''' — Подразделение, в котором оформляется заказ.* '''costcode''' — Кост-код сотрудника.* '''respstore''' — Код ответственного филиала. Для ответственного филиала в который передается заказ, требуется включение параметра "Разрешить клиенту передавать заказы в этот филиал"* '''pickup''' — Признак оформления забора YES/NO. Если стоит YES, то весь заказ считается заданием на забор груза, а не на доставку! Применяется для вызова курьера к отправителю для забора других отправлений. ''Внимание!'' при добавлении в забор складских товаров, их тип '''''type''''' всегда должен быть установлен как [7] Забор товара, если будет указан другой тип, то он будет исправлен в момент добавления заказа на [7] Забор товара* '''acceptpartially''' — Признак возможности частичного выкупа товаров отправления YES/NO.* '''uid''' - Универсальный идентификатор заказа на стороне отправителя. Не обязательный параметр, ограниченного по времени действия. Время хранения в системе, - сутки. * '''items''' — Контейнер для описания вложений. <rspoiler text="Необязательный контейнер">Если для поставщика товара в системе MeaSoft не указаны полное наименование компании и ИНН в карточке клиента, заполните параметры <code>suppcompany</code> и <code>suppINN</code> в этом контейнере. Отсутствие информации о поставщике приведет к [[Настройка модуля печати кассовых чеков#Ошибка фискализации (ошибка программирования реквизита 1226)|ошибке фискализации]].</rspoiler>. Атрибуты::* '''''item''''' — Название вложения.:* '''''quantity''''' — Количество единиц товара.:* '''''mass''''' — Масса единицы товара в килограммах.:* '''''volume''''' — Объемный вес единицы товара в килограммах. При указании объемного веса значение подставляется вместо массы:* '''''length''''' — Длина единицы товара (в сантиметрах).:* '''''width''''' — Ширина единицы товара (в сантиметрах).:* '''''height''''' — Высота единицы товара (в сантиметрах).:* '''''retprice''''' — Цена единицы товара. Округляется до копеек. Должна быть с учетом всех скидок и наценок. Для вложений типов 1, 2, 3 не может быть отрицательной. <!-- , либо мы сами посчитаем скидку при указании тега order->discount -->:* '''''inshprice''''' — Объявленная ценность единицы товара. Округляется до копеек. Если не указана принимается равной '''''retprice'''''.:* '''''VATrate''''' — Ставка НДС — целое число процентов. Если товар хранится в КС (смотрите '''article''' ниже), значение берется из номенклатуры. Иначе, если значение указано, берется указанное значение, если нет - значение из настроек фирмы КС. Значение «0» означает ставку «Без НДС», ставка «0%» на данный момент не поддерживается.:* '''''barcode''''' — Штрихкод вложения.:* '''''article''''' — Артикул вложения. ''Внимание!'' Указание артикула используется только тогда, когда товар хранится на ответственном хранении в службе доставки, и необходима комплектация. В этом случае система пытается привязать товар к [[API#Справочник номенклатуры|справочнику номенклатуры]]. Если товар в справочнике не найден — система выдаст соответствующую ошибку. Если по артикулу найдено несколько товаров — система выберет один из них случайным образом, что может привести к ошибочной комплектации! Если товар НЕ на ответственном хранении — артикул указывать НЕ нужно. Позиция попадет в систему просто текстом.:* '''''itemcode''''' — Внутренний код товара, может использоваться вместо артикула. ''Внимание!'' Указание кода товара используется только тогда, когда товар хранится на ответственном хранении в службе доставки, и необходима комплектация. В этом случае система пытается привязать товар к [[API#Справочник номенклатуры|справочнику номенклатуры]]. Если товар в справочнике не найден — система выдаст соответствующую ошибку. Если товар НЕ на ответственном хранении — код товара указывать НЕ нужно.:* '''''type''''' — Тип вложения. Принимает значения::: 1 — Товар. По-умолчанию.:: 2 — Доставка. Такое вложение добавится автоматически, если заполнить order->deliveryprice:: 3 — Услуга:: 4 — Предоплата. Указывается сумма. Поле quantity игнорируется, всегда «1». В заказе сумма будет отрицательной независимо от знака в запросе. Такое вложение добавится автоматически при указании order->paytype=NO.:: 6 — Оплата кредитом. Указывается сумма. Поле quantity игнорируется, всегда «1». В заказе сумма будет отрицательной независимо от знака в запросе.:: 7 — Забор товара. Если товар нужно у получателя забрать, возможно — вернуть деньги, или его стоимость вычтется из суммы других товаров. У такого товара в заказе будет отрицательное количество независимо от знака в запросе.:* '''''extcode''''' — Внешний код строки. Используется для идентификации строк заказов при получении статусов. Необязательное поле.:* '''''origincountry''''' — Код страны-производителя в соответствии со [https://ru.wikipedia.org/wiki/ISO_3166-1 стандартом ISO_3166-1], например, «RU», «RUS» или «643» для России.:* '''''GTD''''' — Номер ГТД.:* '''''excise''''' — Сумма акциза.:* '''''suppcompany''''' — Наименование компании поставщика, если отличается от заказчика.:* '''''suppphone''''' — Номер телефона компании поставщика, если отличается от заказчика.:* '''''suppINN''''' — ИНН компании поставщика, если отличается от заказчика.:* '''''governmentCode''''' — Код товарной номенклатуры. Используется для [[Маркировка|маркированных товаров, например («Честный знак»)]]. Для кода '''Честный знак''' Нужно указывать все данные из нанесенного QR-кода кроме не читаемых символов (#29). Если код не известен — укажите знак вопроса «?», тогда курьер отсканирует код фактически передаваемого покупателю товара. Для некоторых процессов может использоваться значение «!» — в этом случае курьер сканирует серийный номер товара, но это не считается кодом маркировки. При этом, если указано значение «?» или «!» и quantity больше 1, то такое вложение растиражируется quantity раз.:* '''''govType''''' — Тип маркировки товара. В данный момент существуют следующие типы маркировки::: 1 — Честный знак. По-умолчанию.:: 2 — ГИИС ДМДК.:: 3 — Серийный номер. :* '''''extraTags''''' — Строка в формате JSON для отправки в ОФД. :: Тэг 1265 - значение отраслевого реквизита = код места деятельности аптеки :: Тэг 1262 – идентификатор ФОИВ = "020" (константа ФОИВ МИНЗДРАВа) :: Тэг 1263 - дата нормативного акта федерального органа исполнительной власти = "14.12.2018" (константа) :: Тэг 1264 - номер нормативного акта федерального органа исполнительной власти = "1556"(константа) :: Тэг 1212 - Признак предмета расчета :: Пример:
<source lang="json">"item_industry_props":{"tag1262":"020","tag1263":"14.12.2018","tag1264":"1556","tag1265":"tm=mdlp&sid=00000000XXXXXX"},"tag1212": "1"</source> *'''paytypepackages''' - Тип оплаты заказа получателем — Контейнер для описания мест. Необязательный контейнер. Принимает значенияАтрибуты::* CASH - Наличными при получении (по-умолчанию)'''''package''''' — Название места.:* CARD - Картой при получении'''''code''''' — Внутренний код строки.:* NO - Без оплаты'''''strbarcode''''' — Штрихкод места.:* '''''mass''''' — Масса места в килограммах. Этот тип оплаты передается, если заказ уже оплачен и не требует инкассации:* '''''message''''' — Строка сообщения. API добавит к товарам строку предоплаты :* '''''length''''' — Длина товарного места (в сумму заказа, чтобы общая сумма была 0, однако сантиметрах).:* '''''width''''' — Ширина товарного места (в кассовом чеке будут все товары с ценами, и оплата предоплатой, как того требует 54-ФЗсантиметрах).:* OTHER - Прочее '''''height''''' — Высота товарного места (Предусмотрен для того, чтобы оплата поступала непосредственно в курьерскую службу посредством прочих типов оплаты - таких каксантиметрах).: вебмани, яденьги, картой * '''''quantity''''' — Количество мест с данным набором параметров. Действует ограничение на сайте, прочие платежные системы и тобщее количество мест в заказе. Общее количество мест в заказе не может быть больше 1000.д * '''deliveryset''' — настройка [[Дифференцированная стоимость доставки|дифференцированной стоимости доставки]].Атрибуты::* '''''above_price''''' — стоимость в случае полного выкупа заказа (действует как «сумма от» последней границы, указанной в теге below_sum):* OPTION - На выбор получателя. Этот тип оплаты нельзя передавать с заказом. Он выставляется автоматически '''''return_price''''' — стоимость в зависимости от настройки клиентаслучае возврата заказа:* '''''VATrate''''' — Ставка НДС — целое число процентов. * '''below''' — граница стоимости настроек:* '''''below_sum''''' — граница стоимости выкупаемого заказа:* '''''price''''' — стоимость выкупаемого заказа до соответствующей границы
*'''zipcodeadvprices''' - Почтовый индекс — Контейнер для описания дополнительных услуг.*'''weight''' - Общий вес заказа в килограммахНеобязательный элемент.*'''return_weight''' - Общий вес возврата заказа <span style="color: red;>Для обработки в килограммах.*'''quantity''' - Количество мест.*'''service''' - Режим доставки (тип API включите дополнительные услуги) передается код из справочника в настройках полей [[Личный кабинет курьерской службы#Справочник Видов срочностиНастройка личного кабинета клиента|"Виды срочности"заказов и заборов]].</span>:*'''return_service''' - Режим возврата (тип услуги) передается код из справочника "Виды срочности".*'code''type''' - Тип корреспонденции (отправления) передается — код из справочника "Типы корреспонденции"услуги.:*'''return_type''' - Тип возвратной корреспонденции (отправления) передается код из справочника "Типы корреспонденции".*'value''price''' - Сумма заказа. В случае наличия контейнера items — значение данного параметра будет проигнорировано, и рассчитано автоматическиуслуги.*'''deliveryprice''' - Сумма доставки. В случае наличия контейнера items, в него будет добавлено вложение "Доставка".*'''return''' - Признак необходимости возврата.*'''return_service''' - Режим возврата (Если тип услуги) передается код из справочника "Виды срочности".*'''enclosure''' - Вложение.*'''inshprice''' - Объявленная ценность.*'''instruction''' - Поручение - Примечание.*'''courier''' - Запланированный курьер. Согласно коду курьера в КС2008.*'''receiverpays''' - Признак оплаты стоимости доставки - услуг службы доставки получателем, а не заказчиком YES/NO.*'''department''' - Подразделениеbool, то в котором оформляется заказ.*'''pickup''' - Признак оформления забора YES/NO. Если стоит YES, то весь заказ считается заданием на забор груза, а не на доставку! Применяется для вызова курьера к отправителю для забора других отправлений.*'''acceptpartially''' - Признак возможности частичного выкупа товаров отправления YES/NOзначении передаем true.
*'''itemsoverall_volume''' - Контейнер для описания вложений. Необязательный контейнер. Атрибуты::* '''''item''''' - Название вложения.:* '''''quantity''''' - Количество единиц товара.:* '''''mass''''' - Масса единицы товара в килограммах.:* '''''volume''''' - Объемный вес единицы товара в килограммах. При указании объемного веса значение подставляется вместо массы:* '''''length''''' - Длина единицы товара (в сантиметрах).:* '''''width''''' - Ширина единицы товара (в сантиметрах).:* '''''height''''' - Высота единицы товара (в сантиметрах).:* '''''retprice''''' - Цена единицы товара. Округляется до копеек. Должна быть с учетом всех скидок и наценок. Для вложений типов 1 — Общий объем, 2, 3 не может быть отрицательнойм3. <!-- , либо мы сами посчитаем скидку при указании тега order->discount -->:* '''''VATrate''''' - Ставка НДС - целое число процентовВиртуальное поле. Если значение не указано, подставляется значение "20"Необязательное.:* '''''barcode''''' - Штрих-код вложенияИз этого поля рассчитывается длина/высота/ширина места. [[Файл:Article.png|thumb|100px|right]]:* '''''article''''' - Артикул вложения. ''Внимание!'' Указание артикула используется Расчет срабатывает только тогда, когда товар хранится на ответственном хранении если в службе доставки, и необходима комплектация. В этом случае система пытается привязать товар к [[API#Справочник номенклатуры|справочнику номенклатуры]]. Если товар в справочнике не найден - система выдаст соответствующую ошибку. Если по артикулу найдено несколько товаров - система выберет один из них случайным образом, что может привести к ошибочной комплектации! Если товар НЕ на ответственном хранении - артикул указывать НЕ нужно. Позиция попадет в систему просто текстом.:* '''''type''''' - Тип вложения. Принимает каждом месте есть нулевые значения::: 1 - Товар. По-умолчанию.:: 2 - Доставка. Такое вложение добавится автоматически, если заполнить order->deliveryprice:: 3 - Услуга:: 4 - Предоплата. Указывается сумма. Поле quantity игнорируется, всегда "1". В заказе сумма будет отрицательной независимо от знака в запросе. Такое вложение добавится автоматически при указании order->paytype=NO.:: 6 - Оплата кредитом. Указывается сумма. Поле quantity игнорируется, всегда "1". В заказе сумма будет отрицательной независимо от знака в запросе.:: 7 - Забор товара. Если товар нужно у получателя забрать, возможно - вернуть деньги, длины или его стоимость вычтется из суммы других товаров. У такого товара в заказе будет отрицательное количество независимо от знака в запросе.:* '''''extcode''''' - Внешний код строки. Используется для идентификации строк заказов при получении статусов. Необязательное поле.:* '''''origincountry''''' - Код страны-производителя в соответствии со [https://ru.wikipedia.org/wiki/ISO_3166-1 стандартом ISO_3166-1], например, "RU", "RUS" высоты или "643" для России.:* '''''GTD''''' - Номер ГТД.:* '''''excise''''' - Сумма акциза.:* '''''suppcompany''''' - Наименование компании поставщика, если отличается от заказчика.:* '''''suppphone''''' - Номер телефона компании поставщика, если отличается от заказчика.:* '''''suppINN''''' - ИНН компании поставщика, если отличается от заказчика.:* '''''governmentCode''''' - Код товарной номенклатуры. Используется для [[Маркировка | маркированных товаров ("Честный знак")]]. Нужно указывать полностью все данные из нанесенного QR-кода. Если поле заполнено - поле quantity должно содержать только "1", иначе вернется ошибкаширины.
*'''packagesuserid''' - Контейнер для описания мест — Идентификатор пользователя, строковый или числовой тип. Необязательный контейнерВиртуальное поле. Атрибуты::* '''''package''''' - Название местаНеобязательное.:* '''''code''''' - Внутренний код строки.:* '''''strbarcode''''' - Штрих-код местаДанное поле используется совместно с настройками «Цена доставки для получателя», определяя приоритет правила.:* '''''mass''''' - Масса места Можно использовать в килограммах.:* '''''message''''' - Строка сообщения.:* '''''length''''' - Длина единицы товара (в сантиметрах).:* '''''width''''' - Ширина единицы товара (в сантиметрах).:* '''''height''''' - Высота единицы товара (в сантиметрах)различных CMS/CRM системах, настраивая цены для определенного покупателя.
* '''deliverysetgroupid''' - настройка [[Дифференциальная стоимость — Идентификатор группы пользователя, строковый или числовой тип. Виртуальное поле. Необязательное. Данное поле используется совместно с настройками «Цена доставки | дифференциальной стоимости доставки]]для получателя», определяя приоритет правила. Атрибуты::* '''''above_price''''' - стоимость Можно использовать в случае полного выкупа заказа (действует как "сумма от" последней границыразличных CMS/CRM системах, указанной в теге below_sum):* '''''return_price''''' - стоимость в случае возврата заказанастраивая цены для определенной группы покупателей.
В случае необходимости указания, помимо товаров, дополнительных услуг (например, ДОСТАВКА, комплектация, подъем на этаж и ти т.д д.) - — их нужно указать в том же контейнере items как товары, без артикула.
=== Примеры ответов ===
При успешном выполнении запроса, создании заказа, возвращается сумма заказа в атрибуте orderprice, а также ошибка 0. При не успешном — номер ошибки и текст ее на английском языке в атрибуте errormsg, для некоторых ошибок выводится перевод на русский в атрибуте errormsgru.
В атрибут orderno помещается номер заказа, в атрибут barcode — штрихкод заказа.
'''Пример успешного ответа'''
<?xml version="1.0" encoding="UTF-8"?>
<neworder>
<createorder orderno="AB23541" barcode="67567#114" error="0" errormsg="successSuccess" errormsgru="Успешно" orderprice="5000"></createorder> <createorder orderno="55_6542AB23542" barcode="67567#115" error="0" errormsg="successSuccess" errormsgru="Успешно" orderprice="6000"></createorder> <createorder orderno="AB23542AB23543" barcode="67567#116" error="0" errormsg="successSuccess" errormsgru="Успешно" orderprice="0"></createorder>
</neworder>
</source>
<?xml version="1.0" encoding="UTF-8"?>
<neworder>
<createorder orderno="AB23541" barcode="67567#114" error="1767" errormsg="Such number Order barcode already existsin the database." errormsgru="Такой штрихкод заказа уже есть в базе."></createorder> <createorder orderno="AB23542" barcode="67567#115" error="1317" errormsg="empty companyOrder number already exists in the database." errormsgru="Такой номер заказа уже есть в базе."></createorder> <createorder orderno="AB23543" barcode="67567#116" error="1467" errormsg="empty personOrder barcode already exists in the database." errormsgru="Такой штрихкод заказа уже есть в базе."></createorder>
</neworder>
</source>
</source>
=== Коды и описание ошибок при оформлении заказа ==={|class=wikitable!Код ошибки!Английское описание!Русское описание|-|0 ||Success||Успешно|- Ошибок нет. |1 - Ошибка авторизации. (отсутствуют теги <auth login="" pass=""></auth>, неверный логин или пароль)||Wrong XML||Некорректный файл XML.|-|2 ||Lat is empty||Укажите широту.|- Отправлен пустой запрос (отсутствует контейнер <neworder></neworder> в XML документе). |3 - Некорректно указана сумма заказа||Specify a valid «Price» field value.||Укажите корректное значение поля «Сумма».|-|4 - Некорректный общий вес заказа||Specify a valid «Weight» field value.||Укажите корректное значение поля «Вес».|-|5 - Не ||Recepient city/town not found.||Город назначения не найден город получатель.|-|6 - Не найден город отправитель||Sender city/town not found.||Город отправления не найден.|-|7 - Не заполнен адрес получателя||Specify the «Recipient address» field value.||Укажите значение поля «Адрес получателя».|-|8 - Не заполнен телефон получателя||Specify the «Recipient phone» field value. 9 - Не заполнено контактное имя получателя||Укажите значение поля «Телефон получателя».|-10 - Не заполнено название компании получателя|9||Specify the «Recipient name» field value.||Укажите значение поля «ФИО получателя». 11 |- Некорректная сумма объявленной ценности. 12 - Артикул не найден|10||Specify a valid «Quantity» field value.||Укажите корректное значение поля «Количество».|-13 - Не заполнено название компании отправителя|11||Specify a valid «Declared value» field value.||Укажите корректное значение поля «Объявленная ценность». 14 |- Не заполнено контактное имя отправителя. 15 - Не заполнен телефон отправителя|12||Supplier SKU ID not found.||Артикул не найден. 16 |- Не заполнен адрес отправителя. |17 - Заказ с таким номером ||Order number already exists in the database.||Такой номер заказа уже существуетесть в базе.|-== Запрос статуса заказов ==|18||Order code already exists in the database.||Такой код заказа уже есть в базе.|-|19||The delivery date format is not valid. Specify a date in YYYY-MM-DD format.||Укажите значение поля «Дата доставки» в формате гггг-мм-дд.=== Пример запроса статуса заказа === <source lang="xml">|-<?xml version="1|20||Specify a valid «Delivery mode» field value.||Укажите корректное значение поля «Режим доставки».0" encoding="UTF|-8" ?><statusreq> <auth extra="8" login="login" pass="pass"></auth>|21||Specify a valid «Return trip mode» field value.||Укажите корректное значение поля «Режим возврата». <client>CLIENT</client>|- <orderno>1234</orderno>|22||Specify a valid «Delivery type» field value.||Укажите корректное значение поля «Тип доставки». <orderno2>5678</orderno2>|- <ordercode>34234</ordercode>|23||Specify a valid «Return shipment type» field value.||Укажите корректное значение поля «Тип возврата». <givencode>234534</givencode> <datefrom>2016-07|-21</datefrom> <dateto>2016-07-21</dateto>|30||Specify the «Order number» field value.||Укажите значение поля «Номер заказа». <target>Автозавод</target>|- <done>ONLY_NOT_DONE</done>|31||Specify the «Barcode» field value.||Укажите значение поля «Штрихкод». <changes>ONLY_LAST</changes></statusreq></source>|-|32||Specify the «Sender company» field value.||Укажите значение поля «Компания-отправитель».=== Описание полей запроса статуса ===|- '''statusreq''' - Корневой контейнер. Обязательный элемент|33||Specify the «Sender name» field value.||Укажите значение поля «ФИО отправителя».*'''auth''' |- Авторизация|34||Specify the «Sender phone» field value. Обязательный элемент||Укажите значение поля «Телефон отправителя».*'''client''' |- Признак клиента или агента|35||Specify the «Sender city/town» field value. Необязательный элемент||Укажите значение поля «Город отправителя».:* CLIENT |- Признак клиента, |36||Specify the «Sender address» field value.||Укажите значение по умолчаниюполя «Адрес отправителя».:* AGENT |- Признак агента|37||Specify the «Pickup date» field value.||Укажите значение поля «Дата забора». В ответ отдается информация по заказам, переданным агенту на доставку*'''orderno''' |- Номер заказа|38||Specify the «Pickup time from» field value. Необязательный элемент||Укажите значение поля «Время забора с».*'''ordercode''' - Внутренний код заказа|-|39||Specify the «Pickup time to» field value. Необязательный элемент||Укажите значение поля «Время забора до».*'''orderno2''' |- Номер заказа из срочных. Необязательный элемент.*'''datefrom''' |40||Specify the «Recipient company» field value.||Укажите значение поля «Компания- Дата заказа "с". Необязательный элементполучатель».*'''dateto''' |- Дата заказа "по"|41||Specify the «Recipient name» field value. Необязательный элемент||Укажите значение поля «ФИО получателя».*'''target''' |- Строка поиска|42||Specify the «Recipient phone» field value. Позволяет указать текст, который содержится в названии компании или адресе получателя||Укажите значение поля «Телефон получателя».*'''done''' |- Может принимать значения: :* ONLY_DONE |43||Specify the «Recipient city/town» field value.||Укажите значение поля «Город получателя».|- Только доставленные (имеются в виду успешные статусы, например, '''Доставлен''' или '''Частично доставлен'''):* ONLY_NOT_DONE |44||Specify the «Recipient address» field value.||Укажите значение поля «Адрес получателя».|- Только не доставленные (заказы, которые не являются доставленными, например, '''Не доставлен''' или '''Утерян'''):* ONLY_NEW |45||Specify the «Delivery date» field value.||Укажите значение поля «Дата доставки».|- Только новые:* ONLY_DELIVERY - Только заказы в обработке - заказы, находящиеся в любом статусе, кроме конечных: Доставлено, Не доставлено, Отменён и т|46||Specify the «Delivery time from» field value.д||Укажите значение поля «Время доставки с».:* ''Пусто'' |- все корреспонденции *'''changes''' - может принимать |47||Specify the «Delivery time to» field value.||Укажите значение только ONLY_LASTполя «Время доставки до». Если указан этот параметр, все остальные игнорируются|-|48||Specify the «Recipient postcode» field value. Описание данного режима приведено здесь: [[#Передача только изменившихся статусов|Передача только изменившихся статусов]]|Укажите значение поля «Индекс получателя».|-|49||Specify the «Weight» field value.||Укажите значение поля «Вес».<div style="color: #a94442; background|-color: #f2dede; border: 1px solid #ebccd1; padding: 3px 10px 10px;">'''Обратите внимание!'''|50||Specify the «Payment type» field value.||Укажите значение поля «Тип оплаты».|-# Периода запроса статусов (контейнеры '''datefrom''' и '''dateto''') ограничивается двумя месяцами — два месяца до даты '''"по"'''|51||Specify the «Quantity» field value.||Укажите значение поля «Количество».# Если не указаны обе даты — '''dateto''' принимается равной текущей дате|-|52||Specify the «Amount» field value.||Укажите значение поля «Сумма».# Если не указана дата '''dateto''' — она принимается равной '''datefrom''' плюс 2 месяца|-|53||Specify the «Declared value» field value.||Укажите значение поля «Объявленная стоимость».# Если не указана дата '''datefrom''' — она принимается равной '''dateto''' минус 2 месяца|-|54||Specify the «Description» field value.||Укажите значение поля «Описание».</div>|-<br />|55||Specify the «Instruction» field value.||Укажите значение поля «Поручение».|-=== Примеры ответов === |56||Specify the «Delivery mode» field value.||Укажите значение поля «Режим доставки».|-'''Пример успешного ответа'''|57||Specify the «Shipment type» field value.||Укажите значение поля «Тип отправления».|-<source lang="xml"><?xml version="1|58||Specify whether return trip is required.0" encoding="UTF-8"?>||Укажите значение поля «Необходимость возврата».|-<statusreq count="23">|59||Specify the «Return trip mode» field value.||Укажите значение поля «Режим возврата» <order orderno="111111" awb="qwerty" orderno2="123123" ordercode="34534234" givencode="2345334">|- <barcode>111111</barcode> <sender> <company>МВД</company> <person>Иванов И|60||Specify the «Return shipment type» field value.И||Укажите значение поля «Тип возврата».</person> <phone>123|-45|61||Specify barcode.||Укажите штрихкод.|-67</phone> <contacts>|62||Specify item weight.||Укажите массу единицы товара. <phone>+74951234567</phone>|- </contacts>|63||Specify item quantity.||Укажите количество товара. <town code="23432">Санкт|-Петербург</town> <address>Петровка 38 офис 35</address> <date>2014-03-22</date> <time_min>09:00</time_min> <time_max>14:00</time_max> </sender> <receiver> <company>МВД</company> <person>Иванов И|64||Specify item price.И||Укажите цену единицы товара.</person> <phone>123|-45-67 - Иван (916)234|65||Specify item name.45||Укажите название товара.21 Петр,mvd@mail|-|66||Wrong XLS file||Некорректный файл XLS.ru</phone> <contacts>|- <phone>+74951234567</phone>|67||Order barcode already exists in the database.||Такой штрихкод заказа уже есть в базе. <phone>+79162344521</phone>|- <email>mvd@mail|68||Select the «Payment by recipient» field value.||Укажите значение поля «Оплата получателем».|-|69||Specify department.||Укажите отдел.ru</email> </contacts> <inn>1112223335</inn> <zipcode>125480</zipcode>|- <town |70||Specify service partner code="153361" regioncode="78" regionname="Санкт.||Укажите значение поля «Код подрядчика».|-Петербург город">Санкт-Петербург город</town> <address>Петровка 38 офис 35</address> <pvz>|71||Date cannot be earlier than tomorrow.||Дата не может быть раньше чем завтра. <code>126</code> <clientcode>QWERTY</clientcode> </pvz> <date>2014|-03-22</date> <time_min>09:00</time_min>|72||Date cannot be later than 15 days from now.||Дата не может быть позже чем через 15 дней. <time_max>14:00</time_max>|- <coords lat="55|73||Date cannot be earlier than today.680327" lon="37||Дата не может быть раньше чем сегодня.604456"></coords> </receiver>|- <weight>5|74||Date cannot be later than {0} days from now.||Дата не может быть позже, чем через {0} дней.1</weight> <return_weight>5.1</return_weight>|- <quantity>2</quantity>|75||Specify a valid «Item weight» field value.||Укажите корректное значение поля «Масса единицы товара». <paytype>CASH</paytype>|- <service>2</service> <return_service>2</service>|76||Specify a valid «Quantity» field value.||Укажите корректное значение поля «Количество товара». <type>3</type>|- <return_type>3</return_type>|77||Specify a valid «Item price» field value.||Укажите корректное значение поля «Цена единицы товара». <waittime>12</waittime>|- <price>387.5</price>|78||Specify a valid «Delivery time from» field value.||Укажите корректное значение поля «Время доставки с». <print_check>YES</print_check>|- <inshprice>387|79||Specify a valid «Delivery time to» field value.||Укажите корректное значение поля «Время доставки до».5</inshprice> <enclosure>Детские игрушки</enclosure>|- <instruction>Проверить при покупателе, подписать акт</instruction> <currcoords lat="55|80||Specify a valid «Pickup time from» field value.680327" lon="37||Укажите корректное значение поля «Время забора с».604456" accuracy="50" RequestDateTime="2014|-04|81||Specify a valid «Pickup time to» field value.||Укажите корректное значение поля «Время забора до».|-21 18:07:45"></currcoords> <courier>|82||Specify a valid «Pickup point» field value.||Укажите корректное значение поля «ПВЗ». <code>26</code>|- <name>Иванов Владимир Петрович</name>|83||Duplicate number in the registry.||Дублирование номера в реестре. <phone>+79161234567</phone>|- </courier> <deliveryprice total="158|84||Duplicate barcode in the registry.6" delivery="100||Дублирование штрихкода в реестре.00" |-|85||Specify a valid «Weight at return="58trip» field value.||Укажите корректное значение поля «Вес возврата».6"> <advprice code="1" price="150">База</advprice>|- <advprice code="2" price="0">% от объявленной стоимости</advprice>|86||Specify the «Weight at return trip» field value.||Укажите значение поля «Вес возврата».|- <advprice code="3" price="8|87||Order weight exceeds the allowed maximum for the pickup point.||Вес превышает допустимое значение для этого ПВЗ.6">Топливный сбор</advprice> <advprice code="4" price="0">Округление</advprice> </deliveryprice>|- <receiverpays>NO</receiverpays> <status eventstore="филиал в Санкт|88||Pickup date cannot be earlier than today.||Дата забора не может быть раньше чем сегодня.|-Петербурге" eventtime="2016|89||Specify a later delivery date.||Укажите более позднюю дату доставки.|-06|90||Inappropriate «Weight» or «Pay type» field value for the selected city or town. Please review and correct the values.||Значение поля «Масса» или «Тип оплаты» для выбранного города указано некорректно или отсутствует. Проверьте значения и исправьте.|-02 17:22:00" createtimegmt="2016-06-03 16:14:44" message="" title="Доставлен">COMPLETE</status> <statushistory>|91||{deliverytype} {deliverydate} is {holidaytype}. Select another date.||{deliverytype} {deliverydate} является {holidaytype}. Выберите другую дату. <status eventstore="Офис в Москве" eventtime="2016|-05|92||{deliverytype} {deliverydate} is {holidaytype}. Select another date.||{deliverytype} {deliverydate} является {holidaytype}. Выберите другую дату.|-30 10:20:00" createtimegmt="2016-06|93||Add items.||Добавьте товары.|-03 16:14:44" message="" title="Новый">NEW</status> <status eventstore="Офис в Москве" eventtime="2016|95||The selected pickup point only allows paid orders.||Выбранный ПВЗ выдает только предоплаченные заказы.|-06|96||Order barcode exceeds the allowed maximum (25) symbols.||Длина штрихкода заказа превышает максимально допустимую (25 символов).|-01 17:38:00" createtimegmt="2016|97||The pickup date format is not valid. Specify a date in YYYY-06MM-03 16:14:44" message="филиал DD format.||Укажите значение поля «Дата забора» в Санктформате гггг-мм-дд.|-Петербурге" title="Планируется отправка">DEPARTURING</status> <status eventstore="Офис в Москве" eventtime="2016|98||Specify the cost code.||Укажите значение поля «Кост-06код».|-01 19:53:00" createtimegmt="2016-06|99||The item is not in stock.||Товар отсутствует на складе.|-03 16:14:44" message="филиал в Санкт-Петербурге" title="Отправлено со склада">DEPARTURE</status> <status eventstore="филиал в Санкт|100||Set the quantity of the item marked with Chestny ZNAK to one.||Укажите количество товара, маркированного кодом «Честный ЗНАК», равным единице.|-Петербурге" eventtime="2016|101||Quantity of item Delivery cannot be greater than 1||Количество вложений типа «Доставка» не может быть более 1.|-06|102||А database error occurred. Please try later again.||Ошибка базы данных. Попробуйте позже.|-|103||Order not found.||Заказ не найден.|-02 07:41:00" createtimegmt="2016-06-03 16:14:44" message="" title="Получен складом">ACCEPTED</status> <|104||Cannot edit order in the current status eventstore="филиал .||Невозможно изменить заказ в Санкт-Петербурге" eventtime="2016текущем статусе.|-06|105||Discount cannot be greater than the order amount. Specify a smaller value.||Размер скидки не может превышать сумму заказа. Укажите меньшее значение скидки.|-02 09:17:00" createtimegmt="2016|106||Specify the correct additional service code.||Укажите корректный код дополнительной услуги.|-06-03 16:14:44" message="" title="Выдан курьеру на доставку">DELIVERY</status> <status eventstore="филиал в Санкт|107||Specify the correct additional service name.||Укажите корректное значение поля [advprice][value].|-Петербурге" eventtime="2016-06|108||Specify the «Additional services» field value.||Укажите значение поля «Дополнительные услуги».|-02 17:22:00" createtimegmt="2016|110||Specify the correct TIN.||Укажите корректный ИНН.|-06-03 16:14:44" message="" title="Доставлен |111||Specify the correct IIN (KZ).||Укажите корректный ИИН (предварительноКЗ)">COURIERDELIVERED</status>. <status eventstore="филиал в Санкт|-Петербурге" eventtime="2016|112||Specify the overall volume.||Укажите общий объем.|-06|113||Cannot apply the delivery mode. Select another delivery mode.||Режим доставки не подходит для заказа. Выберите другой режим.|-02 17:22:00" createtimegmt="2016|114||The pickup point does not support the selected delivery mode. Specify another pickup point.||ПВЗ не подходит для выбранного режима доставки. Укажите другой ПВЗ.|-06-03 16:14:44" message="" title="Доставлен">COMPLETE</status> </statushistory>|115||Specify a valid recipient phone number.||Укажите корректный телефон получателя.|- <customstatecode>2<customstatecode>|116||Specify recipient PIN code.||Укажите пин-код получателя. <clientstatecode></clientstatecode>|-|117||Order date cannot be earlier than {0}. Specify another date.||Дата заказа не может быть раньше {0}. Укажите другую дату. <costcode>cc12345</costcode>|- <receipt fdNum="124555" fnSn="9289000100295555" kktNum="0001611984048555" inn="7722756555" fdValue="2899551555" summ="387|118||Pickup date cannot be earlier than {0}.5" ofdUrl="gateSpecify another date.ofd.ru">https://ofd||Дата забора не может быть раньше {0}.ru/rec/7722756555/0001611984048555/9289000100295555/124555/2899551555</receipt> <deliveredto>Иванова, секрУкажите другую дату.</deliveredto> <delivereddate>2016|-06-02</delivereddate> <deliveredtime>17:22</deliveredtime>|119||Specify the correct item type.||Укажите корректный тип вложения.|- <outstrbarcode>EXT123456</outstrbarcode>|120||The pickup point does not accept payment by card.||В выбранном ПВЗ оплата картой не принимается. <items>|- <|121||Invalid item code="34533" extcode="abc123" quantity="1" mass="format||Неверный формат кода товарной номенклатуры|-|122||Pickup time cannot be earlier than {0} hours.2" retprice="37||Время забора не может быть раньше чем через {0} часа.|-|123||Pickup interval cannot be less than {0} minutes.5" VATrate="||Интервал времени забора не может быть менее {0} минут. Укажите корректный интервал.|-|124||Specify a valid " barcode="2345625213125" article="1Payment type" returns="0" origincountry="040" GTD="" excise="0field value.00" governmentCode="11223311" suppcompany="Поставщик" suppINN="1112223334" suppphone="79161234567">Мяч<||Укажите корректное значение поля «Тип оплаты».|-|125||Recepient city/item> <item code="34456" extcode="abc124" quantity="2" mass="2" retprice="100" VATrate="10" barcode="4645625213138" article="2" returns="0" governmentCode="">Обруч</item>town by postcode not found.||Город получателя по его индексу не найден.|-|126||Incorrect items prepayment and pickup.||Заказ не может содержать только вложения «Предоплата» и «Забор».|-|127||Package limit exceeded||Превышен лимит количества мест|- <|128||Quantity of item code="34421" extcode="abc125" quantity="3" mass="0Prepayment cannot be greater than 1||Количество вложений типа «Предоплата» не может быть больше 1.|-|129||Sum of cod must be equal sum of items||Объявленная стоимость должна быть равна сумме вложений.|-|130||Specify a valid respstore code.||Укажите код ответственного филиала.3" retprice="50" VATrate="18" barcode="2345625213126" article="3" returns="0" governmentCode="">Погремушка желтая</item> </items>|- <packages> <package code=|131||Cannot edit, order has not been synchronized.||Невозможно изменить заказ пока он не синхронизирован.|-|132||Specify a valid "33331Recipient city/town" strbarcode="ORD0000001" mass="1field value.||Укажите город получателя|-|133||Specify a valid " message=weight"for the town.||Укажите корректный вес для города|-|134||Specify a valid " got="YESpaytype"></package> <package code="33332" strbarcode="ORD0000002" mass="2for the town.5" message="" got="NO"></package>||Укажите тип оплаты для города </packages>|- <|135||Specify the correct SKU ID/code for item.||Укажите артикул/код вложения|-|136||Specify warehouse goods in the order>.||Укажите вложения в заказе</statusreq> |-</source>|137||The order's date of creation is more than 60 days ago.||Заказ создан более 60 дней назад|-|138||Specify a valid "Package dimension" field value.||Укажите корректные габариты места|-|139||Wrong type of XML query||Ошибка запроса|-|140||Duplicate item code in the order.||Дублирование кода вложения в заказе|-|141||Duplicate additional service in the order.||Дублирование кода дополнительной услуги в заказе|-|} === Передача значений полей в форме создания заказа в Личном Кабинете через GET параметры ===Если вам требуется передавать значения полей в форме создания заказа в Личном Кабинете через GET параметры, то вы можете подробно ознакомиться с этим на данной странице - [[Личный_кабинет_клиента#Передача и подстановка значений полей формы создания заказа через GET параметры]]
=== Пример запроса статуса заказа ===
<source lang="xml">
<?xml version="1.0" encoding="utfUTF-8"?><statusreq count> <auth extra="08"login="login" pass="pass"></auth> <client>CLIENT</client> <orderno>1234</orderno> <orderno2>5678</orderno2> <ordercode>34234</ordercode> <givencode>234534</givencode> <uid>af11c7c6-6645-4a20-9604-be911a75722d</uid> <datefrom>2016-07-21</datefrom> <dateto>2016-07-21</dateto> <target>Автозавод</target> <done>ONLY_NOT_DONE</done> <changes>ONLY_LAST</changes> <conditions> <namecontains/> <namestarts/> </conditions></statusreq>
</source>
=== Описание полей запроса статуса ==='''Пример ответа statusreq''' — Корневой контейнер. Обязательный элемент.* '''auth''' — Авторизация. Обязательный элемент.* '''client''' — Признак клиента или агента. Необязательный элемент.:* CLIENT — Признак клиента, значение по умолчанию:* AGENT — Признак агента. В ответ отдается информация по заказам, переданным агенту на доставку* '''orderno''' — Идентификатор заказа у клиента (шифр). Необязательный элемент.* '''ordercode''' — Внутренний код заказа. Необязательный элемент.* '''orderno2''' — Номер заказа из срочных. Необязательный элемент. * '''uid''' — Уникальный идентификатор, если он был добавлен при ошибке авторизациисоздании заказа. Необязательный элемент. Запрос информации по uid возможен в течении суток после создания заказа* '''datefrom''' — Дата заказа «с». Необязательный элемент.* '''dateto''' — Дата заказа «по». Необязательный элемент.* '''target''' — Строка поиска. Позволяет указать текст, который содержится в названии компании или адресе получателя.* '''done''' — Может принимать значения::* ONLY_DONE — Только доставленные (имеются в виду успешные статусы, например, '''Доставлен''' или '''Частично доставлен'''):* ONLY_NOT_DONE — Только не доставленные (заказы, которые не являются доставленными, например, '''Не доставлен''' или '''Утерян'''):* ONLY_NEW — Только новые:* ONLY_DELIVERY — Только заказы в обработке — заказы, находящиеся в любом статусе, кроме конечных: Доставлено, Не доставлено, Отменён и т. д.:* ''Пусто'' — все корреспонденции
* '''Пример ответа при ошибке синтаксисаconditions''' <source lang="xml"><?xml version="1 — Задает условия фильтрации по «orderno».0" encoding="UTF-8"?><request> <error>column:1 line:11 message:expected '>'</error></request></source> === Описание полей ответа статусов ===Все поля ответа соответствуют структуре order при создании заказа, с некоторыми добавлениями: * Атрибуты контейнера '''order'''::* '''''awb''''' - Номер накладной в системе курьерской службы.:* '''''orderno2''''' - Номер накладной в подсистеме срочной доставки курьерской службывложенные элементы одновременно накладывают условие «И».Минимум 5 символов!:* '''''ordercodenamecontains''''' - внутренний код — Поиск по номеру заказа в системе(шифр), применяется для некоторых внутренних операцийкоторый содержит «orderno».:* '''''givencode''namestarts''' - внутренний код — Поиск по номеру заказа в системе(шифр), применяется для некоторых внутренних операций. * атрибут '''''code''''' контейнера '''item''' - внутренний код строки заказа в системе, применяется для некоторых внутренних операций.:* '''''returns''''' - количество данного товара, от которого отказался получатель. Не нулевое только в случае частичного отказа. * атрибут '''''got''''' контейнера '''package''' - признак принятого места YES / NO.:* '''''returns''''' - количество данного товара, от которого отказался получатель. Не нулевое только в случае частичного отказа. * '''''coords''''' в контейнере '''receiver''' - координаты получателя.* '''currcoords''' - текущие координаты заказа. Атрибуты::* '''''lat''''' - широта:* '''''lon''''' - долгота:* '''''accuracy''''' - точность в метрах:* '''''RequestDateTime''''' - дата/время последнего обновления координаткоторый начинается с «orderno».
<div style="color: #a94442; background-color: #f2dede; border: 1px solid #ebccd1; padding: 3px 10px 10px;">
'''Обратите внимание!'''
# Атрибуты контейнера Периода запроса статусов (контейнеры '''datefrom''' и '''dateto'''status) ограничивается двумя месяцами — два месяца до даты ''' заполняются для версий системы «по»'''2008.0# Если не указаны обе даты — '''dateto''' принимается равной текущей дате.0.670# Если не указана дата '''dateto''' — она принимается равной '''datefrom''' и новееплюс 2 месяца.# Контейнер Если не указана дата '''statushistorydatefrom''' заполняется для тарифа "[[Личный_кабинет#.D0.9F.D0.BE.D0.B4.D0.BA.D0.BB.D1.8E.D1.87.D0.B5.D0.BD.D0.B8.D0.B5|Премиум]]" и версий системы — она принимается равной '''2008.0.0.670dateto''' и новееминус 2 месяца.# Контейнер Поиск по '''deliverypriceconditions''' заполняется работает только для тарифа "[[Личный_кабинет#.D0.9F.D0.BE.D0.B4.D0.BA.D0.BB.D1.8E.D1.87.D0.B5.D0.BD.D0.B8.D0.B5|Премиум]]".«Номер заказа(шифр)» и только от 4 символов
</div>
<br />
=== Передача только изменившихся статусов Примеры ответов ===В нашем API предусмотрено очень удобное средство получения статусов всех заказов, без необходимости "бомбить" сервер запросами статусов по каждому заказу. Работает это так: раз в какое-то время, например, в 10 минут, вы посылаете запрос "А покажите все изменившиеся статусы". '''Пример запроса ниже. Система вам отдает ВСЕ заказы, статусы (или некоторые другие поля, см ниже) которых изменились с момента последнего запроса. Вы разбираете полученный документ, по каждому заказу сохраняете его актуальный статус в своей системе, и если все хорошо, у вас все получилось, ваша система неожиданно не упала от наплыва информации, посылаете нам запрос подтверждения получения статусов (commitlaststatus). Мы у себя отмечаем, что эти статусы вами получены, и их не надо передавать повторно. Т.о. сколько бы заказов у вас не было, статусы по ним всем почти в реальном времени вы можете получать всего 2-мя запросами.успешного ответа'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8" ?><statusreqcount="23"> <auth extraorder orderno="111111" awb="8qwerty" orderno2="123123" loginordercode="login34534234" passgivencode="pass2345334"> <barcode>111111</authbarcode> <sender> <changescompany>ONLY_LASTМВД</changescompany> <person>Иванов И.И.</statusreqperson> <phone>123-45-67</sourcephone> <contacts>Система выдает все заказы, в которых, с момента последнего запроса в этом режиме, изменилось хотя бы одно из полей: <phone>+74951234567</phone> orderno </contacts> status delivereddate deliveredtime deliveredto receiver <town code="23432">Санкт-Петербург</town>date receiver-> <address price После успешной обработки ответа необходимо отметить полученные статусы успешно полученными, отправив запрос>Петровка 38 офис 35<source lang="xml"/address> <?xml version="1.0" encoding="UTF-8" ?date>2014-03-22</date> <commitlaststatustime_min>09:00</time_min> <auth extra="8" login="login" pass="pass"time_max>14:00</time_max> </authsender> <receiver> <clientcompany>CLIENTМВД</clientcompany> <person>Иванов И.И.</commitlaststatusperson> </sourcephone> '''Описание полей запроса''' *'''auth''' 123-45-67 - АвторизацияИван (916)234. Обязательный элемент45.21 Петр,mvd@mail.ru</phone>*'''client''' - Признак клиента или агента. Необязательный элемент.:* CLIENT - Признак клиента, значение по умолчанию:* AGENT - Признак агента. В ответ отдается информация по заказам, переданным агенту на доставку В случае успеха Вы получите ответ <source lang="xml"contacts> <?xml version="1.0" encoding="UTF-8" ?phone>+74951234567</phone> <commitlaststatus error="0"phone>OK+79162344521</commitlaststatusphone> </sourceemail>mvd@mail.ru</email> </contacts>Данный способ передачи статусов гарантирует полную корректную передачу статусов, даже в случае, если в нашей системе статус изменился в промежутке времени между запросом статусов и подтверждением их получения. Если система не получила подтверждение успешной передачи статуса, она будет считать информацию не переданной, и выдаст ее при повторном запросе. <inn>1112223335</inn> <zipcode>125480</zipcode> <div styletown code="153361" regioncode="78" regionname="color: #a94442; backgroundСанкт-color: #f2dede; border: 1px solid #ebccd1; padding: 3px 10px 10px;Петербург город">Санкт-Петербург город</town>'''Обратите внимание!''' <address>Петровка 38 офис 35</address> # При данном способе передачи ( <changesarea>ONLY_LASTРайон 1</changesarea> <pvz>) система просматривает заказы, оформленные за последние 3 месяца. Если заказ сделан ранее - изменение статуса по нему не попадет в результат выполнения данного запроса.# Система всегда выдает текущий статус. Т.е. Вы можете одним запросом получить статус "NEW", а следующим - "COMPLETE". В промежутке между запросами отправление могло пройти через несколько промежуточных статусов. Если нужна гарантия получения всех промежуточных статусов, нужно анализировать блок statushistory (может не заполняться в следствии ограничений версии или тарифа конкретной службы доставки). <code>126</code># Система никогда не гарантирует последовательность прохождения заказом набора статусов. Т.е. Вы можете получить статус "COMPLETE", а следующим запросом - "NEW" - такое может произойти, например, если оператор ошибочно отметил заказ выполненным, а затем исправил ошибку. <clientcode>QWERTY</clientcode> </divpvz> <date>2014-03-22<br /date> <time_min>09:00</time_min> <time_max>14:00</time_max> <coords lat="55.680327" lon= Трекинг заказа по номеру == Запрос трекинга по номеру предназначен для выдачи минимальной обезличенной информации о конкретном заказе не авторизованному пользователю"37. Наша система имеет для этого интерфейс по адресу 604456"home.courierexe.ru></{код экстра}coords> <deliveryPIN>1234</tracking"deliveryPIN> </receiver> <price>387. Вы можете либо сделать ссылку на такую страницу на своем сайте, либо разместить ее iframe'ом у себя, либо сделать свою и пользоваться нашим API5</price> <inshprice>387. Этот интерфейс создан специально для выдачи информации живому пользователю сайта. Для получения статусов заказов в свою информационную систему нужно использовать запрос 5</inshprice> <paytype code="statusreq1", желательно с параметром changes=ONLY_LAST!>CASH</paytype> <weight>5.1</weight>'''Пример запроса:''' <source lang="xml"quantity>2</quantity> <?xml version="1.0" encoding="UTF-8"?service>2<tracking/service> <extratype>83</extratype> <ordernoreturn>1234NO</ordernoreturn> <return_service>2</trackingservice> <return_type>3</sourcereturn_type> '''Пример ответа:''' <return_weight>5.1<source lang="xml"/return_weight> <?xml version="1.0" encoding="UTF-8"?return_message>Доставлено в целости</return_message> <trackingpickup>NO</pickup> <print_check>YES<order orderno="1234"/print_check> <waittime>12<sender/waittime> <town code="1" country="RU"enclosure>Москва городДетские игрушки</townenclosure> <dateinstruction>Проверить при покупателе, подписать акт</dateinstruction> </sender> <receiver> <town codecurrcoords lat="155.680327" countrylon="RU37.604456">Москва город</town> <date>2015accuracy="50" RequestDateTime="2014-04-21 18:07:45"></datecurrcoords> <courier> <code>26</receivercode> <AWBname>BarCodeИванов Владимир Петрович</AWBname> <weightphone>0+79161234567</weightphone> <quantity>1 </quantitycourier> <currcoords latdeliveryprice total="158.6" londelivery="100.00" return=" accuracy58.6"> <advprice code="1" RequestDateTimeprice="150" >База</advprice> <status eventstoreadvprice code="филиал в Санкт-Петербурге2" eventtimeprice="2016-06-02 17:22:000" createtimegmt>% от объявленной стоимости</advprice> <advprice code="2016-06-03 16:14:44" message3" price="8.6" title>Топливный сбор</advprice> <advprice code="Доставлен4" countryprice="RU0">COMPLETEОкругление</statusadvprice> </deliveryprice> <receiverpays>NO</receiverpays> <acceptpartially>NO<statushistory/acceptpartially> <status eventstore="Офис филиал в МосквеСанкт-Петербурге" eventtime="2016-0506-30 1002 17:2022:00" createtimegmt="2016-06-03 16:14:44" message="" title="НовыйДоставлен" eventtown="Санкт-Петербург город" countrycolor="RU16777215">NEWCOMPLETE</status> <statushistory> <status eventstore="Офис в Москве" eventtime="2016-0605-01 1730 10:3820:00" createtimegmt="2016-06-03 16:14:44" message="филиал в Санкт-Петербурге" title="Планируется отправкаНовый" eventtown="Москва город" country="RU">DEPARTURINGNEW</status> <status eventstore="Офис в Москве" eventtime="2016-06-01 1917:5338:00" createtimegmt="2016-06-03 16:14:44" message="филиал в Санкт-Петербурге" title="Отправлено со складаПланируется отправка" eventtown="Москва город" country="RU">DEPARTUREDEPARTURING</status> <status eventstore="филиал Офис в Санкт-ПетербургеМоскве" eventtime="2016-06-02 0701 19:4153:00" createtimegmt="2016-06-03 16:14:44" message="" titleфилиал в Санкт-Петербурге" title="Отправлено со склада" eventtown="Получен складомМосква город" country="RU">ACCEPTEDDEPARTURE</status> <status eventstore="филиал в Санкт-Петербурге" eventtime="2016-06-02 0907:1741:00" createtimegmt="2016-06-03 16:14:44" message="" title="Выдан курьеру на доставкуПолучен складом" eventtown="Санкт-Петербург город" country="RU">DELIVERYACCEPTED</status> <status eventstore="филиал в Санкт-Петербурге" eventtime="2016-06-02 09:17:22:00" createtimegmt="2016-06-03 16:14:44" message="" title="Доставлен (предварительно)Выдан курьеру на доставку" countryeventtown="RUСанкт-Петербург город" country="RU">COURIERDELIVEREDDELIVERY</status> <status eventstore="филиал в Санкт-Петербурге" eventtime="2016-06-02 17:22:00" createtimegmt="2016-06-03 16:14:44" message="" title="Доставлен(предварительно)" eventtown="Санкт-Петербург город" country="RU">COMPLETECOURIERDELIVERED</status> </statushistory> </order></tracking></source> '''Получение информации status eventstore="филиал в формате 17 TRACK''' '''Пример запроса:'''<source langСанкт-Петербурге" eventtime="xml"><?xml version=2016-06-02 17:22:00"1.0" encodingcreatetimegmt="UTF2016-8"?>06-03 16:14:44"<tracking17 message="" title="Доставлен" eventtown="Санкт-Петербург город" country="RU"> COMPLETE<extra/status>8 </extrastatushistory> <ordernocustomstatecode>12342</ordernocustomstatecode> <clientstatecode></tracking17clientstatecode> <deliveredto>Иванова, секр.</sourcedeliveredto> <delivereddate>2016-06-02</delivereddate>'''Пример ответа:''' <predeliveredtime>{ "number"17:"ExtNumber",22</deliveredtime> "oriNumber":"1234", <department>Отдел</department> "oriCountry":"RU", <costcode>cc12345</costcode> "destCountry":"RU", <outstrbarcode>EXT123456</outstrbarcode> "status":"Complete", <respstore>14</respstore> "events":[ <partner>Офис на Ленина</partner> { "time":" <arrival>2016-0605-02 1723:22:0021</arrival> <receipt fdNum=", 124555"locationfnSn=":9289000100295555"RUkktNum=", 0001611984048555"contentinn=":7722756555"CompletefdValue=" }, { 2899551555"timesumm=":387.5"2016-06-02 17:22:00ofdUrl=", "locationgate.ofd.ru">https://ofd.ru/rec/7722756555/0001611984048555/9289000100295555/124555/2899551555</receipt> <items> <item code="RU", "content34533":extcode="Courierdeliveredabc123" }, { quantity="time1":mass="2016-06-02 09:17:000.2", retprice="location37.5":VATrate="RU0", barcode="content2345625213125":article="Delivery1" }, { returns="time0":origincountry="2016-06-02 07:41:00040", GTD="location":excise="RU0.00", governmentCode="content11223311":suppcompany="AcceptedПоставщик" }, { suppINN="time1112223334":suppphone="2016-06-01 19:53:0079161234567",>Мяч</item> "location <item code=":34456" extcode="RUabc124", quantity="content2":mass="Departure2" }, { retprice="100"timeVATrate=":10"2016-06-01 17:38:00barcode=", 4645625213138"locationarticle=":2"RUreturns=", 0"contentgovernmentCode=":"Departuring">Обруч</item> }, { <item code="time34421":extcode="2016-05-30 10:20:00abc125", quantity="location3":mass="RU0.3", retprice="50" VATrate="18" barcode="2345625213126" itemcode="44123" article="3"contentreturns=":0" governmentCode="New" } ]}>Погремушка желтая</preitem> </items> <packages> <package code="33331" strbarcode="ORD0000001" mass="1" message="" got="YES"></package> <package code="33332" strbarcode="ORD0000002" mass="2.5" message="" got="NO"></package> </packages> </order></statusreq> </source> '''Пример ответа если нет заказов''' <source lang="xml"><?xml version="1.0" encoding="utf-8"?><statusreq count="0"></statusreq> </source> '''Пример ответа при ошибке авторизации''' <source lang="xml"><?xml version="1.0" encoding="utf-8"?><request><error error="1" errormsg="authorization error"></error></request></source>
<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<request>
<error>column:1 line:11 message:expected '>'</error>
</request>
</source>
== Изменение заказа = Описание полей ответа статусов ===Все поля ответа соответствуют структуре order при создании заказа, с некоторыми добавлениями:
* '''courier''' — Данные курьера, которому выдан заказ. Если заказ не выдан, то выводятся данные запланированного курьера.* '''waittime ''' — Время ожидания курьера.* '''deliveryprice''' — Стоимость услуг в валюте расчетов с клиентом. Атрибуты::* '''''total''''' — общая стоимость услуг:* '''''delivery''''' — стоимость доставки «Туда»:* '''''return''''' — стоимость доставки «Обратно» (если order->return== Отмена заказа ==YES)Тэг '''deliveryprice''' включает список дополнительных услуг (только для тарифа «Премиум»)::* '''''advprice''''' — наименование дополнительной услуги:* '''''code''''' — код дополнительной услуги:* '''''price''''' — стоимость дополнительной услуги
Контейнер '''status''' может принимать следующие значения:
: AWAITING_SYNC — Ожидает синхронизации. Данные заказа пока не появились в службе доставки.
: '''NEW''' — Успешно создан, передан в службу доставки.
: NEWPICKUP — Создан забор.
: PICKUP — Забран у отправителя.
: WMSASSEMBLED — Скомплектован на складе фулфилмента.
: WMSDISASSEMBLED — Разукомплектован на склад фулфилмента.
: '''ACCEPTED''' — Получен складом.
: CUSTOMSPROCESS — Производится таможенный контроль.
: CUSTOMSFINISHED — Таможенный контроль произведен.
: CONFIRM — Согласована доставка.
: UNCONFIRM — Не удалось согласовать доставку.
: DEPARTURING — Планируется отправка со склада на другой склад.
: DEPARTURE — Отправлено со склада на другой склад.
: INVENTORY — Инвентаризация. Убедились в наличии отправления на складе.
: PICKUPREADY — Готов к выдаче в ПВЗ.
: '''DELIVERY''' — Выдан курьеру на доставку.
: COURIERDELIVERED — Доставлен (предварительно, ожидает подтверждения менеджером, чтобы перейти в статус COMPLETE).
: COURIERPARTIALLY — Частично доставлен (предварительно, ожидает подтверждения менеджером, чтобы перейти в статус PARTIALLY).
: COURIERCANCELED — Отказ (предварительно, после этого ожидается COURIERRETURN).
: COURIERRETURN — Возвращено курьером. Курьер не смог доставить до получателя и вернул заказ обратно на склад. Это промежуточный статус, после которого менеджер выясняет, нужно ли повторно доставлять (статусы DATECHANGE/DELIVERY) или это окончательная недоставка (CANCELED).
: DATECHANGE — Перенос даты доставки.
: '''COMPLETE''Пример запроса отмены заказа' — Доставлен.:'''<source lang="xml"><?xml version="1PARTIALLY''' — Доставлен частично.0" encoding="UTF-8" ?><cancelorder> <auth extra="8" login="login" pass="pass" : '''CANCELED''' — Не доставлен (Возврат/> <order orderno="" ordercode="123456" /> <order orderno="123aaa" ordercode="" /></cancelorder></source>Отмена). После этого статуса отправление должны вернуть заказчику, будут статусы RETURNING и RETURNED
: RETURNING — Планируется возврат заказчику (после CANCELED).
: RETURNED — Возвращен заказчику.
: LOST — Утрачен/утерян.
'''Примечание.''' В будущем возможно дополнение используемого набора статусов.
<div style="color: #a94442; background-color: #f2dede; border: 1px solid #ebccd1; padding: 3px 10px 10px;">'''Пример ответа:Обратите внимание!'''<source lang="xml"><?xml version="1# Контейнер '''statushistory''' и '''deliveryprice''' заполняется для тарифов [[Личный кабинет курьерской службы#Функции личного кабинета|Премиум и Максимум]].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="Заказ # Система никогда не найден" />гарантирует последовательность прохождения заказом набора статусов. То есть Вы можете получить статус «COMPLETE», а следующим запросом — «NEW» — такое может произойти, например, если оператор ошибочно отметил заказ выполненным, а затем исправил ошибку.</cancelorderdiv></sourcebr>
== Получение вложений к накладной =Передача только изменившихся статусов ===В нашем API предусмотрено удобное средство получения статусов всех заказов, без необходимости «бомбить» сервер запросами статусов по каждому заказу. Работает это так: раз, например, в 10 минут, вы посылаете запрос «покажите все изменившиеся статусы». Пример запроса ниже. Система вам отдает ВСЕ заказы, статусы (или некоторые другие поля, см. ниже) которых изменились с момента последнего запроса. Вы разбираете полученный документ, по каждому заказу сохраняете его актуальный статус в своей системе, и если все хорошо, у вас все получилось, ваша система неожиданно не упала от наплыва информации, посылаете нам запрос подтверждения получения статусов (commitlaststatus). Мы у себя отмечаем, что эти статусы вами получены и их не надо передавать повторно. Таким образом, сколько бы заказов у вас ни было, статусы по ним всем почти в реальном времени вы можете получать всего двумя запросами.
<source lang="xml">
<?xml version="1.0" encoding="UTF-8" ?>
<attachmentsstatusreq> <auth extra="8" login="login" pass="pass" ></auth> <changes>ONLY_LAST</changes> <ordernostreamid>12345671234</ordernostreamid></attachmentsstatusreq>
</source>
* '''auth''' — авторизация. Обязательный элемент.
* '''streamid''' — идентификатор потока. Если у вас несколько интеграций и каждая нуждается в получении статусов, вы можете передавать данный параметр и тем самым разделять получение и отметку об успешном получении статусов по заказам. Значение должно входить в промежуток от 100 до 10000, включительно. Необязательный элемент.
* '''client''' — признак клиента или агента. Необязательный элемент.
:* CLIENT — признак клиента, значение по умолчанию
:* AGENT — признак агента. В ответ отдается информация по заказам, переданным агенту на доставку
<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?><attachments> <item namecommitlaststatus error="doc1.docx" size="356540">JVBERi0xLjMNOK</commitlaststatus> JUBQREYwMTIzNDU2Nzg5IDI NMyAwIG9iag08PA0vVHlwZSA</source> U3VidHlwZSAvSW1hZ2UNL1d pZHRoIDE4MDgNL0hlaWdodCA ggNCAwIFINL0JpdHNQZXJDb 21wb25lbnQgMQ0vRGVjb2RlUТакой способ передачи статусов гарантирует полную корректную передачу статусов, даже если в нашей системе статус изменился между запросом статусов и подтверждением их получения. Если система не получила подтверждение передачи статуса, она будет считать информацию непереданной и выдаст ее при повторном запросе. ENL0NvbHVtbnMgMTgwOA0+P g0vSW1hZ2VNYXNrIHRydWUNL XhEZWNvZGUNPj4Nc3RyZWFt DQ</item> <item name="photo2.jpg" sizediv style="74861color: #a94442; background-color: #f2dede; border: 1px solid #ebccd1; padding: 3px 10px 10px;">VBERi0xLjMN JUBQREYwMTIzNDU2Nzg5IDI NMyAwIG9iag08PA0vVHlwZSA vWE9iamVjdA0vU3VidHlwZS AvSW1hZ2UNL1dpZHRoIDEzNj gNL0hlaWdodCAxMzMzDS9MZ W5ndGggNCAwIFINL0JpdHNQZ XJDb21wb25lbnQgMQ0vRGVj b2RlUGFybXMgPDwNL0sgLTEN L0NvbHVtbnMgMTM2OA0+Pg0 vSW# При этом способе передачи (<changes>ONLY_LAST</itemchanges>) система просматривает заказы, оформленные за последние 3 месяца. Если заказ сделан ранее, изменение статуса по нему не попадет в результат выполнения запроса.# Система всегда выдает текущий статус. Вы можете одним запросом получить статус «NEW», а следующим — «COMPLETE». Между запросами отправление могло пройти через несколько промежуточных статусов. Если нужна гарантия получения всех промежуточных статусов, нужно анализировать блок statushistory (может не заполняться вследствие ограничений версии или тарифа конкретной службы доставки).# Система не гарантирует последовательность прохождения заказом набора статусов. Вы можете получить статус «COMPLETE», а следующим запросом «NEW» — такое может произойти, например, если оператор ошибочно отметил заказ выполненным, а затем исправил ошибку.</attachmentsdiv></sourcebr>
'''Пример запроса:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<tracking>
<extra>8</extra>
<orderno>1234</orderno>
</tracking>
</source>
<source lang="xml">
<?xml version="1.0" encoding="UTF-8" ?><setorderinfotracking> <auth extraorder orderno="8111111" login> <barcode>111111</barcode> <AWB>111111</AWB> <sender> <town code="login1" passcountry="passRU" >Москва город</town> <order ordercode="123456"date>2014-03-22</date> <time_min>09:00</time_min> <messagetime_max>Получил Иванов14:00</messagetime_max> </ordersender> <receiver> <order ordercodetown code="1" country="234567RU">Москва город</town> <statuszipcode>PICKUPREADY125480</statuszipcode> <eventtimedate>20162014-0503-30 1022</date> <time_min>09:2000</time_min> <time_max>14:00</eventtimetime_max> </receiver> <price>387.5</price> <messageinshprice>Клиент отказался от покупки387.5</messageinshprice> <paytype>CASH</paytype> <weight>5.1<items/weight> <quantity>2</quantity> <service>2</service> <type>3</type> <return>NO</return> <return_service>2</return_service> <return_date></return_date> <return_time></return_time> <return_message></return_message> <waittime>12</waittime> <enclosure>Детские игрушки</enclosure> <instruction>Проверить при покупателе, подписать акт</instruction> <item codedeliveryprice total="34533158.6" quantitydelivery="1100.00" reasonreturn="058.6" /> <courier> <code>26<item /code> <name>Иванов Владимир Петрович</name> <phone>+79161234567</phone> </courier> <currcoords lat="55.680327" lon="3445637.604456" quantityaccuracy="050" reasonRequestDateTime="02014-04-21 18:07:45" /> <item codestatus eventstore="филиал в Санкт-Петербурге" eventtime="2016-06-02 17:22:00" createtimegmt="344212016-06-03 16:14:44" quantitymessage="2" reasontitle="0Доставлен" >COMPLETE</status> </itemsstatushistory> <image filenamestatus eventstore="Офис в Москве" eventtime="2016-05-30 10:20:00" createtimegmt="filename1.jpg2016-06-03 16:14:44" message="" title="Новый"> NEW</9j/4AAQSkZJRgAstatus> BAQAAAQABAAD <status eventstore="Офис в Москве" eventtime="2016-06-01 17:38:00" createtimegmt="2016-06-03 16:14:44" message="филиал в Санкт-Петербурге" title="Планируется отправка">DEPARTURING</2wBDAA0JCg sKCA0LCgsODg0PEyAVExISEy ccHhcgLikxMC4pLSwzOko+M zZGNywtQFdBRkxOUlNSMj5aY VpQYEpRUk//2wBDAQ4ODhMR EyYVFSZPNS01T09PT09PT09P T09PT09PT09PT09PT09PT09 PT09PT09PT09PT09PT09PT09status> PT09PT0//wAARCAYACAADAS IA </imagestatus eventstore="Офис в Москве" eventtime="2016-06-01 19:53:00" createtimegmt="2016-06-03 16:14:44" message="филиал в Санкт-Петербурге" title="Отправлено со склада"> DEPARTURE</orderstatus> </setorderinfostatus eventstore="филиал в Санкт-Петербурге" eventtime="2016-06-02 07:41:00" createtimegmt="2016-06-03 16:14:44" message="" title="Получен складом">ACCEPTED</sourcestatus> '''Описание полей запроса статуса:''' '''setorderinfo''' <status eventstore="филиал в Санкт-Петербурге" eventtime="2016- Корневой контейнер. Обязательный элемент.*'''auth''' 06- Авторизация. Обязательный элемент.*'''order''' 02 09:17:00" createtimegmt="2016- Контейнер заказа. Обязательный элемент. Запрос может содержать более одного контейнера '''order'''. Атрибут '''''ordercode''''' 06- внутренний код заказа.03 16:14:44" message="" title="Выдан курьеру на доставку">DELIVERY</status>*''' <status''' eventstore="филиал в Санкт- Новый статус заказа. Доступны статусы из раздела [[#Описание полей ответа статусов]], кроме AWAITING_SYNC и NEW.*'''Петербурге" eventtime''' ="2016- Дата и время изменения статуса. Обязательно при указании статуса.*'''message''' 06-02 17:22:00" createtimegmt="2016- Текст сообщения ''Инфо о доставке''.*'''paytype''' 06- Тип оплаты заказа. Допустимые значения CASH03 16:14:44" message="" title="Доставлен (предварительно)">COURIERDELIVERED</CARD.status>*'''items''' <status eventstore="филиал в Санкт-Петербурге" eventtime="2016-06- Контейнер для описания вложений '''item''' . Атрибуты02 17:22:* '''''code''''' 00" createtimegmt="2016-06- Код вложения.03 16:14:44" message="" title="Доставлен">COMPLETE</status>:* '''''quantity''''' - Количество доставленных единиц вложения. </statushistory>:* '''''reason''''' - Причина недоставки <deliveredto>Иванова, выбирается из соответствующего списка статусовсекр.</deliveredto>*'''image''' <delivereddate>2016- Контейнер прикрепляемого изображения. Содержит текст файла изображения, закодированный по стандарту ''base64''. Контейнер '''order''' может содержать более одного контейнера '''image'''. Атрибут:06-02</delivereddate> <deliveredtime>17:* '''''filename''''' - Имя файла.22</deliveredtime> <outstrbarcode>EXT123456</outstrbarcode> <items> '''Пример ответа:''' <source langitem code="xml34533"><?xml versionextcode="abc123" quantity="1" mass="0.2" retprice="37.5" VATrate="0" barcode="2345625213125" article="1" returns="0" encodingorigincountry="UTF-8040" GTD="" excise="0.00" governmentCode="11223311" suppcompany="Поставщик" suppINN="1112223334" suppphone="79161234567"?>Мяч<setorderinfo/item> <order ordercodeitem code="34456" extcode="abc124" quantity="2" mass="2" retprice="100" VATrate="10" barcode="1234564645625213138" errorarticle="02" errormsgreturns="OK0" errormsgrugovernmentCode="Успешно" >Обруч</item> <order ordercodeitem code="34421" extcode="abc125" quantity="3" mass="0.3" retprice="50" VATrate="18" barcode="2345672345625213126" errorarticle="593" errormsgreturns="value [date_put] is already set0" errormsgrugovernmentCode="Значение [Дата доставки] уже указано" >Погремушка желтая</item> </items> </order></setorderinfotracking>
</source>
'''Получение информации в формате 17 TRACK''' '''Пример запроса получения печатных форм:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8" ?><waybilltracking17> <auth extra=">8" login="login" pass="pass" </extra> <ordersorderno> 1234<order orderno="1234567" ordercode="33331" /> <order orderno="1234568" ordercode="33332" /> </orders> <form>1</form></waybilltracking17>
</source>
'''Пример ответа:'''
<source lang=pre>{ "number":"ExtNumber", "oriNumber":"1234", "oriCountry":"RU", "destCountry":"RU", "status":"Complete", "events":[ { "time":"2016-06-02 17:22:00", "location":"RU", "content":"Complete" }, { "time":"2016-06-02 17:22:00", "location":"RU", "content":"Courierdelivered" }, { "time":"2016-06-02 09:17:00", "location":"RU", "content":"xmlDelivery"><?xml version= }, { "1.0time" encoding=:"UTF2016-06-802 07:41:00"?>,<waybill> "location":"RU", < "content>EODIcaI8KSBlwQ 4MnEOR7Px8U8EBAyGICBnwpw ":"Accepted" IZhQgz0ZxuPs8EBM/GcbjzB AwhBl8hwQYIO00GmEwg1CeEG }, mqYTChNU0wqf8l8nz4zgc+K fCno+zwU5GjOZmzXGcbEQYIM { 4zkegRE40zWzONyoNNMIOIa cWnp6aDCGEGE9NQmoQd2mg00 "time":"2016-06-01 19:53:00", 79U4f3hPTwnfp6Sdrafeqpa JDpFw/1aYT077VNNNdO00G3q "location":"RU", mqqvp9p2E7T0/wiFemv8uG6 OM</ "content>":"Departure"</waybill> },</source> { "time":"2016-06-01 17:38:00", "location":"RU",В тэге "content возвращаются бинарные данные (файл pdf)":"Departuring" }, закодированные в base64. { "time":"2016-05-30 10:20:00",'''Обратите внимание''' "location":"RU", что печатные формы для заборов не формируются. "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|Запроса статусов заказов]].
== Изменение заказа ==
Запрос предназначен для изменения заказов.
Изменять заказы могут курьерские службы с тарифами «Премиум» и «Максимум». Чтобы разрешить изменение заказов, в личном кабинете курьерской службы перейдите в '''Настройки''' > '''Заказы''' и в разделе '''Отмена и редактирование''' установите флажок '''Разрешить отмену и изменение заказов'''. Вы также можете пометить в списке '''Статусы для отмены и редактирования заказов''' галками статусы корреспонденции, для которых возможны отмена и изменение заказов. По умолчанию (когда в этом списке ничего не выбрано) редактирование и отмена разрешены для статуса «Новый»
<div style="color: #a94442; background-color: #f2dede; border: 1px solid #ebccd1; padding: 3px 10px 10px;">
'''Обратите внимание!'''
# Данные запроса изменения указываются '''полностью''', как если бы заказ создавался впервые.
# При отсутствии вложения в запросе изменения данное вложение '''не удаляется''' из заказа, но его количество становится равным 0.
# При одновременном изменении заказа в API и системе курьерской службы приоритет отдается данным системы курьерской службы. То есть изменения в API приняты не будут.
</div>
При редактировании заказа может быть отменен запланированный курьер. Это зависит от значения переменной '''Справочники''' > '''Переменные''' > '''Корреспонденция''' > '''Автоматически устанавливать заплан. курьера по району''':
* '''Нет''' — при редактировании заказа по АПИ курьер не изменяется;
* '''Район''' — если изменен адрес доставки, курьер сбрасывается;
* '''Район или дата план. доставки''' — если изменен адрес доставки или плановая дата вручения, курьер сбрасывается.
=== Описание полей запроса изменения ===
Все поля запроса соответствуют структуре order при создании заказа за исключением:
* значение '''orderno''' данным методом изменить нельзя.
* значение '''barcode''' изменяется в случае явного его указания. В случае отсутствия или пустого значения - остается прежним.
* вместо корневого тэга '''neworder''' указывается '''editorder''';
* тэг курьера '''courier''' можно изменить только при включенной настройке '''Разрешить изменение курьера по АПИ''';
* для вложений '''item''' указывается внутренний код вложения в атрибуте '''code''', который можно получить при получении статуса заказа.
* для мест '''package''' указывается внутренний код вложения в атрибуте '''code''', который можно получить при получении статуса заказа.
Необходимо иметь в виду, что:
# Заказ нельзя изменить, пока он не синхронизирован с системой (пока предыдущие изменения не переданы в бэк-офис)
# Удаление вложений и мест выполняется не моментально, а в процессе синхронизации с бэк-офисом (для записей указываются метки Удалено)
=== Описание полей ответа изменения ===
Все поля ответа соответствуют ответу при создании заказа за исключением корневого тэга — вместо '''neworder''' возвращается '''editorder'''.
== Отмена заказа ==
Запрос предназначен для отмены заказов.
Отменять заказы могут курьерские службы с тарифами «Премиум» и «Максимум». Разрешения для отмены заказов и статусы в которых заказы можно отменять описаны в разделе '''Изменение заказов'''
При отмене заказа поле «Инфо о доставке» получает значение «Отменено заказчиком», поле «Дата доставки» — текущую дату, а «Вручил курьер» — системную запись «ОТМЕНА».
'''Пример запроса справочника городовотмены заказа:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?><townlistcancelorder> <auth extra="8" login="login" pass="pass" /> <codesearchorder orderno="" ordercode="123456" /> <zipcode>110000 <order orderno="123aaa" ordercode="" /zipcode> <kladrcode>0100000100800</kladrcodecancelorder> <fiascode>bd21979d-46f8-49d0-9105-e8d65172a983</fiascodesource> <code>123</code> </codesearch> <conditions>'''Описание полей:''' '''cancelorder''' — Корневой контейнер. Обязательный элемент.* '''auth''' — Авторизация. Обязательный элемент. <city>Краснодарский край</city>* '''order''' — Контейнер отменяемого заказа. Обязательный элемент. Запрос может содержать более одного контейнера '''order'''. Атрибуты: <namecontains>новгород</namecontains>:* '''''orderno''''' — Шифр заказа. <namestarts>Моск</namestarts>:* '''''ordercode''''' — Внутренний код заказа. <name>Москва</name>Обратите внимание, что должен быть указан хотя бы один из атрибутов ''orderno'' или ''ordercode''! <fullname>Москва город</fullname> <country>1</country> </conditions>'''Пример ответа:''' <limitsource lang="xml"> <limitfrom>30</limitfrom?xml version="1.0" encoding="UTF-8" ?> <limitcount>10</limitcountcancelorder> <countall>YES <order orderno="123test" ordercode="123456" error="0" errormsg="OK" errormsgru="Успешно" /countall> <order orderno="123aaa" ordercode="" error="52" errormsg="order not found" errormsgru="Заказ не найден" /limit></townlistcancelorder>
</source>
'''Описание полей:''' '''addattachments''' — Корневой контейнер. Обязательный элемент.*'''limitauth''' - Ограничивает вывод результата — Авторизация. Обязательный элемент.:* '''limitfromorderno''' - Задает номер записи результата, начиная — Номер заказа. Обязательный элемент. Может использоваться тэг <ordercode> с которой выдавать ответуказанием внутреннего кода заказа. По-умолчанию - 0* '''attachments''' — Обязательный элемент, в котором перечисляются передаваемые данные файлов.:** '''limitcountitem'''- Задает количество записей результата — Бинарные данные (файл), которые нужно вернутьзакодированные в base64. По-умолчанию - 10000Обязательный элемент.:* ** '''name''' — Атрибут элемента '''countallitem''' - YES указывает на необходимость подсчета общего количества найденных совпадений, в котором передается имя файла. Это может замедлять выполнение запроса. Если отключено - в ответе не указываются totalcount и totalpagesОбязательный элемент.
'''Пример ответа:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<townlist countaddattachments> <attachments> <item name="3photo1.jpg" pageerror="10" totalcounterrormsg="3OK" totalpageserrormsgru="1Успешно"> <town> <code>26379</code> <city> <code>23<item name="photo2.jpg" error="0" errormsg="OK" errormsgru="Успешно" /code> <name>Краснодарский край </nameattachments> </cityaddattachments> <name>Сочи город</namesource> <fiascode>79da737a-603b-4c19-9b54-9114c96fb912</fiascode> <kladrcode>2300000700000</kladrcode>== Получение вложений к накладной == <shortname /> (not yet supported)'''Пример запроса:''' <typename /source lang="xml"> (not yet supported) <coords lat?xml version="431.58550" lonencoding="39.7231UTF-8" /?> </townattachments> <townauth extra="8" login="login" pass="pass" /> <codeorderno>403311234567</codeorderno> <city/attachments> <code>32</codesource> <name>Брянская область</name> </city>'''Описание полей:''' '''attachments''' — Корневой контейнер. Обязательный элемент.* '''auth''' — Авторизация. Обязательный элемент. <name>Сочилов хутор<* '''orderno''' — Номер/name>код заказа. Обязательный элемент. <fiascode>c9c96c67-2cc9-4f10-afde-fd32417ea216</fiascode> <kladrcode>3201900011100</kladrcode> <shortname />'''Пример ответа:''' <typename /source lang="xml"> <coords lat?xml version="521.64070" lonencoding="33.1724UTF-8" /?> </townattachments> <townitem name="doc1.docx" size="35654">JVBERi0xLjMN <code>114016</code> JUBQREYwMTIzNDU2Nzg5IDI NMyAwIG9iag08PA0vVHlwZSA <city> U3VidHlwZSAvSW1hZ2UNL1d pZHRoIDE4MDgNL0hlaWdodCA <code>60</code> ggNCAwIFINL0JpdHNQZXJDb 21wb25lbnQgMQ0vRGVjb2RlU <name>Псковская область</name> ENL0NvbHVtbnMgMTgwOA0+P g0vSW1hZ2VNYXNrIHRydWUNL XhEZWNvZGUNPj4Nc3RyZWFt DQ</cityitem> <item name>Сочихино деревня</name> <fiascode>10df7588-19c1-49d1-a387-9de1cf3eb26f</fiascode> <kladrcode>6001900015400</kladrcode> <shortname /> <typename /> <coords lat="56photo2.6003jpg" lonsize="29.354274861" />VBERi0xLjMN JUBQREYwMTIzNDU2Nzg5IDI NMyAwIG9iag08PA0vVHlwZSA vWE9iamVjdA0vU3VidHlwZS AvSW1hZ2UNL1dpZHRoIDEzNj gNL0hlaWdodCAxMzMzDS9MZ W5ndGggNCAwIFINL0JpdHNQZ XJDb21wb25lbnQgMQ0vRGVj b2RlUGFybXMgPDwNL0sgLTEN L0NvbHVtbnMgMTM2OA0+Pg0 vSW</townitem></townlistattachments>
</source>
В ответе города сортируются по популярности, важности тегах item возвращаются бинарные данные (районные центры и т.д.файлы), и только затем - по алфавитузакодированные в base64.
== Справочник регионов Изменение статуса агентом ==Запрос изменения статуса заказа позволяет установить окончательный статус заказа — «Доставлен» или «Не доставлен (Возврат/Отмена)». Кроме этого, устанавливается дата и время (при необходимости) изменения статуса, а также сообщение в поле ''Инфо о доставке''. При необходимости к заказу можно прикрепить изображения.
'''Пример ответазапроса изменения статуса:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?><regionlist countsetorderinfo> <auth extra="8" login="2login" pass="pass"/> <cityorder ordercode="123456"> <codemessage>80Получил Иванов</codemessage> <countryoutstrbarcode> <code>17654312</codeoutstrbarcode> <name>Россия </nameorder> <id>643</idorder ordercode="234567"> <ShortName1status>RUPICKUPREADY</ShortName1status> <ShortName2eventtime>RUS2016-05-30 10:20:00</ShortName2eventtime> <message>Клиент отказался от покупки</countrymessage> <namepaytype>Агинский Бурятский автономный округCASH</name> </city> <citypaytype> <codestoreprice>1123</codestoreprice> <countryitems> <item code>="34533" quantity="1<" reason="0" governmentCode="11223311" /code> <nameitem code="34456" quantity="0" reason="0" />Россия <item code="34421" quantity="2" reason="0" /name> <id>643 </iditems> <ShortName1image filename="filename1.jpg">RU</ShortName1>9j/4AAQSkZJRgA <ShortName2>RUS< BAQAAAQABAAD/ShortName2>2wBDAA0JCg sKCA0LCgsODg0PEyAVExISEy ccHhcgLikxMC4pLSwzOko+M zZGNywtQFdBRkxOUlNSMj5aY <VpQYEpRUk//country>2wBDAQ4ODhMR EyYVFSZPNS01T09PT09PT09P T09PT09PT09PT09PT09PT09 PT09PT09PT09PT09PT09PT09 <name>Адыгея республикаPT09PT0//wAARCAYACAADAS IA</nameimage> </cityorder></regionlistsetorderinfo>
</source>
'''Описание полей запроса статуса:''' '''setorderinfo''' — Корневой контейнер. Обязательный элемент.* '''auth''' — Авторизация. Обязательный элемент.* '''order''' — Контейнер заказа. Обязательный элемент. Запрос может содержать более одного контейнера '''order'''. Атрибут '''''ordercode''''' — внутренний код заказа.* '''status''' — Новый статус заказа. Доступны статусы из раздела [[#Описание полей ответа статусов]], кроме AWAITING_SYNC и NEW.* '''eventtime''' — Дата и время изменения статуса. Обязательно при указании статуса.* '''message''' — Текст сообщения ''Инфо о доставке''.* '''outstrbarcode''' — код у подрядчика (код заказа во внешней системе). Используется в интеграциях с внешними системами.* '''paytype''' — Тип оплаты заказа. Допустимые значения CASH/CARD.* '''storeprice''' — Агентское вознаграждение.* '''items''' — Контейнер для описания вложений '''item''' . Атрибуты::* '''''code''''' — Код вложения.:* '''''quantity''''' — Количество доставленных единиц вложения.:* '''''reason''''' — Причина недоставки, выбирается из соответствующего списка статусов.:* '''''governmentCode''''' — Указание кода ТН для вложения при необходимости.* '''image''' — Контейнер прикрепляемого изображения. Содержит текст файла изображения, закодированный по стандарту ''base64''. Контейнер '''order''' может содержать более одного контейнера '''image'''. Атрибут::* '''''filename''''' — Имя файла. '''Пример запроса справочника улицответа:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<streetlistsetorderinfo> <conditions> <town>Москва город</town> // ОБЯЗАТЕЛЬНОЕ ПОЛЕ! <namecontains>Хохло</namecontains> <namestarts>Академика Х</namestarts> <name>Академика Хохлова</name> <fullname>Академика Хохлова ул.</fullname> </conditions> <limit> <limitfrom>30</limitfrom> <limitcount>10</limitcount> <countall>YES<order ordercode="123456" error="0" errormsg="OK" errormsgru="Успешно" /countall> <order ordercode="234567" error="59" errormsg="value [date_put] is already set" errormsgru="Значение [Дата доставки] уже указано" /limit></streetlistsetorderinfo>
</source>
<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?><streetlist countwaybill> <auth extra="18" pagelogin="1login" totalcountpass="3" totalpages="1pass"/> <streetorders> <nameorder orderno="1234567" ordercode="33331" />Академика Хохлова ул. <order orderno="1234568" ordercode="33332" /name> <shortname>Академика Хохлова </shortnameorders> <typenameform>ул.1</typenameform> <start>5</streetstart></streetlistwaybill>
</source>
'''Пример запроса справочника номенклатурыответа:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8" ?><itemlistwaybill> <auth extra="8" login="login" pass="pass"></authcontent>EODIcaI8KSBlwQ 4MnEOR7Px8U8EBAyGICBnwpw <codesearch> <code>123456< IZhQgz0ZxuPs8EBM/code>GcbjzB AwhBl8hwQYIO00GmEwg1CeEG <article>FD343</article> mqYTChNU0wqf8l8nz4zgc+K fCno+zwU5GjOZmzXGcbEQYIM <barcode>2345625213125</barcode> 4zkegRE40zWzONyoNNMIOIa cWnp6aDCGEGE9NQmoQd2mg00 < 79U4f3hPTwnfp6Sdrafeqpa JDpFw/codesearch>1aYT077VNNNdO00G3q <conditions> <namecontains>телевизор</namecontains> <namestarts>sony</namestarts> <name>Sony KDL-55W905 ЖК-телевизор</name> <quantity>EXISTING_ONLY</quantity> < mqqvp9p2E7T0/conditions> <limit> <limitfrom>30</limitfrom> <limitcount>10</limitcount> <countall>YES</countall> wiFemv8uG6 OM</limitcontent></itemlistwaybill>
</source>
'''Обратите внимание''', что печатные формы для заборов не формируются. '''Пример ответас ошибкой:'''<source lang="xml"><?xml version="1.0" encoding="UTF-8"?><waybill> <error>Текст ошибки</error></waybill></source> == Справочник городов =='''Пример запроса справочника городов:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<itemlist counttownlist> <auth extra="3" totalcount="3" page="1" totalpages="18"/> <itemcodesearch> <codezipcode>123456110000</codezipcode> <articlekladrcode>FD3430100000100800</articlekladrcode> <barcodefiascode>2345625213125bd21979d-46f8-49d0-9105-e8d65172a983</barcodefiascode> <namecode>Sony KDL-55W905 ЖК-телевизор123</namecode> <retprice/codesearch>65000 </retpriceconditions> <purchpricecity>50000Краснодарский край</purchpricecity> <weightnamecontains>5.1новгород</weightnamecontains> <lengthnamecontainsparts>50молоково моск</lengthnamecontainsparts> <widthnamestarts>30Моск</widthnamestarts> <heightname>40Москва</heightname> <CountInPalletfullname>30Москва город</CountInPalletfullname> <HasSerialscountry>1</HasSerialscountry> <CountryOfOrigin>Малайзия </CountryOfOriginconditions> (not yet supported) <Message>Хороший телевизор</Messagelimit> <Message2limitfrom>Снова хороший телевизор30</Message2limitfrom> <quantitylimitcount>1210</quantitylimitcount> <reservedcountall>3YES</reservedcountall> <item/limit> ...</itemlisttownlist></source> '''Описание полей:'''*'''code''' - Внутренний идентификатор, присвоенный системой.*'''article''' - Артикул, назначенный клиентом (поставщиком).*'''barcode''' - Штрих-код производителя.*'''name''' - Наименование.*'''retprice''' - Розничная цена по-умолчанию. При оформлении заказа цена используется та, которая указана в заказе.*'''purchprice''' - Закупочная цена.*'''weight''' - Масса в килограммах.*'''length''' - Длина в сантиметрах.*'''width''' - Ширина в сантиметрах.*'''height''' - Высота в сантиметрах.*'''CountInPallet''' - Количество штук в паллете.*'''HasSerials''' - Требует учета серийных номеров. Принимает значения 1 - даВнутри контейнера townlist все элементы могут как отсутствовать, 0 - нет.*'''CountryOfOrigin''' - Наименование страны происхождения на русском языке.*'''Message''' - Комментарийтак и комбинироваться.*'''Message2''' - Дополнительный комментарий.*'''quantity''' - Количество на складе. Товары, уже собранные в заказы в этом количестве Поиск не присутствуют, считаются покинувшими товарный склад. ''Это поле может быть недоступным в некоторых установках.''*'''reserved''' - Количество зарезервированного товара. Может превышать остаток на складе, если покупатели ждут следующей поставки. ''Это поле может быть недоступным в некоторых установкахчувствителен к регистру.''
* '''Пример запроса движения номенклатурыcodesearch''' — Поиск по кодам. В случае использования — контейнеры conditions и limit игнорируются.:* '''zipcode''' — Поиск по индексу. Обратите внимание на то, что один почтовый индекс может распространяться на несколько населенных пунктов. В этом случае система вернет несколько записей.<source lang="xml">:* '''kladrcode''' — Поиск по 13-ти значному коду КЛАДР.<?xml version="1:* '''fiascode''' — Поиск по коду ФИАС (AOGUID).0" encoding="UTF-8" ?><itemmovements> <auth extra="8" login="login" pass="pass"></auth> <:* '''code>4259</code></itemmovements></source>''' — Поиск по коду в системе.
*'''codeconditions''' — Задает условия поиска. Все вложенные элементы одновременно накладывают условие «И».:* '''city''' — Поиск по всем населенным пунктам региона.:* '''namecontainsparts''' — Поиск населенных пунктов, название которых содержит все указанные слова, с разбиением поисковой фразы через пробел. Например "моск моло" найдет деревню "Молоково" в Московской области.:* '''namecontains''' — Поиск населенных пунктов, название которых содержит указанный текст.:* '''namestarts''' — Поиск населенных пунктов, название которых начинается с указанного текста.:* '''name''' — Поиск населенных пунктов, название которых соответствует указанному тексту.:* '''fullname''' — Поиск населенных пунктов, название вместе с типом населенного пункта которых соответствует указанному тексту.:* '''country''' — Поиск только по стране с указанным внутренним кодом или текстовым кодом в соответствии [https://ru.wikipedia.org/wiki/ISO_3166- внутренний код товара в справочнике номенклатуры1 стандартом ISO_3166-1], например, «RU», «RUS» для России.
* '''limit''' — Ограничивает вывод результата.
:* '''limitfrom''' — Задает номер записи результата, начиная с которой выдавать ответ. По-умолчанию — 0.
:* '''limitcount'''- Задает количество записей результата, которые нужно вернуть. По-умолчанию — 10000.
:* '''countall''' — YES указывает на необходимость подсчета общего количества найденных совпадений. Это может замедлять выполнение запроса. Если отключено — в ответе не указываются totalcount и totalpages.
'''Пример ответа движения номенклатуры:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8" ?><itemmovements townlist count="163" page="1" totalcount="3" totalpages="1"> <itemmovementtown> <code>15150026379</code> <datecity> <code>2017-05-2623</datecode> <retpricename>0Краснодарский край</retpricename> <quantity>1</quantitycity> <deliveredname>0Сочи город</deliveredname> <itemfiascode> <code>425979da737a-603b-4c19-9b54-9114c96fb912</codefiascode> <namekladrcode>Настольная игра Дженга2300000700000</namekladrcode> <shortname /item> (not yet supported) <statustypename /> (not yet supported) <codecoords lat="43.5855" lon="39.7231" />5 </codetown> <nametown>Возврат от покупателя </namecode> 40331</statuscode> <storecity> <code>132</code> <name>офис в МосквеБрянская область</name> </storecity> <order> <ordercodename>3374830Сочилов хутор</ordercodename> <numberfiascode>123660c9c96c67-2cc9-4f10-afde-0fd32417ea216</numberfiascode> <datekladrcode>2017-05-243201900011100</datekladrcode> <ordernoshortname />14123 <typename /orderno> <barcodecoords lat="52.6407" lon="33.1724" />0000000670 </barcodetown> <company>ТОВАР</companytown> <addresscode>Кравченко ул., 1114016</addresscode> <delivereddate>2017-05-29 </delivereddatecity> <deliveredtimecode>12:00:0060</deliveredtimecode> <deliveredto name>Псковская область</name> </ordercity> <document> <codename>21991Сочихино деревня</codename> <numberfiascode>31810df7588-19c1-49d1-a387-9de1cf3eb26f</numberfiascode> <datekladrcode>2017-05-266001900015400</datekladrcode> <messageshortname /> <typename /message> <coords lat="56.6003" lon="29.3542" /document> </itemmovementstown></itemlisttownlist>
</source>
<source lang="xml">
<?xml version="1.0" encoding="UTF-8" ?><pvzlistregionlist count="2"> <city> <auth extra="8" login="login" pass="pass"code>80</authcode> <country> <code>12341</code> <townname>Нижний ТагилРоссия</townname> <parentcodeid>6643</parentcodeid> <acceptcashShortName1>YESRU</acceptcashShortName1> <acceptcardShortName2>RUS</ShortName2>YES </acceptcardcountry> <name>Агинский Бурятский автономный округ<acceptfitting/name>YES </acceptfittingcity> <city> <maxweightcode>301</maxweightcode> <acceptindividualscountry>YES <code>1</acceptindividualscode> <ltname>57.924737Россия</ltname> <lgid>59.940019643</lgid> <rtShortName1>57.905682RU</rtShortName1> <rgShortName2>59.984669RUS</rgShortName2> <json/country>YES <name>Адыгея республика</name> </jsoncity></pvzlistregionlist>
</source>
<source lang="xml">
<?xml version="1.0" encoding="UTF-8" ?><pvzlist count="2"streetlist> <pvzconditions> <codetown>126Москва город</codetown> <clientcode>3< /clientcode> <name>Нижний Тагил</name>ОБЯЗАТЕЛЬНОЕ ПОЛЕ! <parentcodenamecontains>6Хохло</parentcodenamecontains> <parentnamenamestarts>ИнтеграцияАкадемика Х</parentnamenamestarts> <town code="124267"name>Нижний Тагил городАкадемика Хохлова</townname> <addressfullname>622036, г. Нижний Тагил, Академика Хохлова ул. Циолковского, д. 17</addressfullname> <phone>+73435417709, +73435254989 </phoneconditions> <comment>Новый пункт доставки</comment> <worktime>Вс 10:00-16:00, Сб 10:00-16:00, Пн-Пт 10:00-20:00 </worktimelimit> <traveldescriptionlimitfrom>Жилое 5-ти этажное здание, торцом к дороге, второе здание от перекрестка Пархоменко-Циолковского30</traveldescriptionlimitfrom> <maxweightlimitcount>10</maxweightlimitcount> <acceptcashcountall>YES</acceptcashcountall> <acceptcard>YES </acceptcardlimit> <acceptfitting>YES</acceptfittingstreetlist> <acceptindividuals>YES</acceptindividualssource> <latitude>57* '''conditions''' — Задает условия поиска. Все вложенные элементы одновременно накладывают условие «И».93457</latitude> <longitude>59:* '''town''' — Обязательное поле. Название или код населенного пункта.95131</longitude> </pvz>:* '''namecontains''' — Поиск улиц, название которых содержит указанный текст. <pvz>:* '''namestarts''' — Поиск улиц, название которых начинается с указанного текста. <code>245</code> <clientcode>NTG1</clientcode> <:* '''name>На Красноармейской</name>''' — Поиск улиц, название которых соответствует указанному тексту. <parentcode>6</parentcode>:* '''fullname''' — Поиск улиц, для которых название вместе с типом соответствует указанному тексту. <parentname>Интеграция</parentname> <town code="124267">Нижний Тагил город</town>* '''limit''' — Ограничивает вывод результата. <address>КРАСНОАРМЕЙСКАЯ:* '''limitfrom''' — Задает номер записи результата, дначиная с которой выдавать ответ.79</address> <phone>+7(3435)379По-044</phone>умолчанию — 0. <comment>Возможность примерки отсутствует</comment> <worktime>Вс 10:00* '''limitcount'''-16:00Задает количество записей результата, Сб 10:00которые нужно вернуть. По-16умолчанию — 10000.:00, Пн-Пт 10:00-20:00</worktime> <traveldescription>Напротив ТЦ Пирамида</traveldescription> <maxweight>20</maxweight> <acceptcash>* '''countall''' — YES</acceptcash> <acceptcard>YES</acceptcard> <acceptfitting>NO</acceptfitting> <acceptindividuals>YES</acceptindividuals> <latitude>57указывает на необходимость подсчета общего количества найденных совпадений. Это может замедлять выполнение запроса.93468</latitude> <longitude>60Если отключено, в ответе не указываются totalcount и totalpages.55476</longitude> </pvz></pvzlist></source>
<source lang="xml">
<?xml version="1.0" encoding="UTF-8" ?><servicesstreetlist count="1" page="1" totalcount="3" totalpages="1"> <street> <code>124</code> <name>Академика Хохлова ул.</name> <shortname>Академика Хохлова</shortname> <typename>ул.</typename> <auth extra="8"/street></servicesstreetlist>
</source>
В ответе улицы сортируются по алфавиту. == Справочник номенклатуры =='''Пример ответа запроса справочника Видов срочностиноменклатуры:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8" ?>
<services countitemlist> <auth extra="28" login="login" pass="pass"></auth> <servicecodesearch> <code>1123456</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> </serviceconditions> <serviceexcept> <code>2123478</code> </except> <namelimit> <limitfrom>30</limitfrom> <limitcount>10</limitcount> <countall>СрочноYES</namecountall> </servicelimit></servicesitemlist>
</source>
* '''Пример запроса стоимости доставкиlimit''' — Ограничивает вывод результата.:* '''<source lang="xml"><?xml version="1limitfrom''' — Задает номер записи результата, начиная с которой выдавать ответ.0" encoding="UTF-8" ?><calculator> <auth extra="8" login="login" pass="pass" /> <calc townfrom="Москва" townto="3800000300000" l="10" w="20" h="30" mass="3:* '''limitcount''' — Задает количество записей результата, которые нужно вернуть.7" service="1" /></calculator></source>
<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<calculatoritemlist count="3" totalcount="3" page="1" totalpages="1"> <calcitem> <townfrom code="1">Москва город123456</townfromcode> <townto code="56603"article>Иркутск городFD343</towntoarticle> <massbarcode>3.72345625213125</massbarcode> <service name="Экспресс">Sony KDL-55W905 ЖК-телевизор</name> <retprice>65000</retprice> <purchprice>50000</purchprice> <weight>5.1</serviceweight> <zonelength>50</length> <width>30</width> <height>40</height> <VATrate>20</VATrate> <CountInPallet>30</CountInPallet> <CountInBox>2</zoneCountInBox> <HasSerials>1</HasSerials> <priceCountryOfOrigin>1163Малайзия</priceCountryOfOrigin> (not yet supported) <mindeliverydaysMessage>1Хороший телевизор</Message> <Message2>Снова хороший телевизор</Message2> <quantity>12</mindeliverydaysquantity> <maxdeliverydaysreserved>3</maxdeliverydaysreserved> </calcitem> ...</calculatoritemlist>
</source>
<source lang="xml">
<?xml version="1.0" encoding="UTF-8" ?>
<smalistitemmovements> <auth extra="8" login="login" pass="pass" ></auth> <code>4259</code> <datefrom>20162020-0210-1001</datefrom> <dateto>20162020-0310-1002</dateto></smalistitemmovements>
</source>
'''Пример ответа на запрос списка актов передачи денегдвижения номенклатуры:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?><smalist itemmovements count="116"> <smaitemmovement> <code>6278151500</code> <numberdate>39922017-05-26</numberdate> <actdateretprice>2016-02-120</actdateretprice> <datepayquantity>1</datepayquantity> <datetodelivered>2016-02-120</datetodelivered> <promiseddatepayitem> <code>4259</promiseddatepaycode> <name>Настольная игра Дженга</name> </item> <pricestatus> <code>5</code> <name>Возврат от покупателя</name>637.00 </pricestatus> <pricecorrstore>113.00 <code>1</code> <name>офис в Москве</name> </pricecorrstore> <rurorder>13430 <ordercode>3374830</ordercode> <number>123660-0</number> <date>2017-05-24</date> <orderno>14123</orderno> <barcode>0000000670</barcode> <company>ТОВАР</company> <address>Кравченко ул.00, 1</address> <delivereddate>2017-05-29</rurdelivereddate> <pricekurdeliveredtime>570.12:00:00</pricekurdeliveredtime> <priceagdeliveredto />67.00 </priceagorder> <paynodocument>42423 <code>21991</paynocode> <paytypenumber>1318</paytypenumber> <paytypenamedate>Безнал2017-05-26</paytypenamedate> <message><signedcopyreceived/message>NO </signedcopyreceiveddocument> </smaitemmovements></smalistitemlist>
</source>
* '''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''' — комментарий == Детализация актов передачи денег Получение справочника тарифов по городам ==
'''Пример запроса детализации актов передачи денег:справочника тарифов по городам'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8" ?><smadetailtariffs> <auth extra="8" login="login" pass="pass" /> <codetownfrom>6278Москва</codetownfrom> <service>1</smadetailservice> <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>
'''smadetailОписание полей ответа ''' * '''townfrom''' — код ФИАС города- Корневой контейнеротправителя. Обязательный элемент* '''service''' — режим доставки.* '''tariffs''' — cписок тарифов по городу.:* '''townregion''' — регион города-получателя.:*'''authtowntofias''' — код ФИАС города- Авторизацияполучателя. Обязательный элемент:* '''towntocode''' — внутренний код города-получателя.:*'''codetowntoname''' — наименование города- Код акта передачи денег (смполучателя.:* '''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"?><smadetail countitemdoc> <auth extra="28" login="login" pass="pass"> <specialsma/auth> <code>4249421991</code> <ordercode>14424</ordercodeitemdoc> <orderno>11111</ordernosource> <orderdate>2018-01-01</orderdate> <delivereddate>2018-10-01</delivereddate>* '''code''' — внутренний код документа приходной накладной (см. предыдущий запрос). <company>Компания</company>'''Пример ответа движения номенклатуры:''' <price>314.00</pricesource lang="xml"> <rur>8800?xml version="1.00</rur0" encoding="UTF-8" ?> <inshprice>314.00</inshpriceitemdoc> <pricekurcode>270.0021991</pricekurcode> <priceagnumber>44.00318</priceagnumber> <pricecalcdate>8486.002017-05-26</pricecalcdate> <paytypemessage>2</paytypemessage> <paytypename>наличными курьером </paytypenameitems> <statusitem code="4259" quantity="1" barcode="200300" article="123555">ДоставленоНастольная игра Дженга</statusitem> </specialsmaitems></smadetailitemdoc>
</source>
<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<shortlinkmanifest> <hashresult error="Текст ошибки">35AF350CERROR</hashresult></shortlinkmanifest>
</source>