Изменения

'''English version is [[API documentationDocumentation|HERE!]]'''

В системе "Курьерская служба 2008" имеется возможность интеграции Вы можете настроить интеграцию с MeaSoft средствами XML API, по протоколу HTTP POST.

Данное API предназначено для интеграции клиентов (интернет-магазинов и прочих компаний-заказчиков доставки) с [http://courierexe.ru/our_clients.htm курьерскими службами], работающими под управлением системы [https://curie.ru/ MeaSoft "Курьерская служба 2008"]. Если Вы являетесь '''агрегатором''', передающим данные от клиентов, возможно, Вам придется последовательно подключаться под разными пользователями, если курьерская служба должна вести раздельный учет взаиморасчетов по клиентам. Если Вы являетесь '''подрядчиком''' - Вы можете забирать заказы, используя значение client=AGENT в запросе [[#Пример запроса статуса заказа|statusreq]], и передавать статусы заказов используя метод [[#Изменение статуса агентом|setorderinfo]]. Так же для интеграций с подрядчиками у нас есть специальная платформа, но добавлять подрядчиков в нее можно только на нашей стороне. Присылайте нам коммерческое предложение, описание Вашего сервиса, и мы с радостью его рассмотрим.

При написании данной документации мы предполагаемЕсли вы '''агрегатор''', что ее читатель обладает необходимой для понимания квалификацией программистапередающий данные от клиентов, владеет XML и средой разработкивозможно, в которой он делает интеграцию. Если Вы не являетесь программистом - Вам необходимо привлечь к проекту профессионального программиставам придется последовательно подключаться под разными пользователями, если курьерская служба должна вести раздельный учет взаиморасчетов по клиентам.

Если вы '''подрядчик''', вы можете забирать заказы, используя значение client=AGENT в запросе [[#Пример запроса статуса заказа|statusreq]], и передавать статусы заказов, используя метод [[#Изменение статуса агентом|setorderinfo]]. Также для интеграций с подрядчиками у Васнас есть специальная платформа, но добавлять подрядчиков в нее можно только на нашей стороне. Присылайте нам коммерческое предложение, описание вашего сервиса, и мы с радостью его рассмотрим. При написании этой документации мы предполагаем, что ее читатель обладает необходимой для понимания квалификацией программиста, владеет XML и средой разработки, в которой он делает интеграцию. Если вы не программист, вам необходимо привлечь к проекту профессионального программиста. Если у вас после прочтения данной документации остались вопросы, Вы можете задайте их задать по почте [mailto:support@courierexe.ru support@courierexe.ru]. Обязательно представьтесь, напишите Ваши ваши контактные данные (телефон, скайп) и название компании, с которой Вы вы хотите интегрироваться.

|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-Битрикс|описание]].

|style="text-align: center;"|[httphttps://courierexe.ru/download/api/prestashop.zip Скачать]|Поддерживает версии 1.5.2.0 и выше (2.x в том числе)Подробнее см. [[PrestaShop|описание]].

|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/ Альтернативный модуль сторонних разработчиков]

|style="text-align: center;"|[httphttps://www.webasyst.ru/store/plugin/shop/measoftcourier/ Установить модуль]<br>[https://www.webasyst.ru/store/plugin/shipping/measoftcourier/ Установить плагин]|Модуль предназначен для отправки заявок в КС, а плагин для расчета стоимости доставки при оформлении заказа. Инструкции есть в маркете, а также см. [[Webasyst|описание]].

<!--|[[Файл:advantshop.png|center|x44px]]

|Компания PROMO разработала этот модуль и настраивает интеграцию КС 2008 MeaSoft с ADVANTSHOP своим клиентам.|- -->|[[Файл:insales.png|center|x80px]]|style="text-align: center;"|Настраивается в [[Личный кабинет клиента|ЛК пользователя]]|[[InSales|Инструкция по настройке]]

|[[Файл:insalesiiko.pngjpg|center|x80px]]

|[[Интеграция с другими системами#InSalesIiko|Инструкция по настройке]]

|style="text-align: center;"|[[Файл:Leadvertex-howto.png|center|x44px]]|[httphttps://blog.leadvertex.ru/news/2110-integraciya-s-kurerkami-na-platforme-measoft/ Настраивается] в ЛК пользователя в системе [https://Leadvertex.ru Leadvertex]|[[LeadVertex|Инструкция по настройке]]<br>Модуль разработан и поддерживается компанией LeadVertex.

|[http://wiki.courierexe.ru/index.php?title=Интеграция_с_другими_системами#[RetailCRM |Настраивается]] в ЛК пользователя в системе

|[https://infostart.ru/public/692790/ Альтернативный модуль сторонних разработчиков(1 версия)] [https://infostart.ru/public/1531484/ Альтернативный модуль сторонних разработчиков (2 версия)]

|style="text-align: center;"|[httphttps://courierexe.ru/download/api/com_measoft.zip Скачать]|Работает только с компонентом Virtuemart. Внимание! Модуль новый, поэтому возможна некорректная передача данных. Проверяйте, если что - сообщайте, исправим!Инструкция в архиве

|style="text-align: center;"|[https://www.amocrm.ru/extensions/courier2008 Установитьmeasoft Описание на сайте amoCRM]|Подробнее см. Подробное описание настроек читайте [[Интеграция с другими системами#amoCRM|описаниетут]].

|style="height:50px; text-align: center;"|[https://home.courierexe.ru/moysklad/step1 Настроить интеграцию с MeaSoft]|[[Интеграция с другими системами#Мой СкладМойСклад|Инструкция]]

|style="text-align: center;"|[httphttps://courierexe.ru/download/apiwordpress/wordpress.zip php Скачать]|[[Интеграция с другими системами#Wordpress|Инструкция]]

|Поддерживает версии 4.10 и выше.<br>[[Интеграция с другими системами#CS-Cart|Инструкция]]|-|[[Файл:webhooks.jpg|center|x100px]]|style="text-align: center;"|Читайте описание [[Webhook|на этой странице]]|Передача информации о статусах и заказах в вашу систему|-|[[Файл:Logo_tilda_black.png|center|x100px]]|style="text-align: center;"|Читайте описание [[Tilda|на этой странице]]|Работает только на платных тарифах

Для отображения списка пунктов выдачи есть [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], логин: test пароль: testm. Там на закладке "Автоматизация" Вы сможете увидеть свои пробовать выполнять запросы "глазами" нашей системы. Так же там есть интерфейс к API для выполнения отладки, а также видеть историю отправленных запросов. На закладке "Созданные заказы появятся в пункте основного меню '''Отслеживание" Вы увидите созданные заказы'''.

Для упрощения интеграции можно скачать [httphttps://courierexe.ru/download/api/php_sample.zip пример обращения к сервису на PHP].

1. Описание параметров:* '''Параметр extra''' (Цифровой  — экстра-код, уникальный идентификатор компании. Запросите этот параметр у компании, с которой Вы вы интегрируетесь). Посмотреть этот код можно в интерфейсе программы КС2008 через основное меню * '''login''' — логин клиента;* '''pass''' — пароль клиента;* '''"Справочники - Дополнительные возможности"measoftid''' — системная переменная, используемая системой. Цифровое значение будет указано во второй гиперссылке (на скриншоте ниже отмечено "звездочкой"):

Запросите эти данные у курьерской службы, к которой вы подключаетесь. Курьерская служба передает временный пароль, его нужно сменить после первого входа в [[Файл:extra1.pngЛичный кабинет клиента|750pxЛК клиента]].

2. '''Логин''' - параметр учетной записи для ЛК клиента и API== Авторизация курьерской службы ==Если курьерской службе требуется подключение под своими учетным данными, указывается в карточке клиента на вкладке '''"Прочее"''' в поле '''"Имя пользователя"'''. Возможно, что в программе КС2008 понадобится создать новую карточку клиента (на скриншоте ниже).используйте строку вида:

3. <source lang=xml><auth extra="8" login="login" pass="pass" clientcode="123"></auth></source> Описание:* '''Парольextra''' - параметр учетной записи для ЛК клиента и API, указывается в карточке клиента на вкладке  — уникальный идентификатор компании;* '''login''' — логин курьерской службы;* '''"Прочее"pass''' в поле  — пароль курьерской службы;* '''"Пароль"clientcode'''  — внутренний код клиента (на скриншоте нижевкладка '''Клиенты''', столбец «Внутренний код»).

Вы можете узнать код экстра, логин и пароль курьерской службы в офисном приложении MeaSoft в справочнике '''Дополнительные возможности'''. Подробнее см. раздел «[[Файл:33_client.pngЛичный кабинет курьерской службы#Подключение|500pxПодключение]]».

На стороне курьерской службы имеется веб-сервис по адресу: https://home.courierexe.ru/api/. <rspoiler text="Еще есть порт 8443.">Некоторые маршрутизаторы, используемые провайдерами, РНК и прочее, в попытке глубокого анализа, могут повреждать трафик на стандартный порт 443. Сделано по тикету 10964.</rspoiler> Тестовые авторизационные данные: логин: test login пароль: testmpass, параметр extra: 8. Обратите внимание, что тестовая площадка для всех одна. Не нужно передавать в нее заказы с конфиденциальными данными, их смогут увидеть другие участники.Для использования интеграции в "боевом" режиме, запросите '''логин''', '''пароль''', и параметр '''extra''' у той компании, с которой интегрируетесь.Вы можете отправлять тестовые запросы к нашему сервису в личном кабинете на закладке "Автоматизация". В личном кабинете так же можно видеть историю отправленных Вами запросов.

Клиент отправляет запросы к сервисуДля использования интеграции в «боевом» режиме, методом HTTP POSTзапросите '''логин''', '''пароль''', сервис обрабатывает запросы и возвращает результат выполнения. Все запросы и ответы передаются в формате XML.Кодировка - UTF-8. Разделитель целой и дробной частей чисел - используется символ точки. Даты представляются в виде YYYY-MM-DDпараметр '''extra''' у той компании, время - HH:MM.В силу [https://ru.wikipedia.org/wiki/XML#.D0.A0.D0.B5.D1.88.D0.B5.D0.BD.D0.B8.D0.B5_.D0.BF.D1.80.D0.BE.D0.B1.D0.BB.D0.B5.D0.BC.D1.8B_.D0.BD.D0.B5.D0.BE.D0.B4.D0.BD.D0.BEс которой интегрируетесь.D0.B7.D0.BD.D0.B0.D1.87.D0.BD.D0.BE.D1.81.D1.82.D0.B8_.D1.80.D0.B0.D0.B7.D0.BC.D0.B5.D1.82.D0.BA.D0.B8 особенностей языка XML], некоторые символы в тексте должны быть заменены: & на &amp;amp; < на &amp;lt; > на &amp;gt; " на &amp;quot;

Вы можете отправлять тестовые запросы к нашему сервису и видеть историю отправленных запросов в личном кабинете на закладке '''Интеграция'''. Клиент отправляет запросы к сервису методом HTTP POST, сервис обрабатывает запросы и возвращает результат выполнения. Все запросы и ответы передаются в формате XML.Кодировка — UTF-8. Разделитель целой и дробной частей чисел — используется символ точки. Даты представляются в виде YYYY-MM-DD, время — HH:MM. В силу [https://ru.wikipedia.org/wiki/XML#.D0.A0.D0.B5.D1.88.D0.B5.D0.BD.D0.B8.D0.B5_.D0.BF.D1.80.D0.BE.D0.B1.D0.BB.D0.B5.D0.BC.D1.8B_.D0.BD.D0.B5.D0.BE.D0.B4.D0.BD.D0.BE.D0.B7.D0.BD.D0.B0.D1.87.D0.BD.D0.BE.D1.81.D1.82.D0.B8_.D1.80.D0.B0.D0.B7.D0.BC.D0.B5.D1.82.D0.BA.D0.B8 особенностей языка XML], некоторые символы в тексте должны быть заменены: & на &amp;amp; < на &amp;lt; > на &amp;gt; " на &amp;quot; Наше API принципиально работает только по HTTPS, т.к. так как передает конфиденциальные данные. В некоторых системах с этим возникают проблемы. Если ваша система не может полноценно работать с шифрованием, мы рекомендуем развернуть http-сервер у себя локально, установить [http://courierexe.ru/download/api/proxy.zip прокси на PHP]. <spoiler text="Как запустить">Для теста можете запустить его на сервере следующей командой: php -S <IP>:8080 proxy.phpгде <IP> -  — это адрес вашего сервера, а 8080 порт, на котором будут приниматься запросы.

*30 запросов tracking с одного IP-адреса за 1 минуту (используйте statusreq!);*150 запросов с одного IP-адреса/акаунта за 1 минуту;*1500 запросов с одного IP-адреса/акаунта за 20 минут;*3000 запросов с одного аккаунта за 1 час;*200 Мб скачанных текстовых данных за 3 часа.* Превышение количества запросов статусов несуществующих заказов над существующими

* не нужно «бомбить» наше API запросами статусов, последовательно перебирая номера всех ваших заказов, особенно запросами "tracking"«tracking», они предназначены не для этого (смотрите описание). Особенно ровно в 00 минут каждого часа;

Мы абсолютно уверены, что данные ограничения на порядки превосходят необходимые объемы предоставления сервиса для решения любых задач. Если у вас возникают проблемы, вы не знаете, как уложиться в эти рамки — рамки — спросите у нас, мы обязательно поможем!

<returnprice>NO387.5</returnprice> <inshprice>387.5</inshprice> <deliveryprice VATrate="20">150</deliveryprice> <discount>120</discount> <paytype>CASH</paytype>

<item extcode="abc123" quantity="1" mass="0.2" retprice="37.5" VATrate="0" barcode="2345625213125" textArticle="1" article="1" volume="3" origincountry="AUT" GTD="321546654" excise="15.20" suppcompany="ООО &quot;Рога и копыта&quot;" suppphone="79161234567" suppINN="1112223334" govType="2" governmentCode="11223311" extraTags="">Мяч</item>

<package strbarcode="ORD0000001" mass="1" message="" quantity="3"></package>

Обязательными на уровне системы являются только 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''newfolder''''' - Признак нового  — Штрихкод заказа. Если клиент штрихкодирует свои отправления и штрихкод отличается от номера заказа YES/NO, в этом поле указывается штрихкод. Если стоит YESШК содержит кириллицу или малое количество символов, то формируется ШК в системе курьерской службы для данной корреспонденции создастся новый заказ. Необязательный элементформате EAN13.

*'''order''' <spoiler text="Заполнение номера заказа (шифра) и штрих- Контейнер для описания одного заказа, обязательный элемент. В одном контейнере '''neworder''' может быть много контейнеров '''order''' для создания нескольких заказов одним запросом.кода">Шифр и штрих-код заполняются исходя из начальных значений:

:* '''''orderno''''' - Номер заказа. Если присваивается клиентом - указывается здесь. # Если не присваивается - можно оставить пустым, система сгенерирует свой номер, шифр и вернет его в ответе. Система проверяет наличие заказов с указанным номером в пределах текущего календарного года, и в случае их существования ШК пустые - заказ создан не будетоба поля заполняются автоматически значением вида XXX#YYY, а в ответе вернется ошибка 17 "Such number exists". Если не указан штрих-код после ШК проверяется на корректность (поле barcodeвалидируется)# Если ШК пустой, а шифр заполнен - ШК заполняется значением из шифра и значение поля подходит для использования его в качестве штрихвалидируется# Если шифр пустой, а ШК заполнен -кодашифр заполняется значением из ШК, данное значение будет скопировано в поле "Штрихпосле чего ШК валидируется# Если оба непустые -код". Это накладывает ограничения в частностивалидируется ШК, на длину указанного поля (25 знаков, чтобы работали стандартные печатные формы).шифр не проверяется

Корректный (валидный) ШК отвечает следующим требованиям:*'''barcode''' - Штрих-код заказа. В случае, если клиент штрих-кодирует свои отправления, и штрих-код отличается от номера заказа, в этом поле указывается штрих-код. В случае наличия нескольких мест, и раздельной их маркировки, в этом поле допустимы маски в виде длина не меньше 5 символов подчеркивания, говорящие о позициях штрих-кода, переменных для разных мест в рамках одного заказа.* значение не меньше значения переменной <br mparam code="MinPrePrintedNum"/>''Например'': В заказе номер 123 имеется 20 товарных вложений* содержит символы, которые упакованы в 3 транспортных места. Клиент формирует 3 можно использовать для формирования штрих-кода на транспортные места: CLNT0012301, CLNT0012302, CLNT0012303, где CLNT - префикс клиента, 00123 - номер заказа, 01-03 - номер транспортного места в заказекод а формате Code128 (т.е. В поле barcode нужно указать CLNT00123__ (система поймет, что 2 последних символа могут быть любымивсе печатные символы, и будут отражать штрих-коды к одному заказукроме кириллицы). Если вы не сами печатаете накладные с указанным штрих-кодом, то указанный штрих-код не должен быть длиннее 25 знаков, иначе он не поместится на стандартных печатных формах.

Если ШК не прошел проверку, то:* если переменная <mparam code="StoreInvLength"/> равна 0, ШК заполняются автоматически значением вида XXX#YYY (или приравнивается шифру в том же формате)* если переменная <mparam code="StoreInvLength"/> больше 0, ШК заполняются автоматически сквозным номером (если шифр в формате XXX#YYY, то шифр приравнивается ШК)</spoiler> В случае наличия нескольких мест и раздельной их маркировки в этом поле допустимы маски в виде символов подчеркивания, говорящие о позициях штрихкода, переменных для разных мест в рамках одного заказа.<br>''Например'': В заказе номер 123 имеется 20 товарных вложений, которые упакованы в 3 транспортных места. Клиент формирует 3 штрихкода на транспортные места: CLNT0012301, CLNT0012302, CLNT0012303, где CLNT — префикс клиента, 00123 — номер заказа, 01-03 — номер транспортного места в заказе. В поле barcode нужно указать CLNT00123__ (система поймет, что 2 последних символа могут быть любыми и будут отражать штрихкоды к одному заказу). Если вы не сами печатаете накладные с указанным штрихкодом, то указанный штрихкод не должен быть длиннее 25 знаков, иначе он не поместится на стандартных печатных формах. *'''sender''' -  — Информация о отправителе заказа. Необязательный контейнер.

*'''receiver''' -  — Информация о получателе заказа. Обязательный контейнер.

*'''company''' -  — Компания-получатель.*'''person''' -  — Контактное лицо. ''Должно быть заполнено хотя бы одно из полей - полей — company или person!''*'''phone''' -  — Телефон. Можно указывать несколько телефонов, E-mail в этом поле.*'''town''' -  — Город.* '''pvz''' — Код пункта самовывоза по справочнику. Кроме того, ПВЗ можно указать в строке '''''address''''' в виде::* код ПВЗ в нашей системе:* код ПВЗ в системе подрядчика:* наименование ПВЗ в виде строки "ПВЗ " + «Наименование ПВЗ».  При указании ПВЗ в поле адреса необходимо проверять значение поля город получателя (он должен соответствовать данным ПВЗ) либо не передавать его вообще.

Также можно указать страну получателя в атрибуте '''''country''''' в соответствии с [https://ru.wikipedia.org/wiki/ISO_3166-1 стандартом ISO_3166-1], например, "RU"«RU», "RUS" «RUS» или "643" «643» для России.

:* 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 — Забор товара. Если товар нужно у получателя забрать, возможно — вернуть деньги, или его стоимость вычтется из суммы других товаров. У такого товара в заказе будет отрицательное количество независимо от знака в запросе.:: 9 — Код подтверждения. Используется для вложения, в котором сохраняется регулярное выражение для проверки кодов вложений. См. '''''extraTags''''':* '''''extcode''''' — Внешний код строки. Используется для идентификации строк заказов при получении статусов. Необязательное поле.:*'''instruction''origincountry'''''  — Код страны-производителя в соответствии со [https://ru.wikipedia.org/wiki/ISO_3166- Поручение 1 стандартом ISO_3166- Примечание1], например, «RU», «RUS» или «643» для России.:* '''''GTD''''' — Номер ГТД.:*'''courier''excise' - Запланированный курьер'''' — Сумма акциза. Согласно коду курьера в КС2008:* '''''suppcompany''''' — Наименование компании поставщика, если отличается от заказчика.:*'''receiverpays''suppphone'''' - Признак оплаты стоимости доставки - услуг службы доставки получателем' — Номер телефона компании поставщика, а не заказчиком YES/NOесли отличается от заказчика.:*'''department''suppINN'' - Подразделение''' — ИНН компании поставщика, в котором оформляется заказесли отличается от заказчика.:*'''pickup''governmentCode''''' — Код товарной номенклатуры. Используется для [[Маркировка|маркированных товаров, например («Честный знак»)]]. Для кода '''Честный знак''' Нужно указывать все данные из нанесенного QR- Признак оформления забора YES/NOкода кроме не читаемых символов (#29). Если стоит YESкод не известен — укажите знак вопроса «?», то весь заказ тогда курьер отсканирует код фактически передаваемого покупателю товара. Для некоторых процессов может использоваться значение «!» — в этом случае курьер сканирует серийный номер товара, но это не считается заданием на забор грузакодом маркировки. При этом, а не на доставкуесли указано значение «?» или «! Применяется для вызова курьера к отправителю для забора других отправлений» и quantity больше 1, то такое вложение растиражируется quantity раз.:*'''acceptpartially''govType'''''  — Тип маркировки товара. В данный момент существуют следующие типы маркировки::: 1 — Честный знак. По- Признак возможности частичного выкупа товаров отправления YES/NOумолчанию.:: 2 — ГИИС ДМДК.:: 3 — Серийный номер.:* '''''message''''' — Строка сообщения.:* '''''extraTags''''' — Строка в формате JSON для различных целей.

*'''items''' - Контейнер для описания вложений. <rspoiler text="Необязательный контейнер">Если для поставщика товара в системе MeaSoft не указаны полное наименование компании и ИНН в карточке клиента, заполните параметры <code>suppcompany</code> и <code>suppINN</code> в этом контейнере. Отсутствие информации о поставщике приведет к [[Настройка модуля печати кассовых чеков#Ошибка фискализации (ошибка программирования реквизита 1226)|ошибке фискализации]].</rspoiler>. Атрибуты::* '''''item''''' Тэг 1265 - Название вложения.:* '''''quantity''''' - Количество единиц товара.:* '''''mass''''' - Масса единицы товара в килограммах.:* '''''volume''''' - Объемный вес единицы товара в килограммах. При указании объемного веса значение подставляется вместо массы:* '''''length''''' - Длина единицы товара (в сантиметрах).:* '''''width''''' - Ширина единицы товара (в сантиметрах).:* '''''height''''' - Высота единицы товара (в сантиметрах).:* '''''retprice''''' - Цена единицы товара. Округляется до копеек. Должна быть с учетом всех скидок и наценок. Для вложений типов 1, 2, 3 не может быть отрицательной. <!-- , либо мы сами посчитаем скидку при указании тега order->discount -->:* '''''inshprice''''' - Объявленная ценность единицы товара. Округляется до копеек. Если не указана принимается равной '''''retprice'''''.:* '''''VATrate''''' - Ставка НДС - целое число процентов. Если значение не указано, подставляется значение "20". Значение "0" означает ставку "Без НДС", ставка "0%" на данный момент не поддерживается.:* '''''barcode''''' - Штрих-код вложения. [[Файл:Article.png|thumb|100px|right]]:* '''''article''''' - Артикул вложения. ''Внимание!'' Указание артикула используется только тогда, когда товар хранится на ответственном хранении в службе доставки, и необходима комплектация. В этом случае система пытается привязать товар к [[API#Справочник номенклатуры|справочнику номенклатуры]]. Если товар в справочнике не найден - система выдаст соответствующую ошибку. Если по артикулу найдено несколько товаров - система выберет один из них случайным образом, что может привести к ошибочной комплектации! Если товар НЕ на ответственном хранении - артикул указывать НЕ нужно. Позиция попадет в систему просто текстом.:* '''''itemcode''''' - Внутренний код товара, может использоваться вместо артикула. ''Внимание!'' Указание кода товара используется только тогда, когда товар хранится на ответственном хранении в службе доставки, и необходима комплектация. В этом случае система пытается привязать товар к [[API#Справочник номенклатуры|справочнику номенклатуры]]. Если товар в справочнике не найден - система выдаст соответствующую ошибку. Если товар НЕ на ответственном хранении - код товара указывать НЕ нужно.:* '''''type''''' - Тип вложения. Принимает значения::: 1 - Товар. По-умолчанию.:: 2 - Доставка. Такое вложение добавится автоматически, если заполнить order->deliveryprice:: 3 - Услуга:: 4 - Предоплата. Указывается сумма. Поле quantity игнорируется, всегда "1". В заказе сумма будет отрицательной независимо от знака в запросе. Такое вложение добавится автоматически при указании order->paytypeотраслевого реквизита =NO.:: 6 - Оплата кредитом. Указывается сумма. Поле quantity игнорируется, всегда "1". В заказе сумма будет отрицательной независимо от знака в запросе.:: 7 - Забор товара. Если товар нужно у получателя забрать, возможно - вернуть деньги, или его стоимость вычтется из суммы других товаров. У такого товара в заказе будет отрицательное количество независимо от знака в запросе.:* '''''extcode''''' - Внешний код строки. Используется для идентификации строк заказов при получении статусов. Необязательное поле.:* '''''origincountry''''' - Код страны-производителя в соответствии со [https://ru.wikipedia.org/wiki/ISO_3166-1 стандартом ISO_3166-1], например, "RU", "RUS" или "643" для России.:* '''''GTD''''' - Номер ГТД.:* '''''excise''''' - Сумма акциза.:* '''''suppcompany''''' - Наименование компании поставщика, если отличается от заказчика.:* '''''suppphone''''' - Номер телефона компании поставщика, если отличается от заказчика.:* '''''suppINN''''' - ИНН компании поставщика, если отличается от заказчика.:* '''''governmentCode''''' - Код товарной номенклатуры. Используется для [[Маркировка | маркированных товаров ("Честный знак")]]. Нужно указывать все данные из нанесенного QR-кода кроме не читаемых символов (#29). Если код не известен - укажите знак вопроса "?", тогда курьер отсканирует код фактически передаваемого покупателю товара. Для некоторых процессов может использоваться значение "!" - в этом случае курьер сканирует серийный номер товара, но это не считается кодом маркировки. Если поле заполнено - поле quantity должно содержать только "1", иначе вернется ошибка. места деятельности аптеки

*'''packages''' - Контейнер для описания мест. Необязательный контейнер. Атрибуты::* '''''package''''' - Название места.:* '''''code''''' - Внутренний код строки.:* '''''strbarcode''''' - Штрих-код места.:* '''''mass''''' - Масса места в килограммах.:* '''''message''''' - Строка сообщения.:* '''''length''''' - Длина единицы товара (в сантиметрах).:* '''''width''''' - Ширина единицы товара (в сантиметрах).:* '''''height''''' - Высота единицы товара Тэг 1262 – идентификатор ФОИВ = "020" (в сантиметрахконстанта ФОИВ МИНЗДРАВа).

* '''deliveryset''' - настройка [[Дифференциальная стоимость доставки | дифференциальной стоимости доставки]]. Атрибуты::* '''''above_price''''' Тэг 1263 - стоимость в случае полного выкупа заказа (действует как дата нормативного акта федерального органа исполнительной власти = "сумма от14.12.2018" последней границы, указанной в теге below_sum(константа):* '''''return_price''''' - стоимость в случае возврата заказа:* '''''VATrate''''' - Ставка НДС - целое число процентов.

* '''below''' - граница стоимости настроек:* '''''below_sum''''' - граница стоимости выкупаемого заказа:* '''''price''''' Тэг 1264 - стоимость выкупаемого заказа до соответствующей границыномер нормативного акта федерального органа исполнительной власти = "1556"(константа)

* '''advprices''' - Контейнер для описания дополнительных услуг. Необязательный элемент. <span style="color: red;>Для обработки в API требует включения в настройках полей оформления [[Личный_кабинет_курьерской_службы#Настройка вкладки "Оформить заказ"|заказов]] / [[Личный_кабинет_курьерской_службы#Настройка вкладки "Заявка на забор"|заборов]]</span>:* '''''code''''' - код услуги:* '''''value''''' Тэг 1212 - значение услуги. Если тип услуги bool, то в значении передаем trueПризнак предмета расчета

*:: Маска валидации - регулярное выражение для проверки кодов вложений курьером. Указывается во вложении с типом 9 (см. атрибут вложения '''''type'costcode''' - Кост-код сотрудника.')

:: Пример: <source lang="json">"item_industry_props":{"tag1262":"020","tag1263":"14.12.2018","tag1264":"1556","tag1265":"tm=mdlp&sid=00000000XXXXXX"},"tag1212": "1""ValidationMask": "(A-Z0-9){6,8}"</source>  Для клиентов из '''Узбекистана''' необходимо указывать код ИКПУ и код упаковки в следующем формате:<source lang="json">"ikpu":"123123123","packageCode":"123456"</source>   * '''packages''' — Контейнер для описания мест. Необязательный контейнер. Атрибуты::* '''''package''''' — Название места.:* '''''code''''' — Внутренний код строки.:* '''''strbarcode''''' — Штрихкод места.:* '''''mass''''' — Масса места в килограммах.:* '''''message''''' — Строка сообщения.:* '''''length''''' — Длина товарного места (в сантиметрах).:* '''''width''''' — Ширина товарного места (в сантиметрах).:* '''''height''''' — Высота товарного места (в сантиметрах).:* '''''quantity''''' — Количество мест с данным набором параметров. Действует ограничение на общее количество мест в заказе. Общее количество мест в заказе не может быть больше 1000. * '''deliveryset''' — настройка [[Дифференцированная стоимость доставки|дифференцированной стоимости доставки]]. Атрибуты::* '''''above_price''''' — стоимость в случае полного выкупа заказа (действует как «сумма от» последней границы, указанной в теге below_sum):* '''''return_price''''' — стоимость в случае возврата заказа:* '''''VATrate''''' — Ставка НДС — целое число процентов. * '''below''' — граница стоимости настроек:* '''''below_sum''''' — граница стоимости выкупаемого заказа:* '''''price''''' — стоимость выкупаемого заказа до соответствующей границы * '''advprices''' — Контейнер для описания дополнительных услуг. Необязательный элемент. <span style="color: red;>Для обработки в API включите дополнительные услуги в настройках полей [[Личный кабинет курьерской службы#Настройка личного кабинета клиента|заказов и заборов]]</span>:* '''''code''''' — код услуги.:* '''''value''''' — значение услуги. Если тип услуги bool, то в значении передаем true. * '''extrafields''' — Контейнер для описания расширенных полей. Необязательный элемент. Может содержать несколько элементов extrafield* '''extrafield''' — Контейнер для описания расширенного поля.:* '''''name''''' — наименование переменной. Может содержать только латинские буквы, цифры и знак подчеркивания "_", но начинаться может только с буквы. Максимальная длина - 20 символов.:* '''''value''''' — значение переменной. Максимальная длина - 250 символов. * '''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 — штрихкод заказа.

<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>

<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>

== Запрос статуса заказов =Коды и описание ошибок =  === Пример запроса статуса заказа =={|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>|- <client>CLIENT</client>|2||Lat is empty||Укажите широту. <orderno>1234</orderno>|- <orderno2>5678</orderno2>|3||Specify a valid «Price» field value.||Укажите корректное значение поля «Сумма». <ordercode>34234</ordercode>|- <givencode>234534</givencode>|4||Specify a valid «Weight» field value.||Укажите корректное значение поля «Вес». <datefrom>2016-07|-21</datefrom> <dateto>2016-07-21<|5||Recepient city/dateto>town not found.||Город назначения не найден. <target>Автозавод</target>|- <done>ONLY_NOT_DONE<|6||Sender city/done>town not found.||Город отправления не найден. <changes>ONLY_LAST</changes>|-</statusreq>|7||Specify the «Recipient address» field value.||Укажите значение поля «Адрес получателя».</source>|-|8||Specify the «Recipient phone» field value.||Укажите значение поля «Телефон получателя».=== Описание полей запроса статуса ===|- '''statusreq''' - Корневой контейнер|9||Specify the «Recipient name» field value. Обязательный элемент||Укажите значение поля «ФИО получателя».*'''auth''' |- Авторизация|10||Specify a valid «Quantity» field value. Обязательный элемент||Укажите корректное значение поля «Количество».*'''client''' |- Признак клиента или агента|11||Specify a valid «Declared value» field value. Необязательный элемент||Укажите корректное значение поля «Объявленная ценность».:* CLIENT |- Признак клиента, значение по умолчанию:* AGENT - Признак агента|12||Supplier SKU ID not found.||Артикул не найден. В ответ отдается информация по заказам, переданным агенту на доставку*'''orderno''' |- Номер |17||Order number already exists in the database.||Такой номер заказа. Необязательный элементуже есть в базе.*'''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.||Укажите значение поля «Номер заказа».|- заказы, находящиеся в любом статусе, кроме конечных: Доставлено, Не доставлено, Отменён и т|31||Specify the «Barcode» field value.д||Укажите значение поля «Штрихкод».:* ''Пусто'' |- все корреспонденции *'''changes''' |32||Specify the «Sender company» field value.||Укажите значение поля «Компания- может принимать значение только ONLY_LASTотправитель». Если указан этот параметр, все остальные игнорируются|-|33||Specify the «Sender name» field value. Описание данного режима приведено здесь: [[#Передача только изменившихся статусов|Передача только изменившихся статусов]]|Укажите значение поля «ФИО отправителя».|-|34||Specify the «Sender phone» field value.||Укажите значение поля «Телефон отправителя».<div style="color: #a94442; background|-color: #f2dede; border: 1px solid #ebccd1; padding: 3px 10px 10px;">'''Обратите внимание!'''|35||Specify the «Sender city/town» field value.||Укажите значение поля «Город отправителя».|-# Периода запроса статусов (контейнеры '''datefrom''' и '''dateto''') ограничивается двумя месяцами &mdash; два месяца до даты '''"по"'''|36||Specify the «Sender address» field value.||Укажите значение поля «Адрес отправителя».# Если не указаны обе даты &mdash; '''dateto''' принимается равной текущей дате|-|37||Specify the «Pickup date» field value.||Укажите значение поля «Дата забора».# Если не указана дата '''dateto''' &mdash; она принимается равной '''datefrom''' плюс 2 месяца|-|38||Specify the «Pickup time from» field value.||Укажите значение поля «Время забора с».# Если не указана дата '''datefrom''' &mdash; она принимается равной '''dateto''' минус 2 месяца|-|39||Specify the «Pickup time to» field value.||Укажите значение поля «Время забора до».</div>|-<br />|40||Specify the «Recipient company» field value.||Укажите значение поля «Компания-получатель».|-=== Примеры ответов === |41||Specify the «Recipient name» field value.||Укажите значение поля «ФИО получателя».|-'''Пример успешного ответа'''|42||Specify the «Recipient phone» field value.||Укажите значение поля «Телефон получателя».|-<source lang="xml">|43||Specify the «Recipient city/town» field value.||Укажите значение поля «Город получателя».<?xml version="1|-|44||Specify the «Recipient address» field value.||Укажите значение поля «Адрес получателя».0" encoding="UTF|-8"?><statusreq count="23">|45||Specify the «Delivery date» field value.||Укажите значение поля «Дата доставки».|- <order orderno="111111" awb="qwerty" orderno2="123123" ordercode="34534234" givencode="2345334">|46||Specify the «Delivery time from» field value.||Укажите значение поля «Время доставки с». <barcode>111111</barcode>|- <sender> <company>МВД</company>|47||Specify the «Delivery time to» field value.||Укажите значение поля «Время доставки до».|- <person>Иванов И|48||Specify the «Recipient postcode» field value.И||Укажите значение поля «Индекс получателя».</person> <phone>123|-45-67</phone> <contacts>|49||Specify the «Weight» field value.||Укажите значение поля «Вес».|- <phone>+74951234567</phone>|50||Specify the «Payment type» field value.||Укажите значение поля «Тип оплаты».|- </contacts>|51||Specify the «Quantity» field value.||Укажите значение поля «Количество». <town code="23432">Санкт|-Петербург</town> <address>Петровка 38 офис 35</address>|52||Specify the «Amount» field value.||Укажите значение поля «Сумма». <date>2014-03|-22</date> <time_min>09:00</time_min>|53||Specify the «Declared value» field value.||Укажите значение поля «Объявленная стоимость». <time_max>14:00</time_max>|- </sender>|54||Specify the «Description» field value.||Укажите значение поля «Описание». <receiver>|- <company>МВД</company> <person>Иванов И|55||Specify the «Instruction» field value.И||Укажите значение поля «Поручение».</person> <phone>123|-45-67 |56||Specify the «Delivery mode» field value.||Укажите значение поля «Режим доставки».|- Иван (916)234|57||Specify the «Shipment type» field value.45.21 Петр,mvd@mail||Укажите значение поля «Тип отправления».ru</phone> <contacts>|- <phone>+74951234567</phone>|58||Specify whether return trip is required.||Укажите значение поля «Необходимость возврата». <phone>+79162344521</phone>|- <email>mvd@mail|59||Specify the «Return trip mode» field value.ru</email>||Укажите значение поля «Режим возврата» </contacts>|- <inn>1112223335</inn>|60||Specify the «Return shipment type» field value.||Укажите значение поля «Тип возврата». <zipcode>125480</zipcode>|- <town code="153361" regioncode="78" regionname="Санкт|61||Specify barcode.||Укажите штрихкод.|-Петербург город">Санкт-Петербург город</town> <address>Петровка 38 офис 35</address>|62||Specify item weight.||Укажите массу единицы товара. <pvz>|- <code>126</code>|63||Specify item quantity.||Укажите количество товара. <clientcode>QWERTY</clientcode>|- </pvz>|64||Specify item price.||Укажите цену единицы товара. <date>2014|-03-22</date> <time_min>09:00</time_min>|65||Specify item name.||Укажите название товара. <time_max>14:00</time_max>|- <coords lat="55|66||Wrong XLS file||Некорректный файл XLS.680327" lon="37.604456"></coords> </receiver>|- <pickup>NO</pickup>|67||Order barcode already exists in the database.||Такой штрихкод заказа уже есть в базе. <weight>5.1</weight>|- <return_weight>5|68||Select the «Payment by recipient» field value.||Укажите значение поля «Оплата получателем».1</return_weight> <quantity>2</quantity>|- <paytype>CASH</paytype>|69||Specify department.||Укажите отдел. <|-|70||Specify service>2</service>partner code.||Укажите значение поля «Код подрядчика». <return_service>2</service>|- <type>3</type>|71||Date cannot be earlier than tomorrow.||Дата не может быть раньше чем завтра. <return_type>3</return_type>|- <waittime>12</waittime> <price>387|72||Date cannot be later than 15 days from now.||Дата не может быть позже чем через 15 дней.5</price> <print_check>YES</print_check>|- <inshprice>387|73||Date cannot be earlier than today.||Дата не может быть раньше чем сегодня.5</inshprice> <enclosure>Детские игрушки</enclosure>|- <instruction>Проверить при покупателе|74||Date cannot be later than {0} days from now.||Дата не может быть позже, подписать акт</instruction>чем через {0} дней.|- <currcoords lat="55|75||Specify a valid «Item weight» field value.680327" lon="37||Укажите корректное значение поля «Масса единицы товара».604456" accuracy="50" RequestDateTime="2014|-04-21 18:07:45"></currcoords> <courier>|76||Specify a valid «Quantity» field value.||Укажите корректное значение поля «Количество товара». <code>26</code>|- <name>Иванов Владимир Петрович</name>|77||Specify a valid «Item price» field value.||Укажите корректное значение поля «Цена единицы товара». <phone>+79161234567</phone>|- </courier> <deliveryprice total="158|78||Specify a valid «Delivery time from» field value.6" delivery="100||Укажите корректное значение поля «Время доставки с».00" return="58|-|79||Specify a valid «Delivery time to» field value.||Укажите корректное значение поля «Время доставки до».6"> <advprice code="1" price="150">База</advprice>|- <advprice code="2" price="0">% от объявленной стоимости</advprice>|80||Specify a valid «Pickup time from» field value.||Укажите корректное значение поля «Время забора с».|- <advprice code="3" price="8|81||Specify a valid «Pickup time to» field value.||Укажите корректное значение поля «Время забора до».6">Топливный сбор</advprice> <advprice code="4" price="0">Округление</advprice>|-|82||Specify a valid «Pickup point» field value.||Укажите корректное значение поля «ПВЗ». </deliveryprice>|- <receiverpays>NO</receiverpays>|83||Duplicate number in the registry.||Дублирование номера в реестре. <acceptpartially>NO</acceptpartially>|- <status eventstore="филиал |84||Duplicate barcode in the registry.||Дублирование штрихкода в Санктреестре.|-Петербурге" eventtime="2016-06|85||Specify a valid «Weight at return trip» field value.||Укажите корректное значение поля «Вес возврата».|-02 17:22:00" createtimegmt="2016|86||Specify the «Weight at return trip» field value.||Укажите значение поля «Вес возврата».|-06-03 16:14:44" message="" title="Доставлен">COMPLETE</status> <statushistory>|87||Order weight exceeds the allowed maximum for the pickup point.||Вес превышает допустимое значение для этого ПВЗ.|- <status eventstore="Офис в Москве" eventtime="2016|88||Pickup date cannot be earlier than today.||Дата забора не может быть раньше чем сегодня.|-05|89||Specify a later delivery date.||Укажите более позднюю дату доставки.|-30 10:20:00" createtimegmt="2016|90||Inappropriate «Weight» or «Pay type» field value for the selected city or town. Please review and correct the values.||Значение поля «Масса» или «Тип оплаты» для выбранного города указано некорректно или отсутствует. Проверьте значения и исправьте.|-06-03 16:14:44" message="" title="Новый">NEW</status> <status eventstore="Офис в Москве" eventtime="2016|91||{deliverytype} {deliverydate} is {holidaytype}. Select another date.||{deliverytype} {deliverydate} является {holidaytype}. Выберите другую дату.|-06-01 17:38:00" createtimegmt="2016|92||{deliverytype} {deliverydate} is {holidaytype}. Select another date.||{deliverytype} {deliverydate} является {holidaytype}. Выберите другую дату.|-06|93||Add items.||Добавьте товары.|-03 16:14:44" message="филиал в Санкт|95||The selected pickup point only allows paid orders.||Выбранный ПВЗ выдает только предоплаченные заказы.|-Петербурге" title="Планируется отправка">DEPARTURING</status> <status eventstore="Офис в Москве" eventtime="2016|96||Order barcode exceeds the allowed maximum (25) symbols.||Длина штрихкода заказа превышает максимально допустимую (25 символов).|-|97||The pickup date format is not valid. Specify a date in YYYY-06MM-01 19:53:00" createtimegmt="2016DD format.||Укажите значение поля «Дата забора» в формате гггг-06мм-03 16:14:44" message="филиал в Санктдд.|-Петербурге" title="Отправлено со склада">DEPARTURE</status> <status eventstore="филиал в Санкт|98||Specify the cost code.||Укажите значение поля «Кост-Петербурге" eventtime="2016код».|-06|99||The item is not in stock.||Товар отсутствует на складе.|-02 07:41:00" createtimegmt="2016|100||Set the quantity of the item marked with Chestny ZNAK to one.||Укажите количество товара, маркированного кодом «Честный ЗНАК», равным единице.|-06-03 16:14:44" message="" title="Получен складом">ACCEPTED</status> <status eventstore="филиал в Санкт|101||Quantity of item Delivery cannot be greater than 1||Количество вложений типа «Доставка» не может быть более 1.|-Петербурге" eventtime="2016|102||А database error occurred. Please try later again.||Ошибка базы данных. Попробуйте позже.|-06|103||Order not found.||Заказ не найден.|-02 09:17:00" createtimegmt="2016-06-03 16:14:44" message="" title="Выдан курьеру на доставку">DELIVERY</|104||Cannot edit order in the current status>.||Невозможно изменить заказ в текущем статусе. <status eventstore="филиал в Санкт|-Петербурге" eventtime="2016|105||Discount cannot be greater than the order amount. Specify a smaller value.||Размер скидки не может превышать сумму заказа. Укажите меньшее значение скидки.|-06|106||Specify the correct additional service code.||Укажите корректный код дополнительной услуги.|-02 17:22:00" createtimegmt="2016|107||Specify the correct additional service name.||Укажите корректное значение поля [advprice][value].|-06-03 16:14:44" message="" title="Доставлен (предварительно)">COURIERDELIVERED</status> <status eventstore="филиал в Санкт|108||Specify the «Additional services» field value.||Укажите значение поля «Дополнительные услуги».|-Петербурге" eventtime="2016|110||Specify the correct TIN.||Укажите корректный ИНН.|-06|111||Specify the correct IIN (KZ).||Укажите корректный ИИН (КЗ).|-02 17:22:00" createtimegmt="2016|112||Specify the overall volume.||Укажите общий объем.|-06-03 16:14:44" message="" title="Доставлен">COMPLETE</status> </statushistory>|113||Cannot apply the delivery mode. Select another delivery mode.||Режим доставки не подходит для заказа. Выберите другой режим. <customstatecode>2<customstatecode>|- <clientstatecode></clientstatecode> <costcode>cc12345</costcode>|114||The pickup point does not support the selected delivery mode. Specify another pickup point.||ПВЗ не подходит для выбранного режима доставки. Укажите другой ПВЗ.|- <receipt fdNum="124555" fnSn="9289000100295555" kktNum="0001611984048555" inn="7722756555" fdValue="2899551555" summ="387|115||Specify a valid recipient phone number.||Укажите корректный телефон получателя.5" ofdUrl="gate|-|116||Specify recipient PIN code.ofd||Укажите пин-код получателя.ru">https://ofd|-|117||Order date cannot be earlier than {0}.ru/rec/7722756555/0001611984048555/9289000100295555/124555/2899551555</receipt> <deliveredto>Иванова, секрSpecify another date.</deliveredto> <delivereddate>2016||Дата заказа не может быть раньше {0}. Укажите другую дату.|-06-02</delivereddate> <deliveredtime>17:22</deliveredtime>|118||Pickup date cannot be earlier than {0}. Specify another date.||Дата забора не может быть раньше {0}. Укажите другую дату. <arrival>2016|-05|119||Specify the correct item type.||Укажите корректный тип вложения.|-02 23:21</arrival> <outstrbarcode>EXT123456</outstrbarcode>|120||The pickup point does not accept payment by card.||В выбранном ПВЗ оплата картой не принимается. <return_message>Доставлено в целости</return_message>|- <department>Отдел</department>|121||Invalid item code format||Неверный формат кода товарной номенклатуры <items>|- <item code="34533" extcode="abc123" quantity="1" mass="|122||Pickup time cannot be earlier than {0} hours.||Время забора не может быть раньше чем через {0} часа.2" retprice="37|-|123||Pickup interval cannot be less than {0} minutes.5" VATrate="||Интервал времени забора не может быть менее {0} минут. Укажите корректный интервал.|-|124||Specify a valid " barcode="2345625213125" article="1" returns="0" origincountry=Payment type"040" GTD="" excise="0field value.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>|125||Recepient city/town by postcode not found.||Город получателя по его индексу не найден.|-|126||Incorrect items prepayment and pickup.||Заказ не может содержать только вложения «Предоплата» и «Забор».|-|127||Package limit exceeded||Превышен лимит количества мест|- <|128||Quantity of item code="34421" extcode="abc125" quantity="3" mass="0Prepayment cannot be greater than 1||Количество вложений типа «Предоплата» не может быть больше 1.|-|129||Sum of cod must be equal sum of items||Объявленная стоимость должна быть равна сумме вложений.|-|130||Specify a valid respstore code.||Укажите код ответственного филиала.3" retprice="50" VATrate="18" barcode="2345625213126" itemcode="44123" article="3" returns="0" governmentCode="">Погремушка желтая</item> </items>|- <packages> <package code=|131||Cannot edit, order has not been synchronized.||Невозможно изменить заказ пока он не синхронизирован.|-|132||Specify a valid "33331Recipient city/town" strbarcode=field value.||Укажите город получателя|-|133||Specify a valid "ORD0000001weight" mass=for the town.||Укажите корректный вес для города|-|134||Specify a valid "1paytype" message="" got="YES"><for the town.||Укажите тип оплаты для города|-|135||Specify the correct SKU ID/code for item.||Укажите артикул/package> <package code="33332" strbarcode="ORD0000002" mass="2.5" message="" got="NO">код вложения|-|136||Specify warehouse goods in the order.||Укажите вложения в заказе|-|137||The order's date of creation is more than 60 days ago.||Заказ создан более 60 дней назад|-|138||Specify a valid "Package dimension" field value.||Укажите корректные габариты места|-|139||Wrong type of XML query||Ошибка запроса|-|140||Duplicate item code in the order.||Дублирование кода вложения в заказе|-|141||Duplicate additional service in the order.||Дублирование кода дополнительной услуги в заказе|-|144||Incorrect extrafields.||Некорректные расширенные поля.|-|} === Передача значений полей в форме создания заказа в Личном Кабинете через GET параметры ===Если вам требуется передавать значения полей в форме создания заказа в Личном Кабинете через GET параметры, то вы можете подробно ознакомиться с этим на данной странице - [[Личный_кабинет_клиента#Передача и подстановка значений полей формы создания заказа через GET параметры]] == Запрос статуса заказов == === Пример запроса статуса заказа ===<source lang="xml"><?xml version="1.0" encoding="UTF-8" ?><statusreq> <auth extra="8" 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> </packagelimit> 500</packages> </orderlimit></statusreq>

=== Описание полей запроса статуса ==='''Пример ответа statusreq''' — Корневой контейнер. Обязательный элемент.* '''auth''' — Авторизация. Обязательный элемент.* '''client''' — Признак клиента или агента. Необязательный элемент.:* CLIENT — Признак клиента, значение по умолчанию:* AGENT — Признак агента. В ответ отдается информация по заказам, переданным агенту на доставку* '''orderno''' — Идентификатор заказа у клиента (шифр). Необязательный элемент.* '''ordercode''' — Внутренний код заказа. Необязательный элемент.* '''orderno2''' — Номер заказа из срочных. Необязательный элемент. * '''uid''' — Уникальный идентификатор, если нет заказовон был добавлен при создании заказа. Необязательный элемент. Запрос информации по uid возможен в течении суток после создания заказа* '''datefrom''' — Дата заказа «с». Необязательный элемент.* '''dateto''' — Дата заказа «по». Необязательный элемент.* '''target''' — Строка поиска. Позволяет указать текст, который содержится в названии компании или адресе получателя.* '''done''' — Может принимать значения::* ONLY_DONE — Только доставленные (имеются в виду успешные статусы, например, '''Доставлен''' или '''Частично доставлен'''):* ONLY_NOT_DONE — Только не доставленные (заказы, которые не являются доставленными, например, '''Не доставлен''' или '''Утерян'''):* ONLY_NEW — Только новые:* ONLY_DELIVERY — Только заказы в обработке — заказы, находящиеся в любом статусе, кроме конечных: Доставлено, Не доставлено, Отменён и т. д.:* ''Пусто'' — все корреспонденции

<source lang="xml"><?xml version="1* '''changes''' — может принимать значение только ONLY_LAST.0" encoding="utf-8"?><statusreq count="0"></statusreq> </source>Если указан этот параметр, все остальные игнорируются. Описание данного режима приведено здесь: [[#Передача только изменившихся статусов|Передача только изменившихся статусов]]

* '''Пример ответа при ошибке авторизацииconditions''' — Задает условия фильтрации по «orderno». Все вложенные элементы одновременно накладывают условие «И». Минимум 5 символов!:* '''namecontains''' — Поиск по номеру заказа(шифр), который содержит «orderno».:* '''namestarts''' — Поиск по номеру заказа(шифр), который начинается с «orderno». * '''limit''' — Необязательный параметр. Дает возможность получить не все измененные заказы, а только какое-то определенное количество. Помогает на случай, если у вас скопилось очень много измененных заказов и нужно их грузить лимитировано. После каждой итерации нужно вызывать commitlaststatus с контейнером списка обработанных кодов, [[#Лимитирование запросов|читать подробнее]]

<source langdiv style="xmlcolor: #a94442; background-color: #f2dede; border: 1px solid #ebccd1; padding: 3px 10px 10px;"><?xml version="1'''Обратите внимание!'''# Периода запроса статусов (контейнеры '''datefrom''' и '''dateto''') ограничивается двумя месяцами — два месяца до даты '''«по»'''.# Если не указаны обе даты — '''dateto''' принимается равной текущей дате.# Если не указана дата '''dateto''' — она принимается равной '''datefrom''' плюс 2 месяца.0" encoding="utf-8"?><request># Если не указана дата '''datefrom''' — она принимается равной '''dateto''' минус 2 месяца.<error error="1" errormsg="authorization error"></error># Поиск по '''conditions''' работает только для «Номер заказа(шифр)» и только от 4 символов</requestdiv></sourcebr>

=== Примеры ответов ==='''Пример успешного ответа при ошибке синтаксиса'''

<requeststatusreq count="23"> <order orderno="111111" awb="qwerty" orderno2="123123" ordercode="34534234" givencode="2345334"> <barcode>111111</barcode> <errorsender> <company>МВД</company>column:1 line:11 message:expected ' <person>'Иванов И.И.</errorperson> <phone>123-45-67</requestphone> <contacts> <phone>+74951234567</sourcephone> </contacts> <town code=== Описание полей ответа статусов ==="23432">Санкт-Петербург</town>Все поля ответа соответствуют структуре order при создании заказа, с некоторыми добавлениями: <address>Петровка 38 офис 35</address> <date>2014-03-22</date>* Атрибуты контейнера '''order''' <time_min>09:00</time_min> <time_max>14:* '''''awb''''' - Номер накладной в системе курьерской службы00</time_max> </sender> <receiver> <company>МВД</company> <person>Иванов И.И.</person>:* '''''orderno2''''' <phone>123-45-67 - Номер накладной в подсистеме срочной доставки курьерской службыИван (916)234.45.21 Петр,mvd@mail.ru</phone> <contacts> <phone>+74951234567</phone>:* '''''ordercode''''' - внутренний код заказа в системе, применяется для некоторых внутренних операций <phone>+79162344521</phone> <email>mvd@mail.ru</email> </contacts> <inn>1112223335</inn> <zipcode>125480</zipcode>:* '''''givencode''''' <town code="153361" regioncode="78" regionname="Санкт-Петербург город">Санкт- внутренний код заказа в системе, применяется для некоторых внутренних операций.Петербург город</town> <address>Петровка 38 офис 35</address> <area>Район 1</area> <pvz>* атрибут ''''' <code''''' контейнера '''item''' >126</code> <clientcode>QWERTY</clientcode> </pvz> <date>2014-03- внутренний код строки заказа в системе, применяется для некоторых внутренних операций.22</date> <time_min>09:00</time_min> <time_max>14:* '''''returns''''' - количество данного товара, от которого отказался получатель00</time_max> <coords lat="55. Не нулевое только в случае частичного отказа680327" lon="37.604456"></coords> <deliveryPIN>1234</deliveryPIN>* атрибут '''''got''''' контейнера '''package''' - признак принятого места YES </ NOreceiver> <price>387.5</price>:* '''''returns''''' - количество данного товара, от которого отказался получатель <inshprice>387. Не нулевое только в случае частичного отказа5</inshprice> <paytype code="1">CASH</paytype> <weight>5.1</weight> <quantity>2</quantity> <service>2</service> <type>3</type> <return>NO</return> <return_service>2</service>* '''''coords''''' <return_type>3</return_type> <return_weight>5.1</return_weight> <return_message>Доставлено в контейнере '''receiver''' целости</return_message> <return_date>2026-01- координаты получателя.19</return_date> <return_time>13:18:00</return_time>* ''' <pickup''' - признак оформления забора, возможные значения: '''YES''', '''>NO'''. Если указано '''</pickup> <print_check>YES'''</print_check> <waittime>12</waittime> <enclosure>Детские игрушки</enclosure> <instruction>Проверить при покупателе, то весь заказ считается заданием на забор груза, а не на доставку.подписать акт</instruction> * ''' <currcoords''' lat="55.680327" lon="37.604456" accuracy="50" RequestDateTime="2014-04- текущие координаты заказа. Атрибуты21 18:07:* '''''lat''''' - широта45"></currcoords>:* '''''lon''''' - долгота <courier>:* '''''accuracy''''' - точность в метрах <code>26</code>:* '''''RequestDateTime''''' - дата <name>Иванов Владимир Петрович</время последнего обновления координат.name> <phone>+79161234567</phone>* ''' </courier''' - Данные курьера, которому выдан заказ. Если заказ не выдан, то выводятся данные запланированного курьера.>* '''waittime ''' - Время ожидания курьера.* ''' <deliveryprice''' - Стоимость услуг в валюте расчетов с клиентомtotal="158. Атрибуты::* '''''total''''' - общая стоимость услуг:* '''''6" delivery''''' - стоимость доставки ="Туда100.00":* '''''return''''' - стоимость доставки ="Обратно58.6" (если order->return <advprice code="1" price=YES)"150">База</advprice>Тэг '''deliveryprice''' включает список дополнительных услуг (только для тарифа <advprice code="2" price="Премиум0"):>% от объявленной стоимости</advprice>:* ''''' <advprice code="3" price="8.6">Топливный сбор</advprice''''' - наименование дополнительной услуги>:* ''''' <advprice code''''' - код дополнительной услуги="4" price="0">Округление</advprice> </deliveryprice>:* '''''price''''' - стоимость дополнительной услуги <receiverpays>NO</receiverpays> <acceptpartially>NO</acceptpartially>* ''' <status''' eventstore="филиал в Санкт-Петербурге" eventtime="2016-06- статус доставки (список статусов см. ниже). Атрибуты (заполняются начиная с версии системы 2008.0.0.670)02 17:22:* '''''eventstore''''' 00" createtimegmt="2016-06- филиал, к которому относится текущий статус03 16:* '''''eventtime''''' - время события по часовому поясу места его наступления.14:* '''''createtimegmt''''' 44" message="" title="Доставлен" eventtown="Санкт- время по GMT создания записи о смене статуса в БД. Используется для сортировки записей, чтобы соблюсти хронологическую последовательность. <spoiler textПетербург город" color="Подробнее16777215">Большинство событий фиксируются COMPLETE</status> <statushistory> <status eventstore="Офис в полях Москве" eventtime и createtimegmt на основании одного действия, тогда они отличаются только сдвигом от GMT. Однако, если курьер доставил отправление ="2016-05-30 10.10.2010 в :20:00, по какой" createtimegmt="2016-06-то причине не внес это в мобильное приложение, на следующий день сдал накладную, и в 9 утра оператор внесла, что он доставил вчера в 2003 16:14:00. Тогда в createtimegmt будет сегодня 6 утра (для Москвы), а 44" message="" title="Новый" eventtown="Москва город" country="RU">NEW</status> <status eventstore="Офис в Москве" eventtime ="2016-06- вчера в 2001 17:38:00. При этом оператор по каким" createtimegmt="2016-то причинам может внести время вручения раньше, чем какое06-то предыдущее событие, т.о. нарушится последовательность времени 03 16:14:44" message="филиал в eventtime, но при сортировке по createtimegmt всеСанкт-равно все будет правильно.Петербурге" title="Планируется отправка" eventtown="Москва город" country="RU">DEPARTURING</spoilerstatus> <status eventstore="Офис в Москве" eventtime="2016-06-01 19:* '''''message''''' 53:00" createtimegmt="2016- наименование филиала06-получателя, при передаче между филиалами03 16:14:* '''''title''''' - русское наименование статуса44" * '''statushistory''' message="филиал в Санкт- история статусов доставки. Содержит список контейнеров '''status'''. Заполняется только для тарифа Петербурге" title="Отправлено со склада" eventtown="Москва город" country="ПремиумRU" начиная с версии системы 2008.0.0.670.>DEPARTURE</status>* '''customstatecode''' <status eventstore="филиал в Санкт- код внутреннего статуса курьерской службы. Значения уточняйте в курьерской службе. Назначаются курьерской службой в разделе Петербурге"Справочникиeventtime=" 2016-06- 02 07:41:00"Статусыcreatetimegmt=" 2016-06- 03 16:14:44" message="" title="15 Статусы корреспонденцииПолучен складом" eventtown=". Справочник не передается через API клиенту по причине возможного наличия в нем внутренних технологических статусов курьерской службы.* '''clientstatecode''' Санкт- код статуса клиента. Используется, если клиент предлагает свои коды статусов доставкиПетербург город" country="RU">ACCEPTED</причин недоставки.status>* '''deliveredto''' <status eventstore="филиал в Санкт- данные о вручении, либо причина недоставки.* '''delivereddate''' Петербурге" eventtime="2016- дата вручения.* '''deliveredtime''' 06- время вручения. В случае недоставки может быть пустым.* '''arrival''' - плановая дата прибытия в формате гггг02 09:17:00" createtimegmt="2016-мм06-дд чч03 16:мм14:сс44"* '''outstrbarcode''' message="" title="Выдан курьеру на доставку" eventtown="Санкт- код у подрядчика (код заказа во внешней системе). Используется Петербург город" country="RU">DELIVERY</status> <status eventstore="филиал в интеграциях с внешними системами.* '''return_message''' Санкт-Петербурге" eventtime="2016- информация о возврате* '''department''' 06- Подразделение, в котором оформляется заказ. Контейнер '''status''' может принимать следующие значения02 17:22: ACCEPTED — Получен складом.00" createtimegmt="2016-06-03 16: AWAITING_SYNC — Ожидает синхронизации. Данные заказа пока не появились в бэкофисе.14: CANCELED — Не доставлен (Возврат/Отмена).44": COMPLETE — Доставлен.: CONFIRM — Согласована доставка.: COURIERCANCELED — Отказ со слов курьера.: COURIERDELIVERED — message="" title="Доставлен (предварительно)." eventtown="Санкт-Петербург город" country="RU">COURIERDELIVERED</status> <status eventstore="филиал в Санкт-Петербурге" eventtime="2016-06-02 17: COURIERPARTIALLY — Частично со слов курьера.22: COURIERRETURN — Возвращено курьером. Курьер не смог доставить до получателя и вернул заказ обратно на склад. Это промежуточный статус, после которого менеджер выясняет, нужно ли пытаться заново доставить заказ или это окончательная недоставка.00" createtimegmt="2016-06-03 16: CUSTOMSFINISHED — Таможенный контроль произведен.14: CUSTOMSPROCESS — Производится таможенный контроль.44": DATECHANGE — Перенос. message="" title="Доставлен" eventtown="Санкт-Петербург город" country="RU">COMPLETE</status>: DELIVERY — Выдан курьеру на доставку. </statushistory>: DEPARTURE — Отправлено со склада. <customstatecode>2<customstatecode>: DEPARTURING — Планируется отправка. <clientstatecode></clientstatecode>: INVENTORY — Инвентаризация <deliveredto>Иванова, секр.</deliveredto>: LOST — Утрачен <delivereddate>2016-06-02</утерян.delivereddate> <deliveredtime>17: NEW — Новый.22</deliveredtime>: NEWPICKUP — Создан забор. <department>Отдел</department>: PARTIALLY — Доставлен частично. <costcode>cc12345</costcode>: PICKUP — Забран у отправителя. <outstrbarcode>EXT123456</outstrbarcode>: PICKUPREADY — Готов к выдаче. <respstore>14</respstore>: RETURNED — Возвращен.: RETURNING — Планируется возврат.: UNCONFIRM — Не удалось согласовать доставку.: WMSASSEMBLED — Скомплектован <partner>Офис на складе.Ленина</partner> <arrival>2016-05-02 23: WMSDISASSEMBLED — Разукомплектован. '''Примечание.''' В будущем возможно изменение используемого набора статусов.21</arrival> <div stylereceipt fdNum="124555" fnSn="9289000100295555" kktNum="0001611984048555" inn="7722756555" fdValue="color: #a94442; background-color: #f2dede; border: 1px solid #ebccd1; padding: 3px 10px 10px;2899551555" summ=">'''Обратите внимание!''' # Атрибуты контейнера '''status''' заполняются для версий системы 2008387.05" ofdUrl="gate.0ofd.670 и вышеru">https://ofd.# Контейнер '''statushistory''' заполняется для тарифа [[Личный_кабинет#.D0.9F.D0.BE.D0.B4.D0.BA.D0.BB.D1.8E.D1.87.D0.B5.D0.BD.D0.B8.D0.B5|Премиум]] и версий системы 2008.0.0.670 и выше.# Контейнер '''deliveryprice''' заполняется для тарифа [[Личный_кабинет#.D0.9F.D0.BE.D0.B4.D0.BA.D0.BB.D1.8E.D1.87.D0.B5.D0.BD.D0.B8.D0.B5|Премиум]].ru/rec/7722756555/0001611984048555/9289000100295555/124555/2899551555</divreceipt> <br /items>  <item code="34533" extcode="abc123" quantity= Передача только изменившихся статусов "1" mass="0.2" retprice="37.5" VATrate="0" barcode="2345625213125" article="1" returns="0" origincountry=В нашем API предусмотрено очень удобное средство получения статусов всех заказов, без необходимости "бомбить040" GTD=" сервер запросами статусов по каждому заказу. Работает это так: раз в какое-то время, например, в 10 минут, вы посылаете запрос "А покажите все изменившиеся статусыexcise="0. Пример запроса ниже. Система вам отдает ВСЕ заказы, статусы (или некоторые другие поля, см ниже) которых изменились с момента последнего запроса. Вы разбираете полученный документ, по каждому заказу сохраняете его актуальный статус в своей системе, и если все хорошо, у вас все получилось, ваша система неожиданно не упала от наплыва информации, посылаете нам запрос подтверждения получения статусов (commitlaststatus). Мы у себя отмечаем, что эти статусы вами получены, и их не надо передавать повторно. Т.о. сколько бы заказов у вас не было, статусы по ним всем почти в реальном времени вы можете получать всего 2-мя запросами. Для получения только изменившихся статусов отправьте запрос<source lang00" governmentCode="xml11223311"><?xml versiongovType="1.0" encodingsuppcompany="Поставщик" suppINN="1112223334" suppphone="UTF-879161234567" ?>Мяч<statusreq/item> <auth extraitem code="34456" extcode="abc124" quantity="2" mass="2" retprice="100" VATrate="10" barcode="4645625213138" article="2" returns="80" logingovernmentCode="login" passgovType="pass1">Обруч</authitem> <changesitem code="34421" extcode="abc125" quantity="3" mass="0.3" retprice="50" VATrate="18" barcode="2345625213126" itemcode="44123" article="3" returns="0" governmentCode="" govType="1">ONLY_LASTПогремушка желтая</changesitem> </statusreqitems> </source> Система выдает все заказы, в которых, с момента последнего запроса в этом режиме, изменилось хотя бы одно из полей: orderno status delivereddate deliveredtime deliveredto receiver->date receiver-packages>address price После успешной обработки ответа необходимо отметить полученные статусы успешно полученными, отправив запрос <source langpackage code="33331" strbarcode="xmlORD0000001"><?xml versionmass="1.0" encodingmessage="" got="UTF-8YES" ?><commitlaststatus/package> <auth extrapackage code="33332" strbarcode="ORD0000002" mass="82.5" loginmessage="login" passgot="passNO"></authpackage> <client/packages>CLIENT </clientextrafields> </commitlaststatusextrafield> <name>courier_car</sourcename> '''Описание полей запроса''' *'''auth''' - Авторизация. Обязательный элемент.*'''client''' - Признак клиента или агента. Необязательный элемент.:* CLIENT - Признак клиента, значение по умолчанию:* AGENT - Признак агента. В ответ отдается информация по заказам <value>ВАЗ 2106, переданным агенту на доставку В случае успеха Вы получите ответ бежевый<source lang="xml"/value> <?xml version="1.0" encoding="UTF-8" ?/extrafield> <commitlaststatus error="0"/extrafields>OK </commitlaststatusorder></sourcestatusreq> Данный способ передачи статусов гарантирует полную корректную передачу статусов, даже в случае, если в нашей системе статус изменился в промежутке времени между запросом статусов и подтверждением их получения. Если система не получила подтверждение успешной передачи статуса, она будет считать информацию не переданной, и выдаст ее при повторном запросе.  <div style="color: #a94442; background-color: #f2dede; border: 1px solid #ebccd1; padding: 3px 10px 10px;"/source>'''Обратите внимание!'''

# При данном способе передачи (<changes>ONLY_LAST</changes>) система просматривает заказы, оформленные за последние 3 месяца. Если заказ сделан ранее - изменение статуса по нему не попадет в результат выполнения данного запроса.# Система всегда выдает текущий статус. Т.е. Вы можете одним запросом получить статус "NEW", а следующим - "COMPLETE". В промежутке между запросами отправление могло пройти через несколько промежуточных статусов. Если нужна гарантия получения всех промежуточных статусов, нужно анализировать блок statushistory (может не заполняться в следствии ограничений версии или тарифа конкретной службы доставки).# Система никогда не гарантирует последовательность прохождения заказом набора статусов. Т.е. Вы можете получить статус "COMPLETE", а следующим запросом - "NEW" - такое может произойти, например, '''Пример ответа если оператор ошибочно отметил заказ выполненным, а затем исправил ошибку.</div><br />нет заказов'''

Запрос трекинга по номеру предназначен для выдачи минимальной обезличенной информации о конкретном заказе не авторизованному пользователю<source lang="xml"><?xml version="1. Наша система имеет для этого интерфейс по адресу 0" encoding="home.courierexe.ru/{код экстра}/trackingutf-8". Вы можете либо сделать ссылку на такую страницу на своем сайте, либо разместить ее iframe'ом у себя, либо сделать свою и пользоваться нашим API. Этот интерфейс создан специально для выдачи информации живому пользователю сайта. Для получения статусов заказов в свою информационную систему нужно использовать запрос ?><request><error error="statusreq1", желательно с параметром changeserrormsg=ONLY_LAST!"authorization error"></error></request></source> '''Пример ответа при ошибке синтаксиса'''

<trackingrequest> <extraerror>8</extra> <ordernocolumn:1 line:11 message:expected '>1234'</ordernoerror></trackingrequest>

=== Описание полей ответа статусов ===Все поля ответа соответствуют структуре order при создании заказа, с некоторыми добавлениями: * Атрибуты контейнера '''order''Пример ответа'::* '''''awb''''' — Номер накладной в системе курьерской службы.<source lang="xml">:* '''''orderno2''''' — Номер накладной в подсистеме срочной доставки курьерской службы.<?xml version="1:* '''''ordercode''''' — внутренний код заказа в системе, применяется для некоторых внутренних операций.0" encoding="UTF-8"?><tracking>:* '''''givencode''''' — внутренний код заказа в системе, применяется для некоторых внутренних операций. <order orderno="111111"> <barcode>111111</barcode>*'''paytype''' - Тип оплаты заказа получателем. Принимает значения: <AWB>111111</AWB>:: CASH - Наличными при получении (по-умолчанию) <sender>:: CARD - Картой при получении <town code="1" country="RU">Москва город</town>:: NO - Без оплаты. <date>2014:: OTHER -03Прочее (Предусмотрен для того, чтобы оплата поступала непосредственно в курьерскую службу посредством прочих типов оплаты -22</date> <time_min>09таких как:00</time_min>вебмани, яденьги, картой на сайте, прочие платежные системы и т.д.) <time_max>14* Атрибуты контейнера '''paytype''':00</time_max> </sender> <receiver> <town ** '''''code=''''' - (integer) внутренний код типа оплаты заказа в системном справочнике "1Типы оплаты корреспонденции" country="RU">Москва город</town>. Не обязательный элемент.  <zipcode>125480</zipcode> <date>2014-03-22</date>* атрибут '''''code''''' контейнера '''item''' — внутренний код строки заказа в системе, применяется для некоторых внутренних операций. <time_min>09:00</time_min>* '''''returns''''' — количество данного товара, от которого отказался получатель. Не нулевое только в случае частичного отказа. <time_max>14:00</time_max> <* атрибут '''''got''''' контейнера '''package''' — признак принятого места YES /receiver>NO. <price>387:* '''''returns''''' — количество данного товара, от которого отказался получатель. Не нулевое только в случае частичного отказа.5</price> <inshprice>387.5</inshprice> <paytype>CASH<* '''''area''''' в контейнере '''receiver''' — район/paytype>метро получателя. <weight>5* '''''coords''''' в контейнере '''receiver''' — координаты получателя.1</weight> <quantity>2</quantity>* '''''deliveryPIN''''' в контейнере '''receiver''' — Пин-код. <service>2</service> <type>3</type> <return>* '''pickup''' — признак оформления забора, возможные значения: '''YES''', '''NO</return>'''. Если указано '''YES''', то весь заказ считается заданием на забор груза, а не на доставку. <return_service>2</service>* '''currcoords''' — текущие координаты заказа. Атрибуты: <return_date></return_date>:* '''''lat''''' — широта <return_time></return_time>:* '''''lon''''' — долгота <return_message></return_message>:* '''''accuracy''''' — точность в метрах <waittime>12<:* '''''RequestDateTime''''' — дата/waittime>время последнего обновления координат. <enclosure>Детские игрушки</enclosure> <instruction>Проверить при покупателе* '''courier''' — Данные курьера, которому выдан заказ. Если заказ не выдан, подписать акт</instruction>то выводятся данные запланированного курьера.* '''waittime ''' — Время ожидания курьера. <* '''deliveryprice ''' — Стоимость услуг в валюте расчетов с клиентом. Атрибуты::* '''''total="158.6" ''''' — общая стоимость услуг:* '''''delivery="100.00" ''''' — стоимость доставки «Туда»:* '''''return''''' — стоимость доставки «Обратно» (если order->return="58.6" />YES)Тэг '''deliveryprice''' включает список дополнительных услуг (только для тарифа «Премиум»): <courier>:* '''''advprice''''' — наименование дополнительной услуги <:* '''''code>26</code>''''' — код дополнительной услуги <name>Иванов Владимир Петрович</name>:* '''''price''''' — стоимость дополнительной услуги <phone>+79161234567</phone> </courier> <currcoords lat="55* '''status''' — статус доставки (список статусов см. ниже). Атрибуты (заполняются начиная с версии системы 2008.0.680327" lon="370.604456" accuracy="50" RequestDateTime="2014-04-21 18670):07:45" /> <status * '''''eventstore="''''' — филиал в Санкт-Петербурге" , к которому относится текущий статус:* '''''eventtime="2016-06-02 17''''' — время события по часовому поясу места его наступления.:22:00" * '''''createtimegmt''''' — время по GMT создания записи о смене статуса в БД. Используется для сортировки записей, чтобы соблюсти хронологическую последовательность. <spoiler text="2016-06-03 16:14:44" message="" title="ДоставленПодробнее">COMPLETE</status> <statushistory> <status eventstore="Офис Большинство событий фиксируются в Москве" полях 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сс. Заполняется только при использовании автоматических систем планирования (Максоптра, Яндекс доставка), во всех остальных случаях - пустое.* '''outstrbarcode''' — код у подрядчика (код заказа во внешней системе). Используется в интеграциях с внешними системами.* '''partner''' — текущий филиал/подрядчик.* '''return_message''' — информация о возврате* '''return_date''' -06дата возврата* '''return_time''' -03 16время возврата* '''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 — Не удалось согласовать доставку.: DEPARTURING — Планируется отправка со склада на другой склад. <status eventstore="филиал в Санкт-Петербурге" eventtime="2016-06-02 09:17DEPARTURE — Отправлено со склада на другой склад.:00" createtimegmt="2016-06-03 16INVENTORY — Инвентаризация. Убедились в наличии отправления на складе.:14PICKUPREADY — Готов к выдаче в ПВЗ.:44" message="" title="'''DELIVERY''' — Выдан курьеру на доставку">DELIVERY</status>.: COURIERDELIVERED — Доставлен (предварительно, ожидает подтверждения менеджером, чтобы перейти в статус COMPLETE). <status eventstore="филиал : COURIERPARTIALLY — Частично доставлен (предварительно, ожидает подтверждения менеджером, чтобы перейти в Санкт-Петербурге" eventtime="2016-06-02 17статус PARTIALLY).:22COURIERCANCELED — Отказ (предварительно, после этого ожидается COURIERRETURN).:00" createtimegmt="2016-06-03 16COURIERRETURN — Возвращено курьером. Курьер не смог доставить до получателя и вернул заказ обратно на склад. Это промежуточный статус, после которого менеджер выясняет, нужно ли повторно доставлять (статусы DATECHANGE/DELIVERY) или это окончательная недоставка (CANCELED).: DATECHANGE — Перенос даты доставки. :14'''COMPLETE''' — Доставлен.:44" message="" title="'''PARTIALLY''' — Доставлен частично.: '''CANCELED''' — Не доставлен (Возврат/Отмена). После этого статуса отправление должны вернуть заказчику, будут статусы RETURNING и RETURNED : RETURNING — Планируется возврат заказчику (предварительнопосле CANCELED)">COURIERDELIVERED<.: RETURNED — Возвращен заказчику.: LOST — Утрачен/status>утерян. : PARTLYRETURNING — Планируется возврат остатков.: PARTLYRETURNED — Остаток возвращен.: TRANSACCEPTED — Прибыл на склад перевозчика.: PICKUPTRANS — Забран у перевозчика. <status eventstore="филиал в Санкт: WITHDRAWN_FROM_PICKUP_POINT -Петербурге" eventtime="2016Изъят.: CUSTOMSDELAY -06Задержка отправления таможенным органом.: DEPARTUREDELAY -02 17Задержка отправления перевозчиком.:22:00" createtimegmtSTORETAKE - Принят в работу на складе. '''Примечание.''' В будущем возможно дополнение используемого набора статусов. <div style="2016color: #a94442; background-06-03 16color: #f2dede; border:141px solid #ebccd1; padding:44" message="" title="Доставлен3px 10px 10px;">COMPLETE</status> </'''Обратите внимание!''' # Контейнер '''statushistory>''' и '''deliveryprice''' заполняется для тарифов [[Личный кабинет курьерской службы#Функции личного кабинета|Премиум и Максимум]].# Контейнер '''packages''' не возвращает более 1000 элементов. <deliveredto>Иванова# Система никогда не гарантирует последовательность прохождения заказом набора статусов. То есть Вы можете получить статус «COMPLETE», а следующим запросом — «NEW» — такое может произойти, например, если оператор ошибочно отметил заказ выполненным, секра затем исправил ошибку.</deliveredto> <delivereddate>2016-06-02</delivereddatediv> <deliveredtime>17:22</deliveredtimebr> <outstrbarcode>EXT123456</outstrbarcode> <items> <item code="34533" extcode="abc123" quantity="1" massПередача только изменившихся статусов ==="0В нашем API предусмотрено удобное средство получения статусов всех заказов, без необходимости «бомбить» сервер запросами статусов по каждому заказу. Работает это так: раз, например, в 10 минут, вы посылаете запрос «покажите все изменившиеся статусы». Пример запроса ниже. Система вам отдает ВСЕ заказы, статусы (или некоторые другие поля, см. ниже) которых изменились с момента последнего запроса. Вы разбираете полученный документ, по каждому заказу сохраняете его актуальный статус в своей системе, и если все хорошо, у вас все получилось, ваша система неожиданно не упала от наплыва информации, посылаете нам запрос подтверждения получения статусов (commitlaststatus). Мы у себя отмечаем, что эти статусы вами получены и их не надо передавать повторно.2" retprice="37Таким образом, сколько бы заказов у вас ни было, статусы по ним всем почти в реальном времени вы можете получать всего двумя запросами.5" VATrate Для получения только изменившихся статусов отправьте запрос:<source lang="0xml" barcode="2345625213125" article><?xml version="1" returns=".0" origincountryencoding="040" GTD="" excise="0.00" governmentCode="11223311" suppcompany="Поставщик" suppINN="1112223334" suppphone="79161234567UTF-8"?>Мяч</itemstatusreq> <item codeauth extra="34456" extcode="abc124" quantity="2" mass="2" retprice="100" VATrate="10" barcode="46456252131388" articlelogin="2login" returns="0" governmentCodepass="pass">Обруч</itemauth> <item code="34421" extcode="abc125" quantity="3" mass="0.3" retprice="50" VATrate="18" barcode="2345625213126" article="3" returns="0" governmentCode=""changes>Погремушка желтаяONLY_LAST</itemchanges> </itemsstreamid> 1234</orderstreamid></trackingstatusreq></source>

После успешной обработки ответа необходимо отметить полученные статусы успешно полученными, отправив запрос:<source lang="xml"><?xml version="1.0" encoding="UTF-8" ?><commitlaststatus> <auth extra="8" login="login" pass="pass"></auth> <client>CLIENT</client> <streamid>1234</streamid></commitlaststatus></source> '''Получение информации Описание полей запроса''' * '''auth''' — авторизация. Обязательный элемент.* '''streamid''' — идентификатор потока. Если у вас несколько интеграций и каждая нуждается в формате 17 TRACKполучении статусов, вы можете передавать данный параметр и тем самым разделять получение и отметку об успешном получении статусов по заказам. Значение должно входить в промежуток от 100 до 10000, включительно. Необязательный элемент.* '''client''' — признак клиента или агента. Необязательный элемент.:* CLIENT — признак клиента, значение по умолчанию:* AGENT — признак агента. В ответ отдается информация по заказам, переданным агенту на доставку

'''Пример запросаВ случае успеха вы получите ответ:'''

<?xml version="1.0" encoding="UTF-8"?><tracking17commitlaststatus error="0"> <extra>8</extra> <orderno>1234</orderno>OK</tracking17commitlaststatus>

'''Пример ответа:'''Такой способ передачи статусов гарантирует полную корректную передачу статусов, даже если в нашей системе статус изменился между запросом статусов и подтверждением их получения. Если система не получила подтверждение передачи статуса, она будет считать информацию непереданной и выдаст ее при повторном запросе. <pre>{ "numberdiv style="color: #a94442; background-color: #f2dede; border: 1px solid #ebccd1; padding:3px 10px 10px;"ExtNumber"># При этом способе передачи (<changes>ONLY_LAST</changes>) система просматривает заказы, оформленные за последние 3 месяца. Если заказ сделан ранее,изменение статуса по нему не попадет в результат выполнения запроса. "oriNumber":"1234"# Система всегда выдает текущий статус. Вы можете одним запросом получить статус «NEW», а следующим — «COMPLETE». Между запросами отправление могло пройти через несколько промежуточных статусов. Если нужна гарантия получения всех промежуточных статусов,нужно анализировать блок statushistory (может не заполняться вследствие ограничений версии или тарифа конкретной службы доставки). "oriCountry":"RU"# Система не гарантирует последовательность прохождения заказом набора статусов. Вы можете получить статус «COMPLETE», а следующим запросом «NEW» — такое может произойти, например, если оператор ошибочно отметил заказ выполненным,а затем исправил ошибку.</div><br>  === Лимитирование запросов === "destCountry":"RU"Дает возможность получить не все измененные заказы, а только какое-то определенное количество. Помогает на случай, если у вас скопилось очень много измененных заказов и нужно их грузить лимитировано. После успешной обработки получнных заказов,'''обязательно''' нужно вызвать commitlaststatus с кодами обработанных заказов.  '''Пример'''  "status"Для получения ограниченного числа изменившихся заказов отправьте запрос:"Complete", <source lang="eventsxml":[> { <?xml version="time1.0":encoding="2016-06UTF-02 17:22:008",?><statusreq> <auth extra="location8":login="RUlogin", pass="content":"Completepass"></auth> <changes>ONLY_LAST</changes> <limit>5</limit></statusreq> },</source> { "time":"2016-06-02 17:22После успешной обработки ответа необходимо отметить полученные статусы успешно полученными, отправив запрос:00", <source lang="locationxml":"RU",> <?xml version="content1.0":encoding="CourierdeliveredUTF-8"?> },<commitlaststatus> { "time": <auth extra="2016-06-02 09:17:008", login="locationlogin":pass="RUpass",></auth> <acs> "content":"Delivery" <ac>11111</ac> }, <ac>22222</ac> { <ac>33333</ac> "time":"2016-06-02 07:41:00", <ac>44444</ac> "location":"RU", <ac>55555</ac> "content":"Accepted" </acs> },</commitlaststatus> {</source> "time":"2016-06-01 19:53:00", "location":"RU", "content":"Departure"* '''acs''' — контейнер. Обязательный элемент. },* '''ac''' — атрибут''' ordercode''' контейнера '''order''' полученного на этапе запроса '''statusreq'''. { "time":"2016-06-01 17:38:00"Помимо приведенных в примере параметров, вы также можете передавать и остальные, описанные ранее,например '''streamid'''. "location":"RU", "content":"Departuring"== Трекинг заказа по номеру == Запрос трекинга по номеру предназначен для выдачи минимальной обезличенной информации о конкретном заказе не авторизованному пользователю. Наша система имеет для этого интерфейс по адресу «home.courierexe.ru/{код экстра}/tracking». Вы можете либо сделать ссылку на такую страницу на своем сайте, либо разместить ее [[#Размещение страниц на своем сайте (iframe)|iframe’ом]] у себя, либо сделать свою и пользоваться нашим API. Этот интерфейс создан специально для выдачи информации живому пользователю сайта. Для получения статусов заказов в свою информационную систему нужно использовать запрос «statusreq»,желательно с параметром changes=ONLY_LAST! { "time"'''Пример запроса:'''<source lang="2016-05-30 10:20:00xml",> <?xml version="location1.0":encoding="RUUTF-8",?><tracking> "content":"New" <extra>8</extra> } <orderno>1234</orderno> ]</tracking>}</presource>

Функция ищет последний заказ по номеру среди заказов всех клиентов. Выдает неперсонализированную информацию о текущем состоянии заказа.'''Пример ответа:'''<br /source lang="xml">Описание контейнеров ответа аналогично описанию [[API#.D0.97.D0.B0.D0.BF.D1.80.D0.BE.D1.81_.D1.81.D1.82.D0.B0.D1.82.D1.83.D1.81.D0.B0_.D0.B7.D0.B0.D0.BA.D0.B0.D0.B7.D0.BE.D0.B2|Запроса статусов заказов]]<?xml version="1.0" encoding="UTF-8"?><tracking> <order orderno="111111" ordercode= Изменение заказа =="12345"> <barcode>111111</barcode> <AWB>111111</AWB> <sender>Запрос предназначен для изменения заказов, находящихся в статусах <town code="Ожидает синхронизации1" или country="НовыйRU", а также по которым не было произведено изменений >Москва город</town> <date>2014- статуса корреспонденции, времени доставки 03- то есть заказов, которые ещё не находятся в работе.22</date> <time_min>09:00</time_min> <time_max>14:00</time_max> </sender> <receiver> <div styletown code="color: #a94442; background1" country="RU">Москва город</town> <zipcode>125480</zipcode> <date>2014-03-color22</date> <time_min>09: #f2dede; border00</time_min> <time_max>14: 1px solid #ebccd1; padding: 3px 10px 10px;"00</time_max>'''Обратите внимание!''' </receiver># Данные запроса изменения указываются '''полностью''', как если бы заказ создавался впервые <price>387.5</price># При отсутствии вложения в запросе изменения данное вложение '''не удаляется''' из заказа, но его количество становится равным 0 <inshprice>387.5</inshprice># При одновременном изменении заказа в API и системе курьерской службы приоритет отдается данным системы курьерской службы <paytype>CASH</paytype> <weight>5. То есть изменения в API приняты не будут!1</weight> <quantity>2</quantity> <service>2</service> <type>3</type> <return>NO</return> <return_service>2</return_service> <return_date></return_date> <return_time></return_time> <return_message></return_message> <waittime>12</divwaittime> <enclosure>Детские игрушки<br /enclosure> <instruction>Проверить при покупателе, подписать акт</instruction> <deliveryprice total="158.6" delivery="100.00" return= Описание полей запроса изменения ==="58.6" />Все поля запроса соответствуют структуре order при создании заказа за исключением: <courier>* вместо корневого тэга '''neworder''' указывается '''editorder''' <code>26</code>* тэг штрих-кода '''barcode''' не указывается, поскольку присваивается при создании заказа. <name>Иванов Владимир Петрович</name>* для вложений '''item''' указывается внутренний код вложения в атрибуте '''code''', который можно получить при получении статуса заказа. <phone>+79161234567</phone> </courier> <currcoords lat="55.680327" lon="37.604456" accuracy="50" RequestDateTime= Описание полей ответа изменения "2014-04-21 18:07:45" /> <status eventstore="филиал в Санкт-Петербурге" eventtime="2016-06-02 17:22:00" createtimegmt=Все поля ответа соответствуют ответу при создании заказа за исключением корневого тэга "2016-06- вместо '''neworder''' возвращается '''editorder'''.03 16:14:44" message="" title="Доставлен">COMPLETE</status> <statushistory> <status eventstore="Офис в Москве" eventtime="2016-05-30 10:20:00" createtimegmt= Отмена заказа "2016-06-03 16:14:44" message="" title="Новый">NEW</status> <status eventstore="Офис в Москве" eventtime="2016-06-01 17:38:00" createtimegmt="2016-06-03 16:14:44" message="филиал в Санкт-Петербурге" title="Планируется отправка">DEPARTURING</status>Запрос отмены предназначен для отмены тех заказов, по которым не было произведено изменений <status eventstore="Офис в Москве" eventtime="2016-06-01 19:53:00" createtimegmt="2016- статуса доставки, статуса корреспонденции, времени доставки 06- то есть заказов, которые ещё не находятся 03 16:14:44" message="филиал в работе.Санкт-Петербурге" title="Отправлено со склада">DEPARTURE</status>Возможность отмены заказа есть только у курьерских служб с тарифом <status eventstore="филиал в Санкт-Петербурге" eventtime="2016-06-02 07:41:00"Премиумcreatetimegmt=" и по2016-умолчанию она выключена, ее нужно отдельно включить06-03 16:14: [[Личный кабинет курьерской службы#Дополнительные настройки]].44" message="" title="Получен складом">ACCEPTED</status> <status eventstore="филиал в Санкт-Петербурге" eventtime="2016-06-02 09:17:00" createtimegmt="2016-06-03 16:14:44" message="" title="Выдан курьеру на доставку">DELIVERY</status>При отмене заказа поле <status eventstore="филиал в Санкт-Петербурге" eventtime="2016-06-02 17:22:00" createtimegmt="2016-06-03 16:14:44" message=""Инфо о доставкеtitle=" получает значение Доставлен (предварительно)"Отменено заказчиком>COURIERDELIVERED</status> <status eventstore=", поле филиал в Санкт-Петербурге"Дата доставкиeventtime=" 2016-06- текущую дату, а 02 17:22:00"Вручил курьерcreatetimegmt=" 2016-06- системную запись 03 16:14:44" message="ОТМЕНА"title="Доставлен">COMPLETE</status> </statushistory> <deliveredto>Иванова, секр.</deliveredto> <delivereddate>2016-06-02</delivereddate> <deliveredtime>17:22</deliveredtime>'''Пример запроса отмены заказа:''' <outstrbarcode>EXT123456</outstrbarcode> <items> <source langitem code="34533" extcode="abc123" quantity="1" mass="0.2" retprice="37.5" VATrate="0" barcode="2345625213125" article="1" returns="0" origincountry="040" GTD="" excise="0.00" governmentCode="11223311" suppcompany="Поставщик" suppINN="1112223334" suppphone="xml79161234567">Мяч</item> <?xml versionitem code="34456" extcode="abc124" quantity="2" mass="2" retprice="100" VATrate="10" barcode="4645625213138" article="2" returns="1.0" encodinggovernmentCode="UTF-8" ?>Обруч<cancelorder/item> <auth extraitem code="34421" extcode="abc125" quantity="3" mass="0.3" retprice="50" VATrate="18" barcode="2345625213126" article="3" returns="0" governmentCode="8" login>Погремушка желтая</item> </items> <acquirers> <acquirer code="login2" passname="passIbox" /> <order ordernoacquirer code="5" ordercodename="123456Payme" /> <order ordernoacquirer code="123aaa6" ordercodename="Click" /> </acquirers> </order></cancelordertracking></source> где,* '''acquirers''' / '''acquirer''' - эквайринг, доступный для получения ссылки на оплату заказа** '''acquirers''' / '''acquirer''' / ''code'' - внутренний код эквайринга** '''Описание полей запроса статуса:acquirers''' / '''acquirer''' / ''name''- наименование эквайринга

'''Пример ответазапроса:'''

<?xml version="1.0" encoding="UTF-8" ?><cancelordertracking17> <order orderno="123test" ordercode="123456" error="0" errormsg="OK" errormsgru="Успешно" extra>8</extra> <order orderno="123aaa" ordercode="" error="52" errormsg="order not found" errormsgru="Заказ не найден" >1234</orderno></cancelordertracking17>

== Добавление вложений к накладной == '''Пример запросаответа:'''<source lang=pre>{ "number":"ExtNumber", "oriNumber":"1234", "oriCountry":"RU", "destCountry":"RU", "status":"Complete", "events":[ { "time":"2016-06-02 17:22:00", "location":"RU", "town":"Москва", "store":"xmlМосква Главный">, "content":"Complete" }, { "time":"2016-06-02 17:22:00", "location":"RU", "town":"Москва", "store":"Москва Главный", "content":"Courierdelivered" }, { "time":"2016-06-02 09:17:00", "location":"RU", "town":"Москва", "store":"Москва Главный", "content":"Delivery" }, {<?xml version= "1.0time" encoding=:"UTF2016-806-02 07:41:00", "location":"RU", "town":"Москва", "store":"Москва Главный", "content" ?>:"Accepted" },<addattachments> { <auth extra= "time"8:" login=2016-06-01 19:53:00", "loginlocation" pass=:"passRU" />, <orderno>1234567</orderno> "town":"Горький", <attachments> "store":"Горький Автозавод", <item name= "content":"photo1.jpgDeparture">JVBERi0xLjMN1wb25lbnQgMQ JUBQREYwMTIzNDU2Nzg5IDI NMyAwIG9iag08PA0vVHlwZSA }, { U3VidHlwZSAvSW1hZ2UNL1d pZHRoIDE4MDgNL0hlaWdodCA "time":"2016-06-01 17:38:00", ggNCAwIFINL0JpdHNQZXJDb 21wb25lbnQgMQ0vRGVjb2RlU "location":"RU", ENL0NvbHVtbnMgMTgwOA0+P g0vSW1hZ2VNYXNrIHRydWUNL "town":"Горький", XhEZWNvZGUNPj4Nc3RyZWFt DQ</item> "store":"Горький Автозавод", <item name= "content":"photo2.jpgDeparturing">VBERi0xLjMNAwIG9iag0HRoJ JUBQREYwMTIzNDU2Nzg5IDI NMyAwIG9iag08PA0vVHlwZSA }, vWE9iamVjdA0vU3VidHlwZS AvSW1hZ2UNL1dpZHRoIDEzNj { gNL0hlaWdodCAxMzMzDS9MZ W5ndGggNCAwIFINL0JpdHNQZ "time":"2016-05-30 10:20:00", "location":"RU", XJDb21wb25lbnQgMQ0vRGVj b2RlUGFybXMgPDwNL0sgLTEN "town":"Горький", L0NvbHVtbnMgMTM2OA0+Pg0 vSW</item> "store":"Горький Автозавод", "content":"New" </attachments> }</addattachments> ]}</sourcepre>

'''addattachments''' <div style="color: #a94442; background- Корневой контейнер. Обязательный элемент.color: #f2dede; border: 1px solid #ebccd1; padding: 3px 10px 10px;">*'''authОбратите внимание!''' - Авторизация. Обязательный элемент.*'''orderno''' - Номер заказа. Обязательный элементЭтим методом вы можете только получить ссылку на оплату. Может использоваться тэг <ordercode> с указанием внутреннего кода заказа.*'''attachments''' - Обязательный элемент, в котором перечисляются передаваемые данные файловФискализация этого платежа идет отдельным процессом.**'''item''' - Бинарные данные (файл), закодированные По его возможности уточняйте в base64. Обязательный элементслужбе поддержки.***'''name''' - Атрибут элемента '''item''', в котором передается имя файла. Обязательный элемент.</div>

'''Пример ответазапроса:'''

<addattachmentsacqlink> <extra>8</extra> <acq> <attachmentscode>2</code> <item name="photo1.jpg" error="0" errormsg="OK" errormsgru="Успешно" /acq> <item name="photo2.jpg" error="0" errormsg="OK" errormsgru="Успешно" order> <code>12345</code> </attachmentsorder></addattachmentsacqlink>

'''Пример запросаответа:'''

<?xml version="1.0" encoding="UTF-8" ?><attachments> <auth extraacqlink error="80" loginamount="login2000" passextid="pass161083231" >https:/> <orderno>1234567</orderno>qr.nspk.ru/AD10001A7GLVGA9YDO2I0789SIOPV3?type=02&amp;bank=1000011&amp;sum=2000&amp;cur=RUB&amp;crc=7E9C</attachmentsacqlink>

где*'''Описание полей:acqlink'''- ссылка на оплату заказа *acqlink.'''attachmentsamount''' - Корневой контейнер. Обязательный элемент.тип integer сумма платежа в копейках в общем случае, в других случаях в соответствии с типом валюты*acqlink.'''authextid''' - Авторизация. Обязательный элемент.идентификатор счета на стороне платежной системы*acqlink.'''orderno'error'' - Номер/код заказа. Обязательный элемент.  '''Пример ответаошибки, если отличается от 0, означает невозможность получения ссылки на оплату, в этом случае ссылки на оплату не будет и ответ будет выглядеть так:'''

<attachments> <item nameacqlink error="doc1.docx2" sizemessage="35654Ошибка авторизации: Invalid token">JVBERi0xLjMN JUBQREYwMTIzNDU2Nzg5IDI NMyAwIG9iag08PA0vVHlwZSA U3VidHlwZSAvSW1hZ2UNL1d pZHRoIDE4MDgNL0hlaWdodCA ggNCAwIFINL0JpdHNQZXJDb 21wb25lbnQgMQ0vRGVjb2RlU ENL0NvbHVtbnMgMTgwOA0+P g0vSW1hZ2VNYXNrIHRydWUNL XhEZWNvZGUNPj4Nc3RyZWFt DQ</item> <item nameamount="photo2.jpg2000" sizeextid="74861">VBERi0xLjMN JUBQREYwMTIzNDU2Nzg5IDI NMyAwIG9iag08PA0vVHlwZSA vWE9iamVjdA0vU3VidHlwZS AvSW1hZ2UNL1dpZHRoIDEzNj gNL0hlaWdodCAxMzMzDS9MZ W5ndGggNCAwIFINL0JpdHNQZ XJDb21wb25lbnQgMQ0vRGVj b2RlUGFybXMgPDwNL0sgLTEN L0NvbHVtbnMgMTM2OA0+Pg0 vSW</item></attachments>

где*acqlink.'''message''' - текст ошибки возвращаемой эквайрингом Возможные типы ошибок получения ссылки:* '''1''' - не настроен эквайринг, либо не найден заказ* '''2''' - ошибка на стороне эквайринга* '''3''' - запрещающий статус курьера (заказ доставлен, частично доставлен)* '''4''' - оплата заказа не разрешена == Изменение заказа ==Запрос предназначен для изменения заказов. Изменять заказы могут курьерские службы с тарифами «Премиум» и «Максимум». Чтобы разрешить изменение заказов, в личном кабинете курьерской службы перейдите в '''Настройки''' > '''Заказы''' и в разделе '''Отмена и редактирование''' установите флажок '''Разрешить отмену и изменение заказов'''. Вы также можете пометить в списке '''Статусы для отмены и редактирования заказов''' галками статусы корреспонденции, для которых возможны отмена и изменение заказов. По умолчанию (когда в этом списке ничего не выбрано) редактирование и отмена разрешены для статуса «Новый» <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''', который можно получить при получении статуса заказа.  Необходимо иметь в виду, что: # Заказ нельзя изменить, пока он не синхронизирован с системой (файлыпока предыдущие изменения не переданы в бэк-офис)# Удаление вложений и мест выполняется не моментально, закодированные а в base64.процессе синхронизации с бэк-офисом (для записей указываются метки Удалено)

== Изменение статуса агентом =Описание полей ответа изменения ===Все поля ответа соответствуют ответу при создании заказа за исключением корневого тэга — вместо '''neworder''' возвращается '''editorder'''.

== Отмена заказа ==Запрос изменения статуса заказа позволяет установить окончательный статус заказа - "Доставлен" или "Не доставлен (Возврат/Отмена)"предназначен для отмены заказов.

Кроме этого, устанавливается дата Отменять заказы могут курьерские службы с тарифами «Премиум» и время (при необходимости) изменения статуса, а также сообщение «Максимум». Разрешения для отмены заказов и статусы в которых заказы можно отменять описаны в поле разделе '''Инфо о доставкеИзменение заказов'''.

При необходимости к заказу можно прикрепить изображенияотмене заказа поле «Инфо о доставке» получает значение «Отменено заказчиком», поле «Дата доставки» — текущую дату, а «Вручил курьер» — системную запись «ОТМЕНА».

'''Пример запроса изменения статусаотмены заказа:'''

<setorderinfocancelorder>

<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>

'''Описание полей запроса статуса:''' '''setorderinfo''' - Корневой контейнер. Обязательный элемент.*'''auth''' - Авторизация. Обязательный элемент.*'''order''' - Контейнер заказа. Обязательный элемент. Запрос может содержать более одного контейнера '''order'''. Атрибут '''''ordercode''''' - внутренний код заказа.*'''status''' - Новый статус заказа. Доступны статусы из раздела [[#Описание полей ответа статусов]], кроме AWAITING_SYNC и NEW.*'''eventtime''' - Дата и время изменения статуса. Обязательно при указании статуса.*'''message''' - Текст сообщения ''Инфо о доставке''.*'''paytype''' - Тип оплаты заказа. Допустимые значения CASH/CARD.*'''items''' - Контейнер для описания вложений '''item''' . Атрибуты::* '''''code''''' - Код вложения.:* '''''quantity''''' - Количество доставленных единиц вложения.:* '''''reason''''' - Причина недоставки, выбирается из соответствующего списка статусов.*'''image''' - Контейнер прикрепляемого изображения. Содержит текст файла изображения, закодированный по стандарту ''base64''. Контейнер '''order''' может содержать более одного контейнера '''image'''. Атрибут::* '''''filename''''' - Имя файла.

<?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>

== Получение документов для печати Добавление вложений к накладной == Метод позволяет прикрепить файлы к корреспонденции.Размер загружаемого файла не должен превышать 1 Мб.

'''Пример запроса получения печатных форм:'''

<waybilladdattachments>

<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 orderno="1234568" ordercodeitem name="33332photo2.jpg" />VBERi0xLjMNAwIG9iag0HRoJ JUBQREYwMTIzNDU2Nzg5IDI NMyAwIG9iag08PA0vVHlwZSA vWE9iamVjdA0vU3VidHlwZS AvSW1hZ2UNL1dpZHRoIDEzNj gNL0hlaWdodCAxMzMzDS9MZ W5ndGggNCAwIFINL0JpdHNQZ XJDb21wb25lbnQgMQ0vRGVj b2RlUGFybXMgPDwNL0sgLTEN L0NvbHVtbnMgMTM2OA0+Pg0 vSW</ordersitem> <form>1</formattachments></waybilladdattachments></source> '''Описание полей:'''

 '''Описание полей:'''waybill ''' - addattachments''' — Корневой контейнер. Обязательный элемент.*'''auth''' -  — Авторизация. Обязательный элемент.*'''ordersorderno''' - Список заказов для получения печатных форм — Номер заказа. Содержит тэги '''order''' Обязательный элемент. Может использоваться тэг <ordercode> с атрибутами:указанием внутреннего кода заказа.:* '''attachments''orderno''''' - шифр заказа — Обязательный элемент, в котором перечисляются передаваемые данные файлов.:** '''item''ordercode''''' - внутренний код заказа — Бинарные данные (файл), закодированные в base64. Указывать необходимо один из атрибутов для всех заказовОбязательный элемент. Приоритет имеет атрибут ''''*** 'ordercode''name'''* — Атрибут элемента '''formitem''' - Формат накладной, в котором передается имя файла. Не обязательный Обязательный элемент. Принимает значения::* 1 - Подробная накладная (по-умолчанию):* 2 - Наклейки Zebra:* 3 - Наклейки на страницу формата А4:* 4 - Акты приема-передачи

<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>

В тэге content возвращаются бинарные данные (файл pdf), закодированные в base64.'''Описание полей:''' '''attachments''' — Корневой контейнер. Обязательный элемент.* '''Обратите вниманиеauth''', что печатные формы для заборов не формируются — Авторизация. Обязательный элемент.* '''orderno''' — Номер/код заказа. Обязательный элемент.

'''Пример запроса справочника городовответа:'''

<townlistattachments> <auth extraitem name="doc1.docx" timestamp="2025-01-01 12:00:00" size="835654" />JVBERixLjMN <codesearch>UwLJdLwIDKxTn+AScMjKqor7Xm3sp1yj1k6BzlPdX2Qsiit6yg3g1fCI4YVAgclUOIY5tDra2LvAcIS <zipcode>110000< 5/+8PsL/sXb0+aoper/9kL/4Ov/zipcode>YE9QsHwyg7YZTtKICy0YVIYb4Nt7L1tPUMfaX9NpuTsvFCtBAvYG <kladrcode>0100000100800</kladrcode> eJVZoZ2tm6+fZVqAavZpeLizVLtct1a+xvG0+bTSkw3Ac8PhdNfL4smrT2hSgPJLfyaVGyA2ndyW22t <fiascode>bd21979d-46f8-49d0-9105-e8d65172a983< sFtTP5knktPNumSZ56QsFRPJkaU8ExDxAcMYMDIoBiIoR4/fiascode> <code>123<dDjHMbMW/code>EW4fiB1pvWmV2ONWIl1Xdub <Xg1ob0qWX9W4qagsqzGhjRLsEGeJGVXg9oVC+XkJa9esrhGUmC0tuKEla+AplVO/codesearch>OtHwXcW0FWui1z7 <conditions>6KHrtobuWV0xa9sCEiSvb91w3ePHOvfcveo5xt9o4ZevHF7ZOeKxV5qmVx2MI44a1L+Mhk5YuGT12xd <city>Краснодарский край< Ibsb7r+j9bff/city> <namecontains>новгород<unQlv0al6HBnoD5G89q4+tkjgDtvwwARmqm2aa2Jgvmth8mrXquTNtl2u467vbF/namecontains>5r <namestarts>Моск< vnMt9uesu21Me1bjeNJGlVfAaCtw+/namestarts> <name>Москва<jfenJ/name>fWjqa7ygExx+L0BcTGroxrKexQXIQ1ImfEW7ZRJZa+O <fullname>Москва город< ip7xJmmNESMxrgu/fullname>dquBbGypjJpFDJVRH1rVPR1Ifl4aFS5IEdDWZFSdyBBWKWhVSVu517ZgzOCFAwp <country>1< wwbFph29g4fTaxnvn/country>3X78x+Tt56ZNffArgULt+HByvy7+yz6U6XWMawCi3+6gJXN0S+jf4t+HT34wg <km7/conditions>HDp55YTSWMoCMgZsvZkBrXtIv4WA7xgkT4YpYpxjwLvnsWKkGE+pDbxER0UUWlpVFRY4oilTfM4 <limit>MIzgCPgxjOlZ87ceA7ceRJrgpipFGyugPQ4OTI2S8lWJoqTpHJlJbNOeYM7zTcoVxSNyJXiYWSAMklT <limitfrom>30< q/xd+3fd3/limitfrom>USq2V1rJ7RyBLHsuDSiLwgaOFc5LUCRGI+QWuBAsIwPlZrgRpSMseJyTzD15PKiIRE7bc Rggk5ijXAPpqISetD4wVm0AD2LHuBZdaxmK3HOKIZoG0QLmiZdVqspXnFIJwVyCKhWiDCI4bzH8Y76w <limitcount>10</limitcount> TAnwM67HIqMISOkmJXY8mlYhpiNa7g2oTBkKxo4wgnvETQIUUrlFOn9KdOreDiKQx071rN4N61yRAi1 <countall>YES< 7EGRhSOgoeLYv+k41+KZ1SVBXAuDjB+xuxnQmm8wJDcP5IRn+5penzbR/countall>ivm7qleHK5o790w8ejXchI vOHIPWtWwYhtAO34LdDXqFqWxZEBLNstMCwwITBTWirxk12zuUppp</limititem></townlistattachments></source> В тегах item возвращаются бинарные данные (файлы), закодированные в base64. == Изменение статуса агентом ==Запрос изменения статуса заказа позволяет установить окончательный статус заказа — «Доставлен» или «Не доставлен (Возврат/Отмена)». Кроме этого, устанавливается дата и время (при необходимости) изменения статуса, а также сообщение в поле ''Инфо о доставке''.

Внутри контейнера townlist все элементы могут как отсутствовать, так и комбинироваться. Поиск не чувствителен При необходимости к региструзаказу можно прикрепить изображения.

*'''codesearch''' - Поиск по кодам. В случае использования - контейнеры conditions и limit игнорируются.:* '''zipcode''' - Поиск по индексу. Обратите внимание на то, что один почтовый индекс может распространяться на несколько населенных пунктов. В этом случае система вернет несколько записей.:* '''kladrcode''' - Поиск по 13-ти значному коду КЛАДР.:* '''fiascode''' - Поиск по коду ФИАС (AOGUID).:* '''code''' - Поиск по коду в системе. *'''conditions''' - Задает условия поиска. Все вложенные элементы одновременно накладывают условие "И".:* '''city''' - Поиск по всем населенным пунктам региона.:* '''namecontains''' - Поиск населенных пунктов, название которых содержит указанный текст.:* '''namestarts''' - Поиск населенных пунктов, название которых начинается с указанного текста.:* '''name''' - Поиск населенных пунктов, название которых соответствует указанному тексту.:* '''fullname''' - Поиск населенных пунктов, название вместе с типом населенного пункта которых соответствует указанному тексту.:* '''country''' - Поиск только по стране с указанным кодом. *'''limit''' - Ограничивает вывод результата.:* '''limitfrom''' - Задает номер записи результата, начиная с которой выдавать ответ. По-умолчанию - 0.:* '''limitcount'''- Задает количество записей результата, которые нужно вернуть. По-умолчанию - 10000.:* '''countall''' - YES указывает на необходимость подсчета общего количества найденных совпадений. Это может замедлять выполнение Пример запроса. Если отключено - в ответе не указываются totalcount и totalpages. '''Пример ответаизменения статуса:'''

<?xml version="1.0" encoding="UTF-8"?><townlist countsetorderinfo> <auth extra="38" pagelogin="1login" totalcountpass="3" totalpages="1pass"/> <townorder ordercode="123456"> <codemessage>26379Получил Иванов</codemessage> <cityoutstrbarcode> <code>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="43.585534533" quantity="1" reason="0" longovernmentCode="39.723111223311" /> <item code="34456" quantity="0" reason="0" /town> <townitem code="34421" quantity="2" reason="0" /> <code>40331</codeitems> <cityattachments> <codeattachment filename="filename1.jpg">32</code>9j/4AAQSkZJRgA <name>Брянская область<BAQAAAQABAAD/name>2wBDAA0JCg sKCA0LCgsODg0PEyAVExISEy ccHhcgLikxMC4pLSwzOko+M zZGNywtQFdBRkxOUlNSMj5aY < VpQYEpRUk/city> <name>Сочилов хутор</name>2wBDAQ4ODhMR EyYVFSZPNS01T09PT09PT09P <fiascode>c9c96c67-2cc9-4f10-afde-fd32417ea216</fiascode> T09PT09PT09PT09PT09PT09 PT09PT09PT09PT09PT09PT09 <kladrcode>3201900011100< PT09PT0/kladrcode> <shortname /> wAARCAYACAADAS IA<typename /attachment> <coords latattachment filename="52filename2.6407jpg" lon="33.1724" /> </town> <town> <code>114016<9j/code> <city>4AAQSkZJRgA <code>60<BAQAAAQABAAD/code>2wBDAA0JCg sKCA0LCgsODg0PEyAVExISEy <name>Псковская область</name>ccHhcgLikxMC4pLSwzOko+M zZGNywtQFdBRkxOUlNSMj5aY < VpQYEpRUk/city> <name>Сочихино деревня</name>2wBDAQ4ODhMR EyYVFSZPNS01T09PT09PT09P <fiascode>10df7588-19c1-49d1-a387-9de1cf3eb26f</fiascode> T09PT09PT09PT09PT09PT09 PT09PT09PT09PT09PT09PT09 <kladrcode>6001900015400< PT09PT0/kladrcode> <shortname /> wAARCAYACAADAS IA<typename /attachment> <coords lat="56.6003" lon="29.3542" /attachments> </townorder></townlistsetorderinfo></source> 

  '''Пример запроса справочникаответа:'''

<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>

== Получение документов для печати =='''Пример ответазапроса получения печатных форм:'''

<?xml version="1.0" encoding="UTF-8"?><regionlist count="2"waybill> <city> <code>80<auth extra="8" login="login" pass="pass" /code> <countryclient> <code>1CLIENT</codeclient> <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> <countrystart> <code>15</codestart> <nameintegration>Россия</name> <id>643</id> <ShortName1>RU</ShortName1> <ShortName2>RUS</ShortName2> </country> <name>Адыгея республика</name> 21</cityintegration></regionlistwaybill>

'''Пример запроса справочника улиц:waybill''' — Корневой контейнер. Обязательный элемент<source lang="xml">* '''auth''' — Авторизация. Обязательный элемент<?xml version="1* '''client''' — Признак клиента или агента. Необязательный элемент.0" encoding="UTF-8"?><streetlist>:* CLIENT — Признак клиента, значение по умолчанию <conditions>:* AGENT — Признак агента. В ответ отдается информация по заказам, переданным агенту на доставку <town>Москва город</town> // ОБЯЗАТЕЛЬНОЕ ПОЛЕ!* '''orders''' — Список заказов для получения печатных форм. Содержит тэги '''order''' с атрибутами: <namecontains>Хохло</namecontains>:* '''''orderno''''' — шифр заказа <namestarts>Академика Х</namestarts>:* '''''ordercode''''' — внутренний код заказа. Указывать необходимо один из атрибутов для всех заказов. Приоритет имеет атрибут '''''ordercode''''' <name>Академика Хохлова</name> <fullname>Академика Хохлова ул* '''form''' — Формат накладной. Не обязательный элемент.</fullname>Принимает значения: </conditions>:* 1 — Подробная накладная (по-умолчанию) <limit>:* 2 — Наклейки Zebra <limitfrom>30</limitfrom>:* 3 — Наклейки на страницу формата А4 <limitcount>10</limitcount>:* 4 — Акты приема-передачи <countall>YES</countall>* '''start''' — Имеет смысл только для form = 3. Начальная позиция первой наклейки. Используется для пропуска наклеек на листе для их экономии. </limit>* '''integration''' - Получение наклеек от подрядчика. Не обязательный элемент, имеет смысл при наличии кода подрядчика в карточке заказа. Принимает значение:</streetlist></source>:* 21 - подрядчик GTD

<streetlist countwaybill> <integration code="121" page> <order code="133331" totalcount> <content>JVBERi0xLjYNJeLjz9MNC...</content> </order> <order code="3" totalpages="133332"> <streetcontent> <name>Академика Хохлова улJVBERi0xLjYNJeLjz9MNC...</namecontent> <shortname/order>Академика Хохлова </shortnameintegration> <typenamecontent>ул.<EODIcaI8KSBlwQ 4MnEOR7Px8U8EBAyGICBnwpw IZhQgz0ZxuPs8EBM/GcbjzB AwhBl8hwQYIO00GmEwg1CeEG mqYTChNU0wqf8l8nz4zgc+K fCno+zwU5GjOZmzXGcbEQYIM 4zkegRE40zWzONyoNNMIOIa cWnp6aDCGEGE9NQmoQd2mg00 79U4f3hPTwnfp6Sdrafeqpa JDpFw/typename>1aYT077VNNNdO00G3q mqqvp9p2E7T0/wiFemv8uG6 OM</streetcontent></streetlistwaybill>

== Справочник номенклатуры ==В тэге content возвращаются бинарные данные (файл pdf), закодированные в base64.При записи в файл необходимо использовать двоичный формат записи!  Блок integration содержит отдельные наклейки для заказов, предоставленные подрядчиком, так же закодированные в base64.  '''Обратите внимание''' Лимит количества при единовременном получении печатных форм - 1000 штук. Если нужно получить больше - делайте это несколькими запросами. '''Обратите внимание''' Печатные формы для заборов не формируются. 

'''Пример запроса справочника номенклатурыответа с ошибкой:'''

<?xml version="1.0" encoding="UTF-8" ?><itemlistwaybill> <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> <excepterror> <code>123478Текст ошибки</codeerror> </except> <limit> <limitfrom>30</limitfrom> <limitcount>10</limitcount> <countall>YES</countall> </limit></itemlistwaybill></source> Внутри контейнера itemlist все элементы могут как отсутствовать, так и комбинироваться. Поиск не чувствителен к регистру.*'''codesearch''' - Поиск по кодам. В случае использования - контейнеры conditions и limit игнорируются.:* '''code''' - Поиск по внутреннему коду системы.:* '''article''' - Поиск по артикулу.:* '''barcode''' - Поиск по штрих-коду. *'''conditions''' - Задает условия поиска. Все вложенные элементы одновременно накладывают условие "И".:* '''namecontains''' - Поиск товаров, название которых содержит указанный текст.:* '''namestarts''' - Поиск товаров, название которых начинается с указанного текста.:* '''name''' - Поиск товаров, название которых соответствует указанному тексту.:* '''quantity''' - Наличие на складе. Принимает значения EXISTING_ONLY - Только в наличии, NOT_EXISTING_ONLY - Только не в наличии, ALL - Все. ''Это поле может быть недоступным в некоторых установках.'':* '''store''' - Поиск товаров по определенному складу. *'''except''' - Описание исключений для корректного определения количества зарезервированной номенклатуры.:* '''code''' - Код заказа. *'''limit''' - Ограничивает вывод результата.:* '''limitfrom''' - Задает номер записи результата, начиная с которой выдавать ответ.:* '''limitcount''' - Задает количество записей результата, которые нужно вернуть.== Справочник городов =='''Пример ответазапроса справочника городов:'''

<itemlist counttownlist> <auth extra="3" totalcount="3" page="1" totalpages="18"/> <itemcodesearch> <codezipcode>123456110000</codezipcode> <articlekladrcode>FD3430100000100800</articlekladrcode> <barcodefiascode>2345625213125bd21979d-46f8-49d0-9105-e8d65172a983</barcodefiascode> <namecode>Sony KDL-55W905 ЖК-телевизор123</namecode> <retprice/codesearch>65000 </retpriceconditions> <purchpricecity>50000Краснодарский край</purchpricecity> <weightnamecontains>5.1новгород</weightnamecontains> <lengthnamecontainsparts>50молоково моск</lengthnamecontainsparts> <widthnamestarts>30Моск</widthnamestarts> <heightname>40Москва</heightname> <CountInPalletfullname>30Москва город</CountInPalletfullname> <HasSerialscountry>1</HasSerialscountry> <CountryOfOrigin>Малайзия </CountryOfOriginconditions> (not yet supported) <Message>Хороший телевизор</Messagelimit> <Message2limitfrom>Снова хороший телевизор30</Message2limitfrom> <quantitylimitcount>1210</quantitylimitcount> <reservedcountall>3YES</reservedcountall> <item/limit> ...</itemlisttownlist>

'''Описание полей:'''*'''code''' - Внутренний идентификаторВнутри контейнера townlist все элементы могут как отсутствовать, присвоенный системойтак и комбинироваться.*'''article''' - Артикул, назначенный клиентом (поставщиком).*'''barcode''' - Штрих-код производителя.*'''name''' - Наименование.*'''retprice''' - Розничная цена по-умолчанию. При оформлении заказа цена используется та, которая указана в заказе.*'''purchprice''' - Закупочная цена.*'''weight''' - Масса в килограммах.*'''length''' - Длина в сантиметрах.*'''width''' - Ширина в сантиметрах.*'''height''' - Высота в сантиметрах.*'''CountInPallet''' - Количество штук в паллете.*'''HasSerials''' - Требует учета серийных номеров. Принимает значения 1 - да, 0 - нет.*'''CountryOfOrigin''' - Наименование страны происхождения на русском языке.*'''Message''' - Комментарий.*'''Message2''' - Дополнительный комментарий.*'''quantity''' - Количество на складе. Товары, уже собранные в заказы в этом количестве Поиск не присутствуют, считаются покинувшими товарный склад. ''Это поле может быть недоступным в некоторых установках.''*'''reserved''' - Количество зарезервированного товара. Может превышать остаток на складе, если покупатели ждут следующей поставки. ''Это поле может быть недоступным в некоторых установкахчувствителен к регистру.''

* '''Пример запроса движения номенклатурыcodesearch''' — Поиск по кодам. В случае использования — контейнеры conditions и limit игнорируются.:* '''zipcode''' — Поиск по индексу. Обратите внимание на то, что один почтовый индекс может распространяться на несколько населенных пунктов. В этом случае система вернет несколько записей.<source lang="xml">:* '''kladrcode''' — Поиск по 13-ти значному коду КЛАДР.<?xml version="1:* '''fiascode''' — Поиск по коду ФИАС (AOGUID).0" encoding="UTF-8" ?><itemmovements> <auth extra="8" login="login" pass="pass"></auth> <:* '''code>4259</code> <datefrom>2020-10-01</datefrom> <dateto>2020-10-02</dateto></itemmovements></source>''' — Поиск по коду в системе.

*'''codeconditions''' - внутренний код товара  — Задает условия поиска. Все вложенные элементы одновременно накладывают условие «И».:* '''city''' — Поиск по всем населенным пунктам региона.:* '''namecontainsparts''' — Поиск населенных пунктов, название которых содержит все указанные слова, с разбиением поисковой фразы через пробел. Например "моск моло" найдет деревню "Молоково" в справочнике номенклатурыМосковской области.:* '''namecontains''' — Поиск населенных пунктов, название которых содержит указанный текст.:* '''namestarts''' — Поиск населенных пунктов, название которых начинается с указанного текста.:*'''datefromname''' - дата начала периода — Поиск населенных пунктов, название которых соответствует указанному тексту.:*'''datetofullname''' - дата окончания периода — Поиск населенных пунктов, название вместе с типом населенного пункта которых соответствует указанному тексту.Может быть указан :* '''country''' — Поиск только по стране с указанным внутренним кодом или кодтекстовым кодом в соответствии [https://ru.wikipedia.org/wiki/ISO_3166-1 стандартом ISO_3166-1], например, или период«RU», или код и период одновременно«RUS» для России.

'''Пример ответа движения номенклатуры:'''

<?xml version="1.0" encoding="UTF-8" ?><itemmovements townlist count="163" page="1" totalcount="3" totalpages="1"> <itemmovementtown> <code>15150026379</code> <datecity> <code>2017-05-2623</datecode> <retpricename>0Краснодарский край</retpricename> <quantity>1</quantitycity> <deliveredname>0Сочи город</deliveredname> <itemfiascode> <code>425979da737a-603b-4c19-9b54-9114c96fb912</codefiascode> <namekladrcode>Настольная игра Дженга2300000700000</namekladrcode> <shortname /item> (not yet supported) <statustypename /> (not yet supported) <codecoords lat="43.5855" lon="39.7231" />5 </codetown> <nametown>Возврат от покупателя </namecode> 40331</statuscode> <storecity> <code>132</code> <name>офис в МосквеБрянская область</name> </storecity> <order> <ordercodename>3374830Сочилов хутор</ordercodename> <numberfiascode>123660c9c96c67-2cc9-4f10-afde-0fd32417ea216</numberfiascode> <datekladrcode>2017-05-243201900011100</datekladrcode> <ordernoshortname />14123 <typename /orderno> <barcodecoords lat="52.6407" lon="33.1724" />0000000670 </barcodetown> <company>ТОВАР</companytown> <addresscode>Кравченко ул., 1114016</addresscode> <delivereddate>2017-05-29 </delivereddatecity> <deliveredtimecode>12:00:0060</deliveredtimecode> <deliveredto name>Псковская область</name> </ordercity> <document> <codename>21991Сочихино деревня</codename> <numberfiascode>31810df7588-19c1-49d1-a387-9de1cf3eb26f</numberfiascode> <datekladrcode>2017-05-266001900015400</datekladrcode> <messageshortname /> <typename /message> <coords lat="56.6003" lon="29.3542" /document> </itemmovementstown></itemlisttownlist>

*'''item''' - контейнер товара:* '''code''' - внутренний код товара:* '''name''' - наименование товара *'''status''' - контейнер статуса операции:* '''code''' - код статуса:* '''name''' - наименование *'''store''' - контейнер филиала, к которому относится операция:* '''code''' - код филиала:* '''name''' - наименование филиала *'''order''' - контейнер корреспонденции:* '''ordercode''' - внутренний код заказа:* '''number''' - номер заказа:* '''date''' - дата заказа:* '''orderno''' - шифр:* '''barcode''' - штрих-код:* '''company''' - компания:* '''address''' - адрес:* '''delivereddate''' - дата вручения:* '''deliveredtime''' - время вручения:* '''deliveredto''' - данные о вручении, либо причина недоставки *'''document''' - контейнер документа операции:* '''code''' - внутренний код документа:* '''number''' - номер документа:* '''extnumber''' - внешний номер документа:* '''date''' - дата документа:* '''message''' - комментарий == Получение справочника тарифов по городам Справочник регионов == '''Пример запроса справочника тарифов по городам:'''

<tariffsregionlist> <codesearch> <code>77</code> </codesearch> <conditions> <namecontains>край<auth extra="8" login="login" pass="pass" /namecontains> <townfromnamestarts>МоскваМоск</townfromnamestarts> <servicefullname>1Московская область</servicefullname> <mainonlycountry>1RU</country> </mainonlyconditions> </tariffsregionlist>

*'''auth''' — атрибут '''extra''' обязателен, по нему определяется курьерская служба.*'''townfrom''' — город-отправитель. Если не передан, то городом будет «Москва».*'''service''' — режим доставки. Обязательный элемент.*'''mainonly''' — необязательный элемент. Если передан, то в ответе будут данные только по городам из справочника '''Межгород''' > '''Зоны'''.  '''Пример ответа справочника тарифов по городам:'''<source lang="jsonxml">{ "townfrom": <?xml version="0c5b2444-70a0-4932-980c-b4dc0d3f02b5", "service": 1, .0"tariffs": [ { encoding="towntofias": "7339e834-2cb4-4734UTF-a4c7-1fca2c66e5628",?> <regionlist count="towntocode2": "482",> "towntoname": "Уфа город", <city> "pricesnew": { <code>80</code> "before": [ <country> { "price": "100", "every": "0", "mass": " <code>1"</code> }, <name>Россия</name> { <id>643</id> "price": "200", <ShortName1>RU</ShortName1> "every": "1", <ShortName2>RUS</ShortName2> "mass": "2" </country> } <name>Агинский Бурятский автономный округ</name> ], </city> "after": [ <city> { "price": "300", "every": " <code>1",</code> "mass": "3" <country> } ] }, "prices": { "before": { "mass": "3", "price": "202.5" }, "after": { "mass": "3", "every": " <code>1",</code> "price": "18.75" <name>Россия</name> } <id>643</id> }, <ShortName1>RU</ShortName1> "deliveryPeriodMin": 4, <ShortName2>RUS</ShortName2> "deliveryPeriodMax": 5 </country> } <name>Адыгея республика</name> ] </city>}</regionlist>

''' Описание полей ответа '''* '''townfrom''' — код ФИАС города-отправителя.* '''service''' — режим доставки.*'''tariffs''' — cписок тарифов по городу.:* '''towntofias''' — код ФИАС города-получателя.:* '''towntocode''' — внутренний код города-получателя.:* '''towntoname''' — наименование города-получателя.:* '''pricesnew''' — ваши настройки тарифов из справочника '''Межгород''' > '''Тарифы по зонам'''.::* '''price''' — цена.::* '''every''' — за каждые.::* '''mass''' — масса.:* '''prices''' — устаревший элемент, не используется.:* '''deliveryPeriodMin''' — минимальный срок доставки.:* '''deliveryPeriodMax''' — максимальный срок доставки. == Номенклатура приходной накладной Справочник улиц == '''Пример запроса номенклатуры приходной накладнойсправочника улиц:'''

<?xml version="1.0" encoding="UTF-8" ?><itemdocstreetlist> <auth extra="8" login="login" pass="pass"conditions> <town>Москва город</town> // ОБЯЗАТЕЛЬНОЕ ПОЛЕ! <namecontains>Хохло</namecontains> <namestarts>Академика Х</namestarts> <name>Академика Хохлова</name> <fullname>Академика Хохлова ул.</fullname> </conditions> <limit> <limitfrom>30</authlimitfrom> <codelimitcount>2199110</limitcount> <countall>YES</countall> </codelimit></itemdocstreetlist>

*'''codeconditions''' - внутренний  — Задает условия поиска. Все вложенные элементы одновременно накладывают условие «И».:* '''town''' — Обязательное поле. Название или код документа приходной накладной (смнаселенного пункта.:* '''namecontains''' — Поиск улиц, название которых содержит указанный текст.:* '''namestarts''' — Поиск улиц, название которых начинается с указанного текста.:* '''name''' — Поиск улиц, название которых соответствует указанному тексту. предыдущий запрос):* '''fullname''' — Поиск улиц, для которых название вместе с типом соответствует указанному тексту.

'''Пример ответа движения номенклатуры:'''

<?xml version="1.0" encoding="UTF-8" ?><itemdocstreetlist count="1" page="1" totalcount="3" totalpages="1"> <codestreet>21991 </code> <number>318124</numbercode> <datename>2017-05-26Академика Хохлова ул.</datename> <messageshortname>Академика Хохлова</messageshortname> <items> <item code="4259" quantity="1" barcode="200300" article="123555"typename>Настольная игра Дженгаул.</itemtypename> </itemsstreet></itemdocstreetlist>

*'''item''' - контейнер товара:* '''code''' - внутренний код товара:* '''barcode''' - штрих-код товара:* '''article''' - артикул товара:* '''quantity''' - количество поступившего товара == Справочник филиалов номенклатуры == '''Пример запроса списка филиаловсправочника номенклатуры:'''

<storelistitemlist> <auth extra="8" login="login" pass="pass"></auth> <codesearch> <jsoncode>YES123456</jsoncode> <client_codearticle>7890FD343</client_codearticle> <barcode>2345625213125</storelistbarcode> </sourcecodesearch> <conditions>*'''auth''' - Атрибут '''extra''' - обязателен, по нему определяется курьерская служба <namecontains>телевизор</namecontains>*'''json''' - Признак вывода ответа в виде JSON YES <namestarts>sony</NOnamestarts>*'''client_code''' <name>Sony KDL- Код клиента курьерской службы '''Пример ответа:'''55W905 ЖК-телевизор</name> <source lang="xml"quantity>EXISTING_ONLY<?xml version="1.0" encoding="UTF-8" ?/quantity> <storelist count="store>2"</store> <store/conditions> <except> <code>123123478</code> <name/except>ABC </namelimit> </storelimitfrom> 30<store/limitfrom> <codelimitcount>45610</codelimitcount> <namecountall>Филиал 2YES</namecountall> </storelimit></storelistitemlist>

Внутри контейнера itemlist все элементы могут как отсутствовать, так и комбинироваться. Поиск не чувствителен к регистру.* '''codesearch''' — Поиск по кодам. В случае использования — контейнеры conditions и limit игнорируются.:*'''code''' - Код филиала — Поиск по внутреннему коду системы.:* '''article''' — Поиск по артикулу. :*'''namebarcode''' - Наименование филиала — Поиск по штрихкоду.

Для отображения списка пунктов выдачи (ПВЗ) есть * '''готовый JavaScript модульexcept''': https://home.courierexe — Описание исключений для корректного определения количества зарезервированной номенклатуры.ru/js/measoft_map.js Инструкция по использованию - внутри. Посмотреть пример работы можно [https://home.courierexe.ru/pvz_test* '''code''' — Код заказа.html Здесь]

* '''Пример запроса пунктов самовывоза:limit'''<source lang="xml"><?xml version="1 — Ограничивает вывод результата.0" encoding="UTF-8" ?><pvzlist> <auth extra="8" login="login" pass="pass"></auth> <code>1234</code> <client_code>7890</client_code> <town>Нижний Тагил</town> <parentcode>6</parentcode> <acceptcash>YES</acceptcash> <acceptcard>YES</acceptcard> <acceptfitting>YES</acceptfitting> <maxweight>30</maxweight> <acceptindividuals>YES</acceptindividuals> <lt>57:* '''limitfrom''' — Задает номер записи результата, начиная с которой выдавать ответ.924737</lt> <lg>59.940019</lg> <rt>57.905682</rt> <rg>59:* '''limitcount''' — Задает количество записей результата, которые нужно вернуть.984669</rg> <json>YES</json></pvzlist></source>

*'''auth''' - Атрибут '''extra''' - обязателен, по нему определяется курьерская служба, '''login''' и '''pass''' позволяют авторизоваться под клиентом: для отдельного клиента могут быть ограничения по доступности некоторых ПВЗ, и в этом случае они будут учтены.*'''code''' - Внутренний код.*'''client_code''' - Код клиента курьерской службы.*'''town''' - Город получателя.*'''parentcode''' - Фильтр по родительскому [[#Справочник филиалов|филиалу]]*'''acceptcash''' - Фильтр по приему наличных YES/NO*'''acceptcard''' - Фильтр по приему банковских карт YES/NO*'''acceptfitting''' - Фильтр по наличию примерки YES/NO*'''maxweight''' - Фильтр по максимальному весу, с которым работает ПВЗ*'''acceptindividuals''' - Фильтр по доступности физическим лицам YES/NO*'''lt''' - Широта левого верхнего угла*'''lg''' - Долгота левого верхнего угла*'''rt''' - Широта правого нижнего угла*'''rg''' - Долгота правого нижнего угла*'''json''' - Признак вывода ответа в виде JSON YES/NO  '''Пример ответа справочника пунктов самовывоза:'''

<?xml version="1.0" encoding="UTF-8" ?><pvzlist itemlist count="23" totalcount="3" page="1" totalpages="1"> <pvzitem> <code>126123456</code> <clientcodearticle>3FD343</clientcodearticle> <namebarcode>Нижний Тагил2345625213125</namebarcode> <parentcodename>6Sony KDL-55W905 ЖК-телевизор</parentcodename> <parentnameretprice>Интеграция65000</parentnameretprice> <town code="124267" regioncode="66" regionname="Свердловская область"purchprice>Нижний Тагил город50000</townpurchprice> <addressweight>622036, г. Нижний Тагил, ул5. Циолковского, д. 171</addressweight> <phonelength>+73435417709, +7343525498950</phonelength> <commentwidth>Новый пункт доставки30</commentwidth> <worktimeheight>Вс 10:00-16:00, Сб 10:00-16:00, Пн-Пт 10:00-20:0040</worktimeheight> <traveldescriptionVATrate>Жилое 5-ти этажное здание, торцом к дороге, второе здание от перекрестка Пархоменко-Циолковского20</traveldescriptionVATrate> <maxweightCountInPallet>1030</maxweightCountInPallet> <acceptcashCountInBox>YES2</acceptcashCountInBox> <acceptcardHasSerials>YES1</acceptcardHasSerials> <acceptfittingCountryOfOrigin>YESМалайзия</acceptfittingCountryOfOrigin> (not yet supported) <acceptindividualsMessage>YESХороший телевизор</acceptindividualsMessage> <latitudeMessage2>57.93457Снова хороший телевизор</latitudeMessage2> <longitudequantity>59.9513112</longitudequantity> <reserved>3</pvzreserved> <pvzitem> <code>245</code> ... <clientcode>NTG1</clientcodeitemlist> <name>На Красноармейской</namesource> <parentcode>6</parentcode> <parentname>Интеграция</parentname>'''Описание полей:''' <town * '''code="124267" regioncode="66" regionname="Свердловская область">Нижний Тагил город</town> <address>КРАСНОАРМЕЙСКАЯ''' — Внутренний идентификатор, дприсвоенный системой.79</address> <phone>+7* '''article''' — Артикул, назначенный клиентом (3435поставщиком)379.* '''barcode''' — Штрихкод производителя.* '''name''' — Наименование.* '''retprice''' — Розничная цена по-044</phone>умолчанию. При оформлении заказа цена используется та, которая указана в заказе.* '''purchprice''' — Закупочная цена.* '''weight''' — Масса в килограммах.* '''length''' — Длина в сантиметрах.* '''width''' — Ширина в сантиметрах.* '''height''' — Высота в сантиметрах.* '''VATrate''' — Ставка НДС, целое число процентов.* '''CountInPallet''' — Количество штук в паллете.* '''CountInBox''' — Количество штук в упаковке.* '''HasSerials''' — Требует учета серийных номеров. Принимает значения 1 — да, 0 — нет.* '''CountryOfOrigin''' — Наименование страны происхождения на русском языке.* '''Message''' — Комментарий. <comment>Возможность примерки отсутствует</comment>* '''Message2''' — Дополнительный комментарий. <worktime>Вс 10:00-16:00* '''quantity''' — Количество на складе. Товары, уже собранные в заказы в этом количестве не присутствуют, Сб 10:00-16:00считаются покинувшими товарный склад. ''Это поле может быть недоступным в некоторых установках.''* '''reserved''' — Количество зарезервированного товара. Может превышать остаток на складе, Пн-Пт 10если покупатели ждут следующей поставки. ''Это поле может быть недоступным в некоторых установках.'' == Движение номенклатуры =='''Пример запроса движения номенклатуры:00-20:00</worktime>''' <traveldescription>Напротив ТЦ Пирамида</traveldescriptionsource lang="xml"> <maxweight>20</maxweight?xml version="1.0" encoding="UTF-8" ?> <acceptcash>YES</acceptcashitemmovements> <acceptcardauth extra="8" login="login" pass="pass">YES</acceptcardauth> <acceptfittingcode>NO4259</acceptfittingcode> <acceptindividualsdatefrom>YES2020-10-01</acceptindividualsdatefrom> <latitudedateto>57.93468</latitude> <longitude>60.55476</longitude> 2020-10-02</pvzdateto></pvzlistitemmovements>

*'''code''' - Код ПВЗ  — внутренний код товара в системесправочнике номенклатуры. Используется в запросе [[API#Оформление заказа|оформления заказов]]*'''clientcodedatefrom''' - Код ПВЗ используемый компанией-подрядчиком — дата начала периода.*'''namedateto''' - Наименование ПВЗ — дата окончания периода.*'''parentcode''' - Код родительского элемента.*'''parentname''' - Наименование родительского элемента.*'''town''' - Населенный пункт с кодом из [[#Справочник городов|справочника городов]]Может быть указан или код, а также с кодом и наименованием региона.*'''address''' - Адрес ПВЗ.*'''phone''' - Телефоны ПВЗ.*'''comment''' - Дополнительная информация.*'''worktime''' - Режим работы ПВЗ.*'''traveldescription''' - Описание местонахождения ПВЗ или пути к нему.*'''maxweight''' - Максимальный веспериод, с которым работает ПВЗили код и период одновременно.*'''acceptcash''' - Признак приема наличных*'''acceptcard''' - Признак приема банковских карт*'''acceptfitting''' - Наличие примерки*'''latitude''' - Широта*'''longitude''' - Долгота

'''Пример запроса получения фискальных данныхответа движения номенклатуры:'''

<?xml version="1.0" encoding="UTF-8"?><receiptdata> <auth extraitemmovements count="816" login="test" pass="testm" /> <ordersitemmovement> <code>151500<order orderno="123456" /code> <date>2017-05-26<order orderno="890111C" /date> <retprice>0</ordersretprice> <quantity>1</receiptdataquantity> <delivered>0</delivered> <item> <code>4259</sourcecode> <name>Настольная игра Дженга</name>'''Пример ответа получения фискальных данных:''' </item> <source lang="xml"status> <code>5</code>  <name>Возврат от покупателя<?xml version="1.0" encoding="UTF-8"?/name> <receipts count="1"/status> <receiptstore> <ordernocode>1234561</ordernocode> <fdDatetimename>офис в Москве</name>2020-06-07 12:14:00 </fdDatetimestore> <order> <fdValueordercode>1233374830</fdValueordercode> <fdNumnumber>456123660-0</fdNumnumber> <fnSndate>7892017-05-24</fnSndate> <kktNumorderno>10014123</kktNumorderno> <innbarcode>2220000000670</innbarcode> <ofdUrlcompany>gate.ofd.ruТОВАР</ofdUrlcompany> <fullUrladdress>https://checkКравченко ул.ofd.ru/123, 1</fullUrladdress> <pricedelivereddate>123452017-05-29</pricedelivereddate> <lines count="1"deliveredtime>12:00:00</deliveredtime> <linedeliveredto /> <item/order>1111764 </itemdocument> <namecode>Сапоги21991</namecode> <qtynumber>1318</qtynumber> <pricedate>10002017-05-26</pricedate> <vatRatemessage>20</vatRatemessage> <governmentCode>Z16513LK2 </governmentCodedocument> <itemTypeserials>1 </itemTypeserial> 123456789</lineserial> </linesserials> </receiptitemmovements></receiptsitemlist>

Параметры ''' Описание полей ответа:'''* '''code''' — внутренний код операции движения*'''ordernodate''' - Номер заказа — дата операции*'''fdDatetimeretprice''' - Дата и время пробития фискального чека — цена товара*'''fdValuequantity''' - ФПД (фискальный признак документа) — количество товара операции*'''fdNumdelivered''' - ФИСКАЛЬНЫЙ ДОКУМЕНТ (фискальный номер чека) — количество доставленного товара *'''fnSnitem''' - ФН (номер фискального накопителя) — контейнер товара:*'''kktNumcode''' - РН (регистрационный номер кассы) — внутренний код товара:*'''innname''' - ИНН — наименование товара *'''ofdUrlstatus''' - URL адрес (доменное имя) ОФД — контейнер статуса операции:*'''pricecode''' - Сумма чека — код статуса:*'''fullUrlname''' - URL чека для просмотра онлайн — наименование *'''linesstore''' - Позиции чека — контейнер филиала, к которому относится операция:*'''itemcode''' -  — код товарафилиала:*'''name''' -  — наименование товарафилиала * '''order''' — контейнер корреспонденции:* '''ordercode''' — внутренний код заказа:* '''number''' — номер заказа:* '''date''' — дата заказа:* '''orderno''' — шифр:* '''barcode''' — штрихкод:* '''company''' — компания:* '''address''' — адрес:*'''qtydelivereddate''' - количество товара — дата вручения:*'''pricedeliveredtime''' - цена товара — время вручения:*'''governmentCodedeliveredto''' - считанная последовательность — данные о вручении, которая в дальнейшем преобразуется по алгоритму тега 1162либо причина недоставки * '''document''' — контейнер документа операции:* '''code''' — внутренний код документа:* '''number''' — номер документа:* '''extnumber''' — внешний номер документа:* '''date''' — дата документа:*'''vatRatemessage''' - НДС товара — комментарий * '''serials''' — контейнер серийных номеров:*'''itemTypeserial''' - тип товара (товар — серийный номер единицы номенклатуры, доставка и т.д.)участвующей в движении 

== Серийные номера =='''Пример запроса Видов срочностидвижения номенклатуры с серийным номером:'''

<servicesserialmovements> <auth extra="8"login="login" pass="pass"></auth> <serial>123456789</serial></servicesserialmovements>

* '''serial''' — серийный номер единицы номенклатуры.  '''Пример ответа справочника Видов срочностидвижения номенклатуры с серийным номером:'''

<services serialmovements count="216"> <serviceserialmovement> <code>1151500</code> <serial>123456789</serial> <date>2017-05-26</date> <delivered>0</delivered> <item> <code>4259</code> <name>ЭкономНастольная игра Дженга</name> </serviceitem> <servicestatus> <code>25</code> <name>СрочноВозврат от покупателя</name> </status> <order> <ordercode>3374830</ordercode> <number>123660-0</number> <date>2017-05-24</date> <orderno>14123</orderno> <barcode>0000000670</barcode> <company>ТОВАР</company> <address>Кравченко ул., 1</address> <delivereddate>2017-05-29</delivereddate> <deliveredtime>12:00:00</deliveredtime> <deliveredto /> </order> <document> <code>21991</code> <number>318</servicenumber> <date>2017-05-26</servicesdate> <message></sourcemessage> </document> </serialmovement></serialmovements>== Справочник дополнительных услуг ==</source>

''' Описание полей ответа ''' Описание аналогично описанию полей [[#Движение номенклатуры|движения номенклатуры]]   == Серийные номера по заказу =='''Пример запроса дополнительных услугдвижения серийных номеров заказа:'''

<?xml version="1.0" encoding="UTF-8"?><advpricesorderserials> <auth extra="8" login="login" pass="pass" ></auth> <ordercode>123456789</ordercode> <orderno>123456789</orderno> <visiblebarcode>NO123456789</visiblebarcode></advpricesorderserials>

* '''advpricesordercode''' - Корневой контейнер. Обязательный элемент — внутренний код заказа. *'''visibleorderno''' - Признак возврата  — шифр заказа.* '''толькоbarcode''' тех услуг, что доступны для отображения в ЛК YES/NO — штрих-код заказа. Необязательный элементУказывать необходимо один из идентификаторов заказа. По-умолчанию NO

'''Пример ответа справочника дополнительных услугдвижения серийных номеров заказа:'''

<advpricesorderserials> <advpriceorder> <code>13374830</code> <nameorderno>14123</orderno> <barcode>0000000670</barcode> <delivereddate>2024-07-20</delivereddate> <deliveredtime>Этажей в доме10:04:00</namedeliveredtime> <typeassemblydate>int2024-07-19 07:05:34</typeassemblydate> </advpriceorder> <items> <advpriceitem> <code>24259</code> <name>Коэффициент надбавкиНастольная игра Дженга</name> <typearticle>float123000</typearticle> <state>Delivered</advpricestate> <advpriceserials> <codeserial>3123456789</codeserial> <name>Расписаться на упаковке </nameserials> <type>bool </typeitem> </advpriceitems></advpricesorderserials>

Параметры:''' Описание полей ответа ''' *'''codeorder''' - внутренний код услуги — блок заказа::*'''namecode''' - наименование услуги. Если поле "название в ЛК" в настройках услуги не пусто, то возвращает значение поля "название в ЛК". — код:*'''hineorderno''' - подсказка по доп услуге для пользователя — шифр:*'''typebarcode'''  — штрих- тип услуги. Может иметь значения:код:*'''booldelivereddate''' - для услуг вида "чекбокс", "Да" — дата доставки факт:*'''floatdeliveredtime''' - для числа с плавающей точкой — время доставки факт:*'''intassemblydate''' - для целого числа — дата сборки

== Получение справочника тарифов по городам == '''Пример запроса стоимости доставки:справочника тарифов по городам'''

<?xml version="1.0" encoding="UTF-8" ?><calculatortariffs> <auth extra="8" login="login" pass="pass" /> <calc pricetype="CLIENT" townfrom=">Москва" </townfrom> addressfrom="Ленинский проспект, 95" zipcode="664000" townto="3800000300000" addressto="Ленина ул., 10" pvz="123" l="10" w="20" h="30" mass="3.7" <service=">1"</service> price="1200" inshprice="1200" paytype="CASH" <mainonly>1</mainonly> </calculatortariffs>

Параметры:*'''pricetypeauth''' - тип требуемой цены. Возможные значения: "CLIENT" (по-умолчанию) - цена для клиента. "CUSTOMER" - цена для конечного получателя. (пока не поддерживается)* — атрибут '''townfromextra''' - Город отправления*'''addressfrom''' - Адрес отправления*'''zipcode''' - Почтовый индекс города назначения*'''townto''' - Город назначения*'''addressto''' - Адрес назначения*'''pvz''' - Код пункта самовывоза обязателен, по справочникунему определяется курьерская служба.*'''ltownfrom'''  — город- Длина в сантиметрах (отправитель. Если не обязательный параметр)передан, то городом будет «Москва».*'''wservice''' - Ширина в сантиметрах (не обязательный параметр)*'''h''' - Высота в сантиметрах (не обязательный параметр)*'''mass''' - Масса в килограммах — режим доставки. Обязательный элемент.*'''servicemainonly''' - Режим доставки - число, указывающее на запись в справочнике [[#Справочник Видов срочности|видов срочности]] — необязательный элемент. Если этот параметр опустить, система выдаст расчет для всех доступных видов срочностипередан, передав много контейнеров <calc> то в ответе.*будут данные только по городам из справочника '''priceМежгород''' - Сумма наложенного платежа*> '''inshpriceЗоны''' - Сумма объявленной ценности.*'''paytype''' - Тип оплаты

Суммы НП и ОЦВажно понимать, а также тип оплаты CARD имеют значение при настроенных что в тарифе на вкладке Прочее долях (ответе отдаются только тарифы, указанные в разделе "Тарифы по зонам" раздела "Межгород" в процентах) от данных суммофисной системе курьерской службы, т.е. считающихся междугородними.Доставка до городов, рассчитываемая по внутригородским тарифам, в ответе НЕ ОТДАЕТСЯ!

'''Пример ответа стоимости доставки:справочника тарифов по городам'''<source lang="xmljson"><?xml version={ "1.0townfrom" encoding=: "UTF0c5b2444-70a0-4932-980c-8b4dc0d3f02b5", "?>service": 1, "tariffs": [<calculator> { <calc> "towntofias": "0c5b2444-70a0-4932-980c-b4dc0d3f02b5", <townfrom code= "towntocode": 1, "towntoname": ">Москва город</townfrom>", "townregion": "Город Москва", "distance": 0, "pricedistance": 0, "pricesnew": { "before": [ { "price": 100, <townto code= "56603every">Иркутск город</townto>: 0, < "mass>3.7</": 1 }, { "price": 150, "every": 0, "mass>": 5 } ], "after": [ { "price": 0, <service name= "Экспрессevery">: 1</service>, "mass": 38.01 }, <zone>2</zone> { < "price>1163</price>": 15, "every": 1, "mass": 51.01 } ] }, <mindeliverydays> "deliveryPeriodMin": 1</mindeliverydays>, "deliveryPeriodMax": 2 <maxdeliverydays>3</maxdeliverydays> } <mindeliverydate>2020-05-13</mindeliverydate> </calc>]</calculator>}

Параметры:''' Описание полей ответа '''*'''townfrom'''  — код ФИАС города- Городотправителя.* '''service''' — режим доставки.* '''tariffs''' — cписок тарифов по городу.:* '''townregion''' — регион города-отправитель так, как система его распознала и привязала к справочникуполучателя. Атрибут :* '''codetowntofias'''  — код ФИАС города- код из справочника городов системыполучателя.:*'''towntotowntocode'''  — внутренний код города- Город-получатель так, как система его распознала и привязала к справочникуполучателя. Атрибут :* '''codetowntoname'''  — наименование города- код из справочника городов системыполучателя.:*'''massdistance''' - Масса  — дистанция в км до города от МКАД, если в килограммахзапросе townfrom — Москва.:*'''servicepricedistance''' - Режим доставки - число — сумма за километраж до города от МКАД, указывающее на запись если в справочнике видов срочности (см описание на этой странице)запросе townfrom — Москва.:*'''zonepricesnew''' — ваши настройки тарифов из справочника '''Межгород'''> ' - номер тарифной зоны, ''Тарифы по которой рассчиталась стоимостьзонам'''. В зависимости от зоны выбирается тарифная сетка. Так же к цене могут применяться повышающие или понижающие коэффициенты при доставке не из::* '''before/after''' — контейнеры ДО/в региональный центрОТ.:::*'''price''' - рассчитанная стоимость доставки  — цена. Если ответ идет по «before», то в валюте прайс-листа курьерской службыцену также плюсуется сумма pricedistance:::* '''every''' — за каждые.:::* '''mass''' — масса. Рекомендуется к использованию в отличие от одноименного атрибута родительского контейнера:* '''prices''' — устаревший элемент, не используется.:*'''maxdeliverydaysdeliveryPeriodMin''' - максимальный  — минимальный срок доставки в рабочих днях.:*'''mindeliverydatedeliveryPeriodMax''' - минимальная дата  — максимальный срок доставки в учетом выходных дней.

'''''Обратите внимание:''''' В реальном ответе сервера в теге calc присутствует атрибут "price". Он оставлен для обратной совместимости, не используйте его. Пользуйтесь вложенным тегом price. == Получение информации о клиенте Номенклатура приходной накладной == '''Пример запроса получения информации о клиентеноменклатуры приходной накладной:'''

<clientitemdoc> <auth extra="8" login="testlogin" pass="testmpass" ></auth> <code>21991</code> </clientitemdoc>

* '''clientcode''' - Корневой контейнер — внутренний код документа приходной накладной (см. Обязательный элементпредыдущий запрос).*'''auth''' - Авторизация. Обязательный элемент.

'''Пример ответа на запрос получения информации о клиентедвижения номенклатуры:'''

<clientitemdoc> <code>108221991</code> <number>318</number> <date>2017-05-26</date> <message></message> <items> <item code="4259" quantity="1" barcode="200300" article="123555">Настольная игра Дженга</item> </items></clientitemdoc>

''' Описание полей ответа '''*'''code''' - Код клиента — внутренний код приходной накладной* '''number''' — номер документа* '''date''' — дата документа* '''message''' — комментарий

== Справочник филиалов =='''Пример запроса списка актов передачи денегфилиалов:'''

<smaliststorelist> <auth extra="8" login="login" pass="pass" ></auth> <datefromjson>2016-02-10YES</datefromjson> <datetoclient_code>2016-03-107890</datetoclient_code></smaliststorelist>

* '''smalistauth''' - Корневой контейнер. Обязательный элемент.* — Атрибут '''authextra''' - Авторизация. Обязательный элемент. — обязателен, по нему определяется курьерская служба*'''datefromjson''' - Дата "с". Необязательный элемент. — Признак вывода ответа в виде JSON YES/NO*'''datetoclient_code''' - Дата "по". Необязательный элемент.Если интервал дат не указан, то возвращаются акты передачи денег за последний месяц. — Код клиента курьерской службы

'''Пример ответа на запрос списка актов передачи денег:'''

<?xml version="1.0" encoding="UTF-8"?><smalist storelist count="12"> <smastore> <code>6278123</code> <numbername>3992ABC</numbername> <actdate>2016-02-12 </actdatestore> <datepay></datepaystore> <datetocode>2016-02-12456</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>Безнал</paytypenamecode> <signedcopyreceivedname>NOФилиал 2</signedcopyreceivedname> </smastore></smaliststorelist>

*'''code''' -  — Код актафилиала.*'''numbername''' - Номер акта в системе — Наименование филиала. *'''actdate''' - Дата акта== Справочник пунктов самовывоза ==*Для отображения списка пунктов выдачи (ПВЗ) есть '''datepayготовый JavaScript модуль''' - Дата оплаты : https://home.courierexe.ru/js/measoft_map.js Инструкция по актуиспользованию — внутри. Посмотреть пример работы можно [https://home.courierexe.ru/pvz_test.html Здесь]*'''dateto''' - Дата конечного периода для формирования АПД*'''promiseddatepay''' - Плановая дата оплаты*'''price''' - Стоимость услуг*'''pricecorr''' - Сумма корректировки*'''rur''' - Сумма заказа*'''pricekur''' - Стоимость курьерской доставки*'''priceag''' - Агентское вознаграждение*'''payno''' - Номер платежного поручения*'''paytype''' - Тип оплаты: 1 - безналУникальные запросы списка ПВЗ кешируются на стороне личного кабинета и хранятся до 7 часов утра по московскому времени следующего дня. Например, если уникальный запрос с массой 2 кг был отправлен сегодня в 10 часов, 2 - наличными курьеромто завтра в 7 утра он сбросится. Если сегодня в 18 часов в этом же запросе вы укажете массу 2 кг, 3 - наличными в офисеответе вернется тот же список ПВЗ. Если передадите массу 3 кг, 4 - перевод на карту*'''paytypename''' - Строковое представление типа оплаты*'''signedcopyreceived''' - Признак факта возврата акта YES/NOсписок может быть другим.

'''Пример запроса детализации актов передачи денегпунктов самовывоза:'''

<smadetailpvzlist> <auth extra="8" login="login" pass="pass" ></auth> <code>62781234</code> <client_code>7890</client_code> <city>Свердловская область</city> <town regioncode="66" country="RU">Нижний Тагил</town> <address>Щёлковское шоссе</address> <house>77</house> <advanced_search>Строка поиска</advanced_search> <parentcode>6</parentcode> <acceptcash>YES</acceptcash> <acceptcard>YES</acceptcard> <acceptfitting>YES</acceptfitting> <maxweight>30</maxweight> <acceptindividuals>YES</acceptindividuals> <respstores>YES</respstores> <lt>57.924737</lt> <lg>59.940019</lg> <rt>57.905682</rt> <rg>59.984669</rg> <json>YES</json> <with_coords>YES</with_coords> <limit> <limitfrom>30</limitfrom> <limitcount>2</limitcount> <countall>YES</countall> </limit></smadetailpvzlist>

* '''auth''' — Атрибут '''extra''' — обязателен, по нему определяется курьерская служба, '''login''' и '''pass''' позволяют авторизоваться под клиентом: для отдельного клиента могут быть ограничения по доступности некоторых ПВЗ, и в этом случае они будут учтены.* '''smadetailcode'''  — Внутренний код, целое число.* '''client_code''' — Код клиента курьерской службы.* '''city''' — Регион получателя. Можно указать код региона или полное наименование региона из [[#Справочник регионов|справочника регионов]].* '''town''' — Город получателя.Для тега города '''town''' можно указать код региона в атрибуте '''''regioncode''''' из [[#Справочник регионов|справочника регионов]]. Поиск будет производиться в указанном регионе. Также можно указать страну получателя в атрибуте '''''country''''' в соответствии с [https://ru.wikipedia.org/wiki/ISO_3166-1 стандартом ISO_3166- Корневой контейнер1], например, «RU», «RUS» или «643» для России. Обязательный элементДля формата запроса JSON фильтрация по городу работает только в связке с фильтром по адресу. * '''address''' — Фильтр по адресу, работает только в связке с фильтром по городу*'''authhouse''' — Фильтр по номеру дома, работает только в связке с фильтрами по адресу и городу* '''advanced_search''' — Фильтр по коду агента, наименованию, телефону или комментарию* '''parentcode''' — Фильтр по родительскому [[#Справочник филиалов|филиалу]]* '''acceptcash''' — Фильтр по приему наличных YES/NO* '''acceptcard''' — Фильтр по приему банковских карт YES/NO* '''acceptfitting''' — Фильтр по наличию примерки YES/NO* '''maxweight''' — Фильтр по максимальному весу, с которым работает ПВЗ* '''acceptindividuals''' — Фильтр по доступности физическим лицам YES/NO* '''respstores''' - АвторизацияПризнак вывода ответственных филиалов при значении YES* '''lt''' — Широта левого верхнего угла* '''lg''' — Долгота левого верхнего угла* '''rt''' — Широта правого нижнего угла* '''rg''' — Долгота правого нижнего угла* '''json''' — Признак вывода ответа в виде JSON YES/NO* '''with_coords''' — Признак вывода ПВЗ только с наличием координат YES/NO* '''limit''' — Ограничивает вывод результата. Обязательный элемент:* '''limitfrom''' — Задает номер записи результата, начиная с которой выдавать ответ. По-умолчанию — 0.:*'''codelimitcount''' - Код акта передачи денег (смЗадает количество записей результата, которые нужно вернуть. По-умолчанию — 100.:* '''countall''' — YES указывает на необходимость подсчета общего количества найденных совпадений. запрос списка АПД)Это может замедлять выполнение запроса. Обязательный элементЕсли отключено — в ответе не указываeтся totalcount. 

'''Пример ответа на запрос детализации актов передачи денегсправочника пунктов самовывоза:'''

<?xml version="1.0" encoding="UTF-8" ?><pvzlist count="2" totalcount="40465"> <pvz> <code>126</code> <clientcode>3</clientcode> <name>Нижний Тагил</name> <parentcode>6</parentcode> <parentname>Интеграция</parentname> <town code="124267" regioncode="66" regionname="Свердловская область">Нижний Тагил город</town> <address>622036, г. Нижний Тагил, ул. Циолковского, д. 17</address> <phone>+73435417709, +73435254989</phone> <comment>Новый пункт доставки</comment> <worktime>Вс 10:00-16:00, Сб 10:00-16:00, Пн-Пт 10:00-20:00</worktime> <traveldescription>Жилое 5-ти этажное здание, торцом к дороге, второе здание от перекрестка Пархоменко-Циолковского</traveldescription> <maxweight>10</maxweight> <acceptcash>YES</acceptcash> <acceptcard>YES</acceptcard> <acceptfitting>YES</acceptfitting> <acceptindividuals>YES</acceptindividuals> <latitude>57.93457</latitude> <longitude>59.95131</longitude> <uid>40606d00-9c51-11eb-b2c9-cfd6c1111392</uid> </pvz> <pvz> <code>245</code> <clientcode>NTG1</clientcode> <name>На Красноармейской</name> <parentcode>6</parentcode> <parentname>Интеграция</parentname> <town code="124267" regioncode="66" regionname="Свердловская область">Нижний Тагил город</town> <address>КРАСНОАРМЕЙСКАЯ, д.79</address> <phone>+7(3435)379-044</phone> <comment>Возможность примерки отсутствует</comment> <worktime>Вс 10:00-16:00, Сб 10:00-16:00, Пн-Пт 10:00-20:00</worktime> <traveldescription>Напротив ТЦ Пирамида</traveldescription> <maxweight>20</maxweight> <acceptcash>YES</acceptcash> <acceptcard>YES</acceptcard> <acceptfitting>NO</acceptfitting> <acceptindividuals>YES</acceptindividuals> <latitude>57.93468</latitude> <longitude>60.55476</longitude> <uid>41116853-9c51-11eb-b2c9-cfd6c1451392</uid> </pvz></pvzlist></source> * '''code''' — Код ПВЗ в системе. Используется в запросе [[API#Оформление заказа|оформления заказов]]* '''clientcode''' — Код ПВЗ используемый компанией-подрядчиком.* '''name''' — Наименование ПВЗ.* '''parentcode''' — Код родительского элемента.* '''parentname''' — Наименование родительского элемента.* '''town''' — Населенный пункт с кодом из [[#Справочник городов|справочника городов]], а также с кодом и наименованием региона.* '''address''' — Адрес ПВЗ.* '''phone''' — Телефоны ПВЗ.* '''comment''' — Дополнительная информация.* '''worktime''' — Режим работы ПВЗ.* '''traveldescription''' — Описание местонахождения ПВЗ или пути к нему.* '''maxweight''' — Максимальный вес, с которым работает ПВЗ.* '''acceptcash''' — Признак приема наличных* '''acceptcard''' — Признак приема банковских карт* '''acceptfitting''' — Наличие примерки* '''latitude''' — Широта* '''longitude''' — Долгота* '''uid''' — Уникальный идентификатор ПВЗ в системе Measoft. Создается автоматически при получении данных о ПВЗ от агентов.* '''count''' — Количество записей в ответе* '''totalcount''' — Общее количество записей, отвечающее параметрам запроса == Получение фискальных данных заказа =='''Пример запроса получения фискальных данных:'''<source lang="xml"><?xml version="1.0" encoding="UTF-8"?><receiptdata> <auth extra="8" login="login" pass="pass" /> <orders> <order orderno="123456" /> <order orderno="890111C" /> </orders></receiptdata>  </source> '''Пример ответа получения фискальных данных:'''<source lang="xml">  <?xml version="1.0" encoding="UTF-8"?><receipts count="1"> <receipt> <orderno>123456</orderno> <fdDatetime>2020-06-07 12:14:00</fdDatetime> <fdValue>123</fdValue> <fdNum>456</fdNum> <fnSn>789</fnSn> <kktNum>100</kktNum> <inn>222</inn> <ofdUrl>gate.ofd.ru</ofdUrl> <fullUrl>https://check.ofd.ru/123</fullUrl> <price>12345</price> <payType>2</payType> <lines count="1"> <line> <item>1111764</item> <name>Сапоги</name> <extcode>27113415</extcode> <qty>1</qty> <price>1000</price> <vatRate>20</vatRate> <governmentCode>Z16513LK2</governmentCode> <itemType>1</itemType> </line> </lines> </receipt></receipts></source> Параметры ответа:* '''orderno''' — Номер заказа* '''fdDatetime''' — Дата и время пробития фискального чека* '''fdValue''' — ФПД (фискальный признак документа)* '''fdNum''' — ФИСКАЛЬНЫЙ ДОКУМЕНТ (фискальный номер чека)* '''fnSn''' — ФН (номер фискального накопителя)* '''kktNum''' — РН (регистрационный номер кассы)* '''inn''' — ИНН* '''ofdUrl''' — URL адрес (доменное имя) ОФД* '''price''' — Сумма чека* '''paytype''' — Тип оплаты чека. Принимает значения::* CASH — Наличными (по-умолчанию):* CARD — Безналичным способом* '''fullUrl''' — URL чека для просмотра онлайн* '''lines''' — Позиции чека:* '''item''' — код товара:* '''name''' — наименование товара:* '''extcode''' — код товара во внешних системах:* '''qty''' — количество товара:* '''price''' — цена товара:* '''governmentCode''' — считанная последовательность, которая в дальнейшем преобразуется по алгоритму тега 1162:* '''vatRate''' — НДС товара:* '''itemType''' — тип товара (товар, доставка и т. д.) == Справочник Виды срочности =='''Пример запроса видов срочности:'''<source lang="xml"><?xml version="1.0" encoding="UTF-8" ?><services><auth extra="8"/></services></source> '''Пример ответа справочника видов срочности:'''<source lang="xml"><?xml version="1.0" encoding="UTF-8" ?><services count="2"> <service> <code>1</code> <name>Эконом</name> </service> <service> <code>2</code> <name>Срочно</name> </service></services></source> == Справочник дополнительных услуг =='''Пример запроса дополнительных услуг:'''<source lang="xml"><?xml version="1.0" encoding="UTF-8"?><advprices> <auth extra="8" login="login" pass="pass" /></advprices></source> '''advprices''' — Корневой контейнер. Обязательный элемент.  '''Пример ответа справочника дополнительных услуг:'''<source lang="xml"><?xml version="1.0" encoding="UTF-8" ?><advprices> <advprice> <code>1</code> <name>Этажей в доме</name> <type>int</type> </advprice> <advprice> <code>2</code> <name>Коэффициент надбавки</name> <type>float</type> </advprice> <advprice> <code>3</code> <name>Расписаться на упаковке</name> <type>bool</type> </advprice></advprices></source> Параметры:* '''code''' — внутренний код услуги* '''name''' — наименование услуги. Если поле «название в ЛК» в настройках услуги не пусто, то возвращает значение поля «название в ЛК».* '''hine''' — подсказка по доп услуге для пользователя* '''type''' — тип услуги. Может иметь значения::* '''bool''' — для услуг вида «чекбокс», «Да»:* '''float''' — для числа с плавающей точкой:* '''int''' — для целого числа == Расчет стоимости доставки =='''Пример запроса стоимости доставки:'''<source lang="xml"><?xml version="1.0" encoding="UTF-8" ?><calculator> <auth extra="8" login="login" pass="pass" /> <order> <pricetype>CUSTOMER</pricetype> <sender> <town>Санкт-Петербург</town> <address>Петровка 38 офис 35</address> <coords lat="55.680327" lon="37.604456"></coords> </sender> <receiver> <zipcode>125480</zipcode> <town regioncode="78" country="RU">Санкт-Петербург</town> <address>Петровка 38 офис 35</address> <pvz>124</pvz> <coords lat="55.680327" lon="37.604456"></coords> </receiver> <weight>5.1</weight> <service>2</service> <paytype>CASH</paytype> <price>387.5</price> <deliveryprice>150</deliveryprice> <inshprice>387.5</inshprice> <packages> <package mass="1" quantity="5"></package> <package mass="2.5" length="10" width="20" height="30"></package> </packages> <userid>user123</userid> <groupid>customer</groupid> </order></calculator></source>  Параметры:Структура данных и заполнение полей аналогичны и совместимы с [[#Оформление заказа]]. Дополнительные поля:* '''pricetype''' — тип требуемой цены. Возможные значения: «CUSTOMER» (по-умолчанию) — [[Личный кабинет клиента#Цена доставки для получателя|цена для конечного получателя]], «CLIENT» — цена курьерской службы для клиента.* '''userid''' — Идентификатор пользователя, строковый или числовой тип. Виртуальное поле. Необязательное. Данное поле используется совместно с настройками «Цена доставки для получателя», определяя приоритет правила. Можно использовать в различных CMS/CRM системах, настраивая цены для определенного покупателя.* '''groupid''' — Идентификатор группы пользователя, строковый или числовой тип. Виртуальное поле. Необязательное. Данное поле используется совместно с настройками «Цена доставки для получателя», определяя приоритет правила. Можно использовать в различных CMS/CRM системах, настраивая цены для определенной группы покупателей. Суммы НП и ОЦ, а также тип оплаты CARD имеют значение при настроенных в тарифе на вкладке Прочее долях (в процентах) от данных сумм. В авторизации можно опустить параметры login и pass, тогда расчет будет производиться по стандартному тарифу курьерской службы, без учета возможных отличий для конкретного клиента.<br>Объемный вес будет учитываться только при условии указания всех габаритов: длины, ширины и высоты.<br>В полях город-отправитель и город-получатель можно указывать название города (не рекомендуется!), либо код города из нашего справочника, либо 13-ти значный код КЛАДР, либо 36-ти значный код адресной системы ФИАС (AOID).  '''Пример ответа стоимости доставки:'''<source lang="xml"><?xml version="1.0" encoding="UTF-8"?><calculator> <calc> <townfrom code="1">Москва город</townfrom> <townto code="56603">Иркутск город</townto> <mass>3.7</mass> <service name="Экспресс">1</service> <zone>2</zone> <price>1113</price> <mindeliverydays>1</mindeliverydays> <maxdeliverydays>3</maxdeliverydays> <mindeliverydate>2020-05-13</mindeliverydate> <intervals> <workdays> <interval>10:00-16:00</interval> <interval>16:00-22:00</interval> </workdays> <holidays> <interval>12:00-16:00</interval> </holidays> </intervals> <deliveryprice> <advprice code="1" price="1000">База</advprice> <advprice code="4" price="100">Процент от суммы руб</advprice> <advprice code="5" price="63">Процент от объявленной стоимости</advprice> <advprice code="6" price="-50">Скидка при доставке</advprice> </deliveryprice> </calc></calculator></source> Параметры:* '''townfrom''' — Город-отправитель так, как система его распознала и привязала к справочнику. Атрибут '''code''' — код из справочника городов системы.* '''townto''' — Город-получатель так, как система его распознала и привязала к справочнику. Атрибут '''code''' — код из справочника городов системы.* '''mass''' — Масса в килограммах* '''service''' — Режим доставки — число, указывающее на запись в справочнике видов срочности (см описание на этой странице).* '''zone''' — номер тарифной зоны, по которой рассчиталась стоимость. В зависимости от зоны выбирается тарифная сетка. Так же к цене могут применяться повышающие или понижающие коэффициенты при доставке не из/в региональный центр.* '''price''' — рассчитанная стоимость доставки в валюте прайс-листа курьерской службы. Рекомендуется к использованию в отличие от одноименного атрибута родительского контейнера.* '''maxdeliverydays''' — максимальный срок доставки в рабочих днях.* '''mindeliverydate''' — минимальная дата доставки в учетом выходных дней.* '''intervals''' — список интервалов доставки для соответствующей зоны и режима срочности.* '''deliveryprice''' — Данные по составляющим ценам доставки '''''Обратите внимание:''''' В реальном ответе сервера в теге calc присутствует атрибут «price». Он оставлен для обратной совместимости, не используйте его. Пользуйтесь вложенным тегом price. === Коды и описание ошибок ==={|class=wikitable!Код ошибки!Английское описание!Русское описание!Примечание|-|15||tarif not found||Тариф не найден||Ошибка получения тарифов: для клиента не указан тариф|-|19||field [town to] cannot be empty||Поле [город получателя] не может быть пустым||Необходимо указать город получателя или ПВЗ|-|20||field [weight] is incorrect||Некорректное значение [масса]||Значение массы некорректное, например, не является числом. Его необходимо исправить|-|21||town from not found||Город отправителя не найден||Системе не удалось найти указанный населенный пункт отправителя|-|22||town to not found||Город получателя не найден||Системе не удалось найти указанный населенный пункт отправителя|-|23||field [weight] cannot be empty||Поле [масса] не может быть пустым||Необходимо указать значение массы отправления, поле [weight]|-|36||subtown not found||Город в регионе не найден||Не настроено направление доставки до города в регионе: не добавлен регион или указанный город отсутствует в списке региона|-|37||zoneprice not found||Тариф зоны не найден||Отсутствуют зоны тарификации или для них не указаны стоимости|-|38||tarif not found - 1||Тариф не найден 1||Результаты расчета отсутствуют: общая ошибка в случае, если других ошибок нет, но результат пустой |-|39||tarif not found - 2||Тариф не найден 2||Ошибка получения тарифов: для клиента не настроен тариф или тарификация от количества заказов|-|82||field [weight] exceeded limit PVZ||Значение [weight] превышает ограничение ПВЗ||Указанное значение массы больше, чем максимально допустимое для указанного ПВЗ|-|83||attribute [paytype] not allowed PVZ||Значение [paytype] не допустимо для ПВЗ||В ПВЗ не допустим указанный тип оплаты|-|} == Получение информации о клиенте =='''Пример запроса получения информации о клиенте:'''<source lang="xml"><?xml version="1.0" encoding="UTF-8" ?><client> <auth extra="8" login="login" pass="pass" /> </client></source> '''client''' — Корневой контейнер. Обязательный элемент.* '''auth''' — Авторизация. Обязательный элемент. '''Пример ответа на запрос получения информации о клиенте:'''<source lang="xml"><?xml version="1.0" encoding="UTF-8" ?><client> <code>1082</code></client></source> * '''code''' — Код клиента == Список актов передачи денег =='''Пример запроса списка актов передачи денег:'''<source lang="xml"><?xml version="1.0" encoding="UTF-8" ?><smalist> <auth extra="8" login="login" pass="pass" /> <datefrom>2016-02-10</datefrom> <dateto>2016-03-10</dateto></smalist></source> '''smalist''' — Корневой контейнер. Обязательный элемент.* '''auth''' — Авторизация. Обязательный элемент.* '''datefrom''' — Дата «с». Необязательный элемент.* '''dateto''' — Дата «по». Необязательный элемент.Если интервал дат не указан, то возвращаются акты передачи денег за последний месяц. '''Пример ответа на запрос списка актов передачи денег:'''<source lang="xml"><?xml version="1.0" encoding="UTF-8"?><smalist count="1"> <sma> <code>6278</code> <number>3992</number> <actdate>2016-02-12</actdate> <datepay></datepay> <dateto>2016-02-12</dateto> <promiseddatepay></promiseddatepay> <price>637.00</price> <pricecorr>113.00</pricecorr> <rur>13430.00</rur> <pricekur>570.00</pricekur> <priceag>67.00</priceag> <payno>42423</payno> <paytype>1</paytype> <paytypename>Безнал</paytypename> <signedcopyreceived>NO</signedcopyreceived> </sma></smalist></source> * '''code''' — Код акта* '''number''' — Номер акта в системе* '''actdate''' — Дата акта* '''datepay''' — Дата оплаты по акту* '''dateto''' — Дата конечного периода для формирования АПД* '''promiseddatepay''' — Плановая дата оплаты* '''price''' — Стоимость услуг* '''pricecorr''' — Сумма корректировки* '''rur''' — Сумма заказа* '''pricekur''' — Стоимость курьерской доставки* '''priceag''' — Агентское вознаграждение* '''payno''' — Номер платежного поручения* '''paytype''' — Тип оплаты: 1 — безнал, 2 — наличными курьером, 3 — наличными в офисе, 4 — перевод на карту* '''paytypename''' — Строковое представление типа оплаты* '''signedcopyreceived''' — Признак факта возврата акта YES/NO == Детализация актов передачи денег =='''Пример запроса детализации актов передачи денег:'''<source lang="xml"><?xml version="1.0" encoding="UTF-8" ?><smadetail> <auth extra="8" login="login" pass="pass" /> <code>6278</code></smadetail></source> '''smadetail''' — Корневой контейнер. Обязательный элемент.* '''auth''' — Авторизация. Обязательный элемент.* '''code''' — Код акта передачи денег (см. запрос списка АПД). Обязательный элемент. '''Пример ответа на запрос детализации актов передачи денег:'''<source lang="xml"><?xml version="1.0" encoding="UTF-8"?><smadetail count="2"> <specialsma> <code>42494</code> <ordercode>14424</ordercode> <orderno>11111</orderno> <orderdate>2018-01-01</orderdate> <delivereddate>2018-10-01</delivereddate> <company>Компания</company> <price>314.00</price> <rur>8800.00</rur> <inshprice>314.00</inshprice> <pricekur>270.00</pricekur>

<pricecalc>8486.00</pricecalc> <paytype>2</paytype> <paytypename>наличными курьером</paytypename> <weight>0.400</weight> <distance>0.0</distance> <status>Доставлено</status> </specialsma></smadetail></source> *'''code''' -  — Код записи.*'''ordercode''' -  — Код заказа.*'''orderno''' -  — Шифр заказа.*'''orderdate''' -  — Дата заказа.*'''delivereddate''' -  — Дата доставки.*'''company''' -  — Получатель.*'''price''' -  — Стоимость услуг.*'''rur''' -  — Сумма заказа.*'''inshprice''' -  — Стоимость заказа.*'''pricekur''' -  — Стоимость курьерской доставки.*'''priceag''' -  — Агентское вознаграждение.*'''pricecalc''' -  — Сумма для передачи агенту.*'''paytype''' -  — Тип оплаты: 1 - 1 — безнал, 2 - 2 — наличными курьером, 3 - 3 — наличными в офисе, 4 - 4 — перевод на карту.*'''paytypename''' -  — Строковое представление типа оплаты* '''weight''' — Вес заказа.* '''distance''' — Дистанция по заказу*'''status'''  — Статус заказа. == Установка статуса согласования заказа ==Для возможности клиентом установки статуса согласования заказа необходимо включить переменную [[Личный кабинет курьерской службы#Заказы|Разрешить менять статус согласования]] '''Пример запроса установки статуса согласования заказа'''<source lang="xml"><?xml version="1.0" encoding="UTF- Статус 8"?><setapprovalstatus> <auth extra="8" login="login" pass="pass" /> <order ordercode="1234561"> <confirmstate>1</confirmstate> <message>Сообщение статуса</message> </order> <order ordercode="1234562"> <confirmstate>2</confirmstate> <message>Согласовано</message> </order> <order ordercode="1234563"> <confirmstate>3</confirmstate> <message>Не согласовано</message> </order></setapprovalstatus></source> * '''order''' — Контейнер заказа. Обязателен как минимум один элемент.:* '''ordercode''' — Внутренний код заказа.* '''confirmstate''' — Код статуса заказа. Все статусы с кодами можно получить запросом [[#Получение списка статусов согласования заказа|Получение списка статусов согласования заказа]]* '''message''' — Дополнительный комментарий, который отобразится в поле ''Инфо о доставке''. == Получение списка статусов согласования заказа =='''Пример запроса списка статусов согласования заказа'''<source lang="xml"><?xml version="1.0" encoding="UTF-8"?><approvalstatuses> <auth extra="8" login="login" pass="pass" /></approvalstatuses></source> '''Пример ответа списка статусов согласования заказа'''<source lang="xml"><?xml version="1.0" encoding="UTF-8" ?><approvalstatuses count="6"> <status> <code>1</code> <name>Неизвестно</name> </status> <status> <code>2</code> <name>Согласование запрошено</name> </status> <status> <code>3</code> <name>Доставка полностью согласована</name> </status> <status> <code>4</code> <name>Согласовано с изменением времени</name> </status> <status> <code>5</code> <name>Перенос на другую дату</name> </status> <status> <code>6</code> <name>Отказ</name> </status></approvalstatuses></source> == Генерация коротких ссылок == В некоторых случаях, например, при использовании в СМС, может потребоваться использование коротких ссылок на ЛК.Для этого, необходимо отправить запрос с полной ссылкой, в ответ на который придёт хэш-код для ссылки. '''Пример запроса генерации коротких ссылок:'''<source lang="xml"><?xml version="1.0" encoding="UTF-8" ?><shortlink> <link short="0"> https://home.courierexe.ru/8/site/orders </link></shortlink></source> '''shortlink''' -  — Корневой контейнер. Обязательный элемент.*'''link''' -  — Полная ссылка, для которой необходимо получить код. Обязательный элемент. Если атрибут '''short''' равен 1, то ответ не будет содержать XML, а только хэш-код. '''Пример ответа на запрос генерации коротких ссылок:'''<source lang="xml"><?xml version="1.0" encoding="UTF-8"?><shortlink> <hash>35AF350C</hash></shortlink></source> * '''hash''' — Хэш-код ссылки. Далее, можно использовать ссылку на ЛК: <nowiki>https://home.courierexe.ru/35AF350C или curie.ru/35AF350C</nowiki>  '''Примечание!''' Сервис коротких ссылок работает только для ресурсов компании MeaSoft. == Проверка надежности покупателя ==Проверка надежности работает только для тарифа «Максимум» личного кабинета. <source lang="xml"><?xml version="1.0" encoding="UTF-8" ?><mcheck> <auth extra="8" login="login" pass="pass" /> <phones> <phone>89161147992</phone> </phones></mcheck></source> Ответ: <source lang="xml"><?xml version="1.0" encoding="UTF-8" ?><mcheck> <phones> <phone rate="90">89161147992</phone> </phones></mcheck></source>  == Размещение страниц на своем сайте (iframe) == В некоторых случаях имеет смысл разметить те или иные страницы на своем сайте. Например, чтобы клиенты могли рассчитать стоимость доставки не переходя по внешней ссылке, а там же, на сайте, калькулятор можно разместить прямо на странице такого сайта посредством так называемого фрейма — '''iframe'''. [https://ya.ru/search/?text=iframe Фрейм] — контейнер внутри обычной страницы, который позволяет загружать сторонние страницы. Пример загрузки калькулятора: <source lang="html"><iframe id="frame" src="https://home.courierexe.ru/8/calculator"> Здесь должен отобразиться калькулятор</iframe></source> Для удобства пользователей вашего сайта можно указать язык интерфейса (который переключается непосредственно на сайте) параметром '''lang''': <source lang="html"><iframe id="frame" src="https://home.courierexe.ru/8/calculator?lang=2"> Здесь должен отобразиться калькулятор</iframe></source>  <div style="color: #a94442; background-color: #f2dede; border: 1px solid #ebccd1; padding: 3px 10px 10px;">'''Обратите внимание!'''# При использовании iFrame могут не работать некоторые функции, например, подписка на push-уведомления на странице трекинга или отслеживания.# Если язык не указать, то на страницах калькулятора и трекинга отображается свой переключатель языка. Если язык указан, то переключатель не отображается. Поддерживаемые языки и их коды::'''1''' — русский:'''2''' — английский:'''4''' — узбекский</div> == Оформление манифеста == '''Пример запроса на создание манифеста:'''<source lang="xml"><?xml version="1.0" encoding="UTF-8" ?><manifest> <auth extra="8" login="login" pass="pass" /> <store_from>1</store_from> <store_to>2</store_to> <trn_code>3</trn_code> <sentdate>2024-11-07</sentdate> <places> <place> <number>1</number> <seal>7890AABBB</seal> </place> <place> <number>2</number> <seal>123456ABC</seal> </place> </places> <addresses> <address> <code>12345</code> <place>1</place> </address> <address> <code>67890</code> <place>2</place> </address> </addresses></manifest></source>  '''manifest''' - Корневой контейнер. Обязательный элемент.*'''auth''' - Авторизация. Обязательный элемент.*'''store_from''' - код филиала отправителя. Обязательный элемент.*'''store_to''' - код филиала получателя. Обязательный элемент.*'''trn_code''' - код перевозчика. Обязательный элемент.*'''sentdate''' - дата отправки манифеста. Не обязательный элемент.*'''addresses''' - корневой элемент для списка заказов.*:'''address''' - корневой элемент для заказа.*::'''code''' - наш внутренний номер заказа. Обязательный элемент.*::'''place''' - номер места заказа. Обязательный элемент, если переданы места.*'''places''' - корневой элемент для списка мест.*::'''place''' - корневой элемент для места.*::'''number''' - номер места. Обязательный элемент.*::'''seal''' - номер пломбы. Необязательный элемент.  '''Пример успешного ответа'''<source lang="xml"><?xml version="1.0" encoding="UTF-8"?><manifest> <result>OK</result></manifest></source>  '''Пример ответа с ошибкой'''

<shortlinkmanifest> <hash>35AF350C</hash></shortlink></source> *'''hash''' - Хэш-код ссылки. Далее, можно использовать ссылку на ЛК: <nowiki>https://home.courierexe.ru/35AF350C или curie.ru/35AF350C</nowiki>  '''Примечание!''' Сервис коротких ссылок работает только для ресурсов компании MeaSoft. result error== Проверка надежности покупателя == Проверка надежности работает только для тарифа "МаксимумТекст ошибки" личного кабинета. <source lang="xml"><?xml version="1.0" encoding="UTF-8" ?><mcheck> <auth extra="8" login="login" pass="pass" /> <phones> <phone>89161147992</phone> ERROR</phonesresult></mcheckmanifest>

Ответ:'''manifest''' - Корневой контейнер. Обязательный элемент.*'''result ''' - Результат. Принимает значения OK или ERROR.<source lang="xml"><?xml version="1*'''error''' - атрибут с текстом ошибки, если она была.0" encoding="UTF-8" ?><mcheck> <phones> <phone rate="90">89161147992</phone> </phones></mcheck></source>