792
правки
Изменения
API
,→Коды и описание ошибок
<div style="font-size: 24px; color: #2424a9; background-color: #deffde; border: 1px solid #ebccd1; padding: 3px 10px 10px; text-align: center">
'''English version is [[API documentationDocumentation|HERE!]]'''
</div>
Вы можете настроить интегацию интеграцию с MeaSoft средствами XML API по протоколу HTTP POST.
API предназначено для интеграции клиентов (интернет-магазинов и прочих компаний-заказчиков доставки) с [http://courierexe.ru/our_clients.htm курьерскими службами], работающими под управлением системы [https://curie.ru/ MeaSoft].
Если вы '''агрегатор''', передающий данные от клиентов, возможно, вам придется последовательно подключаться под разными пользователями, если курьерская служба должна вести раздельный учет взаиморасчетов по клиентам.
== Готовые интеграции ==
Для работы с популярными CMS и CRM-системами разработаны модули интеграции, перечисленные в таблице ниже.
Сообщайте нам свои пожелания по работе наших модулей. Мы учтем их в новых версиях.
|-
|[[Файл:bitrix.png|center|x44px]]
|style="text-align: center;"|[httphttps://marketplace.1c-bitrix.ru/solutions/measoft.courier/ Установить] <!-- [httphttps://courierexe.ru/download/api/bitrixmeasoft.zip Скачать Unicode]<br>[http://courierexe.ru/download/api/bitrix_ansicourier.zip Скачать ANSI] -->|Поддерживает версии 1420.5 .0 и выше. Подробнее см. [[Интеграция с другими системами#1C-Битрикс|описание]].
|-
|[[Файл:prestashop.png|center|x60px]]
|style="text-align: center;"|[httphttps://courierexe.ru/download/api/prestashop.zip Скачать]|Поддерживает версии 1.5.2.0 и выше (2.x Инструкция в том числе)архиве
|-
|[[Файл:OpencartOCStore.png|center|x60px]]
|style="text-align: center;"|[httphttps://courierexe.ru/download/api/opencart.zip Скачать для версии 1.5.5.1]<br>[httphttps://courierexe.ru/download/api/measoft_oc2.ocmod.zip Скачать для версии 2.0]<br>[httphttps://courierexe.ru/download/api/measoft_oc2.3.ocmod.zip Скачать для версии 2.3]<br>[httphttps://courierexe.ru/download/api/measoft_ос3measoft_oc3.ocmod.zip Скачать для версии 3.0]|Поддерживает версии с 1.5.5.1.<br>Скачивайте модули для своей версии OpenCart.<br>Подробнее см. [[Интеграция с другими системами#OpenCart 1.5.5.1|описание]].<br>[https://opencartforum.com/files/file/2906-avtomatizaciya-otpravki-i-otslezhivanie-dostavok-courierexe-dlya-opencart-15x/ Альтернативный модуль сторонних разработчиков]
|-
|[[Файл:webasyst-shopscript.png|center|x44px]]
|style="text-align: center;"|[httphttps://www.webasyst.ru/store/plugin/shop/measoftcourier/ Установить модуль]<br>[https://www.webasyst.ru/store/plugin/shipping/measoftcourier/ Установить плагин]|Модуль предназначен для отправки заявок в КС, а плагин для расчета стоимости доставки при оформлении заказа.Инструкции в маркете
|-
<!--|[[Файл:advantshop.png|center|x44px]]
|style="text-align: center;"|[https://promo-z.ru/ Сайт компании PROMO]
|Компания PROMO разработала этот модуль и настраивает интеграцию MeaSoft с ADVANTSHOP своим клиентам.
|- -->
|[[Файл:insales.png|center|x80px]]
|style="text-align: center;"|Настраивается в [[Личный кабинет клиента|ЛК пользователя]]
|[[InSales|Инструкция по настройке]]
|-
|[[Файл:insalesiiko.pngjpg|center|x80px]]
|style="text-align: center;"|Настраивается в [[Личный кабинет клиента|ЛК пользователя]]
|[[Интеграция с другими системами#InSalesIiko|Инструкция по настройке]]
|-
|[[Файл:Leadvertex.png|center|x44px]]
|style="text-align: center;"|[httphttps://blog.leadvertex.ru/news/2110-integraciya-s-kurerkami-na-platforme-measoft Настраивается] в ЛК [https://Leadvertex.ru Leadvertex]|[[Интеграция с другими системами#LeadVertex|Инструкция по настройке]]<br>Модуль разработан и поддерживается компанией LeadVertex.
|-
|[[Файл:Retailcrm.png|center|x30px]]
|style="text-align: center;"|[https://www.retailcrm.ru/ RetailCRM]
|[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|x60px]]
|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|x30px]]
|style="height:50px; text-align: center;"|[https://home.courierexe.ru/moysklad/step1 Настроить интеграцию с MeaSoft]
|[[Интеграция с другими системами#МойСклад|Инструкция]]
|-
|style="height:50px; text-align: center;"|[https://itmdev.ru/ms/shipping/ Скачать модуль сторонних разработчиков]
|-
|[[Файл:wordpress.jpg|center|x80px]]
|style="text-align: center;"|[httphttps://courierexe.ru/download/apiwordpress/wordpress.zip php Скачать]|[[Интеграция с другими системами#Wordpress|Инструкция]]
|-
|[[Файл:Cscart.png|center|x60px]]
|style="text-align: center;"|[https://marketplace.cs-cart.com/measoft-en.html Установить]
|Поддерживает версии 4.10 и выше.<br>[[Интеграция с другими системами#CS-Cart|Инструкция]]|-|[[Файл:webhooks.jpg|center|x100px]]|style="text-align: center;"|Читайте описание [[Webhook|на этой странице]]|Передача информации о статусах и заказах в вашу систему
|-
|}
'''Обратите внимание!''' В модулях систем PrestaShop и Joomla для отправки заказа в курьерскую службу зайдите в карточку заказа. В карточке отображается специальная форма отправки заказа, а если заказ отправлен, она позволяет проверить его статус:[[Файл:Form.png|400 px|Форма отправки заказа|none]]
Для отображения списка пунктов выдачи есть [https://home.courierexe.ru/js/measoft_map.js JavaScript модуль]. Инструкция по использованию — использованию — внутри. Посмотреть пример работы можно [https://home.courierexe.ru/pvz_test.html здесь].
== Тестовый аккаунт ==
Для отладки зайдите в тестовый личный кабинет по адресу [https://home.courierexe.ru/8 https://home.courierexe.ru/8], логин: login пароль: pass.
Для упрощения интеграции можно скачать [httphttps://courierexe.ru/download/api/php_sample.zip пример обращения к сервису на PHP].
== Рабочий аккаунт для подключения ==
Строка подключения выглядит следующим образом:
<source lang=xml>
<auth extra="8" login="login" pass="pass"></auth>
</source>
Вы можете узнать код экстра, логин и пароль курьерской службы в офисном приложении MeaSoft в справочнике '''Дополнительные возможности'''. Подробнее см. раздел «[[Файл:33_client.pngЛичный кабинет курьерской службы#Подключение|500pxПодключение]]».
== Общие понятия ==
На стороне курьерской службы имеется веб-сервис по адресу: https://home.courierexe.ru/api/. <rspoiler text="Еще есть порт 8443.">Некоторые маршрутизаторы, используемые провайдерами, РНК и прочее, в попытке глубокого анализа могут повреждать трафик на стандартный порт 443. Сделано по тикету 10964.</rspoiler> Обратите внимание на символ '''"«/"»''' (slash) в конце адреса! . Тестовые авторизационные данные: логин: test login пароль: testmpass, параметр extra: 8. Обратите внимание, что тестовая площадка для всех одна. Не нужно передавать в нее заказы с конфиденциальными данными, их смогут увидеть другие участники.
Для использования интеграции в «боевом» режиме, запросите '''логин''', '''пароль''', и параметр '''extra''' у той компании, с которой интегрируетесь.
== Ограничения ==
С целью защиты от нецелевого использования сервисов и DDoS-атак действуют следующие ограничения:
*30 запросов tracking с одного IP-адреса за 1 минуту (используйте statusreq!);*150 запросов с одного IP-адреса/акаунта за 1 минуту;*1500 запросов с одного IP-адреса/акаунта за 20 минут;*3000 запросов с одного аккаунта за 1 час;*200 Мб скачанных текстовых данных за 3 часа.* Превышение количества запросов статусов несуществующих заказов над существующими
В случае превышения IP-адрес или аккаунт блокируется на время до 3-х часов.
Чтобы не происходило блокировок:
* не нужно «бомбить» наше API запросами статусов, последовательно перебирая номера всех ваших заказов, особенно запросами "tracking"«tracking», они предназначены не для этого (смотрите описание). Особенно ровно в 00 минут каждого часа;
* не нужно каждые 5 минут делать запросы «Покажите статусы всех заказов за последние 3 месяца»;
* для проверки статусов заказов лучше всего использовать запросы [[#Передача только изменившихся статусов|измененных статусов changes=ONLY_LAST]];
* при запросе измененных статусов ОБЯЗАТЕЛЬНО нужно подтверждать успешное получение запросом [[#Передача только изменившихся статусов|commitlaststatus]].
* вы должны знать номера заказов, которые вы отправили. Не нужно перебирать номера всех заказов или брутфорсом перебирать все возможные номера.
Мы абсолютно уверены, что данные ограничения на порядки превосходят необходимые объемы предоставления сервиса для решения любых задач. Если у вас возникают проблемы, вы не знаете, как уложиться в эти рамки — рамки — спросите у нас, мы обязательно поможем!
== Оформление заказа ==
=== Пример оформления заказа ===
<source lang=xml>
<?xml version="1.0" encoding="UTF-8"?>
<coords lat="55.680327" lon="37.604456"></coords>
</receiver>
<returnprice>NO387.5</returnprice> <inshprice>387.5</inshprice> <deliveryprice VATrate="20">150</deliveryprice> <discount>120</discount> <paytype>CASH</paytype>
<weight>5.1</weight>
<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>
<enclosure>Детские игрушки</enclosure>
<instruction>Проверить при покупателе, подписать акт</instruction>
<acceptpartially>NO</acceptpartially>
<costcode>cc12345</costcode>
<respstore>4</respstore>
<uid>af11c7c6-6645-4a20-9604-be911a75722d</uid>
<items>
<item extcode="abc123" quantity="1" mass="0.2" retprice="37.5" VATrate="0" barcode="2345625213125" textArticle="1" article="1" volume="3" origincountry="AUT" GTD="321546654" excise="15.20" suppcompany="ООО "Рога и копыта"" suppphone="79161234567" suppINN="1112223334" govType="2" governmentCode="11223311" extraTags="">Мяч</item>
<item extcode="abc124" quantity="2" mass="2" retprice="100" inshprice="100" VATrate="10" barcode="4645625213138" article="2" length="10" width="20" height="30" origincountry="004">Обруч</item>
<item extcode="abc125" quantity="3" mass="0.3" retprice="50" inshprice="50" barcode="2345625213126" itemcode="44123" article="3" type="1">Погремушка желтая</item>
</items>
<packages>
<package strbarcode="ORD0000001" mass="1" message="" quantity="3"></package>
<package strbarcode="ORD0000002" mass="2.5" message="" length="10" width="20" height="30"></package>
</packages>
</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''' — Корневой контейнер, обязательный элемент.
:* '''''newfolder''''' — Признак нового заказа YES/NO. Если стоит YES, то в системе курьерской службы для данной корреспонденции создастся новый заказ. Необязательный элемент.
* '''order''' — Контейнер для описания одного заказа, обязательный элемент. В одном контейнере '''neworder''' может быть много контейнеров '''order''' для создания нескольких заказов одним запросом.
:* '''''orderno''''' — Номер заказа. Если присваивается клиентом — указывается здесь. Если не присваивается — можно оставить пустым, система сгенерирует свой номер, и вернет его в ответе. Система проверяет наличие заказов с указанным номером в пределах текущего календарного года, и в случае их существования — заказ создан не будет, а в ответе вернется ошибка 17 «Such number exists». Если не указан штрихкод (поле barcode), и значение поля подходит для использования его в качестве штрихкода, данное значение будет скопировано в поле «Штрихкод». Это накладывает ограничения в частности, на длину указанного поля (25 знаков, чтобы работали стандартные печатные формы).
* '''barcode''' — Штрихкод заказа. Если клиент штрихкодирует свои отправления и штрихкод отличается от номера заказа, в этом поле указывается штрихкод. Если ШК содержит кириллицу или малое количество символов, то формируется ШК в формате EAN13.
Корректный (валидный) ШК отвечает следующим требованиям:*'''order''' длина не меньше 5 символов* значение не меньше значения переменной <mparam code="MinPrePrintedNum"/>* содержит символы, которые можно использовать для формирования штрих- Контейнер для описания одного заказа, обязательный элементкод а формате Code128 (т. В одном контейнере '''neworder''' может быть много контейнеров '''order''' для создания нескольких заказов одним запросоме.все печатные символы, кроме кириллицы)
*'''sender''' - — Информация о отправителе заказа. Необязательный контейнер.
<source lang="xml">
<sender>
</source>
*'''receiver''' - — Информация о получателе заказа. Обязательный контейнер.
<source lang="xml">
<receiver>
</source>
*'''company''' - — Компания-получатель.*'''person''' - — Контактное лицо. ''Должно быть заполнено хотя бы одно из полей - полей — company или person!''*'''phone''' - — Телефон. Можно указывать несколько телефонов, E-mail в этом поле.*'''town''' - — Город.* '''pvz''' — Код пункта самовывоза по справочнику. Кроме того, ПВЗ можно указать в строке '''''address''''' в виде::* код ПВЗ в нашей системе:* код ПВЗ в системе подрядчика:* наименование ПВЗ в виде строки "ПВЗ " + «Наименование ПВЗ»
Для тега города '''town''' можно указать код региона в атрибуте '''''regioncode''''' из [[#Справочник регионов|справочника регионов]]. Поиск будет производиться в указанном регионе.
Также можно указать страну получателя в атрибуте '''''country''''' в соответствии с [https://ru.wikipedia.org/wiki/ISO_3166-1 стандартом ISO_3166-1], например, "RU"«RU», "RUS" «RUS» или "643" «643» для России.
Кроме того, поиск города осуществляется с учетом почтового индекса, указанного в теге '''zipcode'''.
:* код населенного пункта из [[#Справочник городов|справочника городов]]
:* 13-ти значный код адресного классификатора КЛАДР
:* 36-ти значный код адресной системы <rspoiler text="ФИАС">Федеральная информационная адресная система — система — единый российский государственный адресный реестр</rspoiler> (AOID)
:* название города (не рекомендуется!)
*'''coords''' - — Координаты получателя. Если не указаны, система будет геокодировать самостоятельно.
* '''zipcode''' — Почтовый индекс.* '''price''' — Сумма заказа (наложенный платеж) - денежные средства, которые курьер должен забрать у получателя в пользу заказчика. В случае наличия контейнера items значение этого параметра будет проигнорировано и рассчитано автоматически.* '''inshprice''' — Объявленная ценность. Если явно не указана сумма — автоматически считается как сумма по товарам.* '''deliveryprice''' — Стоимость доставки, которая устанавливается заказчиком и будет взиматься с получателя в пользу заказчика. Не имеет отношения к стоимости доставки самой курьерской службы, которая рассчитывается в соответствии с тарифамии, не указывается при оформлении заказа и добавляется в заказ автоматически при его обработке курьерской службой. В случае наличия контейнера items в него будет добавлено вложение «Доставка».:* '''''VATrate''''' — Ставка НДС — целое число процентов.* '''discount''' — Сумма скидки. Скидка «размазывается» по товарным вложениям, сумма НП уменьшается на сумму скидки. При этом вложение Скидка не создается. ВНИМАНИЕ, при использовании этого тега общая сумма может расходиться на копейки из-за округления! Старайтесь не использовать этот тег, а указывать цену товаров уже с учетом скидок.*'''paytype''' - — Тип оплаты заказа получателем. Принимает значения::* CASH - CASH — Наличными при получении (по-умолчанию):* CARD - CARD — Картой при получении:* NO - NO — Без оплаты. Этот тип оплаты передается, если заказ уже оплачен и не требует инкассации. API добавит к товарам строку предоплаты в сумму заказа, чтобы общая сумма была 0, однако в кассовом чеке будут все товары с ценами, и оплата предоплатой, как того требует 54-ФЗ.:* OTHER - OTHER — Прочее (Предусмотрен для того, чтобы оплата поступала непосредственно в курьерскую службу посредством прочих типов оплаты - оплаты — таких как: вебмани, яденьги, картой на сайте, прочие платежные системы и ти т.д д.):* OPTION - OPTION — На выбор получателя. Этот тип оплаты нельзя передавать с заказом. Он выставляется автоматически в зависимости от настройки клиента.* '''weight''' — Общий вес заказа в килограммах.* '''quantity''' — Количество мест.* '''service''' — Режим доставки (тип услуги) передается код из справочника «[[#Справочник Видов срочности|Виды срочности]]».* '''type''' — Тип корреспонденции (отправления) передается код из справочника «Типы корреспонденции».* '''return''' — Признак необходимости возврата. Принимает значения::* NO — Возврат не требуется:* YES — Требуется возврат, например, документов:* ONLY — Требуется забрать отправление у поставщика (см. раздел «[[Личный_кабинет_клиента#Привезти ко мне|Привезти ко мне]]»). * '''return_service''' — Режим возврата (тип услуги) передается код из справочника «Виды срочности».* '''return_type''' — Тип возвратной корреспонденции (отправления) передается код из справочника «Типы корреспонденции».* '''return_weight''' — Общий вес возврата заказа в килограммах.* '''enclosure''' — Вложение.* '''instruction''' — Поручение — Примечание.* '''courier''' — Запланированный курьер. Согласно коду курьера в КС2008.* '''receiverpays''' — Признак оплаты стоимости доставки — услуг службы доставки получателем, а не заказчиком YES/NO.* '''department''' — Подразделение, в котором оформляется заказ.* '''costcode''' — Кост-код сотрудника.* '''respstore''' — Код ответственного филиала. Для ответственного филиала в который передается заказ, требуется включение параметра "Разрешить клиенту передавать заказы в этот филиал"* '''pickup''' — Признак оформления забора YES/NO. Если стоит YES, то весь заказ считается заданием на забор груза, а не на доставку! Применяется для вызова курьера к отправителю для забора других отправлений. ''Внимание!'' при добавлении в забор складских товаров, их тип '''''type''''' всегда должен быть установлен как [7] Забор товара, если будет указан другой тип, то он будет исправлен в момент добавления заказа на [7] Забор товара* '''acceptpartially''' — Признак возможности частичного выкупа товаров отправления YES/NO.* '''uid''' - Универсальный идентификатор заказа на стороне отправителя. Не обязательный параметр, ограниченного по времени действия. Время хранения в системе, - сутки.
*'''zipcodeitems''' - Почтовый индекс — Контейнер для описания вложений. <rspoiler text="Необязательный контейнер">Если для поставщика товара в системе MeaSoft не указаны полное наименование компании и ИНН в карточке клиента, заполните параметры <code>suppcompany</code> и <code>suppINN</code> в этом контейнере. Отсутствие информации о поставщике приведет к [[Настройка модуля печати кассовых чеков#Ошибка фискализации (ошибка программирования реквизита 1226)|ошибке фискализации]].</rspoiler>.Атрибуты::*'''weight''item' - Общий вес заказа в килограммах'''' — Название вложения.:*'''return_weight''quantity''' - Общий вес возврата заказа в килограммах'' — Количество единиц товара.:*'''quantity''mass''''' - Количество мест — Масса единицы товара в килограммах.:*'''service''volume''''' - Режим доставки (тип услуги) передается код из справочника [[#Справочник Видов срочности|"Виды срочности"]] — Объемный вес единицы товара в килограммах.При указании объемного веса значение подставляется вместо массы:*'''return_service''length' - Режим возврата '''' — Длина единицы товара (тип услугив сантиметрах) передается код из справочника "Виды срочности".:*'''type''width''''' - Тип корреспонденции — Ширина единицы товара (отправленияв сантиметрах) передается код из справочника "Типы корреспонденции".:*'''return_type''height' - Тип возвратной корреспонденции '''' — Высота единицы товара (отправленияв сантиметрах) передается код из справочника "Типы корреспонденции".:*'''price''retprice' - Сумма заказа'''' — Цена единицы товара. Округляется до копеек. Должна быть с учетом всех скидок и наценок. В случае наличия контейнера items значение данного параметра будет проигнорированоДля вложений типов 1, 2, и рассчитано автоматически3 не может быть отрицательной.<!-- , либо мы сами посчитаем скидку при указании тега order->discount -->:*'''deliveryprice''inshprice''''' - Сумма доставки — Объявленная ценность единицы товара. Округляется до копеек. В случае наличия контейнера items, в него будет добавлено вложение "Доставка"Если не указана принимается равной '''''retprice'''''.:* '''''VATrate''''' - — Ставка НДС - НДС — целое число процентов.*Если товар хранится в КС (смотрите '''returnarticle''' ниже), значение берется из номенклатуры. Иначе, если значение указано, берется указанное значение, если нет - Признак необходимости возвратазначение из настроек фирмы КС. Значение «0» означает ставку «Без НДС», ставка «0%» на данный момент не поддерживается.:*'''return_service''barcode' - Режим возврата (тип услуги) передается код из справочника "Виды срочности"'''' — Штрихкод вложения.:*'''discount''article''''' - Сумма скидки — Артикул вложения. Скидка "размазывается" по товарным вложениям''Внимание!'' Указание артикула используется только тогда, сумма НП уменьшается когда товар хранится на сумму скидкиответственном хранении в службе доставки, и необходима комплектация. При В этом вложение Скидка случае система пытается привязать товар к [[API#Справочник номенклатуры|справочнику номенклатуры]]. Если товар в справочнике не создаетсянайден — система выдаст соответствующую ошибку. ВНИМАНИЕЕсли по артикулу найдено несколько товаров — система выберет один из них случайным образом, при использовании этого тега общая сумма что может расходиться привести к ошибочной комплектации! Если товар НЕ на копейки из-за округления! Старайтесь не использовать этот тег, а ответственном хранении — артикул указывать цену товаров уже с учетом скидокНЕ нужно. Позиция попадет в систему просто текстом.:*'''enclosure''itemcode''''' — Внутренний код товара, может использоваться вместо артикула. ''Внимание!'' - ВложениеУказание кода товара используется только тогда, когда товар хранится на ответственном хранении в службе доставки, и необходима комплектация. В этом случае система пытается привязать товар к [[API#Справочник номенклатуры|справочнику номенклатуры]]. Если товар в справочнике не найден — система выдаст соответствующую ошибку. Если товар НЕ на ответственном хранении — код товара указывать НЕ нужно.:*'''inshprice''type''''' — Тип вложения. Принимает значения::: 1 — Товар. По- Объявленная ценностьумолчанию.:: 2 — Доставка. Такое вложение добавится автоматически, если заполнить order->deliveryprice:: 3 — Услуга:: 4 — Предоплата. Указывается сумма. Поле quantity игнорируется, всегда «1». Если явно не указана В заказе сумма будет отрицательной независимо от знака в запросе. Такое вложение добавится автоматически при указании order- автоматически считается как >paytype=NO.:: 6 — Оплата кредитом. Указывается сумма. Поле quantity игнорируется, всегда «1». В заказе сумма по товарамбудет отрицательной независимо от знака в запросе.:: 7 — Забор товара. Если товар нужно у получателя забрать, возможно — вернуть деньги, или его стоимость вычтется из суммы других товаров. У такого товара в заказе будет отрицательное количество независимо от знака в запросе.:* '''''extcode''''' — Внешний код строки. Используется для идентификации строк заказов при получении статусов. Необязательное поле.:*'''instruction''origincountry' '''' — Код страны-производителя в соответствии со [https://ru.wikipedia.org/wiki/ISO_3166- Поручение 1 стандартом ISO_3166- Примечание1], например, «RU», «RUS» или «643» для России.:*'''courier''GTD''' - Запланированный курьер'' — Номер ГТД.:* '''''excise''''' — Сумма акциза. Согласно коду курьера в КС2008:* '''''suppcompany''''' — Наименование компании поставщика, если отличается от заказчика.:*'''receiverpays''suppphone' - Признак оплаты стоимости доставки - услуг службы доставки получателем'''' — Номер телефона компании поставщика, а не заказчиком YES/NOесли отличается от заказчика.:*'''department''suppINN'''' - Подразделение' — ИНН компании поставщика, в котором оформляется заказесли отличается от заказчика.:*'''pickup''governmentCode''''' — Код товарной номенклатуры. Используется для [[Маркировка|маркированных товаров, например («Честный знак»)]]. Для кода '''Честный знак''' Нужно указывать все данные из нанесенного QR- Признак оформления забора YES/NOкода кроме не читаемых символов (#29). Если стоит YESкод не известен — укажите знак вопроса «?», то весь заказ тогда курьер отсканирует код фактически передаваемого покупателю товара. Для некоторых процессов может использоваться значение «!» — в этом случае курьер сканирует серийный номер товара, но это не считается заданием на забор грузакодом маркировки. При этом, а не на доставкуесли указано значение «?» или «! Применяется для вызова курьера к отправителю для забора других отправлений» и quantity больше 1, то такое вложение растиражируется quantity раз.:*'''acceptpartially''govType' '''' — Тип маркировки товара. В данный момент существуют следующие типы маркировки::: 1 — Честный знак. По- Признак возможности частичного выкупа товаров отправления YES/NOумолчанию.:: 2 — ГИИС ДМДК.:: 3 — Серийный номер.
<source lang="json">
"item_industry_props":{"tag1262":"020","tag1263":"14.12.2018","tag1264":"1556","tag1265":"tm=mdlp&sid=00000000XXXXXX"},
"tag1212": "1"
</source>
* '''packages''' — Контейнер для описания мест. Необязательный контейнер. Атрибуты:
:* '''''package''''' — Название места.
:* '''''code''''' — Внутренний код строки.
:* '''''strbarcode''''' — Штрихкод места.
:* '''''mass''''' — Масса места в килограммах.
:* '''''message''''' — Строка сообщения.
:* '''''length''''' — Длина товарного места (в сантиметрах).
:* '''''width''''' — Ширина товарного места (в сантиметрах).
:* '''''height''''' — Высота товарного места (в сантиметрах).
:* '''''quantity''''' — Количество мест с данным набором параметров. Действует ограничение на общее количество мест в заказе. Общее количество мест в заказе не может быть больше 1000.
* '''advprices''' — Контейнер для описания дополнительных услуг. Необязательный элемент. <span style="color: red;>Для обработки в API включите дополнительные услуги в настройках полей [[Личный кабинет курьерской службы#Настройка личного кабинета клиента|заказов и заборов]]</span>:* '''''code''''' — код услуги.:* '''''value''''' — значение услуги. Если тип услуги bool, то в значении передаем true. * '''overall_volume''' — Общий объем, м3. Виртуальное поле. Необязательное. Из этого поля рассчитывается длина/высота/ширина места. Расчет срабатывает только если в каждом месте есть нулевые значения длины или высоты или ширины. * '''userid''' — Идентификатор пользователя, строковый или числовой тип. Виртуальное поле. Необязательное. Данное поле используется совместно с настройками «Цена доставки для получателя», определяя приоритет правила. Можно использовать в различных CMS/CRM системах, настраивая цены для определенного покупателя. * '''groupid''' — Идентификатор группы пользователя, строковый или числовой тип. Виртуальное поле. Необязательное. Данное поле используется совместно с настройками «Цена доставки для получателя», определяя приоритет правила. Можно использовать в различных CMS/CRM системах, настраивая цены для определенной группы покупателей. <div style="color: #a94442; background-color: #f2dede; border: 1px solid #ebccd1; padding: 3px 10px 10px;">'''Обратите внимание!'''При передаче заказов, у которых плановая дата доставки/забора меньше ближайшей возможной, дата автоматически меняется на самую раннюю возможную. [[Личный кабинет курьерской службы#Как считается минимальная дата возможной доставки|Подробнее]]</div> В случае необходимости указания, помимо товаров, дополнительных услуг (например, ДОСТАВКА, комплектация, подъем на этаж и т. д.) — их нужно указать в том же контейнере items как товары, без артикула. === Примеры ответов ===При успешном выполнении запроса, создании заказа, возвращается сумма заказа в атрибуте orderprice, а также ошибка 0. При не успешном — номер ошибки и текст ее на английском языке в атрибуте errormsg, для некоторых ошибок выводится перевод на русский в атрибуте errormsgru.В атрибут orderno помещается номер заказа, в атрибут barcode — штрихкод заказа. '''Пример успешного ответа'''
<source lang="xml">
<?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!Код ошибки=== Пример запроса статуса заказа ===!Английское описание!Русское описание<source lang="xml">|-<?xml version="1.|0" encoding="UTF||Success||Успешно|-8" ?><statusreq>|1||Wrong XML||Некорректный файл XML.|- <auth extra="8" login="login" pass="pass"></auth>|2||Lat is empty||Укажите широту. <client>CLIENT</client>|- <orderno>1234</orderno>|3||Specify a valid «Price» field value.||Укажите корректное значение поля «Сумма». <orderno2>5678</orderno2>|- <ordercode>34234</ordercode>|4||Specify a valid «Weight» field value.||Укажите корректное значение поля «Вес».|- <givencode>234534<|5||Recepient city/givencode>town not found.||Город назначения не найден. <datefrom>2016-07|-21</datefrom> <dateto>2016-07-21<|6||Sender city/dateto>town not found.||Город отправления не найден. <target>Автозавод</target>|- <done>ONLY_NOT_DONE</done>|7||Specify the «Recipient address» field value.||Укажите значение поля «Адрес получателя». <changes>ONLY_LAST</changes>|-|8||Specify the «Recipient phone» field value.||Укажите значение поля «Телефон получателя».</statusreq>|-</source>|9||Specify the «Recipient name» field value.||Укажите значение поля «ФИО получателя».|-=== Описание полей запроса статуса ===|10||Specify a valid «Quantity» field value.||Укажите корректное значение поля «Количество». '''statusreq''' |- Корневой контейнер. Обязательный элемент.*'''auth''' - Авторизация|11||Specify a valid «Declared value» field value. Обязательный элемент||Укажите корректное значение поля «Объявленная ценность».*'''client''' |- Признак клиента или агента|12||Supplier SKU ID not found. Необязательный элемент||Артикул не найден.:* CLIENT |- Признак клиента, значение по умолчанию:* AGENT - Признак агента|17||Order number already exists in the database. В ответ отдается информация по заказам, переданным агенту на доставку*'''orderno''' - Номер ||Такой номер заказа. Необязательный элементуже есть в базе.*'''ordercode''' - Внутренний |-|18||Order code already exists in the database.||Такой код заказа. Необязательный элементуже есть в базе.*'''orderno2''' |- Номер заказа из срочных. Необязательный элемент.*'''datefrom''' |19||The delivery date format is not valid. Specify a date in YYYY-MM- Дата заказа "с"DD format. Необязательный элемент||Укажите значение поля «Дата доставки» в формате гггг-мм-дд.*'''dateto''' |- Дата заказа "по"|20||Specify a valid «Delivery mode» field value. Необязательный элемент||Укажите корректное значение поля «Режим доставки».*'''target''' |- Строка поиска. Позволяет указать текст, который содержится в названии компании или адресе получателя|21||Specify a valid «Return trip mode» field value.||Укажите корректное значение поля «Режим возврата».*'''done''' |- Может принимать значения: :* ONLY_DONE - Только доставленные (имеются в виду успешные статусы, например, '''Доставлен''' или '''Частично доставлен''')|22||Specify a valid «Delivery type» field value.||Укажите корректное значение поля «Тип доставки».:* ONLY_NOT_DONE |- Только не доставленные (заказы, которые не являются доставленными, например, '''Не доставлен''' или '''Утерян'''):* ONLY_NEW |23||Specify a valid «Return shipment type» field value.||Укажите корректное значение поля «Тип возврата».|- Только новые:* ONLY_DELIVERY - Только заказы в обработке - заказы, находящиеся в любом статусе, кроме конечных: Доставлено, Не доставлено, Отменён и т|30||Specify the «Order number» field value.д||Укажите значение поля «Номер заказа».:* ''Пусто'' |- все корреспонденции *'''changes''' - может принимать |31||Specify the «Barcode» field value.||Укажите значение только ONLY_LASTполя «Штрихкод». Если указан этот параметр, все остальные игнорируются. Описание данного режима приведено здесь: [[#Передача только изменившихся статусов|Передача только изменившихся статусов]]-|32||Specify the «Sender company» field value.||Укажите значение поля «Компания-отправитель».|-<div style="color: #a94442; background|33||Specify the «Sender name» field value.||Укажите значение поля «ФИО отправителя».|-color: #f2dede; border: 1px solid #ebccd1; padding: 3px 10px 10px;">'''Обратите внимание!'''|34||Specify the «Sender phone» field value.||Укажите значение поля «Телефон отправителя».|-# Периода запроса статусов (контейнеры '''datefrom''' и '''dateto''') ограничивается двумя месяцами — два месяца до даты '''"по"'''|35||Specify the «Sender city/town» field value.||Укажите значение поля «Город отправителя».# Если не указаны обе даты — '''dateto''' принимается равной текущей дате|-|36||Specify the «Sender address» field value.# Если не указана дата '''dateto''' — она принимается равной '''datefrom''' плюс 2 месяца||Укажите значение поля «Адрес отправителя».# Если не указана дата '''datefrom''' — она принимается равной '''dateto''' минус 2 месяца|-|37||Specify the «Pickup date» field value.||Укажите значение поля «Дата забора».</div>|-<br />|38||Specify the «Pickup time from» field value.||Укажите значение поля «Время забора с».|-=== Примеры ответов === |39||Specify the «Pickup time to» field value.||Укажите значение поля «Время забора до».|-'''Пример успешного ответа'''|40||Specify the «Recipient company» field value.||Укажите значение поля «Компания-получатель».|-<source lang="xml"><?xml version="1|41||Specify the «Recipient name» field value.||Укажите значение поля «ФИО получателя».0" encoding="UTF|-8"?><statusreq count="23">|42||Specify the «Recipient phone» field value.||Укажите значение поля «Телефон получателя». <order orderno="111111" awb="qwerty" orderno2="123123" ordercode="34534234" givencode="2345334">|- <barcode>111111<|43||Specify the «Recipient city/barcode> <sender> <company>МВД</company> <person>Иванов Иtown» field value.И||Укажите значение поля «Город получателя».</person> <phone>123-45|-67</phone> <contacts>|44||Specify the «Recipient address» field value.||Укажите значение поля «Адрес получателя». <phone>+74951234567</phone>|- </contacts>|45||Specify the «Delivery date» field value.||Укажите значение поля «Дата доставки». <town code="23432">Санкт|-Петербург</town> <address>Петровка 38 офис 35</address>|46||Specify the «Delivery time from» field value.||Укажите значение поля «Время доставки с». <date>2014-03|-22</date> <time_min>09:00</time_min> <time_max>14:00</time_max> </sender> <receiver> <company>МВД</company> <person>Иванов И|47||Specify the «Delivery time to» field value.И||Укажите значение поля «Время доставки до».</person> <phone>123|-45-67 - Иван (916)234|48||Specify the «Recipient postcode» field value.45||Укажите значение поля «Индекс получателя».21 Петр,mvd@mail.ru</phone> <contacts>|- <phone>+74951234567</phone>|49||Specify the «Weight» field value.||Укажите значение поля «Вес». <phone>+79162344521</phone>|- <email>mvd@mail|50||Specify the «Payment type» field value.||Укажите значение поля «Тип оплаты».ru</email> </contacts>|- <inn>1112223335</inn> <zipcode>125480</zipcode>|51||Specify the «Quantity» field value.||Укажите значение поля «Количество». <town code="153361" regioncode="78" regionname="Санкт|-Петербург город">Санкт-Петербург город</town> <address>Петровка 38 офис 35</address>|52||Specify the «Amount» field value.||Укажите значение поля «Сумма». <pvz>|- <code>126</code>|53||Specify the «Declared value» field value.||Укажите значение поля «Объявленная стоимость». <clientcode>QWERTY</clientcode>|- </pvz> <date>2014|54||Specify the «Description» field value.||Укажите значение поля «Описание».|-03-22</date> <time_min>09:00</time_min> <time_max>14:00</time_max> <coords lat="|55||Specify the «Instruction» field value.680327" lon="37||Укажите значение поля «Поручение».604456"></coords> </receiver>|- <pickup>NO</pickup> <weight>5|56||Specify the «Delivery mode» field value.1</weight> <return_weight>5||Укажите значение поля «Режим доставки».1</return_weight> <quantity>2</quantity>|- <paytype>CASH</paytype>|57||Specify the «Shipment type» field value.||Укажите значение поля «Тип отправления». <service>2</service>|- <return_service>2</service>|58||Specify whether return trip is required.||Укажите значение поля «Необходимость возврата». <type>3</type>|- <return_type>3</return_type>|59||Specify the «Return trip mode» field value.||Укажите значение поля «Режим возврата» <waittime>12</waittime> <price>387|-|60||Specify the «Return shipment type» field value.||Укажите значение поля «Тип возврата».5</price> <print_check>YES</print_check>|- <inshprice>387|61||Specify barcode.||Укажите штрихкод.5</inshprice> <enclosure>Детские игрушки</enclosure>|- <instruction>Проверить при покупателе, подписать акт</instruction> <currcoords lat="55|62||Specify item weight.680327" lon="37||Укажите массу единицы товара.604456" accuracy="50" RequestDateTime="2014|-|63||Specify item quantity.||Укажите количество товара.|-04-21 18:07:45"></currcoords> <courier> <code>26</code>|64||Specify item price.||Укажите цену единицы товара.|- <|65||Specify item name>Иванов Владимир Петрович</name>.||Укажите название товара. <phone>+79161234567</phone>|- </courier>|66||Wrong XLS file||Некорректный файл XLS.|- <deliveryprice total="158|67||Order barcode already exists in the database.6" delivery="100||Такой штрихкод заказа уже есть в базе.00" return="58|-|68||Select the «Payment by recipient» field value.||Укажите значение поля «Оплата получателем».6"> <advprice code="1" price="150">База</advprice>|-|69||Specify department.||Укажите отдел.|- <advprice |70||Specify service partner code="2" price="0">% от объявленной стоимости</advprice>.||Укажите значение поля «Код подрядчика». <advprice code="3" price="8.6">Топливный сбор</advprice>|- <advprice code="4" price="0">Округление</advprice>|71||Date cannot be earlier than tomorrow.||Дата не может быть раньше чем завтра. </deliveryprice>|- <receiverpays>NO</receiverpays>|72||Date cannot be later than 15 days from now.||Дата не может быть позже чем через 15 дней.|- <acceptpartially>NO</acceptpartially>|73||Date cannot be earlier than today.||Дата не может быть раньше чем сегодня. <status eventstore="филиал в Санкт|-Петербурге" eventtime="2016|74||Date cannot be later than {0} days from now.||Дата не может быть позже, чем через {0} дней.|-06-02 17:22:00" createtimegmt="2016-06|75||Specify a valid «Item weight» field value.||Укажите корректное значение поля «Масса единицы товара».|-03 16:14:44" message="" title="Доставлен">COMPLETE</status> <statushistory> <status eventstore="Офис в Москве" eventtime="2016|76||Specify a valid «Quantity» field value.||Укажите корректное значение поля «Количество товара».|-05|77||Specify a valid «Item price» field value.||Укажите корректное значение поля «Цена единицы товара».|-30 10:20:00" createtimegmt="2016|78||Specify a valid «Delivery time from» field value.||Укажите корректное значение поля «Время доставки с».|-06|79||Specify a valid «Delivery time to» field value.||Укажите корректное значение поля «Время доставки до».|-03 16:14:44" message="" title="Новый">NEW</status> <status eventstore="Офис в Москве" eventtime="2016|80||Specify a valid «Pickup time from» field value.||Укажите корректное значение поля «Время забора с».|-06-01 17:38:00" createtimegmt="2016|81||Specify a valid «Pickup time to» field value.||Укажите корректное значение поля «Время забора до».|-06|82||Specify a valid «Pickup point» field value.||Укажите корректное значение поля «ПВЗ».|-03 16:14:44" message="филиал |83||Duplicate number in the registry.||Дублирование номера в Санктреестре.|-Петербурге" title="Планируется отправка">DEPARTURING</status> <status eventstore="Офис в Москве" eventtime="2016-06-01 19:53:00" createtimegmt="2016-06-03 16:14:44" message="филиал |84||Duplicate barcode in the registry.||Дублирование штрихкода в Санктреестре.|-Петербурге" title="Отправлено со склада">DEPARTURE</status> <status eventstore="филиал в Санкт|85||Specify a valid «Weight at return trip» field value.||Укажите корректное значение поля «Вес возврата».|-Петербурге" eventtime="2016-06-02 07:41:00" createtimegmt="2016-06|86||Specify the «Weight at return trip» field value.||Укажите значение поля «Вес возврата».|-03 16:14:44" message="" title="Получен складом">ACCEPTED</status> <status eventstore="филиал в Санкт|87||Order weight exceeds the allowed maximum for the pickup point.||Вес превышает допустимое значение для этого ПВЗ.|-Петербурге" eventtime="2016|88||Pickup date cannot be earlier than today.||Дата забора не может быть раньше чем сегодня.|-06|89||Specify a later delivery date.||Укажите более позднюю дату доставки.|-02 09:17:00" createtimegmt="2016-06-03 16:14:44" message="" title="Выдан курьеру на доставку">DELIVERY</status> <status eventstore="филиал в Санкт|90||Inappropriate «Weight» or «Pay type» field value for the selected city or town. Please review and correct the values.||Значение поля «Масса» или «Тип оплаты» для выбранного города указано некорректно или отсутствует. Проверьте значения и исправьте.|-Петербурге" eventtime="2016|91||{deliverytype} {deliverydate} is {holidaytype}. Select another date.||{deliverytype} {deliverydate} является {holidaytype}. Выберите другую дату.|-06|92||{deliverytype} {deliverydate} is {holidaytype}. Select another date.||{deliverytype} {deliverydate} является {holidaytype}. Выберите другую дату.|-02 17:22:00" createtimegmt="2016|93||Add items.||Добавьте товары.|-06|95||The selected pickup point only allows paid orders.||Выбранный ПВЗ выдает только предоплаченные заказы.|-03 16:14:44" message="" title="Доставлен |96||Order barcode exceeds the allowed maximum (25) symbols.||Длина штрихкода заказа превышает максимально допустимую (предварительно25 символов)">COURIERDELIVERED</status>. <status eventstore="филиал в Санкт|-Петербурге" eventtime="2016|97||The pickup date format is not valid. Specify a date in YYYY-06MM-02 17:22:00" createtimegmt="2016DD format.||Укажите значение поля «Дата забора» в формате гггг-06мм-дд.|-03 16:14:44" message="" title="Доставлен">COMPLETE</status> </statushistory>|98||Specify the cost code.||Укажите значение поля «Кост-код». <customstatecode>2<customstatecode>|- <clientstatecode></clientstatecode> <costcode>cc12345</costcode> <receipt fdNum="124555" fnSn="9289000100295555" kktNum="0001611984048555" inn="7722756555" fdValue="2899551555" summ="387|99||The item is not in stock.5" ofdUrl="gate||Товар отсутствует на складе.ofd.ru">https://ofd|-|100||Set the quantity of the item marked with Chestny ZNAK to one.ru/rec/7722756555/0001611984048555/9289000100295555/124555/2899551555</receipt> <deliveredto>Иванова||Укажите количество товара, маркированного кодом «Честный ЗНАК», секрравным единице.</deliveredto> <delivereddate>2016|-06-02</delivereddate> <deliveredtime>17:22</deliveredtime>|101||Quantity of item Delivery cannot be greater than 1||Количество вложений типа «Доставка» не может быть более 1. <arrival>2016-05|-02 23:21</arrival> <outstrbarcode>EXT123456</outstrbarcode> <return_message>Доставлено в целости</return_message>|102||А database error occurred. Please try later again.||Ошибка базы данных. Попробуйте позже.|- <department>Отдел</department>|103||Order not found.||Заказ не найден. <items>|- <item code="34533" extcode="abc123" quantity="1" mass="0|104||Cannot edit order in the current status.2" retprice="37||Невозможно изменить заказ в текущем статусе.5" VATrate="0" barcode="2345625213125" article="1" returns="0" origincountry="040" GTD="" excise="0|-|105||Discount cannot be greater than the order amount. Specify a smaller value.||Размер скидки не может превышать сумму заказа. Укажите меньшее значение скидки.|-|106||Specify the correct additional service code.||Укажите корректный код дополнительной услуги.00" governmentCode="11223311" suppcompany="Поставщик" suppINN="1112223334" suppphone="79161234567">Мяч</item> <item code="34456" extcode="abc124" quantity="2" mass="2" retprice="100" VATrate="10" barcode="4645625213138" article="2" returns="0" governmentCode="">Обруч</item>|-|107||Specify the correct additional service name.||Укажите корректное значение поля [advprice][value]. <item code="34421" extcode="abc125" quantity="3" mass="0|-|108||Specify the «Additional services» field value.||Укажите значение поля «Дополнительные услуги».|-|110||Specify the correct TIN.||Укажите корректный ИНН.|-|111||Specify the correct IIN (KZ).||Укажите корректный ИИН (КЗ).3" retprice="50" VATrate="18" barcode="2345625213126" itemcode="44123" article="3" returns="0" governmentCode="">Погремушка желтая</item> </items>|-|112||Specify the overall volume.||Укажите общий объем. <packages>|- <package code="33331" strbarcode="ORD0000001" mass="1" message="" got="YES"></package>|113||Cannot apply the delivery mode. Select another delivery mode.||Режим доставки не подходит для заказа. Выберите другой режим.|- <package code="33332" strbarcode="ORD0000002" mass="2|114||The pickup point does not support the selected delivery mode. Specify another pickup point.||ПВЗ не подходит для выбранного режима доставки. Укажите другой ПВЗ.5" message="" got="NO"></package> </packages>|- </order>|115||Specify a valid recipient phone number.||Укажите корректный телефон получателя.|-</statusreq> |116||Specify recipient PIN code.||Укажите пин-код получателя.<|-|117||Order date cannot be earlier than {0}. Specify another date.||Дата заказа не может быть раньше {0}. Укажите другую дату.|-|118||Pickup date cannot be earlier than {0}. Specify another date.||Дата забора не может быть раньше {0}. Укажите другую дату.|-|119||Specify the correct item type.||Укажите корректный тип вложения.|-|120||The pickup point does not accept payment by card.||В выбранном ПВЗ оплата картой не принимается.|-|121||Invalid item code format||Неверный формат кода товарной номенклатуры|-|122||Pickup time cannot be earlier than {0} hours.||Время забора не может быть раньше чем через {0} часа.|-|123||Pickup interval cannot be less than {0} minutes.||Интервал времени забора не может быть менее {0} минут. Укажите корректный интервал.|-|124||Specify a valid "Payment type" field value.||Укажите корректное значение поля «Тип оплаты».|-|125||Recepient city/source>town by postcode not found.||Город получателя по его индексу не найден.|-|126||Incorrect items prepayment and pickup.||Заказ не может содержать только вложения «Предоплата» и «Забор».|-|127||Package limit exceeded||Превышен лимит количества мест|-|128||Quantity of item Prepayment cannot be greater than 1||Количество вложений типа «Предоплата» не может быть больше 1.|-|129||Sum of cod must be equal sum of items||Объявленная стоимость должна быть равна сумме вложений.|-|130||Specify a valid respstore code.||Укажите код ответственного филиала.|-|131||Cannot edit, order has not been synchronized.||Невозможно изменить заказ пока он не синхронизирован.|-|132||Specify a valid "Recipient city/town" field value.||Укажите город получателя|-|133||Specify a valid "weight" for the town.||Укажите корректный вес для города|-|134||Specify a valid "paytype" for the town.||Укажите тип оплаты для города|-|135||Specify the correct SKU ID/code for item.||Укажите артикул/код вложения|-|136||Specify warehouse goods in the order.||Укажите вложения в заказе|-|137||The order's date of creation is more than 60 days ago.||Заказ создан более 60 дней назад|-|138||Specify a valid "Package dimension" field value.||Укажите корректные габариты места|-|139||Wrong type of XML query||Ошибка запроса|-|140||Duplicate item code in the order.||Дублирование кода вложения в заказе|-|141||Duplicate additional service in the order.||Дублирование кода дополнительной услуги в заказе|-|}
=== Пример запроса статуса заказа ===
<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 — Только заказы в обработке — заказы, находящиеся в любом статусе, кроме конечных: Доставлено, Не доставлено, Отменён и т. д.:* ''Пусто'' — все корреспонденции * '''changes''' — может принимать значение только ONLY_LAST. Если указан этот параметр, все остальные игнорируются. Описание данного режима приведено здесь: [[#Передача только изменившихся статусов|Передача только изменившихся статусов]]
<div style=== Описание полей ответа "color: #a94442; background-color: #f2dede; border: 1px solid #ebccd1; padding: 3px 10px 10px;">'''Обратите внимание!'''# Периода запроса статусов ===(контейнеры '''datefrom''' и '''dateto''') ограничивается двумя месяцами — два месяца до даты '''«по»'''.# Если не указаны обе даты — '''dateto''' принимается равной текущей дате.# Если не указана дата '''dateto''' — она принимается равной '''datefrom''' плюс 2 месяца.# Если не указана дата '''datefrom''' — она принимается равной '''dateto''' минус 2 месяца.Все поля ответа соответствуют структуре order при создании # Поиск по '''conditions''' работает только для «Номер заказа, с некоторыми добавлениями:(шифр)» и только от 4 символов</div><br>
<source lang="xml">
<?xml version="1.0" encoding="UTFutf-8"?><tracking> <order ordernostatusreq count="1111110"> <barcode>111111</barcodestatusreq> <AWB>111111</AWBsource> '''Пример ответа при ошибке авторизации''' <sendersource lang="xml"> <town code?xml version="1.0" countryencoding="RUutf-8"?>Москва город</townrequest> <dateerror error="1" errormsg="authorization error">2014-03-22</dateerror> <time_min>09:00</time_minrequest> <time_max>14:00</time_maxsource> </sender> '''Пример ответа при ошибке синтаксиса''' <receiversource lang="xml"> <town code?xml version="1.0" countryencoding="RUUTF-8"?>Москва город</townrequest> <zipcodeerror>column:1 line:11 message:expected '>125480'</zipcodeerror> <date/request>2014-03-22</datesource> <time_min>09=== Описание полей ответа статусов ===Все поля ответа соответствуют структуре order при создании заказа, с некоторыми добавлениями: * Атрибуты контейнера '''order''':00</time_min> <time_max>14:00</time_max>* '''''awb''''' — Номер накладной в системе курьерской службы. </receiver>:* '''''orderno2''''' — Номер накладной в подсистеме срочной доставки курьерской службы. <price>387:* '''''ordercode''''' — внутренний код заказа в системе, применяется для некоторых внутренних операций.5</price> <inshprice>387:* '''''givencode''''' — внутренний код заказа в системе, применяется для некоторых внутренних операций.5</inshprice> <*'''paytype>''' - Тип оплаты заказа получателем. Принимает значения::: CASH</- Наличными при получении (по-умолчанию):: CARD - Картой при получении:: NO - Без оплаты.:: OTHER - Прочее (Предусмотрен для того, чтобы оплата поступала непосредственно в курьерскую службу посредством прочих типов оплаты - таких как: вебмани, яденьги, картой на сайте, прочие платежные системы и т.д.)* Атрибуты контейнера '''paytype>''': <weight>5** '''''code''''' - (integer) внутренний код типа оплаты заказа в системном справочнике "Типы оплаты корреспонденции". Не обязательный элемент.1</weight> <quantity>2</quantity> <service>2</service> <type>3</type>* атрибут '''''code''''' контейнера '''item''' — внутренний код строки заказа в системе, применяется для некоторых внутренних операций.:* '''''returns''''' — количество данного товара, от которого отказался получатель. Не нулевое только в случае частичного отказа. <return>NO</return> <return_service>2<* атрибут '''''got''''' контейнера '''package''' — признак принятого места YES /service>NO. <return_date></return_date>:* '''''returns''''' — количество данного товара, от которого отказался получатель. Не нулевое только в случае частичного отказа. <return_time></return_time> <return_message><* '''''area''''' в контейнере '''receiver''' — район/return_message>метро получателя. <waittime>12</waittime>* '''''coords''''' в контейнере '''receiver''' — координаты получателя. <enclosure>Детские игрушки</enclosure>* '''''deliveryPIN''''' в контейнере '''receiver''' — Пин-код. <instruction>Проверить при покупателе* '''pickup''' — признак оформления забора, возможные значения: '''YES''', подписать акт</instruction> <deliveryprice total="158'''NO'''.6" delivery="100Если указано '''YES''', то весь заказ считается заданием на забор груза, а не на доставку.00" return="58* '''currcoords''' — текущие координаты заказа.6" />Атрибуты::* '''''lat''''' — широта <courier>:* '''''lon''''' — долгота <code>26</code>:* '''''accuracy''''' — точность в метрах <name>Иванов Владимир Петрович<:* '''''RequestDateTime''''' — дата/name>время последнего обновления координат. <phone>+79161234567</phone> </* '''courier>''' — Данные курьера, которому выдан заказ. Если заказ не выдан, то выводятся данные запланированного курьера. <currcoords lat="55* '''waittime ''' — Время ожидания курьера.680327" lon="37* '''deliveryprice''' — Стоимость услуг в валюте расчетов с клиентом.604456" accuracy="50" RequestDateTime="2014-04-21 18Атрибуты::07* '''''total''''' — общая стоимость услуг:45" />* '''''delivery''''' — стоимость доставки «Туда» <status eventstore="филиал в Санкт:* '''''return''''' — стоимость доставки «Обратно» (если order-Петербурге" eventtime>return="2016-06-02 17YES)Тэг '''deliveryprice''' включает список дополнительных услуг (только для тарифа «Премиум»):22:00" createtimegmt="2016-06-03 16* '''''advprice''''' — наименование дополнительной услуги:14* '''''code''''' — код дополнительной услуги:44" message="" title="Доставлен">COMPLETE</* '''''price''''' — стоимость дополнительной услуги * '''status>''' — статус доставки (список статусов см. ниже). Атрибуты (заполняются начиная с версии системы 2008.0.0.670)::* '''''eventstore''''' — филиал, к которому относится текущий статус <statushistory>:* '''''eventtime''''' — время события по часовому поясу места его наступления. :* '''''createtimegmt''''' — время по GMT создания записи о смене статуса в БД. Используется для сортировки записей, чтобы соблюсти хронологическую последовательность. <status eventstorespoiler text="Офис Подробнее">Большинство событий фиксируются в Москве" полях eventtime="2016-05-30 и createtimegmt на основании одного действия, тогда они отличаются только сдвигом от GMT. Однако, если курьер доставил отправление 10.10.2010 в 20:00, по какой-то причине не внес это в мобильное приложение, на следующий день сдал накладную, и в 9 утра оператор внесла, что он доставил вчера в 20:00" . Тогда в createtimegmt="2016будет сегодня 6 утра (для Москвы), а в eventtime — вчера в 20:00. При этом оператор по каким-то причинам может внести время вручения раньше, чем какое-06то предыдущее событие, т.о. нарушится последовательность времени в eventtime, но при сортировке по createtimegmt все-03 16:14:44" message="" title="Новый">NEWравно все будет правильно.</statusspoiler> <status eventstore="Офис в Москве" eventtime="2016-06-01 17:38:00" createtimegmt="2016* '''''message''''' — наименование филиала-06-03 16получателя, при передаче между филиалами:14:44" message="филиал * '''''title''''' — русское наименование статуса * '''statushistory''' — история статусов доставки. Содержит список контейнеров '''status'''. Заполняется только для тарифа «Премиум» начиная с версии системы 2008.0.0.670.* '''customstatecode''' — код внутреннего статуса курьерской службы. Значения уточняйте в курьерской службе. Назначаются курьерской службой в разделе «Справочники» — «Статусы» — «15 Статусы корреспонденции». Справочник не передается через API клиенту по причине возможного наличия в Санкт-Петербурге" title="Планируется отправка">DEPARTURING<нем внутренних технологических статусов курьерской службы.* '''clientstatecode''' — код статуса клиента. Используется, если клиент предлагает свои коды статусов доставки/status>причин недоставки.* '''deliveredto''' — данные из поля «Инфо. о доставке» (может быть информация о доставке, причина недоставки и т. п.).* '''delivereddate''' — дата вручения.* '''deliveredtime''' — время вручения. В случае недоставки может быть пустым. <status eventstore="Офис * '''arrival''' — плановая дата прибытия в Москве" eventtime="2016формате гггг-06мм-01 19дд чч:53мм:00" createtimegmt="2016сс. Заполняется только при использовании автоматических систем планирования (Максоптра, Яндекс доставка), во всех остальных случаях -06-03 16пустое.* '''outstrbarcode''' — код у подрядчика (код заказа во внешней системе). Используется в интеграциях с внешними системами.* '''partner''' — текущий филиал/подрядчик.* '''return_message''' — информация о возврате* '''department''' — Подразделение, в котором оформляется заказ. Контейнер '''status''' может принимать следующие значения:14:44" message="филиал AWAITING_SYNC — Ожидает синхронизации. Данные заказа пока не появились в Санкт-Петербурге" title="Отправлено со склада">DEPARTURE</status>службе доставки. <status eventstore="филиал : '''NEW''' — Успешно создан, передан в Санкт-Петербурге" eventtime="2016-06-02 07службу доставки.: NEWPICKUP — Создан забор.:41PICKUP — Забран у отправителя.:00" createtimegmt="2016-06-03 16WMSASSEMBLED — Скомплектован на складе фулфилмента.:14WMSDISASSEMBLED — Разукомплектован на склад фулфилмента.:44" message="" title="'''ACCEPTED''' — Получен складом">ACCEPTED</status>.: CUSTOMSPROCESS — Производится таможенный контроль.: CUSTOMSFINISHED — Таможенный контроль произведен.: CONFIRM — Согласована доставка.: UNCONFIRM — Не удалось согласовать доставку. <status eventstore="филиал в Санкт-Петербурге" eventtime="2016-06-02 09:17DEPARTURING — Планируется отправка со склада на другой склад.:00" createtimegmt="2016-06-03 16DEPARTURE — Отправлено со склада на другой склад.:14INVENTORY — Инвентаризация. Убедились в наличии отправления на складе.:44" message="" title="PICKUPREADY — Готов к выдаче в ПВЗ.: '''DELIVERY''' — Выдан курьеру на доставку">DELIVERY</status>. <status eventstore="филиал : COURIERDELIVERED — Доставлен (предварительно, ожидает подтверждения менеджером, чтобы перейти в Санкт-Петербурге" eventtime="2016-06-02 17статус COMPLETE).:22:00" createtimegmt="2016-06-03 16COURIERPARTIALLY — Частично доставлен (предварительно, ожидает подтверждения менеджером, чтобы перейти в статус PARTIALLY).:14:44" message="" title="Доставлен COURIERCANCELED — Отказ (предварительно, после этого ожидается COURIERRETURN)">COURIERDELIVERED<.: COURIERRETURN — Возвращено курьером. Курьер не смог доставить до получателя и вернул заказ обратно на склад. Это промежуточный статус, после которого менеджер выясняет, нужно ли повторно доставлять (статусы DATECHANGE/status>DELIVERY) или это окончательная недоставка (CANCELED). <status eventstore="филиал в Санкт-Петербурге" eventtime="2016-06-02 17:22DATECHANGE — Перенос даты доставки. :00" createtimegmt="2016-06-03 16'''COMPLETE''' — Доставлен.:14'''PARTIALLY''' — Доставлен частично.:44" message="" title="Доставлен">COMPLETE<'''CANCELED''' — Не доставлен (Возврат/status>Отмена). После этого статуса отправление должны вернуть заказчику, будут статусы RETURNING и RETURNED </statushistory>: RETURNING — Планируется возврат заказчику (после CANCELED). <deliveredto>Иванова, секр: RETURNED — Возвращен заказчику.<: LOST — Утрачен/deliveredto>утерян. <delivereddate>2016-06-02</delivereddate> <deliveredtime>17:22</deliveredtime>PARTLYRETURNING — Планируется возврат остатков. <outstrbarcode>EXT123456</outstrbarcode>: PARTLYRETURNED — Остаток возвращен. <items>: TRANSACCEPTED — Прибыл на склад перевозчика. <item code="34533" extcode="abc123" quantity="1" mass="0: PICKUPTRANS — Забран у перевозчика.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 codediv style="34421" extcode="abc125" quantity="3" mass=color: #a94442; background-color: #f2dede; border: 1px solid #ebccd1; padding: 3px 10px 10px;"0.3" retprice="50" VATrate="18" barcode="2345625213126" article="3" returns="0" governmentCode="">Погремушка желтая</item> </items> </order></tracking></source>'''Обратите внимание!'''
# Контейнер '''statushistory''' и '''deliveryprice''' заполняется для тарифов [[Личный кабинет курьерской службы#Функции личного кабинета|Премиум и Максимум]].
# Система никогда не гарантирует последовательность прохождения заказом набора статусов. То есть Вы можете получить статус «COMPLETE», а следующим запросом — «NEW» — такое может произойти, например, если оператор ошибочно отметил заказ выполненным, а затем исправил ошибку.
</div>
<br>
<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?><tracking17statusreq> <auth extra="8" login="login" pass="pass"></auth> <changes>8ONLY_LAST</extrachanges> <ordernostreamid>1234</ordernostreamid></tracking17statusreq>
</source>
<div style="color: #a94442; background-color: #f2dede; border: 1px solid #ebccd1; padding: 3px 10px 10px;">
</div>
<br>
=== Описание полей запроса изменения =Трекинг заказа по номеру ==Все поля запроса соответствуют структуре order при создании заказа за исключением:* вместо корневого тэга '''neworder''' указывается '''editorder'''* тэг штрих-кода '''barcode''' Запрос трекинга по номеру предназначен для выдачи минимальной обезличенной информации о конкретном заказе не указываетсяавторизованному пользователю. Наша система имеет для этого интерфейс по адресу «home.courierexe.ru/{код экстра}/tracking». Вы можете либо сделать ссылку на такую страницу на своем сайте, поскольку присваивается при создании заказалибо разместить ее [[#Размещение страниц на своем сайте (iframe)|iframe’ом]] у себя, либо сделать свою и пользоваться нашим API.* Этот интерфейс создан специально для вложений '''item''' указывается внутренний код вложения выдачи информации живому пользователю сайта. Для получения статусов заказов в атрибуте '''code'''свою информационную систему нужно использовать запрос «statusreq», который можно получить при получении статуса заказа.желательно с параметром changes=ONLY_LAST!
<source lang="xml">
<?xml version="1.0" encoding="UTF-8" ?><cancelordertracking> <auth extra=">8" login="login" pass="pass" </extra> <order orderno="" ordercode="123456" /> 1234<order /orderno="123aaa" ordercode="" /></cancelordertracking>
</source>
</source>
'''Описание полей:Получение информации в формате 17 TRACK'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<addattachmentstracking17> <attachmentsextra> <item name="photo1.jpg" error="0" errormsg="OK" errormsgru="Успешно" /> <item name="photo2.jpg" error="0" errormsg="OK" errormsgru="Успешно" /> </attachments></addattachments>8</source> == Получение вложений к накладной == '''Пример запроса:'''<source lang="xml"><?xml version="1.0" encoding="UTF-8" ?><attachments> <auth extra="8" login="login" pass="pass" /> <orderno>12345671234</orderno></attachmentstracking17>
</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"xml:">Courierdelivered" }, { "time":"2016-06-02 09:17:00", "location":"RU", "content":"Delivery" }, {<?xml version= "1.0time" encoding=:"UTF2016-806-02 07:41:00", "location":"RU", "content"?>:"Accepted" },<attachments> { <item name= "doc1.docxtime" size=:"356542016-06-01 19:53:00">JVBERi0xLjMN, JUBQREYwMTIzNDU2Nzg5IDI NMyAwIG9iag08PA0vVHlwZSA "location":"RU", U3VidHlwZSAvSW1hZ2UNL1d pZHRoIDE4MDgNL0hlaWdodCA "content":"Departure" ggNCAwIFINL0JpdHNQZXJDb 21wb25lbnQgMQ0vRGVjb2RlU }, ENL0NvbHVtbnMgMTgwOA0+P g0vSW1hZ2VNYXNrIHRydWUNL { XhEZWNvZGUNPj4Nc3RyZWFt DQ</item> "time":"2016-06-01 17:38:00", <item name= "photo2.jpglocation" size=:"74861RU">VBERi0xLjMN , JUBQREYwMTIzNDU2Nzg5IDI NMyAwIG9iag08PA0vVHlwZSA "content":"Departuring" vWE9iamVjdA0vU3VidHlwZS AvSW1hZ2UNL1dpZHRoIDEzNj }, gNL0hlaWdodCAxMzMzDS9MZ W5ndGggNCAwIFINL0JpdHNQZ { XJDb21wb25lbnQgMQ0vRGVj b2RlUGFybXMgPDwNL0sgLTEN "time":"2016-05-30 10:20:00", "location":"RU", "content":"New" L0NvbHVtbnMgMTM2OA0+Pg0 vSW</item> }</attachments> ]}</sourcepre>
== Изменение заказа ==Запрос предназначен для изменения заказов. Изменять заказы могут курьерские службы с тарифами «Премиум» и «Максимум». Чтобы разрешить изменение заказов, в личном кабинете курьерской службы перейдите в '''Настройки''' > '''Заказы''' и в разделе '''Отмена и редактирование''' установите флажок '''Разрешить отмену и изменение заказов'''. Вы также можете пометить в списке '''Статусы для отмены и редактирования заказов''' галками статусы корреспонденции, для которых возможны отмена и изменение заказов. По умолчанию (когда в этом списке ничего не выбрано) редактирование и отмена разрешены для статуса агентом «Новый» <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" ?>
<setorderinfocancelorder>
<auth extra="8" login="login" pass="pass" />
<order orderno="" ordercode="123456"> <message>Получил Иванов</message> </order> <order ordercodeorderno="234567123aaa"> <status>PICKUPREADY</status> <eventtime>2016-05-30 10:20:00</eventtime> <message>Клиент отказался от покупки</message> <paytype>CASH</paytype> <items> <item codeordercode="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> </order></setorderinfocancelorder>
</source>
'''Описание полей запроса статуса:''' '''setorderinfo''' - Корневой контейнер. Обязательный элемент.*'''auth''' - Авторизация. Обязательный элемент.*'''order''' - Контейнер заказа. Обязательный элемент. Запрос может содержать более одного контейнера '''order'''. Атрибут '''''ordercode''''' - внутренний код заказа.*'''status''' - Новый статус заказа. Доступны статусы из раздела [[#Описание полей ответа статусов]], кроме AWAITING_SYNC и NEW.*'''eventtime''' - Дата и время изменения статуса. Обязательно при указании статуса.*'''message''' - Текст сообщения ''Инфо о доставке''.*'''paytype''' - Тип оплаты заказа. Допустимые значения CASH/CARD.*'''items''' - Контейнер для описания вложений '''item''' . Атрибуты::* '''''code''''' - Код вложения.:* '''''quantity''''' - Количество доставленных единиц вложения.:* '''''reason''''' - Причина недоставки, выбирается из соответствующего списка статусов.*'''image''' - Контейнер прикрепляемого изображения. Содержит текст файла изображения, закодированный по стандарту ''base64''. Контейнер '''order''' может содержать более одного контейнера '''image'''. Атрибут::* '''''filename''''' - Имя файла.
'''cancelorder''' — Корневой контейнер. Обязательный элемент.
* '''auth''' — Авторизация. Обязательный элемент.
* '''order''' — Контейнер отменяемого заказа. Обязательный элемент. Запрос может содержать более одного контейнера '''order'''. Атрибуты:
:* '''''orderno''''' — Шифр заказа.
:* '''''ordercode''''' — Внутренний код заказа.
Обратите внимание, что должен быть указан хотя бы один из атрибутов ''orderno'' или ''ordercode''!
'''Пример ответа:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?><setorderinfocancelorder> <order orderno="123test" ordercode="123456" error="0" errormsg="OK" errormsgru="Успешно" /> <order orderno="123aaa" ordercode="234567" error="5952" errormsg="value [date_put] is already setorder not found" errormsgru="Значение [Дата доставки] уже указаноЗаказ не найден" /></setorderinfocancelorder>
</source>
== Получение документов для печати Добавление вложений к накладной == Метод позволяет прикрепить файлы к корреспонденции.Размер загружаемого файла не должен превышать 1 Мб.
'''Пример запроса получения печатных форм:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8" ?>
<waybilladdattachments>
<auth extra="8" login="login" pass="pass" />
<ordersorderno>1234567</orderno> <attachments> <order ordernoitem name="1234567" ordercode="33331photo1.jpg" >JVBERi0xLjMN1wb25lbnQgMQ JUBQREYwMTIzNDU2Nzg5IDI NMyAwIG9iag08PA0vVHlwZSA U3VidHlwZSAvSW1hZ2UNL1d pZHRoIDE4MDgNL0hlaWdodCA ggNCAwIFINL0JpdHNQZXJDb 21wb25lbnQgMQ0vRGVjb2RlU ENL0NvbHVtbnMgMTgwOA0+P g0vSW1hZ2VNYXNrIHRydWUNL XhEZWNvZGUNPj4Nc3RyZWFt DQ</item> <order ordernoitem name="1234568photo2.jpg" ordercode="33332" />VBERi0xLjMNAwIG9iag0HRoJ JUBQREYwMTIzNDU2Nzg5IDI NMyAwIG9iag08PA0vVHlwZSA vWE9iamVjdA0vU3VidHlwZS AvSW1hZ2UNL1dpZHRoIDEzNj gNL0hlaWdodCAxMzMzDS9MZ W5ndGggNCAwIFINL0JpdHNQZ XJDb21wb25lbnQgMQ0vRGVj b2RlUGFybXMgPDwNL0sgLTEN L0NvbHVtbnMgMTM2OA0+Pg0 vSW</ordersitem> <form>1</formattachments></waybilladdattachments>
</source>
'''Описание полей:'''
'''waybilladdattachments''' - — Корневой контейнер. Обязательный элемент.*'''auth''' - — Авторизация. Обязательный элемент.*'''ordersorderno''' - Список заказов для получения печатных форм — Номер заказа. Обязательный элемент. Содержит тэги '''order''' Может использоваться тэг <ordercode> с атрибутами:указанием внутреннего кода заказа.:* '''attachments''orderno''''' - шифр заказа — Обязательный элемент, в котором перечисляются передаваемые данные файлов.:** '''item''ordercode''''' - внутренний код заказа — Бинарные данные (файл), закодированные в base64. Указывать необходимо один из атрибутов для всех заказовОбязательный элемент. Приоритет имеет атрибут *** '''name''ordercode' — Атрибут элемента '''item'*'''form''' - Формат накладной, в котором передается имя файла. Не обязательный Обязательный элемент. Принимает значения::* 1 - Подробная накладная (по-умолчанию):* 2 - Наклейки Zebra:* 3 - Наклейки на страницу формата А4:* 4 - Акты приема-передачи
<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<waybilladdattachments> <contentattachments>EODIcaI8KSBlwQ 4MnEOR7Px8U8EBAyGICBnwpw IZhQgz0ZxuPs8EBM <item name="photo1.jpg" error="0" errormsg="OK" errormsgru="Успешно" /GcbjzB AwhBl8hwQYIO00GmEwg1CeEG > mqYTChNU0wqf8l8nz4zgc+K fCno+zwU5GjOZmzXGcbEQYIM 4zkegRE40zWzONyoNNMIOIa cWnp6aDCGEGE9NQmoQd2mg00 79U4f3hPTwnfp6Sdrafeqpa JDpFw <item name="photo2.jpg" error="0" errormsg="OK" errormsgru="Успешно" /1aYT077VNNNdO00G3q > mqqvp9p2E7T0/wiFemv8uG6 OM</contentattachments></waybilladdattachments>
</source>
== Получение вложений к накладной ==
'''Пример запроса:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8" ?>
<attachments>
<auth extra="8" login="login" pass="pass" />
<orderno>1234567</orderno>
</attachments>
</source>
'''attachments''' — Корневой контейнер. Обязательный элемент.* '''auth''' — Авторизация. Обязательный элемент.* '''Обратите вниманиеorderno''', что печатные формы для заборов не формируются — Номер/код заказа. Обязательный элемент.
<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<townlistattachments> <auth extraitem name="doc1.docx" size="835654" />JVBERi0xLjMN <codesearch>JUBQREYwMTIzNDU2Nzg5IDI NMyAwIG9iag08PA0vVHlwZSA <zipcode>110000</zipcode> U3VidHlwZSAvSW1hZ2UNL1d pZHRoIDE4MDgNL0hlaWdodCA <kladrcode>0100000100800</kladrcode> ggNCAwIFINL0JpdHNQZXJDb 21wb25lbnQgMQ0vRGVjb2RlU <fiascode>bd21979d-46f8-49d0-9105-e8d65172a983</fiascode> <code>123</code> ENL0NvbHVtbnMgMTgwOA0+P g0vSW1hZ2VNYXNrIHRydWUNL XhEZWNvZGUNPj4Nc3RyZWFt DQ</codesearchitem> <conditions> <city>Краснодарский край</city> <namecontains>новгород</namecontains> <namestarts>Моск</namestarts> <name>Москва</item name="photo2.jpg" size="74861">VBERi0xLjMN <fullname>Москва город</fullname> JUBQREYwMTIzNDU2Nzg5IDI NMyAwIG9iag08PA0vVHlwZSA <country>1</country> vWE9iamVjdA0vU3VidHlwZS AvSW1hZ2UNL1dpZHRoIDEzNj </conditions>gNL0hlaWdodCAxMzMzDS9MZ W5ndGggNCAwIFINL0JpdHNQZ <limit>XJDb21wb25lbnQgMQ0vRGVj b2RlUGFybXMgPDwNL0sgLTEN <limitfrom>30 L0NvbHVtbnMgMTM2OA0+Pg0 vSW</limitfromitem> <limitcount>10</limitcountattachments> <countall>YES</countallsource> </limit></townlist>В тегах item возвращаются бинарные данные (файлы), закодированные в base64. == Изменение статуса агентом ==<Запрос изменения статуса заказа позволяет установить окончательный статус заказа — «Доставлен» или «Не доставлен (Возврат/source>Отмена)».
<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?><townlist countsetorderinfo> <auth extra="38" pagelogin="1login" totalcountpass="3" totalpages="1pass"/> <townorder ordercode="123456"> <codemessage>26379Получил Иванов</codemessage> <city> <codeoutstrbarcode>237654312</codeoutstrbarcode> <name>Краснодарский край </nameorder> </cityorder ordercode="234567"> <namestatus>Сочи городPICKUPREADY</namestatus> <fiascodeeventtime>79da737a2016-603b05-4c19-9b54-9114c96fb91230 10:20:00</fiascodeeventtime> <kladrcodemessage>2300000700000Клиент отказался от покупки</kladrcodemessage> <shortname paytype>CASH</paytype> (not yet supported) <typename storeprice>123</storeprice> (not yet supported) <coords latitems> <item code="34533" quantity="1" reason="43.58550" longovernmentCode="39.723111223311" /> </town> <town> <item code>40331<="34456" quantity="0" reason="0" /code> <city> <item code>32</code> <name>Брянская область</name> </city> <name>Сочилов хутор</name> <fiascode>c9c96c67-2cc9-4f10-afde-fd32417ea216</fiascode> <kladrcode>3201900011100</kladrcode> <shortname /> <typename /> <coords lat="52.640734421" quantity="2" lonreason="33.17240" /> </town> <town> <code>114016</codeitems> <cityimage filename="filename1.jpg"> <code>60</code> <name>Псковская область<9j/name>4AAQSkZJRgA <BAQAAAQABAAD/city>2wBDAA0JCg sKCA0LCgsODg0PEyAVExISEy <name>Сочихино деревня</name>ccHhcgLikxMC4pLSwzOko+M zZGNywtQFdBRkxOUlNSMj5aY <fiascode>10df7588-19c1-49d1-a387-9de1cf3eb26f<VpQYEpRUk//fiascode>2wBDAQ4ODhMR EyYVFSZPNS01T09PT09PT09P <kladrcode>6001900015400</kladrcode>T09PT09PT09PT09PT09PT09 PT09PT09PT09PT09PT09PT09 <shortname PT09PT0/> <typename /> wAARCAYACAADAS IA<coords lat="56.6003" lon="29.3542" /image> </townorder></townlistsetorderinfo>
</source>
'''Пример запроса справочникаответа:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<regionlistsetorderinfo> <codesearch> <code>77</code> </codesearch> <conditions> <namecontains>край</namecontains> <namestarts>Моск</namestarts> <fullname>Московская область</fullname> <country>1<order ordercode="123456" error="0" errormsg="OK" errormsgru="Успешно" /country> <order ordercode="234567" error="59" errormsg="value [date_put] is already set" errormsgru="Значение [Дата доставки] уже указано" /conditions></regionlistsetorderinfo>
</source>
== Получение документов для печати =='''Пример ответазапроса получения печатных форм:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?><regionlist count="2"waybill> <city> <code>80<auth extra="8" login="login" pass="pass" /code> <country> <code>1</code> <name>Россия </name> <id>643</id> <ShortName1>RU</ShortName1> <ShortName2>RUS</ShortName2orders> <order orderno="1234567" ordercode="33331" /country> <name>Агинский Бурятский автономный округ<order orderno="1234568" ordercode="33332" /name> </cityorders> <city> <codeform>1</codeform> <country> <code>1</code> <name>Россия</name> <id>643</id> <ShortName1start>RU</ShortName1> <ShortName2>RUS</ShortName2> </country> <name>Адыгея республика</name> 5</citystart></regionlistwaybill>
</source>
'''Описание полей:''' '''waybill''' — Корневой контейнер. Обязательный элемент* '''auth''' — Авторизация. Обязательный элемент* '''orders''' — Список заказов для получения печатных форм. Содержит тэги '''order''' с атрибутами::* '''''orderno''''' — шифр заказа:* '''''ordercode''''' — внутренний код заказа. Указывать необходимо один из атрибутов для всех заказов. Приоритет имеет атрибут '''''ordercode'''''* '''form''' — Формат накладной. Не обязательный элемент. Принимает значения::* 1 — Подробная накладная (по-умолчанию):* 2 — Наклейки Zebra:* 3 — Наклейки на страницу формата А4:* 4 — Акты приема-передачи* '''start''' — Имеет смысл только для form == Справочник улиц ==3. Начальная позиция первой наклейки. Используется для пропуска наклеек на листе для их экономии.
'''Пример запроса справочника улицответа:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<streetlistwaybill> <conditionscontent>EODIcaI8KSBlwQ 4MnEOR7Px8U8EBAyGICBnwpw <town>Москва город</town> IZhQgz0ZxuPs8EBM// ОБЯЗАТЕЛЬНОЕ ПОЛЕ!GcbjzB AwhBl8hwQYIO00GmEwg1CeEG <namecontains>Хохло</namecontains> mqYTChNU0wqf8l8nz4zgc+K fCno+zwU5GjOZmzXGcbEQYIM <namestarts>Академика Х</namestarts> <name>Академика Хохлова</name> <fullname>Академика Хохлова ул.</fullname> 4zkegRE40zWzONyoNNMIOIa cWnp6aDCGEGE9NQmoQd2mg00 <79U4f3hPTwnfp6Sdrafeqpa JDpFw/conditions>1aYT077VNNNdO00G3q <limit> <limitfrom>30</limitfrom> <limitcount>10<mqqvp9p2E7T0/limitcount> <countall>YES</countall> wiFemv8uG6 OM</limitcontent></streetlistwaybill>
</source>
'''Обратите внимание''', что печатные формы для заборов не формируются. '''Пример ответас ошибкой:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<streetlist count="1" page="1" totalcount="3" totalpages="1"waybill> <streeterror> <name>Академика Хохлова ул.</name> <shortname>Академика Хохлова</shortname> <typename>ул.</typename> Текст ошибки</streeterror></streetlistwaybill>
</source>
<source lang="xml">
<?xml version="1.0" encoding="UTF-8" ?><itemlisttownlist> <auth extra="8" login="login" pass="pass"/> </authcodesearch> <codesearchzipcode>110000</zipcode> <codekladrcode>1234560100000100800</codekladrcode> <articlefiascode>FD343bd21979d-46f8-49d0-9105-e8d65172a983</articlefiascode> <barcodecode>2345625213125123</barcodecode> </codesearch> <conditions> <namecontainscity>телевизорКраснодарский край</namecontainscity> <namestartsnamecontains>sonyновгород</namestartsnamecontains> <namenamecontainsparts>Sony KDL-55W905 ЖК-телевизормолоково моск</namenamecontainsparts> <quantitynamestarts>EXISTING_ONLYМоск</quantitynamestarts> <storename>2Москва</storename> <fullname>Москва город</conditionsfullname> <exceptcountry> <code>1234781</codecountry> </exceptconditions> <limit> <limitfrom>30</limitfrom> <limitcount>10</limitcount> <countall>YES</countall> </limit></itemlisttownlist>
</source>
Внутри контейнера itemlist townlist все элементы могут как отсутствовать, так и комбинироваться. Поиск не чувствителен к регистру. *'''codesearchauth''' - Поиск по кодам — Авторизация, необязательный элемент. В Используется в случае использования - контейнеры conditions включенного и limit игнорируются.:* '''code''' - Поиск по внутреннему коду системы.:* '''article''' - Поиск по артикулу.:* '''barcode''' - Поиск настроенного ограничения по штрих-кодунаселенным пунктам в конкретной курьерской службе.
*'''conditionscodesearch''' - Задает условия поиска — Поиск по кодам. Все вложенные элементы одновременно накладывают условие "И"В случае использования — контейнеры conditions и limit игнорируются.:* '''namecontainszipcode''' - — Поиск товаровпо индексу. Обратите внимание на то, название которых содержит указанный текстчто один почтовый индекс может распространяться на несколько населенных пунктов. В этом случае система вернет несколько записей.:* '''namestartskladrcode''' — Поиск по 13- Поиск товаров, название которых начинается с указанного текстати значному коду КЛАДР.:* '''namefiascode''' - — Поиск товаров, название которых соответствует указанному тексту.:* '''quantity''' - Наличие на складе. Принимает значения EXISTING_ONLY - Только в наличии, NOT_EXISTING_ONLY - Только не в наличии, ALL - Все. ''Это поле может быть недоступным в некоторых установкахпо коду ФИАС (AOGUID).'':* '''storecode''' - — Поиск товаров по определенному складукоду в системе.
*'''exceptconditions''' - Описание исключений для корректного определения количества зарезервированной номенклатуры — Задает условия поиска. Все вложенные элементы одновременно накладывают условие «И».:* '''city''' — Поиск по всем населенным пунктам региона.:* '''namecontainsparts''' — Поиск населенных пунктов, название которых содержит все указанные слова, с разбиением поисковой фразы через пробел. Например "моск моло" найдет деревню "Молоково" в Московской области.:* '''namecontains''' — Поиск населенных пунктов, название которых содержит указанный текст.:* '''namestarts''' — Поиск населенных пунктов, название которых начинается с указанного текста.:* '''name''' — Поиск населенных пунктов, название которых соответствует указанному тексту.:* '''fullname''' — Поиск населенных пунктов, название вместе с типом населенного пункта которых соответствует указанному тексту.:* '''codecountry''' — Поиск только по стране с указанным внутренним кодом или текстовым кодом в соответствии [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"?>
<itemlist townlist count="3" totalcountpage="31" pagetotalcount="13" totalpages="1"> <itemtown> <code>12345626379</code> <articlecity> <code>23</code> <name>Краснодарский край</name>FD343 </articlecity> <barcodename>2345625213125Сочи город</barcodename> <namefiascode>Sony KDL79da737a-55W905 ЖК603b-телевизор4c19-9b54-9114c96fb912</namefiascode> <retpricekladrcode>650002300000700000</retpricekladrcode> <purchpriceshortname />50000 (not yet supported) <typename /purchprice> (not yet supported) <weightcoords lat="43.5855" lon="39.7231" /> </town>5.1 <town> <code>40331</weightcode> <lengthcity> <code>32</code> <name>Брянская область</name>50 </lengthcity> <widthname>30Сочилов хутор</widthname> <heightfiascode>40c9c96c67-2cc9-4f10-afde-fd32417ea216</heightfiascode> <VATratekladrcode>203201900011100</VATratekladrcode> <CountInPalletshortname />30 <typename /CountInPallet> <HasSerialscoords lat="52.6407" lon="33.1724" />1 </HasSerialstown> <town> <CountryOfOrigincode>Малайзия114016</CountryOfOrigincode> (not yet supported) <Messagecity>Хороший телевизор <code>60</Messagecode> <name>Псковская область</name> </city> <Message2name>Снова хороший телевизорСочихино деревня</Message2name> <quantityfiascode>1210df7588-19c1-49d1-a387-9de1cf3eb26f</quantityfiascode> <reservedkladrcode>36001900015400</kladrcode> <shortname /reserved> <itemtypename /> . <coords lat="56.6003" lon="29.3542" /> </town></itemlisttownlist>
</source>
== Движение номенклатуры Справочник регионов == '''Пример запроса движения номенклатурысправочника:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8" ?><itemmovementsregionlist> <auth extra="8" login="login" pass="pass"codesearch> <code>77</code> </codesearch> <conditions> <namecontains>край</authnamecontains> <codenamestarts>4259Моск</codenamestarts> <datefromfullname>2020-10-01Московская область</datefromfullname> <country>RU<dateto/country>2020-10-02 </datetoconditions></itemmovementsregionlist>
</source>
<source lang="xml">
<?xml version="1.0" encoding="UTF-8" ?><itemmovements regionlist count="162"> <itemmovementcity> <code>15150080</code> <date>2017-05-26</date> <retprice>0</retprice> <quantity>1</quantity> <delivered>0</delivered> <item> <code>4259</code> <name>Настольная игра Дженга</name> </item> <status> <code>5</code> <name>Возврат от покупателя</name> </status> <storecountry>
<code>1</code>
<name>офис в МосквеРоссия</name> </storeid> 643<order/id> <ordercodeShortName1>3374830RU</ordercodeShortName1> <numberShortName2>123660-0RUS</numberShortName2> <date>2017-05-24 </datecountry> <ordernoname>14123Агинский Бурятский автономный округ</ordernoname> <barcode>0000000670 </barcodecity> <company>ТОВАР</companycity> <addresscode>Кравченко ул., 1</addresscode> <delivereddate>2017-05-29</delivereddatecountry> <deliveredtimecode>12:00:001</deliveredtimecode> <deliveredto /name> Россия</order> <documentname> <codeid>21991643</codeid> <numberShortName1>318RU</numberShortName1> <dateShortName2>2017-05-26RUS</dateShortName2> <message> </messagecountry> <name>Адыгея республика</documentname> </itemmovementscity></itemlistregionlist>
</source>
== Справочник улиц ==''' Описание полей ответа Пример запроса справочника улиц:'''*'''code''' <source lang="xml"><?xml version="1.0" encoding="UTF- внутренний код операции движения8"?><streetlist> <conditions> <town>Москва город</town> // ОБЯЗАТЕЛЬНОЕ ПОЛЕ! <namecontains>Хохло</namecontains> <namestarts>Академика Х</namestarts> <name>Академика Хохлова</name> <fullname>Академика Хохлова ул.</fullname> </conditions> <limit> <limitfrom>30</limitfrom> <limitcount>10</limitcount>*'''date''' - дата операции <countall>YES</countall>*'''retprice''' - цена товара </limit>*'''quantity''' - количество товара операции</streetlist>*'''delivered''' - количество доставленного товара</source>
*'''itemconditions''' - контейнер товара — Задает условия поиска. Все вложенные элементы одновременно накладывают условие «И».:* '''codetown''' - внутренний — Обязательное поле. Название или код товаранаселенного пункта.:* '''namecontains''' — Поиск улиц, название которых содержит указанный текст.:* '''namestarts''' — Поиск улиц, название которых начинается с указанного текста.:* '''name''' - наименование товара — Поиск улиц, название которых соответствует указанному тексту.:* '''fullname''' — Поиск улиц, для которых название вместе с типом соответствует указанному тексту.
*'''statuslimit''' — Ограничивает вывод результата.:* '''limitfrom''' — Задает номер записи результата, начиная с которой выдавать ответ. По- контейнер статуса операцииумолчанию — 0.:* '''codelimitcount''' - код статусаЗадает количество записей результата, которые нужно вернуть. По-умолчанию — 10000.:* '''namecountall''' - наименование — YES указывает на необходимость подсчета общего количества найденных совпадений. Это может замедлять выполнение запроса. Если отключено, в ответе не указываются totalcount и totalpages.
== Справочник номенклатуры =='''Пример запроса справочника тарифов по городамноменклатуры:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?><tariffsitemlist> <auth extra="8" login="login" pass="pass" ></auth> <codesearch> <code>123456</code> <article>FD343</article> <barcode>2345625213125</barcode> </codesearch> <conditions> <namecontains>телевизор</namecontains> <namestarts>sony</namestarts> <name>Sony KDL-55W905 ЖК-телевизор</name> <quantity>EXISTING_ONLY</quantity> <store>2</store> </conditions> <townfromexcept>Москва <code>123478</townfromcode> <service/except>1 <limit> <limitfrom>30</limitfrom> <limitcount>10</servicelimitcount> <countall>YES<mainonly/countall>1 </mainonlylimit> </tariffsitemlist></source> Внутри контейнера itemlist все элементы могут как отсутствовать, так и комбинироваться. Поиск не чувствителен к регистру.* '''codesearch''' — Поиск по кодам. В случае использования — контейнеры conditions и limit игнорируются.:* '''code''' — Поиск по внутреннему коду системы.:*'''autharticle''' — атрибут — Поиск по артикулу.:* '''extrabarcode''' обязателен, — Поиск по нему определяется курьерская службаштрихкоду. *'''townfromconditions''' — город-отправитель — Задает условия поиска. Все вложенные элементы одновременно накладывают условие «И». Если не передан:* '''namecontains''' — Поиск товаров, то городом будет «Москва»название которых содержит указанный текст.:*'''servicenamestarts''' — режим доставки — Поиск товаров, название которых начинается с указанного текста. Обязательный элемент:* '''name''' — Поиск товаров, название которых соответствует указанному тексту.:*'''mainonlyquantity''' — необязательный элемент — Наличие на складе. Если переданПринимает значения EXISTING_ONLY — Только в наличии, то NOT_EXISTING_ONLY — Только не в наличии, ALL — Все. ''Это поле может быть недоступным в ответе будут данные только некоторых установках.'':* '''store''' — Поиск товаров по городам из справочника определенному складу. * '''Межгородexcept''' > — Описание исключений для корректного определения количества зарезервированной номенклатуры.:* '''Зоныcode''' — Код заказа.
* '''limit''' — Ограничивает вывод результата.
:* '''limitfrom''' — Задает номер записи результата, начиная с которой выдавать ответ.
:* '''limitcount''' — Задает количество записей результата, которые нужно вернуть.
'''Пример ответа справочника тарифов по городам'''<source lang="json">{ "townfrom": "0c5b2444-70a0-4932-980c-b4dc0d3f02b5", "service": 1, "tariffs": [ { "towntofias": "7339e834-2cb4-4734-a4c7-1fca2c66e562", "towntocode": "482", "towntoname": "Уфа город", "pricesnew": { "before": [ { "price": "100", "every": "0", "mass": "1" }, { "price": "200", "every": "1", "mass": "2" } ], "after": [ { "price": "300", "every": "1", "mass": "3" } ] }, "prices": { "before": { "mass": "3", "price": "202.5" }, "after": { "mass": "3", "every": "1", "price": "18.75" } }, "deliveryPeriodMin": 4, "deliveryPeriodMax": 5 } ]}</source> ''' Описание полей ответа '''* '''townfrom''' — код ФИАС города-отправителя.* '''service''' — режим доставки.*'''tariffs''' — cписок тарифов по городу.:* '''towntofias''' — код ФИАС города-получателя.:* '''towntocode''' — внутренний код города-получателя.:* '''towntoname''' — наименование города-получателя.:* '''pricesnew''' — ваши настройки тарифов из справочника '''Межгород''' > '''Тарифы по зонам'''.::* '''price''' — цена.::* '''every''' — за каждые.::* '''mass''' — масса.:* '''prices''' — устаревший элемент, не используется.:* '''deliveryPeriodMin''' — минимальный срок доставки.:* '''deliveryPeriodMax''' — максимальный срок доставки. == Номенклатура приходной накладной == '''Пример запроса номенклатуры приходной накладной:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8" ?><itemdoc> <auth extraitemlist count="3" totalcount="83" loginpage="login1" passtotalpages="pass1"> <item> <code>123456</code> <article>FD343</article> <barcode>2345625213125</barcode> <name>Sony KDL-55W905 ЖК-телевизор</name> <retprice>65000</retprice> <purchprice>50000</authpurchprice> <weight>5.1</weight> <length>50</length> <width>30</width> <height>40</height> <VATrate>20</VATrate> <CountInPallet>30</CountInPallet> <CountInBox>2</CountInBox> <HasSerials>1</HasSerials> <CountryOfOrigin>Малайзия</CountryOfOrigin> (not yet supported) <Message>Хороший телевизор</Message> <Message2>Снова хороший телевизор</Message2> <quantity>12<code/quantity> <reserved>219913</codereserved> <item> ...</itemdocitemlist>
</source>
'''Описание полей:'''*'''code''' — Внутренний идентификатор, присвоенный системой.* '''article''' — Артикул, назначенный клиентом (поставщиком).* '''barcode''' — Штрихкод производителя.* '''name''' — Наименование.* '''retprice''' — Розничная цена по- внутренний код документа приходной накладной (смумолчанию. При оформлении заказа цена используется та, которая указана в заказе.* '''purchprice''' — Закупочная цена.* '''weight''' — Масса в килограммах.* '''length''' — Длина в сантиметрах.* '''width''' — Ширина в сантиметрах.* '''height''' — Высота в сантиметрах.* '''VATrate''' — Ставка НДС, целое число процентов.* '''CountInPallet''' — Количество штук в паллете.* '''CountInBox''' — Количество штук в упаковке.* '''HasSerials''' — Требует учета серийных номеров. Принимает значения 1 — да, 0 — нет.* '''CountryOfOrigin''' — Наименование страны происхождения на русском языке.* '''Message''' — Комментарий.* '''Message2''' — Дополнительный комментарий.* '''quantity''' — Количество на складе. Товары, уже собранные в заказы в этом количестве не присутствуют, считаются покинувшими товарный склад. ''Это поле может быть недоступным в некоторых установках.''* '''reserved''' — Количество зарезервированного товара. Может превышать остаток на складе, если покупатели ждут следующей поставки. предыдущий запрос)''Это поле может быть недоступным в некоторых установках.''
== Движение номенклатуры =='''Пример ответа запроса движения номенклатуры:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8" ?>
<itemdocitemmovements> <codeauth extra="8" login="login" pass="pass">21991</codeauth> <numbercode>3184259</numbercode> <datedatefrom>20172020-0510-2601</datedatefrom> <messagedateto>2020-10-02</message> <items> <item code="4259" quantity="1" barcode="200300" article="123555">Настольная игра Дженга</item> </itemsdateto></itemdocitemmovements>
</source>
<source lang="xml">
<?xml version="1.0" encoding="UTF-8" ?>
<storelistitemmovements count="16"> <auth extra="8"itemmovement> <code>151500</authcode> <jsondate>YES2017-05-26</jsondate> <client_coderetprice>78900</client_coderetprice> <quantity>1</storelistquantity> <delivered>0</sourcedelivered> <item>*'''auth''' - Атрибут '''extra''' - обязателен, по нему определяется курьерская служба <code>4259</code>*'''json''' - Признак вывода ответа в виде JSON YES <name>Настольная игра Дженга</NOname>*'''client_code''' - Код клиента курьерской службы </item> <status>'''Пример ответа:''' <code>5</code> <source lang="xml"name>Возврат от покупателя<?xml version="1.0" encoding="UTF-8" ?/name> <storelist count="2"/status> <store> <code>1231</code> <name>ABCофис в Москве</name> </store> <order> <ordercode>3374830</ordercode> <number>123660-0</number> <date>2017-05-24</date> <orderno>14123</orderno> <barcode>0000000670</barcode> <company>ТОВАР</company> <address>Кравченко ул., 1</address> <delivereddate>2017-05-29</delivereddate> <deliveredtime>12:00:00</deliveredtime> <deliveredto /> <store/order> <document> <code>45621991</code> <number>318</number> <date>2017-05-26</date> <message><name/message>Филиал 2 </namedocument> </storeitemmovements></storelistitemlist>
</source>
''' Описание полей ответа '''*'''code''' - Код филиала. — внутренний код операции движения* '''date''' — дата операции* '''retprice''' — цена товара* '''quantity''' — количество товара операции*'''namedelivered''' - Наименование филиала. — количество доставленного товара
* '''Пример запроса пунктов самовывозаstore''' — контейнер филиала, к которому относится операция:* '''<source lang="xml"><?xml version="1.0" encoding="UTF-8" ?><pvzlist> <auth extra="8" login="login" pass="pass"></auth> <code>1234</code>''' — код филиала <client_code>7890</client_code> <town>Нижний Тагил</town> <parentcode>6</parentcode> <acceptcash>YES</acceptcash> <acceptcard>YES</acceptcard> <acceptfitting>YES</acceptfitting> <maxweight>30</maxweight> <acceptindividuals>YES</acceptindividuals> <lt>57.924737</lt> <lg>59.940019</lg> <rt>57.905682</rt> <rg>59.984669</rg> <json>YES</json> <limit> <limitfrom>30</limitfrom> <limitcount>2</limitcount> <countall>YES</countall> </limit></pvzlist></source>:* '''name''' — наименование филиала
*'''authorder''' - Атрибут '''extra''' - обязателен, по нему определяется курьерская служба, '''login''' и '''pass''' позволяют авторизоваться под клиентом — контейнер корреспонденции: для отдельного клиента могут быть ограничения по доступности некоторых ПВЗ, и в этом случае они будут учтены.*'''codeordercode''' - Внутренний — внутренний код.заказа:*'''client_codenumber''' - Код клиента курьерской службы. — номер заказа:*'''towndate''' - Город получателя. — дата заказа:*'''parentcodeorderno''' - Фильтр по родительскому [[#Справочник филиалов|филиалу]] — шифр:*'''acceptcashbarcode''' - Фильтр по приему наличных YES/NO — штрихкод:*'''acceptcardcompany''' - Фильтр по приему банковских карт YES/NO — компания:*'''acceptfittingaddress''' - Фильтр по наличию примерки YES/NO — адрес:*'''maxweightdelivereddate''' - Фильтр по максимальному весу, с которым работает ПВЗ*'''acceptindividuals''' - Фильтр по доступности физическим лицам YES/NO*'''lt''' - Широта левого верхнего угла*'''lg''' - Долгота левого верхнего угла*'''rt''' - Широта правого нижнего угла*'''rg''' - Долгота правого нижнего угла*'''json''' - Признак вывода ответа в виде JSON YES/NO*'''limit''' - Ограничивает вывод результата. — дата вручения:* '''limitfromdeliveredtime''' - Задает номер записи результата, начиная с которой выдавать ответ. По-умолчанию - 0. — время вручения:* '''limitcountdeliveredto'''- Задает количество записей результата — данные о вручении, которые нужно вернуть. По-умолчанию - 100.:* '''countall''' - YES указывает на необходимость подсчета общего количества найденных совпадений. Это может замедлять выполнение запроса. Если отключено - в ответе не указываeтся totalcount.либо причина недоставки
* '''document''' — контейнер документа операции
:* '''code''' — внутренний код документа
:* '''number''' — номер документа
:* '''extnumber''' — внешний номер документа
:* '''date''' — дата документа
:* '''message''' — комментарий
== Получение справочника тарифов по городам == '''Пример ответа запроса справочника пунктов самовывоза:тарифов по городам'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8" ?><pvzlist counttariffs> <auth extra="28" login="login" totalcountpass="40465pass"/> <pvz> <codetownfrom>126Москва</codetownfrom> <clientcodeservice>31</clientcodeservice> <namemainonly>Нижний Тагил1</namemainonly> <parentcode>6</parentcodetariffs> <parentname>Интеграция</parentnamesource> <town code="124267" regioncode="66" regionname="Свердловская область">Нижний Тагил город</town> <address>622036* '''auth''' — атрибут '''extra''' обязателен, гпо нему определяется курьерская служба.* '''townfrom''' — город-отправитель. Нижний ТагилЕсли не передан, улто городом будет «Москва».* '''service''' — режим доставки. Циолковского, дОбязательный элемент. 17</address> <phone>+73435417709* '''mainonly''' — необязательный элемент. Если передан, +73435254989</phoneто в ответе будут данные только по городам из справочника '''Межгород''' >'''Зоны'''. '''Пример ответа справочника тарифов по городам''' <comment>Новый пункт доставки</commentsource lang="json">{ <worktime>Вс 10"townfrom":00"0c5b2444-16:00, Сб 10:0070a0-16:00, Пн4932-Пт 10:00980c-20:00</worktime>b4dc0d3f02b5", <traveldescription>Жилое 5-ти этажное здание"service": 1, торцом к дороге, второе здание от перекрестка Пархоменко-Циолковского</traveldescription> <maxweight>10</maxweight>"tariffs": [ <acceptcash>YES</acceptcash> { <acceptcard>YES</acceptcard> <acceptfitting>YES</acceptfitting> <acceptindividuals>YES</acceptindividuals> <latitude>57.93457</latitude> <longitude>59.95131</longitude> <uid>40606d00 "towntofias": "0c5b2444-9c5170a0-11eb4932-b2c9980c-cfd6c1111392</uid>b4dc0d3f02b5", "towntocode": 1, </pvz> "towntoname": "Москва город", <pvz> "townregion": "Город Москва", <code>245</code> "distance": 0, <clientcode>NTG1</clientcode> "pricedistance": 0, <name>На Красноармейской</name> "pricesnew": { <parentcode>6</parentcode> "before": [ <parentname>Интеграция</parentname> { <town code= "124267price" regioncode=: 100, "66every" regionname=: 0, "Свердловская областьmass">Нижний Тагил город</town>: 1 <address>КРАСНОАРМЕЙСКАЯ }, д.79</address> <phone>+7(3435)379-044</phone> { <comment>Возможность примерки отсутствует</comment> "price": 150, <worktime>Вс 10 "every":00-160, "mass":005 } ], Сб 10 "after": [ { "price":00-160, "every":001, Пн-Пт 10 "mass":00-2038.01 }, { "price":00</worktime>15, <traveldescription>Напротив ТЦ Пирамида</traveldescription> "every": 1, <maxweight>20</maxweight> "mass": 51.01 <acceptcash>YES</acceptcash> } <acceptcard>YES</acceptcard> ] <acceptfitting>NO</acceptfitting> }, <acceptindividuals>YES</acceptindividuals> "deliveryPeriodMin": 1, <latitude>57.93468</latitude> "deliveryPeriodMax": 2 <longitude>60.55476</longitude> } <uid>41116853-9c51-11eb-b2c9-cfd6c1451392</uid> </pvz>]</pvzlist>}
</source>
== Получение фискальных данных заказа Номенклатура приходной накладной == '''Пример запроса получения фискальных данныхноменклатуры приходной накладной:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?><receiptdataitemdoc> <auth extra="8" login="testlogin" pass="testmpass" /> <orders/auth> <order orderno="123456" /code> 21991<order orderno="890111C" /code> </ordersitemdoc></receiptdatasource>
* '''code''' — внутренний код документа приходной накладной (см. предыдущий запрос).
'''Пример ответа получения фискальных данныхдвижения номенклатуры:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?><receipts count="1"> <receiptitemdoc> <ordernocode>12345621991</ordernocode> <fdDatetimenumber>2020-06-07 12:14:00318</fdDatetimenumber> <fdValuedate>1232017-05-26</fdValuedate> <fdNummessage>456</fdNummessage> <fnSn>789 </fnSnitems> <kktNum>100</kktNum> <inn>222</inn> <ofdUrl>gate.ofd.ru</ofdUrl> <fullUrl>https://check.ofd.ru/123</fullUrl> <price>12345</price> <lines countitem code="4259" quantity="1" barcode="200300" article="123555"> <line> <item>1111764Настольная игра Дженга</item> <name>Сапоги</name> <qty>1</qty> <price>1000</price> <vatRate>20</vatRate> <governmentCode>Z16513LK2</governmentCode> <itemType>1</itemType> </line> </lines> </receiptitems></receiptsitemdoc></source> Параметры ответа:*'''ordernoОписание полей ответа ''' - Номер заказа*'''fdDatetimecode''' - Дата и время пробития фискального чека — внутренний код приходной накладной*'''fdValuenumber''' - ФПД (фискальный признак — номер документа)*'''fdNumdate''' - ФИСКАЛЬНЫЙ ДОКУМЕНТ (фискальный номер чека)*'''fnSn''' - ФН (номер фискального накопителя)*'''kktNum''' - РН (регистрационный номер кассы) — дата документа*'''innmessage''' - ИНН — комментарий*'''ofdUrl''' - URL адрес (доменное имя) ОФД*'''price''' - Сумма чека*'''fullUrl''' - URL чека для просмотра онлайн*'''lines''' - Позиции чека:*'''item''' - код — контейнер товара:*'''namecode''' - наименование — внутренний код товара:*'''qtybarcode''' - количество — штрихкод товара:*'''pricearticle''' - цена — артикул товара:*'''governmentCodequantity''' - считанная последовательность, которая в дальнейшем преобразуется по алгоритму тега 1162:*'''vatRate''' - НДС — количество поступившего товара:*'''itemType''' - тип товара (товар, доставка и т.д.) == Справочник Видов срочности филиалов == '''Пример запроса Видов срочностисписка филиалов:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8" ?>
<servicesstorelist> <auth extra="8"></auth> <json>YES</json> <client_code>7890</client_code></servicesstorelist>
</source>
* '''auth''' — Атрибут '''extra''' — обязателен, по нему определяется курьерская служба* '''json''' — Признак вывода ответа в виде JSON YES/NO* '''client_code''' — Код клиента курьерской службы '''Пример ответа справочника Видов срочности:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8" ?>
<services storelist count="2"> <servicestore> <code>1123</code> <name>ЭкономABC</name> </servicestore> <servicestore> <code>2456</code> <name>СрочноФилиал 2</name> </servicestore></servicesstorelist>
</source>
* '''code''' — Код филиала.
* '''name''' — Наименование филиала.
== Справочник дополнительных услуг пунктов самовывоза == Для отображения списка пунктов выдачи (ПВЗ) есть '''Пример запроса дополнительных услуг:готовый JavaScript модуль'''<source lang="xml"><?xml version="1: https://home.courierexe.0" encoding="UTF-8"?><advprices> <auth extra="8" login="login" pass="pass" ru/js/> <visible>NO<measoft_map.js Инструкция по использованию — внутри. Посмотреть пример работы можно [https:/visible></advprices><home.courierexe.ru/source>pvz_test.html Здесь]
Обратите внимание, что если в выборке количество ПВЗ больше '''10000''' и не указаны параметры '''code''', '''json''' или '''limitcount''', то будет возвращаться ошибка. В этом случае необходимо использовать блок '''limit'''.
'''Пример ответа справочника дополнительных услугзапроса пунктов самовывоза:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8" ?>
<advpricespvzlist> <advpriceauth extra="8" login="login" pass="pass"></auth> <code>11234</code> <client_code>7890</client_code> <city>Свердловская область</city> <town regioncode="66" country="RU">Нижний Тагил</town> <address>Щёлковское шоссе</address> <house>77</house> <parentcode>6</parentcode> <acceptcash>YES</acceptcash> <nameacceptcard>Этажей в домеYES</nameacceptcard> <typeacceptfitting>intYES</typeacceptfitting> <maxweight>30</advpricemaxweight> <advpriceacceptindividuals>YES</acceptindividuals> <lt>57.924737<code/lt> <lg>59.940019</lg> <rt>257.905682</codert> <namerg>Коэффициент надбавки59.984669</namerg> <typejson>floatYES</typejson> <with_coords>YES</advpricewith_coords> <advpricelimit> <codelimitfrom>330</codelimitfrom> <namelimitcount>Расписаться на упаковке2</namelimitcount> <typecountall>boolYES</typecountall> </advpricelimit></advpricespvzlist>
</source>
'''Пример запроса стоимости доставкиответа справочника пунктов самовывоза:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8" ?>
<calculator> <auth extrapvzlist count="82" logintotalcount="login" pass="pass40465" > <pvz> <code>126</code> <clientcode>3</clientcode> <name>Нижний Тагил<calc /name> pricetype="CUSTOMER" <parentcode>6</parentcode> townfrom="Москва" <parentname>Интеграция</parentname> addressfrom <town code="Ленинский проспект, 95124267" zipcoderegioncode="66400066" towntoregionname="3800000300000Свердловская область">Нижний Тагил город</town> addressto="Ленина <address>622036, г. Нижний Тагил, ул.Циолковского, 10" pvz="123" l="10" w="20" h="30" mass="3д.7" service="1" price="1200" inshprice="1200" paytype="CASH" 17</address> <phone>+73435417709, +73435254989</calculatorphone> <comment>Новый пункт доставки</sourcecomment> Параметры <worktime>Вс 10:*'''pricetype''' 00- тип требуемой цены. Возможные значения16:00, Сб 10: "CUSTOMER" (по00-умолчанию) - [[Личный кабинет клиента#Цена доставки для получателя|цена для конечного получателя]]16:00, "CLIENT" Пн- цена курьерской службы для клиента.*'''townfrom''' Пт 10:00- Город отправления20:00</worktime>*'''addressfrom''' <traveldescription>Жилое 5- Адрес отправления*'''zipcode''' - Почтовый индекс города назначения*'''townto''' - Город назначения*'''addressto''' - Адрес назначения*'''pvz''' - Код пункта самовывоза по справочнику*'''l''' - Длина в сантиметрах (не обязательный параметр)*'''w''' - Ширина в сантиметрах (не обязательный параметр)*'''h''' - Высота в сантиметрах (не обязательный параметр)*'''mass''' - Масса в килограммах*'''service''' - Режим доставки - числоти этажное здание, указывающее на запись в справочнике [[#Справочник Видов срочности|видов срочности]]. Если этот параметр опуститьторцом к дороге, система выдаст расчет для всех доступных видов срочности, передав много контейнеров второе здание от перекрестка Пархоменко-Циолковского<calc/traveldescription> в ответе.*'''price''' - Сумма наложенного платежа <maxweight>10</maxweight>*'''inshprice''' - Сумма объявленной ценности <acceptcash>YES</acceptcash>*'''paytype''' - Тип оплаты <acceptcard>YES</acceptcard> <acceptfitting>YES</acceptfitting>Суммы НП и ОЦ, а также тип оплаты CARD имеют значение при настроенных в тарифе на вкладке Прочее долях (в процентах) от данных сумм. <acceptindividuals>YES</acceptindividuals> В авторизации можно опустить параметры login и pass, тогда расчет будет производиться по стандартному тарифу курьерской службы, без учета возможных отличий для конкретного клиента <latitude>57.93457<br/latitude>Объемный вес будет учитываться только при условии указания всех габаритов: длины, ширины и высоты <longitude>59.95131<br/longitude>В полях город <uid>40606d00-отправитель и город9c51-получатель можно указывать название города (не рекомендуется!), либо код города из нашего справочника, либо 1311eb-ти значный код КЛАДР, либо 36b2c9-ти значный код адресной системы ФИАС (AOID).cfd6c1111392</uid> </pvz> <pvz>'''Пример ответа стоимости доставки:''' <code>245</code> <clientcode>NTG1<source lang="xml"/clientcode> <name>На Красноармейской<?xml version="1.0" encoding="UTF-8"?/name> <parentcode>6<calculator/parentcode> <parentname>Интеграция<calc/parentname> <townfrom town code="1124267" regioncode="66" regionname="Свердловская область">Москва Нижний Тагил город</townfromtown> <townto code="56603"address>Иркутск городКРАСНОАРМЕЙСКАЯ, д.79</towntoaddress> <massphone>3.+7(3435)379-044</massphone> <service name="Экспресс"comment>1Возможность примерки отсутствует</servicecomment> <zoneworktime>2Вс 10:00-16:00, Сб 10:00-16:00, Пн-Пт 10:00-20:00</zoneworktime> <pricetraveldescription>1163Напротив ТЦ Пирамида</pricetraveldescription> <mindeliverydaysmaxweight>120</mindeliverydaysmaxweight> <maxdeliverydaysacceptcash>3YES</maxdeliverydaysacceptcash> <mindeliverydateacceptcard>2020-05-13YES</mindeliverydateacceptcard> <deliverypriceacceptfitting>NO</acceptfitting> <advprice code="1" price="1000"acceptindividuals>БазаYES</advpriceacceptindividuals> <advprice code="4" price="100"latitude>Процент от суммы руб57.93468</advpricelatitude> <advprice code="5" price="63"longitude>Процент от объявленной стоимости60.55476</advpricelongitude> <uid>41116853-9c51-11eb-b2c9-cfd6c1451392</deliverypriceuid> </calcpvz></calculatorpvzlist></source>
== Получение фискальных данных заказа ==
'''Пример запроса получения фискальных данных:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<receiptdata>
<auth extra="8" login="login" pass="pass" />
<orders>
<order orderno="123456" />
<order orderno="890111C" />
</orders>
</receiptdata>
</source>
'''''Обратите вниманиеПример ответа получения фискальных данных:''''' В реальном ответе сервера в теге calc присутствует атрибут <source lang="pricexml". Он оставлен для обратной совместимости, не используйте его. Пользуйтесь вложенным тегом price.>
</source>
Параметры ответа:* '''orderno''' — Номер заказа* '''fdDatetime''' — Дата и время пробития фискального чека* '''fdValue''' — ФПД (фискальный признак документа)* '''fdNum''' — ФИСКАЛЬНЫЙ ДОКУМЕНТ (фискальный номер чека)* '''fnSn''' — ФН (номер фискального накопителя)* '''kktNum''' — РН (регистрационный номер кассы)* '''inn''' — ИНН*'''codeofdUrl''' - Код клиента — URL адрес (доменное имя) ОФД* '''price''' — Сумма чека== Список актов передачи денег ==* '''fullUrl''' — URL чека для просмотра онлайн* '''lines''' — Позиции чека:* '''item''' — код товара:* '''name''' — наименование товара:* '''qty''' — количество товара:* '''price''' — цена товара:* '''governmentCode''' — считанная последовательность, которая в дальнейшем преобразуется по алгоритму тега 1162:* '''vatRate''' — НДС товара:* '''itemType''' — тип товара (товар, доставка и т. д.)
== Справочник Виды срочности =='''Пример запроса списка актов передачи денегвидов срочности:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8" ?>
<smalistservices> <auth extra="8" login="login" pass="pass" /> <datefrom>2016-02-10</datefrom> <dateto>2016-03-10</dateto></smalistservices>
</source>
'''smalistПример ответа справочника видов срочности:''' - Корневой контейнер. Обязательный элемент.*'''auth''' - Авторизация<source lang="xml"><?xml version="1. Обязательный элемент.*'''datefrom''' 0" encoding="UTF- Дата "с8". Необязательный элемент.?>*'''dateto''' - Дата <services count="по2". Необязательный элемент.> <service> <code>1</code> <name>Эконом</name> </service> <service> <code>2</code> <name>Срочно</name> </service></services></source>Если интервал дат не указан, то возвращаются акты передачи денег за последний месяц.== Справочник дополнительных услуг =='''Пример ответа на запрос списка актов передачи денегзапроса дополнительных услуг:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<smalist countadvprices> <auth extra="8" login="login" pass="1pass"> <sma> <code>6278</code> <number>3992</numberadvprices> <actdate>2016-02-12</actdate> <datepay></datepay> <dateto>2016-02-12</dateto> <promiseddatepay></promiseddatepay> <price>637.00</price> <pricecorr>113.00</pricecorrsource> <rur>13430.00</rur> <pricekur>570'''advprices''' — Корневой контейнер.00</pricekur> <priceag>67Обязательный элемент.00</priceag> <payno>42423</payno> <paytype>1</paytype> <paytypename>Безнал</paytypename> <signedcopyreceived>NO</signedcopyreceived> </sma></smalist></source>
<source lang="xml">
<?xml version="1.0" encoding="UTF-8" ?>
<smadetailadvprices> <advprice> <code>1</code> <name>Этажей в доме<auth extra="8" login="login" pass="pass" /name> <type>int</type> </advprice> <advprice> <code>62782</code> <name>Коэффициент надбавки</name> <type>float</type> </advprice> <advprice> <code>3</code> <name>Расписаться на упаковке</name> <type>bool</type> </advprice></smadetailadvprices></source>
Параметры:* '''code''' — внутренний код услуги* '''smadetailname''' - Корневой контейнер — наименование услуги. Обязательный элементЕсли поле «название в ЛК» в настройках услуги не пусто, то возвращает значение поля «название в ЛК».*'''authhine''' — подсказка по доп услуге для пользователя* '''type''' - Авторизация. Обязательный элемент — тип услуги.Может иметь значения::* '''bool''' — для услуг вида «чекбокс», «Да»:* '''float''' — для числа с плавающей точкой:*'''codeint''' - Код акта передачи денег (см. запрос списка АПД). Обязательный элемент. — для целого числа
== Расчет стоимости доставки =='''Пример ответа на запрос детализации актов передачи денегзапроса стоимости доставки:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8" ?><calculator> <auth extra="8" login="login" pass="pass" /> <order> <pricetype>CUSTOMER</pricetype> <sender> <town>Санкт-Петербург</town> <address>Петровка 38 офис 35</address> <coords lat="55.680327" lon="37.604456"></coords> </sender> <receiver> <zipcode>125480</zipcode> <town regioncode="78" country="RU">Санкт-Петербург</town> <address>Петровка 38 офис 35</address> <pvz>124</pvz> <coords lat="55.680327" lon="37.604456"></coords> </receiver> <weight>5.1</weight> <service>2</service> <paytype>CASH</paytype> <price>387.5</price> <deliveryprice>150</deliveryprice> <inshprice>387.5</inshprice> <packages> <package mass="1" quantity="5"></package> <package mass="2.5" length="10" width="20" height="30"></package> </packages> <userid>user123</userid> <groupid>customer</groupid> </order></calculator></source> Параметры:Структура данных и заполнение полей аналогичны и совместимы с [[#Оформление заказа]]. Дополнительные поля:* '''pricetype''' — тип требуемой цены. Возможные значения: «CUSTOMER» (по-умолчанию) — [[Личный кабинет клиента#Цена доставки для получателя|цена для конечного получателя]], «CLIENT» — цена курьерской службы для клиента.* '''userid''' — Идентификатор пользователя, строковый или числовой тип. Виртуальное поле. Необязательное. Данное поле используется совместно с настройками «Цена доставки для получателя», определяя приоритет правила. Можно использовать в различных CMS/CRM системах, настраивая цены для определенного покупателя.* '''groupid''' — Идентификатор группы пользователя, строковый или числовой тип. Виртуальное поле. Необязательное. Данное поле используется совместно с настройками «Цена доставки для получателя», определяя приоритет правила. Можно использовать в различных CMS/CRM системах, настраивая цены для определенной группы покупателей. Суммы НП и ОЦ, а также тип оплаты CARD имеют значение при настроенных в тарифе на вкладке Прочее долях (в процентах) от данных сумм. В авторизации можно опустить параметры login и pass, тогда расчет будет производиться по стандартному тарифу курьерской службы, без учета возможных отличий для конкретного клиента.<br>Объемный вес будет учитываться только при условии указания всех габаритов: длины, ширины и высоты.<br>В полях город-отправитель и город-получатель можно указывать название города (не рекомендуется!), либо код города из нашего справочника, либо 13-ти значный код КЛАДР, либо 36-ти значный код адресной системы ФИАС (AOID). '''Пример ответа стоимости доставки:'''<source lang="xml"><?xml version="1.0" encoding="UTF-8"?><calculator> <calc> <townfrom code="1">Москва город</townfrom> <townto code="56603">Иркутск город</townto> <mass>3.7</mass> <service name="Экспресс">1</service> <zone>2</zone> <price>1113</price> <mindeliverydays>1</mindeliverydays> <maxdeliverydays>3</maxdeliverydays> <mindeliverydate>2020-05-13</mindeliverydate> <intervals> <workdays> <interval>10:00-16:00</interval> <interval>16:00-22:00</interval> </workdays> <holidays> <interval>12:00-16:00</interval> </holidays> </intervals> <deliveryprice> <advprice code="1" price="1000">База</advprice> <advprice code="4" price="100">Процент от суммы руб</advprice> <advprice code="5" price="63">Процент от объявленной стоимости</advprice> <advprice code="6" price="-50">Скидка при доставке</advprice> </deliveryprice> </calc></calculator></source> Параметры:* '''townfrom''' — Город-отправитель так, как система его распознала и привязала к справочнику. Атрибут '''code''' — код из справочника городов системы.* '''townto''' — Город-получатель так, как система его распознала и привязала к справочнику. Атрибут '''code''' — код из справочника городов системы.* '''mass''' — Масса в килограммах* '''service''' — Режим доставки — число, указывающее на запись в справочнике видов срочности (см описание на этой странице).* '''zone''' — номер тарифной зоны, по которой рассчиталась стоимость. В зависимости от зоны выбирается тарифная сетка. Так же к цене могут применяться повышающие или понижающие коэффициенты при доставке не из/в региональный центр.* '''price''' — рассчитанная стоимость доставки в валюте прайс-листа курьерской службы. Рекомендуется к использованию в отличие от одноименного атрибута родительского контейнера.* '''maxdeliverydays''' — максимальный срок доставки в рабочих днях.* '''mindeliverydate''' — минимальная дата доставки в учетом выходных дней.* '''intervals''' — список интервалов доставки для соответствующей зоны и режима срочности.* '''deliveryprice''' — Данные по составляющим ценам доставки '''''Обратите внимание:''''' В реальном ответе сервера в теге calc присутствует атрибут «price». Он оставлен для обратной совместимости, не используйте его. Пользуйтесь вложенным тегом price. == Получение информации о клиенте =='''Пример запроса получения информации о клиенте:'''<source lang="xml"><?xml version="1.0" encoding="UTF-8" ?><client> <auth extra="8" login="login" pass="pass" /> </client></source> '''client''' — Корневой контейнер. Обязательный элемент.* '''auth''' — Авторизация. Обязательный элемент. '''Пример ответа на запрос получения информации о клиенте:'''<source lang="xml"><?xml version="1.0" encoding="UTF-8" ?><client> <code>1082</code></client></source> * '''code''' — Код клиента == Список актов передачи денег =='''Пример запроса списка актов передачи денег:'''<source lang="xml"><?xml version="1.0" encoding="UTF-8" ?><smalist> <auth extra="8" login="login" pass="pass" /> <datefrom>2016-02-10</datefrom> <dateto>2016-03-10</dateto></smalist></source> '''smalist''' — Корневой контейнер. Обязательный элемент.* '''auth''' — Авторизация. Обязательный элемент.* '''datefrom''' — Дата «с». Необязательный элемент.* '''dateto''' — Дата «по». Необязательный элемент.Если интервал дат не указан, то возвращаются акты передачи денег за последний месяц. '''Пример ответа на запрос списка актов передачи денег:'''<source lang="xml"><?xml version="1.0" encoding="UTF-8"?><smalist count="1"> <sma> <code>6278</code> <number>3992</number> <actdate>2016-02-12</actdate> <datepay></datepay> <dateto>2016-02-12</dateto> <promiseddatepay></promiseddatepay> <price>637.00</price> <pricecorr>113.00</pricecorr> <rur>13430.00</rur> <pricekur>570.00</pricekur> <priceag>67.00</priceag> <payno>42423</payno> <paytype>1</paytype> <paytypename>Безнал</paytypename> <signedcopyreceived>NO</signedcopyreceived> </sma></smalist></source> * '''code''' — Код акта* '''number''' — Номер акта в системе* '''actdate''' — Дата акта* '''datepay''' — Дата оплаты по акту* '''dateto''' — Дата конечного периода для формирования АПД* '''promiseddatepay''' — Плановая дата оплаты* '''price''' — Стоимость услуг* '''pricecorr''' — Сумма корректировки* '''rur''' — Сумма заказа* '''pricekur''' — Стоимость курьерской доставки* '''priceag''' — Агентское вознаграждение* '''payno''' — Номер платежного поручения* '''paytype''' — Тип оплаты: 1 — безнал, 2 — наличными курьером, 3 — наличными в офисе, 4 — перевод на карту* '''paytypename''' — Строковое представление типа оплаты* '''signedcopyreceived''' — Признак факта возврата акта YES/NO == Детализация актов передачи денег =='''Пример запроса детализации актов передачи денег:'''<source lang="xml"><?xml version="1.0" encoding="UTF-8" ?><smadetail> <auth extra="8" login="login" pass="pass" /> <code>6278</code></smadetail></source> '''smadetail''' — Корневой контейнер. Обязательный элемент.* '''auth''' — Авторизация. Обязательный элемент.* '''code''' — Код акта передачи денег (см. запрос списка АПД). Обязательный элемент. '''Пример ответа на запрос детализации актов передачи денег:'''<source lang="xml"><?xml version="1.0" encoding="UTF-8"?><smadetail count="2"> <specialsma> <code>42494</code> <ordercode>14424</ordercode> <orderno>11111</orderno>
<orderdate>2018-01-01</orderdate>
<delivereddate>2018-10-01</delivereddate> <company>Компания</company> <price>314.00</price> <rur>8800.00</rur> <inshprice>314.00</inshprice> <pricekur>270.00</pricekur> <priceag>44.00</priceag> <pricecalc>8486.00</pricecalc> <paytype>2</paytype> <paytypename>наличными курьером</paytypename> <weight>0.400</weight> <distance>0.0</distance> <status>Доставлено</status> </specialsma></smadetail></source> * '''code''' — Код записи.* '''ordercode''' — Код заказа.* '''orderno''' — Шифр заказа.* '''orderdate''' — Дата заказа.* '''delivereddate''' — Дата доставки.* '''company''' — Получатель.* '''price''' — Стоимость услуг.* '''rur''' — Сумма заказа.* '''inshprice''' — Стоимость заказа.* '''pricekur''' — Стоимость курьерской доставки.* '''priceag''' — Агентское вознаграждение.* '''pricecalc''' — Сумма для передачи агенту.* '''paytype''' — Тип оплаты: 1 — безнал, 2 — наличными курьером, 3 — наличными в офисе, 4 — перевод на карту.* '''paytypename''' — Строковое представление типа оплаты* '''weight''' — Вес заказа.* '''distance''' — Дистанция по заказу* '''status''' — Статус заказа. == Генерация коротких ссылок ==В некоторых случаях, например, при использовании в СМС, может потребоваться использование коротких ссылок на ЛК.Для этого, необходимо отправить запрос с полной ссылкой, в ответ на который придёт хэш-код для ссылки. '''Пример запроса генерации коротких ссылок:'''<source lang="xml"><?xml version="1.0" encoding="UTF-8" ?><shortlink> <link short="0"> https://home.courierexe.ru/8/site/orders </link></shortlink></source> '''shortlink''' — Корневой контейнер. Обязательный элемент.* '''link''' — Полная ссылка, для которой необходимо получить код. Обязательный элемент. Если атрибут '''short''' равен 1, то ответ не будет содержать XML, а только хэш-код. '''Пример ответа на запрос генерации коротких ссылок:'''<source lang="xml"><?xml version="1.0" encoding="UTF-8"?><shortlink> <hash>35AF350C</hash></shortlink></source> * '''hash''' — Хэш-код ссылки. Далее, можно использовать ссылку на ЛК: <nowiki>https://home.courierexe.ru/35AF350C или curie.ru/35AF350C</nowiki> '''Примечание!''' Сервис коротких ссылок работает только для ресурсов компании MeaSoft. == Проверка надежности покупателя ==Проверка надежности работает только для тарифа «Максимум» личного кабинета. <source lang="xml"><?xml version="1.0" encoding="UTF-8" ?><mcheck> <auth extra="8" login="login" pass="pass" /> <phones> <phone>89161147992</phone> </phones></mcheck></source> Ответ: <source lang="xml"><?xml version="1.0" encoding="UTF-8" ?><mcheck> <phones> <phone rate="90">89161147992</phone> </phones></mcheck>
</source>
== Генерация коротких ссылок Размещение страниц на своем сайте (iframe) ==
В некоторых случаях, например, при использовании в СМС, может потребоваться использование коротких ссылок имеет смысл разметить те или иные страницы на ЛК.Для этого, необходимо отправить запрос с полной ссылкой, в ответ на который придёт хэш-код для ссылкисвоем сайте.
Например, чтобы клиенты могли рассчитать стоимость доставки не переходя по внешней ссылке, а там же, на сайте, калькулятор можно разместить прямо на странице такого сайта посредством так называемого фрейма — '''Пример запроса генерации коротких ссылок:iframe'''<source lang="xml"><?xml version="1.0" encoding="UTF-8" ?><shortlink> <link short="0"> https://home.courierexe.ru/8/site/orders </link></shortlink></source>
</source>
<source lang="xmlhtml"><?xml versioniframe id="1.0frame" encodingsrc="UTF-https://home.courierexe.ru/8" /calculator?><mcheck> <auth extra="8" loginlang=2"login" pass="pass" /> <phones> <phone>89161147992</phone> </phones>Здесь должен отобразиться калькулятор</mcheckiframe>
</source>
