Изменения

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

API

9747 байт добавлено, 08:41, 9 июля 2020
Справочник дополнительных услуг
{| class="wikitable" align="center" style="width: 80%; margin: auto; color: black; boreder: 1px solid #999999;" cellpadding="10" cellspacing="0"
!style="width: 35%;"|Система управления контентом (CMS)
!style="width: 15%;"|Версия модуля
!style="width: 15%;"|Ссылка
!style="width: 35%;"|Примечание
|-
|[[Файл:bitrix.png|center|x44px]]
|style="text-align: center;"|1.5.9 от 13.12.2018
|style="text-align: center;"|[http://marketplace.1c-bitrix.ru/solutions/measoft.courier/ Установить] <!-- [http://courierexe.ru/download/api/bitrix.zip Скачать Unicode]<br>[http://courierexe.ru/download/api/bitrix_ansi.zip Скачать ANSI] -->
|Поддерживает версии 14.5 и выше
|-
|[[Файл:prestashop.png|center|x44px]]
|style="text-align: center;"|1.4.5 от 10.10.2018
|style="text-align: center;"|[http://courierexe.ru/download/api/prestashop.zip Скачать]
|Поддерживает версии 1.5.2.0 и выше (2.x в том числе!)
|-
|[[Файл:OpencartOCStore.png|center|x44px]]
|style="text-align: center;"|1.7.5 от 10.08.2018<br>2.0.0 от 01.12.2018<br>3.1.1 от 28.02.2019|style="text-align: center;"|[http://courierexe.ru/download/api/opencart.zip Скачать]<br><br>[http://courierexe.ru/download/api/opencart_2measoft_oc2.ocmod.zip Скачать]<br><br>[http://courierexe.ru/download/api/opencart_3measoft_ос3.ocmod.zip Скачать]
|Поддерживает версии с 1.5.5.1<br>Версия 2.0.0 поддерживает версии с 2.0<br>[https://opencartforum.com/files/file/2906-avtomatizaciya-otpravki-i-otslezhivanie-dostavok-courierexe-dlya-opencart-15x/ Альтернативный модуль сторонних разработчиков]
|-
|[[Файл:webasyst-shopscript.png|center|x44px]]
|style="text-align: center;"|1.3.5 от 14.03.2018<br>1.3.4 от 02.03.2019
|style="text-align: center;"|[http://www.webasyst.ru/store/plugin/shop/measoftcourier/ Установить модуль]<br>[https://www.webasyst.ru/store/plugin/shipping/measoftcourier/ Установить плагин]
|Модуль предназначен для отправки заявок в КС, а плагин для расчета стоимости доставки при оформлении заказа.
|-
|[[Файл:advantshop.png|center|x44px]]
|style="text-align: center;"|[https://promo-z.ru/ Сайт компании PROMO]
|Компания PROMO разработала этот модуль и настраивает интеграцию КС 2008 с ADVANTSHOP своим клиентам.
|-
|[[Файл:insales.png|center|x44px]]
|style="text-align: center;"|1.2.1 от 06.09.2017
|style="text-align: center;"|[http://www.insales.ru/collection/all/product/kurierskaya-sluzhba-2008 Установить]
|[http://wiki.courierexe.ru/index.php?title=Интеграция_с_другими_системами#Insales Настраивается] в ЛК пользователя в системе
|-
|[[Файл:Leadvertex.png|center|x44px]]
|style="text-align: center;"|1.0 от 15.11.2016
|style="text-align: center;"|[[Файл:Leadvertex-howto.png|center|x44px]]
|[http://blog.leadvertex.ru/news/2110-integraciya-s-kurerkami-na-platforme-measoft/ Настраивается] в ЛК пользователя в системе [https://Leadvertex.ru Leadvertex]
|-
|[[Файл:Retailcrm.png|center|x44px]]
|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;"|1.4 от 17.11.2017
|style="text-align: center;"|-
|[https://infostart.ru/public/692790/ Альтернативный модуль сторонних разработчиков]
|-
|[[Файл:Joomla2.jpg|center|x44px]]
|style="text-align: center;"|1.0.0 от 12.11.2018
|style="text-align: center;"|[http://courierexe.ru/download/api/com_measoft.zip Скачать]
|Работает только с компонентом Virtuemart. Внимание! Модуль новый, поэтому возможна некорректная передача данных. Проверяйте, если что - сообщайте, исправим!
|-
|[[Файл:Amocrm.png|center|x44px]]
|style="text-align: center;"|-
|style="text-align: center;"|[https://www.amocrm.ru/extensions/courier2008 Установить]
|Внимание! Модуль новый, поэтому возможна некорректная передача данных. Проверяйте, если что - сообщайте, исправим!
|-
|[[Файл:MoySclad.jpg|center|x44px]]
|style="text-align: center;"|-
|style="text-align: center;"|[https://home.courierexe.ru/moysklad/step1 Подключение] [[Интеграция с другими системами#Мой Склад|Инструкция]]
|Ожидается в ближайшее время в магазине Мой Склад
|-
|[[Файл:wordpress.jpg|center|x80px]]
|style="text-align: center;"|WordPress от 5 версии
 
WooCommerce от 3.9 версии
|style="text-align: center;"|[http://courierexe.ru/download/api/wordpress.zip Скачать] [[Интеграция с другими системами#Wordpress|Инструкция]]
|Внимание! Модуль новый, поэтому возможна некорректная передача данных. Проверяйте, если что - сообщайте, исправим!
Для отображения списка пунктов выдачи есть '''готовый JavaScript модуль''': https://home.courierexe.ru/js/measoft_map.js Инструкция по использованию - внутри.Посмотреть пример работы можно [https://home.courierexe.ru/pvz_test.html Здесь]
Данные модули распространяются бесплатно, без каких-либо гарантий со стороны разработчика. Их наличие не нужно рассматривать как средство полной автоматизации взаимодействия с курьерской службой, а скорее как помощь разработчикам интернет-магазинов в построении интеграции с курьерскими службами. В любом случае нужно понимать, что ответственность за корректность передачи данных лежит на интернет-магазине. Однако, мы будем очень признательны, если Вы будете нам сообщать о своих потребностях и/или найденных неточностях в наших модулях, это позволит нам учитывать пожелания в новых версиях.
<inshprice>387.5</inshprice>
<receiverpays>NO</receiverpays>
<discount>120</discount>
<enclosure>Детские игрушки</enclosure>
<instruction>Проверить при покупателе, подписать акт</instruction>
<items>
<item extcode="abc123" quantity="1" mass="0.2" retprice="37.5" VATrate="0" barcode="2345625213125" article="1" volume="3" origincountry="AUT" GTD="321546654" excise="15.20" suppcompany="ООО &quot;Рога и копыта&quot;" suppphone="79161234567" suppINN="1112223334" governmentCode="11223311">Мяч</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" article="3" type="1">Погремушка желтая</item>
</items>
<packages>
<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>
</order>
</neworder>
*'''return''' - Признак необходимости возврата.
*'''return_service''' - Режим возврата (тип услуги) передается код из справочника "Виды срочности".
*'''discount''' - Сумма скидки. Скидка "размазывается" по товарным вложениям, сумма НП уменьшается на сумму скидки. При этом вложение Скидка не создается. ВНИМАНИЕ, при использовании этого тега общая сумма может расходиться на копейки из-за округления! Старайтесь не использовать этот тег, а указывать цену товаров уже с учетом скидок.
*'''enclosure''' - Вложение.
*'''inshprice''' - Объявленная ценность. Если явно не указана сумма - автоматически считается как сумма по товарам.
*'''instruction''' - Поручение - Примечание.
*'''courier''' - Запланированный курьер. Согласно коду курьера в КС2008.
:* '''''height''''' - Высота единицы товара (в сантиметрах).
:* '''''retprice''''' - Цена единицы товара. Округляется до копеек. Должна быть с учетом всех скидок и наценок. Для вложений типов 1, 2, 3 не может быть отрицательной. <!-- , либо мы сами посчитаем скидку при указании тега order->discount -->
:* '''''inshprice''''' - Объявленная ценность единицы товара. Округляется до копеек. Если не указана принимается равной '''''retprice'''''.:* '''''VATrate''''' - Ставка НДС - целое число процентов. Если значение не указано, подставляется значение "20". Значение "0" означает ставку "Без НДС", ставка "0%" на данный момент не поддерживается.
:* '''''barcode''''' - Штрих-код вложения. [[Файл:Article.png|thumb|100px|right]]
:* '''''article''''' - Артикул вложения. ''Внимание!'' Указание артикула используется только тогда, когда товар хранится на ответственном хранении в службе доставки, и необходима комплектация. В этом случае система пытается привязать товар к [[API#Справочник номенклатуры|справочнику номенклатуры]]. Если товар в справочнике не найден - система выдаст соответствующую ошибку. Если по артикулу найдено несколько товаров - система выберет один из них случайным образом, что может привести к ошибочной комплектации! Если товар НЕ на ответственном хранении - артикул указывать НЕ нужно. Позиция попадет в систему просто текстом.
:* '''''below_sum''''' - граница стоимости выкупаемого заказа
:* '''''price''''' - стоимость выкупаемого заказа до соответствующей границы
 
* '''advprices''' - Контейнер для описания дополнительных услуг. Необязательный
:* '''''code''''' - код услуги
:* '''''value''''' - значение услуги. Если тип услуги bool, то в значении передаем true
 
*'''costcode''' - Кост-код сотрудника.
* '''deliveryprice''' - Стоимость услуг в валюте расчетов с клиентом. Атрибуты:
:* '''''total''''' - общая стоимость услуг
:* '''''delivery''''' - стоимость доставки"Туда":* '''''return''''' - стоимость возвратадоставки "Обратно" (если order->return=YES)
Тэг '''deliveryprice''' включает список дополнительных услуг (только для тарифа "Премиум"):
:* '''''advprice''''' - наименование дополнительной услуги
<?xml version="1.0" encoding="UTF-8"?>
<tracking>
<order orderno="1234111111"> <barcode>111111</barcode> <AWB>111111</AWB> <sender> <town code="1" country="RU">Москва город</town> <date>2014-03-22</date> <time_min>09:00</time_min> <time_max>14:00</time_max> </sender> <receiver> <town code="1" country="RU">Москва город</town> <zipcode>125480</zipcode> <date>20152014-0403-1822</date> <time_min>09:00</time_min> <time_max>14:00</time_max> </receiver> <price>387.5</price> <inshprice>387.5</inshprice> <AWBpaytype>BarCodeCASH</AWBpaytype> <weight>05.1</weight> <quantity>12</quantity> <service>2</service> <type>3</type> <return>NO</return> <return_service>2</service> <return_date></return_date> <return_time></return_time> <return_message></return_message> <waittime>12</waittime> <enclosure>Детские игрушки</enclosure> <instruction>Проверить при покупателе, подписать акт</instruction> <deliveryprice total="158.6" delivery="100.00" return="58.6" /> <courier> <code>26</code> <name>Иванов Владимир Петрович</name> <phone>+79161234567</phone> </courier> <currcoords lat="55.680327" lon="37.604456" accuracy="50" RequestDateTime="2014-04-21 18:07:45" /> <status eventstore="филиал в Санкт-Петербурге" eventtime="2016-06-02 17:22:00" createtimegmt="2016-06-03 16:14:44" message="" title="Доставлен" country="RU">COMPLETE</status> <statushistory> <status eventstore="Офис в Москве" eventtime="2016-05-30 10:20:00" createtimegmt="2016-06-03 16:14:44" message="" title="Новый" country="RU">NEW</status> <status eventstore="Офис в Москве" eventtime="2016-06-01 17:38:00" createtimegmt="2016-06-03 16:14:44" message="филиал в Санкт-Петербурге" title="Планируется отправка" country="RU">DEPARTURING</status> <status eventstore="Офис в Москве" eventtime="2016-06-01 19:53:00" createtimegmt="2016-06-03 16:14:44" message="филиал в Санкт-Петербурге" title="Отправлено со склада" country="RU">DEPARTURE</status> <status eventstore="филиал в Санкт-Петербурге" eventtime="2016-06-02 07:41:00" createtimegmt="2016-06-03 16:14:44" message="" title="Получен складом" country="RU">ACCEPTED</status> <status eventstore="филиал в Санкт-Петербурге" eventtime="2016-06-02 09:17:00" createtimegmt="2016-06-03 16:14:44" message="" title="Выдан курьеру на доставку" country="RU">DELIVERY</status> <status eventstore="филиал в Санкт-Петербурге" eventtime="2016-06-02 17:22:00" createtimegmt="2016-06-03 16:14:44" message="" title="Доставлен (предварительно)" country="RU">COURIERDELIVERED</status> <status eventstore="филиал в Санкт-Петербурге" eventtime="2016-06-02 17:22:00" createtimegmt="2016-06-03 16:14:44" message="" title="Доставлен" country>COMPLETE</status> </statushistory> <deliveredto>Иванова, секр.</deliveredto> <delivereddate>2016-06-02</delivereddate> <deliveredtime>17:22</deliveredtime> <outstrbarcode>EXT123456</outstrbarcode> <items> <item code="34533" extcode="abc123" quantity="1" mass="0.2" retprice="37.5" VATrate="0" barcode="2345625213125" article="1" returns="0" origincountry="040" GTD="" excise="0.00" governmentCode="11223311" suppcompany="Поставщик" suppINN="1112223334" suppphone="79161234567">Мяч</item> <item code="34456" extcode="abc124" quantity="2" mass="2" retprice="100" VATrate="10" barcode="4645625213138" article="2" returns="0" governmentCode="">Обруч</item> <item code="34421" extcode="abc125" quantity="3" mass="0.3" retprice="50" VATrate="18" barcode="2345625213126" article="3" returns="0" governmentCode="RU">COMPLETEПогремушка желтая</statusitem> </statushistoryitems> </order></tracking></source>  '''Получение информации в формате 17 TRACK''' '''Пример запроса:'''<source lang="xml"><?xml version="1.0" encoding="UTF-8"?><tracking17> <extra>8</extra> <orderno>1234</orderno></tracking17></source> '''Пример ответа:'''<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":"Delivery" }, { "time":"2016-06-02 07:41:00", "location":"RU", "content":"Accepted" }, { "time":"2016-06-01 19:53:00", "location":"RU", "content":"Departure" },
{
"time":"2016-06-01 02 17:3822:00",
"location":"RU",
"content":"DeparturingComplete"
},
{
"time":"2016-06-02 17:22:00", "location":"RU", "content":"Courierdelivered" }, { "time":"2016-06-02 09:17:00", "location":"RU", "content":"Delivery" }, { "time":"2016-06-02 07:41:00", "location":"RU", "content":"Accepted" }, { "time":"2016-06-01 19:53:00", "location":"RU", "content":"Departure" }, { "time":"2016-06-01 17:38:00", "location":"RU", "content":"Departuring" }, { "time":"2016-05-30 10:20:00",
"location":"RU",
"content":"New"
Описание контейнеров ответа аналогично описанию [[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><br /> === Описание полей запроса изменения ===Все поля запроса соответствуют структуре order при создании заказа за исключением:* вместо корневого тэга '''neworder''' указывается '''editorder'''* тэг штрих-кода '''barcode''' не указывается, поскольку присваивается при создании заказа. === Описание полей ответа изменения ===Все поля ответа соответствуют ответу при создании заказа за исключением корневого тэга - вместо '''neworder''' возвращается '''editorder'''. == Отмена заказа == Запрос отмены предназначен для отмены тех заказов, по которым не было произведено изменений - статуса доставки, статуса корреспонденции, времени доставки - то есть заказов, которые ещё не находятся в работе.Возможность отмены заказа есть только у курьерских служб с тарифом "Премиум" и по-умолчанию она выключена, ее нужно отдельно включить: [[Личный кабинет курьерской службы#Дополнительные настройки]]. При отмене заказа поле "Инфо о доставке" получает значение "Отменено заказчиком", поле "Дата доставки" - текущую дату, а "Вручил курьер" - системную запись "ОТМЕНА".  '''Пример запросаотмены заказа:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8" ?>
<attachmentscancelorder>
<auth extra="8" login="login" pass="pass" />
<order orderno="" ordercode="123456" />1234567 <order orderno="123aaa" ordercode="" /orderno></attachmentscancelorder>
</source>
'''Описание полей:'''
'''attachmentsОписание полей запроса статуса:''' '''cancelorder''' - Корневой контейнер. Обязательный элемент.
*'''auth''' - Авторизация. Обязательный элемент.
*'''ordernoorder''' - Номер/код Контейнер отменяемого заказа. Обязательный элемент.Запрос может содержать более одного контейнера '''order'''. Атрибуты::* '''''orderno''''' - Шифр заказа.:* '''''ordercode''''' - Внутренний код заказа.Обратите внимание, что должен быть указан хотя бы один из атрибутов ''orderno'' или ''ordercode''!
'''Пример ответа:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?><attachmentscancelorder> <item nameorder orderno="doc1.docx123test" sizeordercode="35654123456" error="0" errormsg="OK" errormsgru="Успешно">JVBERi0xLjMN JUBQREYwMTIzNDU2Nzg5IDI NMyAwIG9iag08PA0vVHlwZSA U3VidHlwZSAvSW1hZ2UNL1d pZHRoIDE4MDgNL0hlaWdodCA ggNCAwIFINL0JpdHNQZXJDb 21wb25lbnQgMQ0vRGVjb2RlU ENL0NvbHVtbnMgMTgwOA0+P g0vSW1hZ2VNYXNrIHRydWUNL XhEZWNvZGUNPj4Nc3RyZWFt DQ</item> <item nameorder orderno="123aaa" ordercode="photo2.jpg" sizeerror="7486152" errormsg="order not found" errormsgru="Заказ не найден">VBERi0xLjMN JUBQREYwMTIzNDU2Nzg5IDI NMyAwIG9iag08PA0vVHlwZSA vWE9iamVjdA0vU3VidHlwZS AvSW1hZ2UNL1dpZHRoIDEzNj gNL0hlaWdodCAxMzMzDS9MZ W5ndGggNCAwIFINL0JpdHNQZ XJDb21wb25lbnQgMQ0vRGVj b2RlUGFybXMgPDwNL0sgLTEN L0NvbHVtbnMgMTM2OA0+Pg0 vSW</item></attachmentscancelorder>
</source>
В тегах == Добавление вложений к накладной == '''Пример запроса:'''<source lang="xml"><?xml version="1.0" encoding="UTF-8" ?><addattachments> <auth extra="8" login="login" pass="pass" /> <orderno>1234567</orderno> <attachments> <item возвращаются бинарные данные (файлы), закодированные в base64name="photo1.jpg">JVBERi0xLjMN1wb25lbnQgMQ JUBQREYwMTIzNDU2Nzg5IDI NMyAwIG9iag08PA0vVHlwZSA U3VidHlwZSAvSW1hZ2UNL1d pZHRoIDE4MDgNL0hlaWdodCA ggNCAwIFINL0JpdHNQZXJDb 21wb25lbnQgMQ0vRGVjb2RlU ENL0NvbHVtbnMgMTgwOA0+P g0vSW1hZ2VNYXNrIHRydWUNL XhEZWNvZGUNPj4Nc3RyZWFt DQ</item> <item name="photo2.jpg">VBERi0xLjMNAwIG9iag0HRoJ JUBQREYwMTIzNDU2Nzg5IDI NMyAwIG9iag08PA0vVHlwZSA vWE9iamVjdA0vU3VidHlwZS AvSW1hZ2UNL1dpZHRoIDEzNj gNL0hlaWdodCAxMzMzDS9MZ W5ndGggNCAwIFINL0JpdHNQZ XJDb21wb25lbnQgMQ0vRGVj b2RlUGFybXMgPDwNL0sgLTEN L0NvbHVtbnMgMTM2OA0+Pg0 vSW</item> </attachments></addattachments></source>
== Изменение статуса агентом =='''Описание полей:'''
Запрос изменения статуса '''addattachments''' - Корневой контейнер. Обязательный элемент.*'''auth''' - Авторизация. Обязательный элемент.*'''orderno''' - Номер заказа позволяет установить окончательный статус . Обязательный элемент. Может использоваться тэг <ordercode> с указанием внутреннего кода заказа .*'''attachments''' - "Доставлен" или "Не доставлен Обязательный элемент, в котором перечисляются передаваемые данные файлов.**'''item''' - Бинарные данные (Возврат/Отменафайл)", закодированные в base64. Обязательный элемент.***'''name''' - Атрибут элемента '''item''', в котором передается имя файла. Обязательный элемент.
Кроме этого, устанавливается дата и время (при необходимости) изменения статуса, а также сообщение в поле ''Инфо о доставке''.
При необходимости к заказу можно прикрепить изображения'''Пример ответа:'''<source lang="xml"><?xml version="1.0" encoding="UTF-8"?><addattachments> <attachments> <item name="photo1.jpg" error="0" errormsg="OK" errormsgru="Успешно" /> <item name="photo2.jpg" error="0" errormsg="OK" errormsgru="Успешно" /> </attachments></addattachments></source>
== Получение вложений к накладной ==
'''Пример запроса изменения статуса:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8" ?>
<setorderinfoattachments>
<auth extra="8" login="login" pass="pass" />
<order ordercode="123456"orderno> <message>Получил Иванов</message> </order> <order ordercode="234567"> <status>PICKUPREADY</status> <eventtime>2016-05-30 10:20:00</eventtime> <message>Клиент отказался от покупки</message> <paytype>CASH</paytype> <items> <item code="34533" quantity="1" reason="0" /> <item code="34456" quantity="0" reason="0" /> <item code="34421" quantity="2" reason="0" /> </items> <image filename="filename1.jpg"> /9j/4AAQSkZJRgA BAQAAAQABAAD/2wBDAA0JCg sKCA0LCgsODg0PEyAVExISEy ccHhcgLikxMC4pLSwzOko+M zZGNywtQFdBRkxOUlNSMj5aY VpQYEpRUk//2wBDAQ4ODhMR EyYVFSZPNS01T09PT09PT09P T09PT09PT09PT09PT09PT09 PT09PT09PT09PT09PT09PT09 PT09PT0//wAARCAYACAADAS IA</image> 1234567</orderorderno></setorderinfoattachments></source>
'''Описание полей:'''
'''Описание полей запроса статуса:''' '''setorderinfoattachments''' - Корневой контейнер. Обязательный элемент.*'''auth''' - Авторизация. Обязательный элемент.*'''orderorderno''' - Контейнер Номер/код заказа. Обязательный элемент. Запрос может содержать более одного контейнера '''order'''. Атрибут '''''ordercode''''' - внутренний код заказа.*'''status''' - Новый статус заказа. Доступны статусы из раздела [[#Описание полей ответа статусов]], кроме AWAITING_SYNC и NEW.*'''eventtime''' - Дата и время изменения статуса. Обязательно при указании статуса.*'''message''' - Текст сообщения ''Инфо о доставке''.*'''paytype''' - Тип оплаты заказа. Допустимые значения CASH/CARD.*'''items''' - Контейнер для описания вложений '''item''' . Атрибуты::* '''''code''''' - Код вложения.:* '''''quantity''''' - Количество доставленных единиц вложения.:* '''''reason''''' - Причина недоставки, выбирается из соответствующего списка статусов.*'''image''' - Контейнер прикрепляемого изображения. Содержит текст файла изображения, закодированный по стандарту ''base64''. Контейнер '''order''' может содержать более одного контейнера '''image'''. Атрибут::* '''''filename''''' - Имя файла. 
<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<setorderinfoattachments> <order ordercodeitem name="123456doc1.docx" errorsize="0" errormsg="OK" errormsgru="Успешно35654" >JVBERi0xLjMN JUBQREYwMTIzNDU2Nzg5IDI NMyAwIG9iag08PA0vVHlwZSA U3VidHlwZSAvSW1hZ2UNL1d pZHRoIDE4MDgNL0hlaWdodCA ggNCAwIFINL0JpdHNQZXJDb 21wb25lbnQgMQ0vRGVjb2RlU ENL0NvbHVtbnMgMTgwOA0+P g0vSW1hZ2VNYXNrIHRydWUNL XhEZWNvZGUNPj4Nc3RyZWFt DQ</item> <order ordercodeitem name="234567photo2.jpg" errorsize="59" errormsg="value [date_put] is already set" errormsgru="Значение [Дата доставки] уже указано74861" >VBERi0xLjMN JUBQREYwMTIzNDU2Nzg5IDI NMyAwIG9iag08PA0vVHlwZSA vWE9iamVjdA0vU3VidHlwZS AvSW1hZ2UNL1dpZHRoIDEzNj gNL0hlaWdodCAxMzMzDS9MZ W5ndGggNCAwIFINL0JpdHNQZ XJDb21wb25lbnQgMQ0vRGVj b2RlUGFybXMgPDwNL0sgLTEN L0NvbHVtbnMgMTM2OA0+Pg0 vSW</item></setorderinfoattachments></source> == Получение документов для печати ==В тегах item возвращаются бинарные данные (файлы), закодированные в base64.
== Изменение статуса агентом == Запрос изменения статуса заказа позволяет установить окончательный статус заказа - "Доставлен" или "Не доставлен (Возврат/Отмена)". Кроме этого, устанавливается дата и время (при необходимости) изменения статуса, а также сообщение в поле ''Инфо о доставке''. При необходимости к заказу можно прикрепить изображения.  '''Пример запроса получения печатных формизменения статуса:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8" ?>
<waybillsetorderinfo>
<auth extra="8" login="login" pass="pass" />
<ordersorder ordercode="123456"> <message>Получил Иванов</message> </order> <order ordernoordercode="234567"> <status>PICKUPREADY</status> <eventtime>2016-05-30 10:20:00</eventtime> <message>Клиент отказался от покупки</message> <paytype>CASH</paytype> <items> <item code="34533" quantity="1" reason="0" /> <item code="34456" quantity="12345670" ordercodereason="333310" /> <order ordernoitem code="34421" quantity="12345682" ordercodereason="333320" /> </ordersitems> <image filename="filename1.jpg">/9j/4AAQSkZJRgA BAQAAAQABAAD/2wBDAA0JCg sKCA0LCgsODg0PEyAVExISEy ccHhcgLikxMC4pLSwzOko+M zZGNywtQFdBRkxOUlNSMj5aY VpQYEpRUk//2wBDAQ4ODhMR EyYVFSZPNS01T09PT09PT09P T09PT09PT09PT09PT09PT09 PT09PT09PT09PT09PT09PT09 PT09PT0//wAARCAYACAADAS IA<form/image>1 </formorder></waybillsetorderinfo>
</source>
'''Описание полей:'''
'''waybillОписание полей запроса статуса:''' '''setorderinfo''' - Корневой контейнер. Обязательный элемент.*'''auth''' - Авторизация. Обязательный элемент.*'''ordersorder''' - Список заказов для получения печатных формКонтейнер заказа. Обязательный элемент. Содержит тэги Запрос может содержать более одного контейнера '''order''' с атрибутами::* . Атрибут '''''ordernoordercode''''' - шифр внутренний код заказа.:* '''status''ordercode' - Новый статус заказа. Доступны статусы из раздела [[#Описание полей ответа статусов]], кроме AWAITING_SYNC и NEW.*'''eventtime''' - внутренний код заказаДата и время изменения статуса. Указывать необходимо один из атрибутов для всех заказовОбязательно при указании статуса. Приоритет имеет атрибут *'''message''ordercode'- Текст сообщения ''Инфо о доставке''.*'''formpaytype''' - Формат накладнойТип оплаты заказа. Не обязательный элементДопустимые значения CASH/CARD.*'''items''' - Контейнер для описания вложений '''item''' . Принимает значенияАтрибуты::* 1 '''''code''''' - Подробная накладная (по-умолчанию)Код вложения.:* 2 '''''quantity''''' - Наклейки ZebraКоличество доставленных единиц вложения.:* 3 '''''reason''''' - Наклейки на страницу формата А4Причина недоставки, выбирается из соответствующего списка статусов.*'''image''' - Контейнер прикрепляемого изображения. Содержит текст файла изображения, закодированный по стандарту ''base64''. Контейнер '''order''' может содержать более одного контейнера '''image'''. Атрибут::* 4 '''''filename''''' - Акты приема-передачиИмя файла. 
<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<waybillsetorderinfo> <contentorder ordercode="123456" error="0" errormsg="OK" errormsgru="Успешно" />EODIcaI8KSBlwQ 4MnEOR7Px8U8EBAyGICBnwpw IZhQgz0ZxuPs8EBM/GcbjzB AwhBl8hwQYIO00GmEwg1CeEG mqYTChNU0wqf8l8nz4zgc+K fCno+zwU5GjOZmzXGcbEQYIM 4zkegRE40zWzONyoNNMIOIa cWnp6aDCGEGE9NQmoQd2mg00 79U4f3hPTwnfp6Sdrafeqpa JDpFw/1aYT077VNNNdO00G3q mqqvp9p2E7T0/wiFemv8uG6 OM<order ordercode="234567" error="59" errormsg="value [date_put] is already set" errormsgru="Значение [Дата доставки] уже указано" /content></waybillsetorderinfo>
</source>
== Получение документов для печати ==
В тэге content возвращаются бинарные данные (файл pdf), закодированные в base64.  '''Обратите внимание''', что печатные формы для заборов не формируются. == Отмена заказа == Запрос отмены предназначен для отмены тех заказов, по которым не было произведено изменений - статуса доставки, статуса корреспонденции, времени доставки - то есть заказов, которые ещё не находятся в работе.Возможность отмены заказа есть только у курьерских служб с тарифом "Премиум" и по-умолчанию она выключена, ее нужно отдельно включить: [[Личный кабинет курьерской службы#Дополнительные настройки]]. При отмене заказа поле "Инфо о доставке" получает значение "Отменено заказчиком", поле "Дата доставки" - текущую дату, а "Вручил курьер" - системную запись "ОТМЕНА".  '''Пример запроса отмены заказаполучения печатных форм:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8" ?>
<cancelorderwaybill>
<auth extra="8" login="login" pass="pass" />
<orders> <order orderno="1234567" ordercode="12345633331" /> <order orderno="123aaa1234568" ordercode="33332" /> </orders> <form>1</form></cancelorderwaybill>
</source>
'''Описание полей:'''
'''Описание полей запроса статуса:''' '''cancelorderwaybill''' - Корневой контейнер. Обязательный элемент.*'''auth''' - Авторизация. Обязательный элемент.*'''orderorders''' - Контейнер отменяемого заказа. Обязательный элементСписок заказов для получения печатных форм. Запрос может содержать более одного контейнера Содержит тэги '''order'''. Атрибутыс атрибутами::* '''''orderno''''' - Шифр шифр заказа.:* '''''ordercode''''' - Внутренний внутренний код заказа.Обратите внимание, что должен быть указан хотя бы Указывать необходимо один из атрибутов для всех заказов. Приоритет имеет атрибут '''''ordercode'''''orderno*'' или 'form'ordercode''!- Формат накладной. Не обязательный элемент. Принимает значения::* 1 - Подробная накладная (по-умолчанию):* 2 - Наклейки Zebra:* 3 - Наклейки на страницу формата А4:* 4 - Акты приема-передачи
'''Пример ответа:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8" ?><cancelorderwaybill> <order orderno="123test" ordercode="123456" error="0" errormsg="OK" errormsgru="Успешно" content>EODIcaI8KSBlwQ 4MnEOR7Px8U8EBAyGICBnwpw IZhQgz0ZxuPs8EBM/GcbjzB AwhBl8hwQYIO00GmEwg1CeEG mqYTChNU0wqf8l8nz4zgc+K fCno+zwU5GjOZmzXGcbEQYIM 4zkegRE40zWzONyoNNMIOIa cWnp6aDCGEGE9NQmoQd2mg00 79U4f3hPTwnfp6Sdrafeqpa JDpFw/>1aYT077VNNNdO00G3q mqqvp9p2E7T0/wiFemv8uG6 OM<order orderno="123aaa" ordercode="" error="52" errormsg="order not found" errormsgru="Заказ не найден" /content></cancelorderwaybill>
</source>
 
 
В тэге content возвращаются бинарные данные (файл pdf), закодированные в base64.
 
 
'''Обратите внимание''', что печатные формы для заборов не формируются.
 
== Справочник городов ==
<parentcode>6</parentcode>
<parentname>Интеграция</parentname>
<town code="124267" regioncode="66" regionname="Свердловская область">Нижний Тагил город</town>
<address>622036, г. Нижний Тагил, ул. Циолковского, д. 17</address>
<phone>+73435417709, +73435254989</phone>
<parentcode>6</parentcode>
<parentname>Интеграция</parentname>
<town code="124267" regioncode="66" regionname="Свердловская область">Нижний Тагил город</town>
<address>КРАСНОАРМЕЙСКАЯ, д.79</address>
<phone>+7(3435)379-044</phone>
*'''parentcode''' - Код родительского элемента.
*'''parentname''' - Наименование родительского элемента.
*'''town''' - Населенный пункт с кодом из [[#Справочник городов|справочника городов]], а также с кодом и наименованием региона.
*'''address''' - Адрес ПВЗ.
*'''phone''' - Телефоны ПВЗ.
<source lang="xml">
<?xml version="1.0" encoding="UTF-8" ?>
<services count="2"> <service> <code>1</code> <name>Эконом</name> </service> <service> <code>2</code> <name>Срочно</name> </service></services></source>  == Справочник дополнительных услуг == '''Пример запроса дополнительных услуг:'''<source lang="xml"><?xml version="1.0" encoding="UTF-8"?><advprices> <auth extra="8" login="login" pass="pass" /></advprices></source> '''Пример ответа справочника дополнительных услуг:'''<source lang="xml"><?xml version="1.0" encoding="UTF-8" ?><advprices> <advprice> <code>1</code> <name>Этажей в доме</name> <type>int</type> </advprice> <advprice> <code>2</code> <name>Коэффициент надбавки</name> <type>float</type> </advprice> <advprice> <code>3</code> <name>Расписаться на упаковке</name> <type>bool</type> </advprice></advprices></source> Параметры:*'''code''' - внутренний код услуги*'''name''' - наименование услуги*'''type''' - тип услуги. Может иметь значения::*'''bool''' - для услуг вида "чекбокс", "Да":*'''float''' - для числа с плавающей точкой:*'''int''' - для целого числа == Расчет стоимости доставки == '''Пример запроса стоимости доставки:'''<source lang="xml"><?xml version="1.0" encoding="UTF-8" ?><calculator> <auth extra="8" login="login" pass="pass" /> <calc townfrom="Москва" addressfrom="Ленинский проспект, 95" zipcode="664000" townto="3800000300000" addressto="Ленина ул., 10" l="10" w="20" h="30" mass="3.7" service="1" price="1200" inshprice="1200" paytype="CASH" /></calculator></source> Параметры:*'''townfrom''' - Город отправления*'''addressfrom''' - Адрес отправления*'''zipcode''' - Почтовый индекс города назначения*'''townto''' - Город назначения*'''addressto''' - Адрес назначения*'''l''' - Длина в сантиметрах (не обязательный параметр)*'''w''' - Ширина в сантиметрах (не обязательный параметр)*'''h''' - Высота в сантиметрах (не обязательный параметр)*'''mass''' - Масса в килограммах*'''service''' - Режим доставки - число, указывающее на запись в справочнике [[#Справочник Видов срочности|видов срочности]]. Если этот параметр опустить, система выдаст расчет для всех доступных видов срочности, передав много контейнеров <calc> в ответе.*'''price''' - Сумма наложенного платежа*'''inshprice''' - Сумма объявленной ценности*'''paytype''' - Тип оплаты
== Расчет стоимости доставки == '''Пример запроса стоимости доставки:'''<source lang="xml"><?xml version="1.0" encoding="UTF-8" ?><calculator> <auth extra="8" login="login" pass="pass" /> <calc townfrom="Москва" townto="3800000300000" l="10" w="20" h="30" mass="3.7" service="1" /></calculator></source> Параметры:*'''townfrom''' - Город-отправитель*'''townto''' - Город-получатель*'''l''' - Длина Суммы НП и ОЦ, а также тип оплаты CARD имеют значение при настроенных в сантиметрах тарифе на вкладке Прочее долях (не обязательный параметр)*'''w''' - Ширина в сантиметрах (не обязательный параметр)*'''h''' - Высота в сантиметрах (не обязательный параметрпроцентах)*'''mass''' - Масса в килограммах*'''service''' - Режим доставки - число, указывающее на запись в справочнике [[#Справочник Видов срочности|видов срочности]]. Если этот параметр опустить, система выдаст расчет для всех доступных видов срочности, передав много контейнеров <calc> в ответеот данных сумм.
В авторизации можно опустить параметры login и pass, тогда расчет будет производиться по стандартному тарифу курьерской службы, без учета возможных отличий для конкретного клиента.<br>
<mindeliverydays>1</mindeliverydays>
<maxdeliverydays>3</maxdeliverydays>
<mindeliverydate>2020-05-13</mindeliverydate>
</calc>
</calculator>
*'''price''' - рассчитанная стоимость доставки в валюте прайс-листа курьерской службы. Рекомендуется к использованию в отличие от одноименного атрибута родительского контейнера.
*'''maxdeliverydays''' - максимальный срок доставки в рабочих днях.
*'''mindeliverydate''' - минимальная дата доставки в учетом выходных дней.
'''''Обратите внимание:''''' В реальном ответе сервера в теге calc присутствует атрибут "price". Он оставлен для обратной совместимости, не используйте его. Пользуйтесь вложенным тегом price.

Навигация