Изменения

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

API

42 216 байт добавлено, 23 март
Описание полей ответа статусов
'''Модули распространяются бесплатно, без гарантий со стороны разработчика''', и не являются средством полной автоматизации взаимодействия с курьерской службой. Модули — это помощь разработчикам интернет-магазинов в построении интеграции с курьерскими службами. '''Ответственность за корректность передачи данных лежит на интернет-магазине.'''
Модули сторонних разработчиков обслуживаются и разрабатываются сторонними компаниями. Все вопросы по их приобретению и поддержке необходимо задавать им.
Сообщайте нам свои пожелания по работе наших модулей. Мы учтем их в новых версиях.
|[[Файл:prestashop.png|center|x60px]]
|style="text-align: center;"|[https://courierexe.ru/download/api/prestashop.zip Скачать]
|Поддерживает версии 1.5.2.0 и выше. Подробнее см. [[PrestaShop|описание]].
|-
|[[Файл:OpencartOCStore.png|center|x60px]]
|style="text-align: center;"|[https://courierexe.ru/download/api/opencart.zip Скачать для версии 1.5.5.1]<br>[https://courierexe.ru/download/api/measoft_oc2.ocmod.zip Скачать для версии 2.0]<br>[https://courierexe.ru/download/api/measoft_oc2.3.ocmod.zip Скачать для версии 2.3]<br>[https://courierexe.ru/download/api/measoft_ос3measoft_oc3.ocmod.zip Скачать для версии 3.0]|Поддерживает версии с 1.5.5.1.<br>Скачивайте модули для своей версии OpenCart.<br>Подробнее см. [[OpenCart|описание]].<br>[https://opencartforum.com/files/file/2906-avtomatizaciya-otpravki-i-otslezhivanie-dostavok-courierexe-dlya-opencart-15x/ Альтернативный модуль сторонних разработчиков]
|-
|[[Файл:webasyst-shopscript.png|center|x44px]]
|style="text-align: center;"|[https://www.webasyst.ru/store/plugin/shop/measoftcourier/ Установить модуль]<br>[https://www.webasyst.ru/store/plugin/shipping/measoftcourier/ Установить плагин]
|Модуль предназначен для отправки заявок в КС, а плагин для расчета стоимости доставки при оформлении заказа. Инструкции есть в маркете, а также см. [[Webasyst|описание]].
|-
<!--|[[Файл:advantshop.png|center|x44px]]
|style="text-align: center;"|Настраивается в [[Личный кабинет клиента|ЛК пользователя]]
|[[InSales|Инструкция по настройке]]
|-
|[[Файл:iiko.jpg|center|x80px]]
|style="text-align: center;"|Настраивается в [[Личный кабинет клиента|ЛК пользователя]]
|[[Iiko|Инструкция по настройке]]
|-
|[[Файл:Leadvertex.png|center|x44px]]
|[[Файл:Joomla2.jpg|center|x60px]]
|style="text-align: center;"|[https://courierexe.ru/download/api/com_measoft.zip Скачать]
|Работает только с компонентом Virtuemart.Инструкция в архиве
|-
|[[Файл:Amocrm.png|center|x44px]]
|style="text-align: center;"|[https://www.amocrm.ru/extensions/courier2008 Установитьmeasoft Описание на сайте amoCRM]|Подробнее см. Подробное описание настроек читайте [[amoCRM|описаниетут]].
|-
|rowspan="2"|[[Файл:MoySclad.jpg|center|x30px]]
|style="height:50px; text-align: center;"|[https://home.courierexe.ru/moysklad/step1 Настроить интеграцию с MeaSoft]
|[[МойСклад|Инструкция]]
|-
|-
|[[Файл:wordpress.jpg|center|x80px]]
|style="text-align: center;"|[https://courierexe.ru/download/apiwordpress/wordpress.zip php Скачать]
|[[Wordpress|Инструкция]]
|-
|Поддерживает версии 4.10 и выше.<br>[[CS-Cart|Инструкция]]
|-
|style="height:100px; text-align[[Файл: webhooks.jpg|center;"|'''Webhook'''x100px]]
|style="text-align: center;"|Читайте описание [[Webhook|на этой странице]]
|Передача информации о статусах и заказах в вашу систему
|-
|[[Файл:Logo_tilda_black.png|center|x100px]]
|style="text-align: center;"|Читайте описание [[Tilda|на этой странице]]
|Работает только на платных тарифах
|-
|}
* '''extra''' — экстра-код, уникальный идентификатор компании, с которой вы интегрируетесь.
* '''login''' — логин клиента;
* '''pass''' — пароль клиента;* '''measoftid''' — системная переменная, используемая системой.
Запросите эти данные у курьерской службы, к которой вы подключаетесь. Курьерская служба передает временный пароль, его нужно сменить после первого входа в [[Личный кабинет клиента|ЛК клиента]].
* при запросе измененных статусов ОБЯЗАТЕЛЬНО нужно подтверждать успешное получение запросом [[#Передача только изменившихся статусов|commitlaststatus]].
* вы должны знать номера заказов, которые вы отправили. Не нужно перебирать номера всех заказов или брутфорсом перебирать все возможные номера.
* нужно проверять с каким ответом возвращаются ваши АПИ-запросы. Если мы отвечаем ошибкой, то даже запрос на создание нового заказа учитывается в количестве запросов.
Мы абсолютно уверены, что данные ограничения на порядки превосходят необходимые объемы предоставления сервиса для решения любых задач. Если у вас возникают проблемы, вы не знаете, как уложиться в эти рамки — спросите у нас, мы обязательно поможем!
<coords lat="55.680327" lon="37.604456"></coords>
</receiver>
<returnprice>NO387.5</returnprice> <inshprice>387.5</inshprice> <deliveryprice VATrate="20">150</deliveryprice> <discount>120</discount> <paytype>CASH</paytype>
<weight>5.1</weight>
<return_weight>5.1</return_weight>
<quantity>2</quantity>
<paytype>CASH</paytype>
<service>2</service>
<type>3</type>
<return>NO</return>
<return_service>1</return_service>
<type>3</type>
<return_type>3</return_type>
<return_weight>5.1</return_weight>
<courier>22</courier>
<price>387.5</price>
<deliveryprice VATrate="20">150</deliveryprice>
<inshprice>387.5</inshprice>
<receiverpays>NO</receiverpays>
<discount>120</discount>
<enclosure>Детские игрушки</enclosure>
<instruction>Проверить при покупателе, подписать акт</instruction>
<costcode>cc12345</costcode>
<respstore>4</respstore>
<uid>af11c7c6-6645-4a20-9604-be911a75722d</uid>
<items>
<item extcode="abc123" quantity="1" mass="0.2" retprice="37.5" VATrate="0" barcode="2345625213125" textArticle="1" article="1" volume="3" origincountry="AUT" GTD="321546654" excise="15.20" suppcompany="ООО &quot;Рога и копыта&quot;" suppphone="79161234567" suppINN="1112223334" govType="2" governmentCode="11223311" extraTags="">Мяч</item>
<item extcode="abc124" quantity="2" mass="2" retprice="100" inshprice="100" VATrate="10" barcode="4645625213138" article="2" length="10" width="20" height="30" origincountry="004">Обруч</item>
<item extcode="abc125" quantity="3" mass="0.3" retprice="50" inshprice="50" barcode="2345625213126" itemcode="44123" article="3" type="1">Погремушка желтая</item>
</advprice>
</advprices>
<extrafields>
<extrafield>
<name>courier_car</name>
<value>ВАЗ 2106, бежевый</value>
</extrafield>
</extrafields>
<overall_volume>81</overall_volume>
<userid>user123</userid>
* '''order''' — Контейнер для описания одного заказа, обязательный элемент. В одном контейнере '''neworder''' может быть много контейнеров '''order''' для создания нескольких заказов одним запросом.
:* '''''orderno''''' — Номер заказа. Если присваивается клиентом — указывается здесь. Если не присваивается — можно оставить пустым, система сгенерирует свой номер, и вернет его в ответе. Система проверяет '''у клиента''' наличие заказов с указанным номером в '''пределах текущего календарного года''', которые '''не являются недоставленными''', и в случае их существования — заказ создан не будет, а в ответе вернется ошибка 17 «Such number exists». Если не указан штрихкод (поле barcode), и значение поля подходит для использования его в качестве штрихкода, данное значение будет скопировано в поле «Штрихкод». Это накладывает ограничения в частности, на длину указанного поля (25 знаков, чтобы работали стандартные печатные формы).
* '''barcode''' — Штрихкод заказа. Если клиент штрихкодирует свои отправления и штрихкод отличается от номера заказа, в этом поле указывается штрихкод. Если ШК содержит кириллицу или малое количество символов, то формируется ШК в формате EAN13. <spoiler text="Заполнение номера заказа (шифра) и штрих-кода">Шифр и штрих-код заполняются исходя из начальных значений: # Если шифр и ШК пустые - оба поля заполняются автоматически значением вида XXX#YYY, а после ШК проверяется на корректность (валидируется)# Если ШК пустой, а шифр заполнен - ШК заполняется значением из шифра и валидируется# Если шифр пустой, а ШК заполнен - шифр заполняется значением из ШК, после чего ШК валидируется# Если оба непустые - валидируется ШК, шифр не проверяется Корректный (валидный) ШК отвечает следующим требованиям:* длина не меньше 5 символов* значение не меньше значения переменной <mparam code="MinPrePrintedNum"/>* содержит символы, которые можно использовать для формирования штрих-код а формате Code128 (т.е.все печатные символы, кроме кириллицы) Если ШК не прошел проверку, то:* если переменная <mparam code="StoreInvLength"/> равна 0, ШК заполняются автоматически значением вида XXX#YYY (или приравнивается шифру в том же формате)* если переменная <mparam code="StoreInvLength"/> больше 0, ШК заполняются автоматически сквозным номером (если шифр в формате XXX#YYY, то шифр приравнивается ШК)</spoiler> В случае наличия нескольких мест и раздельной их маркировки в этом поле допустимы маски в виде символов подчеркивания, говорящие о позициях штрихкода, переменных для разных мест в рамках одного заказа.<br>
''Например'': В заказе номер 123 имеется 20 товарных вложений, которые упакованы в 3 транспортных места. Клиент формирует 3 штрихкода на транспортные места: CLNT0012301, CLNT0012302, CLNT0012303, где CLNT — префикс клиента, 00123 — номер заказа, 01-03 — номер транспортного места в заказе. В поле barcode нужно указать CLNT00123__ (система поймет, что 2 последних символа могут быть любыми и будут отражать штрихкоды к одному заказу). Если вы не сами печатаете накладные с указанным штрихкодом, то указанный штрихкод не должен быть длиннее 25 знаков, иначе он не поместится на стандартных печатных формах.
:* код ПВЗ в нашей системе
:* код ПВЗ в системе подрядчика
:* наименование ПВЗ в виде строки "ПВЗ " + «Наименование ПВЗ».  При указании ПВЗ в поле адреса необходимо проверять значение поля город получателя (он должен соответствовать данным ПВЗ) либо не передавать его вообще.
Для тега города '''town''' можно указать код региона в атрибуте '''''regioncode''''' из [[#Справочник регионов|справочника регионов]]. Поиск будет производиться в указанном регионе.
* '''coords''' — Координаты получателя. Если не указаны, система будет геокодировать самостоятельно.
* '''zipcode''' — Почтовый индекс.
* '''price''' — Сумма заказа (наложенный платеж) - денежные средства, которые курьер должен забрать у получателя в пользу заказчика. В случае наличия контейнера items значение этого параметра будет проигнорировано и рассчитано автоматически.
* '''inshprice''' — Объявленная ценность. Если явно не указана сумма — автоматически считается как сумма по товарам.
* '''deliveryprice''' — Стоимость доставки, которая устанавливается заказчиком и будет взиматься с получателя в пользу заказчика. Не имеет отношения к стоимости доставки самой курьерской службы, которая рассчитывается в соответствии с тарифамии, не указывается при оформлении заказа и добавляется в заказ автоматически при его обработке курьерской службой. В случае наличия контейнера items в него будет добавлено вложение «Доставка».
:* '''''VATrate''''' — Ставка НДС — целое число процентов.
* '''discount''' — Сумма скидки. Скидка «размазывается» по товарным вложениям, сумма НП уменьшается на сумму скидки. При этом вложение Скидка не создается. ВНИМАНИЕ, при использовании этого тега общая сумма может расходиться на копейки из-за округления! Старайтесь не использовать этот тег, а указывать цену товаров уже с учетом скидок.
* '''paytype''' — Тип оплаты заказа получателем. Принимает значения:
:* CASH — Наличными при получении (по-умолчанию)
:* OTHER — Прочее (Предусмотрен для того, чтобы оплата поступала непосредственно в курьерскую службу посредством прочих типов оплаты — таких как: вебмани, яденьги, картой на сайте, прочие платежные системы и т. д.)
:* OPTION — На выбор получателя. Этот тип оплаты нельзя передавать с заказом. Он выставляется автоматически в зависимости от настройки клиента.
 
* '''zipcode''' — Почтовый индекс.
* '''weight''' — Общий вес заказа в килограммах.
* '''return_weight''' — Общий вес возврата заказа в килограммах.
* '''quantity''' — Количество мест.
* '''service''' — Режим доставки (тип услуги) передается код из справочника «[[#Справочник Видов Виды срочности|Виды срочности]]».* '''type''' — Тип корреспонденции (отправления) передается код из справочника «Типы корреспонденции».* '''return''' — Признак необходимости возврата. Принимает значения::* NO — Возврат не требуется:* YES — Требуется возврат, например, документов:* ONLY — Требуется забрать отправление у поставщика (см. раздел «[[Личный_кабинет_клиента#Привезти ко мне|Привезти ко мне]]»).
* '''return_service''' — Режим возврата (тип услуги) передается код из справочника «Виды срочности».
* '''type''' — Тип корреспонденции (отправления) передается код из справочника «Типы корреспонденции».
* '''return_type''' — Тип возвратной корреспонденции (отправления) передается код из справочника «Типы корреспонденции».
* '''pricereturn_weight''' — Сумма Общий вес возврата заказа. В случае наличия контейнера items значение этого параметра будет проигнорировано и рассчитано автоматически.* '''deliveryprice''' — Сумма доставки. В случае наличия контейнера items в него будет добавлено вложение «Доставка».:* '''''VATrate''''' — Ставка НДС — целое число процентов.* '''return''' — Признак необходимости возврата.* '''return_service''' — Режим возврата (тип услуги) передается код из справочника «Виды срочности».* '''discount''' — Сумма скидки. Скидка «размазывается» по товарным вложениям, сумма НП уменьшается на сумму скидки. При этом вложение Скидка не создается. ВНИМАНИЕ, при использовании этого тега общая сумма может расходиться на копейки из-за округления! Старайтесь не использовать этот тег, а указывать цену товаров уже с учетом скидоккилограммах.
* '''enclosure''' — Вложение.
* '''inshprice''' — Объявленная ценность. Если явно не указана сумма — автоматически считается как сумма по товарам.
* '''instruction''' — Поручение — Примечание.
* '''courier''' — Запланированный курьер. Согласно коду курьера в КС2008.
* '''receiverpays''' — Признак оплаты стоимости доставки — услуг службы доставки получателем, а не заказчиком YES/NO.
* '''department''' — Подразделение, в котором оформляется заказ.
* '''costcode''' — Кост-код сотрудника.
* '''respstore''' — Код ответственного филиала. Для ответственного филиала в который передается заказ, требуется включение параметра "Разрешить клиенту передавать заказы в этот филиал"
* '''pickup''' — Признак оформления забора YES/NO. Если стоит YES, то весь заказ считается заданием на забор груза, а не на доставку! Применяется для вызова курьера к отправителю для забора других отправлений. ''Внимание!'' при добавлении в забор складских товаров, их тип '''''type''''' всегда должен быть установлен как [7] Забор товара, если будет указан другой тип, то он будет исправлен в момент добавления заказа на [7] Забор товара
* '''acceptpartially''' — Признак возможности частичного выкупа товаров отправления YES/NO.
* '''uid''' - Универсальный идентификатор заказа на стороне отправителя. Не обязательный параметр, ограниченного по времени действия. Время хранения в системе, - сутки.
* '''items''' — Контейнер для описания вложений. <rspoiler text="Необязательный контейнер">Если для поставщика товара в системе MeaSoft не указаны полное наименование компании и ИНН в карточке клиента, заполните параметры <code>suppcompany</code> и <code>suppINN</code> в этом контейнере. Отсутствие информации о поставщике приведет к [[Настройка модуля печати кассовых чеков#Ошибка фискализации (ошибка программирования реквизита 1226)|ошибке фискализации]].</rspoiler>. Атрибуты:
:* '''''retprice''''' — Цена единицы товара. Округляется до копеек. Должна быть с учетом всех скидок и наценок. Для вложений типов 1, 2, 3 не может быть отрицательной. <!-- , либо мы сами посчитаем скидку при указании тега order->discount -->
:* '''''inshprice''''' — Объявленная ценность единицы товара. Округляется до копеек. Если не указана принимается равной '''''retprice'''''.
:* '''''VATrate''''' — Ставка НДС — целое число процентов. Если товар хранится в КС (смотрите '''article''' ниже), значение берется из номенклатуры. Иначе, если значение не указано, подставляется берется указанное значение, если нет - значение «20»из настроек фирмы КС. Значение «0» означает ставку «Без НДС», ставка «0%» на данный момент не поддерживается.
:* '''''barcode''''' — Штрихкод вложения.
:* '''''article''''' — Артикул вложения. ''Внимание!'' Указание артикула используется только тогда, когда товар хранится на ответственном хранении в службе доставки, и необходима комплектация. В этом случае система пытается привязать товар к [[API#Справочник номенклатуры|справочнику номенклатуры]]. Если товар в справочнике не найден — система выдаст соответствующую ошибку. Если по артикулу найдено несколько товаров — система выберет один из них случайным образом, что может привести к ошибочной комплектации! Если товар НЕ на ответственном хранении — артикул указывать НЕ нужно. Позиция попадет в систему просто текстом.
:* '''''suppphone''''' — Номер телефона компании поставщика, если отличается от заказчика.
:* '''''suppINN''''' — ИНН компании поставщика, если отличается от заказчика.
:* '''''governmentCode''''' — Код товарной номенклатуры. Используется для [[Маркировка|маркированных товаров , например («Честный знак»)]]. Для кода '''Честный знак''' Нужно указывать все данные из нанесенного QR-кода кроме не читаемых символов (#29). Если код не известен — укажите знак вопроса «?», тогда курьер отсканирует код фактически передаваемого покупателю товара. Для некоторых процессов может использоваться значение «!» — в этом случае курьер сканирует серийный номер товара, но это не считается кодом маркировки. При этом, если указано значение «?» или «!» и quantity больше 1, то такое вложение растиражируется quantity раз.:* '''''govType''''' — Тип маркировки товара. В данный момент существуют следующие типы маркировки::: 1 — Честный знак. По-умолчанию.:: 2 — ГИИС ДМДК.:: 3 — Серийный номер.:* '''''message''''' — Строка сообщения.:* '''''extraTags''''' — Строка в формате JSON для отправки в ОФД. :: Тэг 1265 - значение отраслевого реквизита = код места деятельности аптеки :: Тэг 1262 – идентификатор ФОИВ = "020" (константа ФОИВ МИНЗДРАВа) :: Тэг 1263 - дата нормативного акта федерального органа исполнительной власти = "14.12.2018" (константа) :: Тэг 1264 - номер нормативного акта федерального органа исполнительной власти = "1556"(константа) :: Тэг 1212 - Признак предмета расчета :: Пример: <source lang="json">"item_industry_props":{"tag1262":"020","tag1263":"14.12.2018","tag1264":"1556","tag1265":"tm=mdlp&sid=00000000XXXXXX"},"tag1212": "1"</source>  Для клиентов из '''Узбекистана''' необходимо указывать код ИКПУ и код упаковки в следующем формате:<source lang="json">"ikpu":"123123123","packageCode":"123456"</source>  
* '''packages''' — Контейнер для описания мест. Необязательный контейнер. Атрибуты:
:* '''''value''''' — значение услуги. Если тип услуги bool, то в значении передаем true.
* '''costcodeextrafields''' — КостКонтейнер для описания расширенных полей. Необязательный элемент. Может содержать несколько элементов extrafield* '''extrafield''' — Контейнер для описания расширенного поля.:* '''''name''''' — наименование переменной. Может содержать только латинские буквы, цифры и знак подчеркивания "_", но начинаться может только с буквы. Максимальная длина -код сотрудника20 символов.:* '''respstore''value''''' — Код ответственного филиалазначение переменной. Максимальная длина - 250 символов.
* '''overall_volume''' — Общий объем, м3. Виртуальное поле. Необязательное. Из этого поля рассчитывается длина/высота/ширина места. Расчет срабатывает только если в каждом месте есть нулевые значения длины или высоты или ширины.
|130||Specify a valid respstore code.||Укажите код ответственного филиала.
|-
|131||Cannot edit, order has not been synchronized.||Невозможно изменить заказ пока он не синхронизирован.|-|132||Specify a valid "Recipient city/town" field value.||Укажите город получателя|-|133||Specify a valid "weight" for the town.||Укажите корректный вес для города|-|134||Specify a valid "paytype" for the town.||Укажите тип оплаты для города|-|135||Specify the correct SKU ID/code for item.||Укажите артикул/код вложения|-|136||Specify warehouse goods in the order.||Укажите вложения в заказе|-|137||The order's date of creation is more than 60 days ago.||Заказ создан более 60 дней назад|-|138||Specify a valid "Package dimension" field value.||Укажите корректные габариты места|-|139||Wrong type of XML query||Ошибка запроса|-|140||Duplicate item code in the order.||Дублирование кода вложения в заказе|-|141||Duplicate additional service in the order.||Дублирование кода дополнительной услуги в заказе|-|144||Incorrect extrafields.||Некорректные расширенные поля.|-|} === Передача значений полей в форме создания заказа в Личном Кабинете через GET параметры ===Если вам требуется передавать значения полей в форме создания заказа в Личном Кабинете через GET параметры, то вы можете подробно ознакомиться с этим на данной странице - [[Личный_кабинет_клиента#Передача и подстановка значений полей формы создания заказа через GET параметры]] == Запрос статуса заказов == === Пример запроса статуса заказа ===
<source lang="xml">
<?xml version="1.0" encoding="UTF-8" ?>
<ordercode>34234</ordercode>
<givencode>234534</givencode>
<uid>af11c7c6-6645-4a20-9604-be911a75722d</uid>
<datefrom>2016-07-21</datefrom>
<dateto>2016-07-21</dateto>
<namestarts/>
</conditions>
<limit>500</limit>
</statusreq>
</source>
:* CLIENT — Признак клиента, значение по умолчанию
:* AGENT — Признак агента. В ответ отдается информация по заказам, переданным агенту на доставку
* '''orderno''' — Номер Идентификатор заказау клиента (шифр). Необязательный элемент.
* '''ordercode''' — Внутренний код заказа. Необязательный элемент.
* '''orderno2''' — Номер заказа из срочных. Необязательный элемент.* '''uid''' — Уникальный идентификатор, если он был добавлен при создании заказа. Необязательный элемент. Запрос информации по uid возможен в течении суток после создания заказа
* '''datefrom''' — Дата заказа «с». Необязательный элемент.
* '''dateto''' — Дата заказа «по». Необязательный элемент.
:* '''namestarts''' — Поиск по номеру заказа(шифр), который начинается с «orderno».
* '''limit''' — Необязательный параметр. Дает возможность получить не все измененные заказы, а только какое-то определенное количество. Помогает на случай, если у вас скопилось очень много измененных заказов и нужно их грузить лимитировано. После каждой итерации нужно вызывать commitlaststatus с контейнером списка обработанных кодов, [[#Лимитирование запросов|читать подробнее]]
<div style="color: #a94442; background-color: #f2dede; border: 1px solid #ebccd1; padding: 3px 10px 10px;">
<town code="153361" regioncode="78" regionname="Санкт-Петербург город">Санкт-Петербург город</town>
<address>Петровка 38 офис 35</address>
<area>Район 1</area>
<pvz>
<code>126</code>
<deliveryPIN>1234</deliveryPIN>
</receiver>
<pickupprice>NO387.5</pickupprice> <inshprice>387.5</inshprice> <paytype code="1">CASH</paytype>
<weight>5.1</weight>
<return_weight>5.1</return_weight>
<quantity>2</quantity>
<paytype>CASH</paytype>
<service>2</service>
<type>3</type>
<return>NO</return>
<return_service>2</service>
<type>3</type>
<return_type>3</return_type>
<return_weight>5.1</return_weight>
<return_message>Доставлено в целости</return_message>
<return_date>2026-01-19</return_date>
<return_time>13:18:00</return_time>
<pickup>NO</pickup>
<print_check>YES</print_check>
<waittime>12</waittime>
<price>387.5</price>
<print_check>YES</print_check>
<inshprice>387.5</inshprice>
<enclosure>Детские игрушки</enclosure>
<instruction>Проверить при покупателе, подписать акт</instruction>
<receiverpays>NO</receiverpays>
<acceptpartially>NO</acceptpartially>
<status eventstore="филиал в Санкт-Петербурге" eventtime="2016-06-02 17:22:00" createtimegmt="2016-06-03 16:14:44" message="" title="Доставлен" eventtown="Санкт-Петербург город" color="16777215">COMPLETE</status>
<statushistory>
<status eventstore="Офис в Москве" eventtime="2016-05-30 10:20:00" createtimegmt="2016-06-03 16:14:44" message="" title="Новый" eventtown="Москва город" country="RU">NEW</status> <status eventstore="Офис в Москве" eventtime="2016-06-01 17:38:00" createtimegmt="2016-06-03 16:14:44" message="филиал в Санкт-Петербурге" title="Планируется отправка" eventtown="Москва город" country="RU">DEPARTURING</status> <status eventstore="Офис в Москве" eventtime="2016-06-01 19:53:00" createtimegmt="2016-06-03 16:14:44" message="филиал в Санкт-Петербурге" title="Отправлено со склада" eventtown="Москва город" country="RU">DEPARTURE</status> <status eventstore="филиал в Санкт-Петербурге" eventtime="2016-06-02 07:41:00" createtimegmt="2016-06-03 16:14:44" message="" title="Получен складом" eventtown="Санкт-Петербург город" country="RU">ACCEPTED</status> <status eventstore="филиал в Санкт-Петербурге" eventtime="2016-06-02 09:17:00" createtimegmt="2016-06-03 16:14:44" message="" title="Выдан курьеру на доставку" eventtown="Санкт-Петербург город" country="RU">DELIVERY</status> <status eventstore="филиал в Санкт-Петербурге" eventtime="2016-06-02 17:22:00" createtimegmt="2016-06-03 16:14:44" message="" title="Доставлен (предварительно)" eventtown="Санкт-Петербург город" country="RU">COURIERDELIVERED</status> <status eventstore="филиал в Санкт-Петербурге" eventtime="2016-06-02 17:22:00" createtimegmt="2016-06-03 16:14:44" message="" title="Доставлен" eventtown="Санкт-Петербург город" country="RU">COMPLETE</status> </statushistory> <customstatecode>2<customstatecode> <clientstatecode></clientstatecode> <costcode>cc12345</costcode> <receipt fdNum="124555" fnSn="9289000100295555" kktNum="0001611984048555" inn="7722756555" fdValue="2899551555" summ="387.5" ofdUrl="gate.ofd.ru">https://ofd.ru/rec/7722756555/0001611984048555/9289000100295555/124555/2899551555</receipt>
<deliveredto>Иванова, секр.</deliveredto>
<delivereddate>2016-06-02</delivereddate>
<deliveredtime>17:22</deliveredtime>
<arrivaldepartment>2016-05-02 23:21Отдел</arrivaldepartment> <costcode>cc12345</costcode>
<outstrbarcode>EXT123456</outstrbarcode>
<respstore>14</respstore>
<partner>Офис на Ленина</partner>
<return_messagearrival>Доставлено в целости2016-05-02 23:21</return_messagearrival> <departmentreceipt fdNum="124555" fnSn="9289000100295555" kktNum="0001611984048555" inn="7722756555" fdValue="2899551555" summ="387.5" ofdUrl="gate.ofd.ru">Отделhttps://ofd.ru/rec/7722756555/0001611984048555/9289000100295555/124555/2899551555</departmentreceipt>
<items>
<item code="34533" extcode="abc123" quantity="1" mass="0.2" retprice="37.5" VATrate="0" barcode="2345625213125" article="1" returns="0" origincountry="040" GTD="" excise="0.00" governmentCode="11223311" govType="1" 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="" govType="1">Обруч</item> <item code="34421" extcode="abc125" quantity="3" mass="0.3" retprice="50" VATrate="18" barcode="2345625213126" itemcode="44123" article="3" returns="0" governmentCode="" govType="1">Погремушка желтая</item>
</items>
<packages>
<package code="33332" strbarcode="ORD0000002" mass="2.5" message="" got="NO"></package>
</packages>
<extrafields>
<extrafield>
<name>courier_car</name>
<value>ВАЗ 2106, бежевый</value>
</extrafield>
</extrafields>
</order>
</statusreq>
:* '''''ordercode''''' — внутренний код заказа в системе, применяется для некоторых внутренних операций.
:* '''''givencode''''' — внутренний код заказа в системе, применяется для некоторых внутренних операций.
 
*'''paytype''' - Тип оплаты заказа получателем. Принимает значения:
:: CASH - Наличными при получении (по-умолчанию)
:: CARD - Картой при получении
:: NO - Без оплаты.
:: OTHER - Прочее (Предусмотрен для того, чтобы оплата поступала непосредственно в курьерскую службу посредством прочих типов оплаты - таких как: вебмани, яденьги, картой на сайте, прочие платежные системы и т.д.)
* Атрибуты контейнера '''paytype''':
** '''''code''''' - (integer) внутренний код типа оплаты заказа в системном справочнике "Типы оплаты корреспонденции". Не обязательный элемент.
 
* атрибут '''''code''''' контейнера '''item''' — внутренний код строки заказа в системе, применяется для некоторых внутренних операций.
:* '''''returns''''' — количество данного товара, от которого отказался получатель. Не нулевое только в случае частичного отказа.
* '''''area''''' в контейнере '''receiver''' — район/метро получателя.
* '''''coords''''' в контейнере '''receiver''' — координаты получателя.
* '''''deliveryPIN''''' в контейнере '''receiver''' — Пин-код.
* '''delivereddate''' — дата вручения.
* '''deliveredtime''' — время вручения. В случае недоставки может быть пустым.
* '''arrival''' — плановая дата прибытия в формате гггг-мм-дд чч: мм: сс. Заполняется только при использовании автоматических систем планирования (Максоптра, Яндекс доставка), во всех остальных случаях - пустое.
* '''outstrbarcode''' — код у подрядчика (код заказа во внешней системе). Используется в интеграциях с внешними системами.
* '''partner''' — текущий филиал/подрядчик.
* '''return_message''' — информация о возврате
* '''return_date''' - дата возврата
* '''return_time''' - время возврата
* '''department''' — Подразделение, в котором оформляется заказ.
: TRANSACCEPTED — Прибыл на склад перевозчика.
: PICKUPTRANS — Забран у перевозчика.
: WITHDRAWN_FROM_PICKUP_POINT - Изъят.: CUSTOMSDELAY - Задержка отправления таможенным органом.: DEPARTUREDELAY - Задержка отправления перевозчиком.: STORETAKE - Принят в работу на складе.
'''Примечание.''' В будущем возможно дополнение используемого набора статусов.
# Контейнер '''statushistory''' и '''deliveryprice''' заполняется для тарифов [[Личный кабинет курьерской службы#Функции личного кабинета|Премиум и Максимум]].
# Контейнер '''packages''' не возвращает более 1000 элементов.
# Система никогда не гарантирует последовательность прохождения заказом набора статусов. То есть Вы можете получить статус «COMPLETE», а следующим запросом — «NEW» — такое может произойти, например, если оператор ошибочно отметил заказ выполненным, а затем исправил ошибку.
</div>
<br>
== Трекинг заказа по номеру ==
Запрос трекинга по номеру предназначен для выдачи минимальной обезличенной информации о конкретном заказе не авторизованному пользователю. Наша система имеет для этого интерфейс по адресу «home.courierexe.ru/{код экстра}/tracking». Вы можете либо сделать ссылку на такую страницу на своем сайте, либо разместить ее iframe’ом у себя, либо сделать свою и пользоваться нашим API. Этот интерфейс создан специально для выдачи информации живому пользователю сайта. Для получения статусов заказов в свою информационную систему нужно использовать запрос «statusreq», желательно с параметром changes=ONLY_LAST!
=== Лимитирование запросов ===Дает возможность получить не все измененные заказы, а только какое-то определенное количество. Помогает на случай, если у вас скопилось очень много измененных заказов и нужно их грузить лимитировано. После успешной обработки получнных заказов, '''Пример запроса:обязательно'''<source lang="xml"><?xml version="1нужно вызвать commitlaststatus с кодами обработанных заказов.0" encoding="UTF-8"?><tracking> <extra>8</extra> <orderno>1234</orderno></tracking></source>'''Пример'''
Для получения ограниченного числа изменившихся заказов отправьте запрос:<source lang="xml"><?xml version="1.0" encoding="UTF-8" ?><statusreq> <auth extra="8" login="login" pass="pass"></auth> <changes>ONLY_LAST</changes> <limit>5</limit></statusreq></source> После успешной обработки ответа необходимо отметить полученные статусы успешно полученными, отправив запрос:<source lang="xml"><?xml version="1.0" encoding="UTF-8" ?><commitlaststatus> <auth extra="8" login="login" pass="pass"></auth> <acs> <ac>11111</ac> <ac>22222</ac> <ac>33333</ac> <ac>44444</ac> <ac>55555</ac> </acs></commitlaststatus></source>  * '''acs''' — контейнер. Обязательный элемент.* '''ac''' — атрибут''' ordercode''' контейнера '''order''' полученного на этапе запроса '''statusreq'''. Помимо приведенных в примере параметров, вы также можете передавать и остальные, описанные ранее, например '''streamid'''. == Трекинг заказа по номеру ==Запрос трекинга по номеру предназначен для выдачи минимальной обезличенной информации о конкретном заказе не авторизованному пользователю. Наша система имеет для этого интерфейс по адресу «home.courierexe.ru/{код экстра}/tracking». Вы можете либо сделать ссылку на такую страницу на своем сайте, либо разместить ее [[#Размещение страниц на своем сайте (iframe)|iframe’ом]] у себя, либо сделать свою и пользоваться нашим API. Этот интерфейс создан специально для выдачи информации живому пользователю сайта. Для получения статусов заказов в свою информационную систему нужно использовать запрос «statusreq», желательно с параметром changes=ONLY_LAST! '''Пример ответазапроса:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<tracking>
<extra>8</extra> <orderno>1234</orderno></tracking></source> '''Пример ответа:'''<source lang="xml"><?xml version="1.0" encoding="UTF-8"?><tracking> <order orderno="111111" ordercode="12345">
<barcode>111111</barcode>
<AWB>111111</AWB>
<item code="34421" extcode="abc125" quantity="3" mass="0.3" retprice="50" VATrate="18" barcode="2345625213126" article="3" returns="0" governmentCode="">Погремушка желтая</item>
</items>
<acquirers>
<acquirer code="2" name="Ibox"/>
<acquirer code="5" name="Payme"/>
<acquirer code="6" name="Click"/>
</acquirers>
</order>
</tracking>
</source>
 
где,
* '''acquirers''' / '''acquirer''' - эквайринг, доступный для получения ссылки на оплату заказа
** '''acquirers''' / '''acquirer''' / ''code'' - внутренний код эквайринга
** '''acquirers''' / '''acquirer''' / ''name'' - наименование эквайринга
"time":"2016-06-02 17:22:00",
"location":"RU",
"town":"Москва",
"store":"Москва Главный",
"content":"Complete"
},
"time":"2016-06-02 17:22:00",
"location":"RU",
"town":"Москва",
"store":"Москва Главный",
"content":"Courierdelivered"
},
"time":"2016-06-02 09:17:00",
"location":"RU",
"town":"Москва",
"store":"Москва Главный",
"content":"Delivery"
},
"time":"2016-06-02 07:41:00",
"location":"RU",
"town":"Москва",
"store":"Москва Главный",
"content":"Accepted"
},
"time":"2016-06-01 19:53:00",
"location":"RU",
"town":"Горький",
"store":"Горький Автозавод",
"content":"Departure"
},
"time":"2016-06-01 17:38:00",
"location":"RU",
"town":"Горький",
"store":"Горький Автозавод",
"content":"Departuring"
},
"time":"2016-05-30 10:20:00",
"location":"RU",
"town":"Горький",
"store":"Горький Автозавод",
"content":"New"
}
Описание контейнеров ответа аналогично описанию [[API#.D0.97.D0.B0.D0.BF.D1.80.D0.BE.D1.81 .D1.81.D1.82.D0.B0.D1.82.D1.83.D1.81.D0.B0 .D0.B7.D0.B0.D0.BA.D0.B0.D0.B7.D0.BE.D0.B2|Запроса статусов заказов]].
== Изменение = Получение ссылки для оплаты заказа ==Запрос предназначен для изменения заказов, по которым не было произведено изменений статуса корреспонденции, времени доставки — то есть заказов, которые ещё не в работе.=
<div style="color: #a94442; background-color: #f2dede; border: 1px solid #ebccd1; padding: 3px 10px 10px;">'''Обратите внимание!'''Этим методом вы можете только получить ссылку на оплату. Фискализация этого платежа идет отдельным процессом. По его возможности уточняйте в службе поддержки.</div> Заказ доступен для оплаты, если:* тип оплаты заказа не наличными, а например картой или по договору, альтернативой может стать установка параметра "Спрашивать тип оплаты" в карточке клиента.* заказ имеет наложенный платеж* не оплачен* активен (не доставлен, не возвращен в т.ч. курьером) '''Пример запроса:'''<source lang="xml"><?xml version="1.0" encoding="UTF-8"?><acqlink> <extra>8</extra> <acq> <code>2</code> </acq> <order> <code>12345</code> </order></acqlink></source> где*'''extra''' - код экстраклиента в системе Measoft.*acq.'''code''' - внутренний код платформы эквайринга в системе Measoft. (известен в МП из [https://wiki.courierexe.ru/index.php/API#.D0.A2.D1.80.D0.B5.D0.BA.D0.B8.D0.BD.D0.B3_.D0.B7.D0.B0.D0.BA.D0.B0.D0.B7.D0.B0_.D0.BF.D0.BE_.D0.BD.D0.BE.D0.BC.D0.B5.D1.80.D1.83 Трекинга]) *order.'''ordercode''' - внутренний код заказа, типа ''int'', уникальный в пределах экстраклиента '''Пример ответа:'''<source lang="xml"><?xml version="1.0" encoding="UTF-8"?><acqlink error="0" amount="2000" extid="161083231">https://qr.nspk.ru/AD10001A7GLVGA9YDO2I0789SIOPV3?type=02&amp;bank=1000011&amp;sum=2000&amp;cur=RUB&amp;crc=7E9C</acqlink></source> где*'''acqlink''' - ссылка на оплату заказа*acqlink.'''amount''' - тип integer сумма платежа в копейках в общем случае, в других случаях в соответствии с типом валюты*acqlink.'''extid''' - идентификатор счета на стороне платежной системы*acqlink.'''error'' - код ошибки, если отличается от 0, означает невозможность получения ссылки на оплату, в этом случае ссылки на оплату не будет и ответ будет выглядеть так:<source lang="xml"><?xml version="1.0" encoding="UTF-8"?><acqlink error="2" message="Ошибка авторизации: Invalid token" amount="2000" extid=""/></source> где*acqlink.'''message''' - текст ошибки возвращаемой эквайрингом Возможные типы ошибок получения ссылки:* '''1''' - не настроен эквайринг, либо не найден заказ* '''2''' - ошибка на стороне эквайринга* '''3''' - запрещающий статус курьера (заказ доставлен, частично доставлен)* '''4''' - оплата заказа не разрешена == Изменение заказа ==Запрос предназначен для изменения заказов. Изменять заказы могут курьерские службы с тарифами «Премиум» и «Максимум». Чтобы разрешить изменение заказов, в личном кабинете курьерской службы перейдите в '''ПараметрыНастройки''' > '''РасширенныеЗаказы''' и в разделе '''Отмена и редактирование''' установите флажок '''Разрешить отмену и изменение заказов'''. Вы также можете пометить в списке '''Статусы для отмены и редактирования заказов''' галками статусы корреспонденции, для которых возможны отмена и изменение заказов. По умолчанию (когда в этом списке ничего не выбрано) редактирование и отмена разрешены для статуса «Новый»
<div style="color: #a94442; background-color: #f2dede; border: 1px solid #ebccd1; padding: 3px 10px 10px;">
=== Описание полей запроса изменения ===
Все поля запроса соответствуют структуре order при создании заказа за исключением:
 
* значение '''orderno''' данным методом изменить нельзя.
* значение '''barcode''' изменяется в случае явного его указания. В случае отсутствия или пустого значения - остается прежним.
* вместо корневого тэга '''neworder''' указывается '''editorder''';
* тэг штрихкода '''barcode''' не указывается, поскольку присваивается при создании заказа;
* тэг курьера '''courier''' можно изменить только при включенной настройке '''Разрешить изменение курьера по АПИ''';
* для вложений '''item''' указывается внутренний код вложения в атрибуте '''code''', который можно получить при получении статуса заказа.
* для мест '''package''' указывается внутренний код вложения в атрибуте '''code''', который можно получить при получении статуса заказа.
 
 
Необходимо иметь в виду, что:
Значение '''orderno''' данным методом # Заказ нельзя изменить нельзя., пока он не синхронизирован с системой (пока предыдущие изменения не переданы в бэк-офис)# Удаление вложений и мест выполняется не моментально, а в процессе синхронизации с бэк-офисом (для записей указываются метки Удалено)
=== Описание полей ответа изменения ===
== Отмена заказа ==
Запрос предназначен для отмены заказов, по которым не было произведено изменений статуса доставки, статуса корреспонденции, времени доставки, то есть заказов, которые ещё не в работе.
Отменять заказы могут курьерские службы с тарифами «Премиум» и «Максимум». Чтобы разрешить отмену Разрешения для отмены заказов, и статусы в личном кабинете курьерской службы перейдите которых заказы можно отменять описаны в разделе '''Параметры''' > '''Расширенные''' и установите флажок '''Разрешить отмену и изменение Изменение заказов'''.
При отмене заказа поле «Инфо о доставке» получает значение «Отменено заказчиком», поле «Дата доставки» — текущую дату, а «Вручил курьер» — системную запись «ОТМЕНА».
== Добавление вложений к накладной ==
 
Метод позволяет прикрепить файлы к корреспонденции.
Размер загружаемого файла не должен превышать 1 Мб.
 
'''Пример запроса:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<attachments>
<item name="doc1.docx" timestamp="2025-01-01 12:00:00" size="35654">JVBERi0xLjMNJVBERixLjMN JUBQREYwMTIzNDU2Nzg5IDI NMyAwIG9iag08PA0vVHlwZSAUwLJdLwIDKxTn+AScMjKqor7Xm3sp1yj1k6BzlPdX2Qsiit6yg3g1fCI4YVAgclUOIY5tDra2LvAcIS U3VidHlwZSAvSW1hZ2UNL1d pZHRoIDE4MDgNL0hlaWdodCA5/+8PsL/sXb0+aoper/9kL/4Ov/YE9QsHwyg7YZTtKICy0YVIYb4Nt7L1tPUMfaX9NpuTsvFCtBAvYG ggNCAwIFINL0JpdHNQZXJDb 21wb25lbnQgMQ0vRGVjb2RlUeJVZoZ2tm6+fZVqAavZpeLizVLtct1a+xvG0+bTSkw3Ac8PhdNfL4smrT2hSgPJLfyaVGyA2ndyW22t ENL0NvbHVtbnMgMTgwOA0sFtTP5knktPNumSZ56QsFRPJkaU8ExDxAcMYMDIoBiIoR4/dDjHMbMW/EW4fiB1pvWmV2ONWIl1Xdub Xg1ob0qWX9W4qagsqzGhjRLsEGeJGVXg9oVC+XkJa9esrhGUmC0tuKEla+AplVO/OtHwXcW0FWui1z7 6KHrtobuWV0xa9sCEiSvb91w3ePHOvfcveo5xt9o4ZevHF7ZOeKxV5qmVx2MI44a1L+Mhk5YuGT12xd Ibsb7r+j9bff/unQlv0al6HBnoD5G89q4+tkjgDtvwwARmqm2aa2Jgvmth8mrXquTNtl2u467vbF/5r vnMt9uesu21Me1bjeNJGlVfAaCtw+/jfenJ/fWjqa7ygExx+P g0vSW1hZ2VNYXNrIHRydWUNLL0BcTGroxrKexQXIQ1ImfEW7ZRJZa+O XhEZWNvZGUNPj4Nc3RyZWFt DQ<ip7xJmmNESMxrgu/item>dquBbGypjJpFDJVRH1rVPR1Ifl4aFS5IEdDWZFSdyBBWKWhVSVu517ZgzOCFAwp wwbFph29g4fTaxnvn/3X78x+Tt56ZNffArgULt+HByvy7+yz6U6XWMawCi3+6gJXN0S+jf4t+HT34wg <item name="photo2.jpg" size="74861">VBERi0xLjMN km7/HDp55YTSWMoCMgZsvZkBrXtIv4WA7xgkT4YpYpxjwLvnsWKkGE+pDbxER0UUWlpVFRY4oilTfM4 JUBQREYwMTIzNDU2Nzg5IDI NMyAwIG9iag08PA0vVHlwZSAMIzgCPgxjOlZ87ceA7ceRJrgpipFGyugPQ4OTI2S8lWJoqTpHJlJbNOeYM7zTcoVxSNyJXiYWSAMklT vWE9iamVjdA0vU3VidHlwZS AvSW1hZ2UNL1dpZHRoIDEzNj q/xd+3fd3/USq2V1rJ7RyBLHsuDSiLwgaOFc5LUCRGI+QWuBAsIwPlZrgRpSMseJyTzD15PKiIRE7bc gNL0hlaWdodCAxMzMzDS9MZ W5ndGggNCAwIFINL0JpdHNQZ Rggk5ijXAPpqISetD4wVm0AD2LHuBZdaxmK3HOKIZoG0QLmiZdVqspXnFIJwVyCKhWiDCI4bzH8Y76w XJDb21wb25lbnQgMQ0vRGVj b2RlUGFybXMgPDwNL0sgLTEN TAnwM67HIqMISOkmJXY8mlYhpiNa7g2oTBkKxo4wgnvETQIUUrlFOn9KdOreDiKQx071rN4N61yRAi1 L0NvbHVtbnMgMTM2OA07EGRhSOgoeLYv+k41+KZ1SVBXAuDjB+xuxnQmm8wJDcP5IRn+Pg0 vSW5penzbR/ivm7qleHK5o790w8ejXchI vOHIPWtWwYhtAO34LdDXqFqWxZEBLNstMCwwITBTWirxk12zuUppp</item>
</attachments>
</source>
<message>Клиент отказался от покупки</message>
<paytype>CASH</paytype>
<storeprice>123</storeprice>
<items>
<item code="34533" quantity="1" reason="0" governmentCode="11223311" />
<item code="34456" quantity="0" reason="0" />
<item code="34421" quantity="2" reason="0" />
</items>
<image attachments> <attachment filename="filename1.jpg"> /9j/4AAQSkZJRgA BAQAAAQABAAD/2wBDAA0JCg sKCA0LCgsODg0PEyAVExISEy ccHhcgLikxMC4pLSwzOko+M zZGNywtQFdBRkxOUlNSMj5aY VpQYEpRUk//2wBDAQ4ODhMR EyYVFSZPNS01T09PT09PT09P T09PT09PT09PT09PT09PT09 PT09PT09PT09PT09PT09PT09 PT09PT0//wAARCAYACAADAS IA</attachment> <attachment filename="filename2.jpg"> /9j/4AAQSkZJRgA BAQAAAQABAAD/2wBDAA0JCg sKCA0LCgsODg0PEyAVExISEy ccHhcgLikxMC4pLSwzOko+M zZGNywtQFdBRkxOUlNSMj5aY VpQYEpRUk//2wBDAQ4ODhMR EyYVFSZPNS01T09PT09PT09P T09PT09PT09PT09PT09PT09 PT09PT09PT09PT09PT09PT09 PT09PT0//wAARCAYACAADAS IA</imageattachment> </attachments>
</order>
</setorderinfo>
* '''outstrbarcode''' — код у подрядчика (код заказа во внешней системе). Используется в интеграциях с внешними системами.
* '''paytype''' — Тип оплаты заказа. Допустимые значения CASH/CARD.
* '''storeprice''' — Агентское вознаграждение.
* '''items''' — Контейнер для описания вложений '''item''' . Атрибуты:
:* '''''code''''' — Код вложения.
:* '''''quantity''''' — Количество доставленных единиц вложения.
:* '''''reason''''' — Причина недоставки, выбирается из соответствующего списка статусов.
:* '''image''governmentCode''''' — Указание кода ТН для вложения при необходимости.* '''attachments''' — Контейнер прикрепляемого изображенияприкрепляемых изображений. Содержит текст файла изображения, закодированный по стандарту Может содержать несколько контейнеров ''base64'attachment'. Контейнер '':* 'order''attachment' может содержать более одного контейнера '' — Контейнер изображения. Содержит текст файла изображения, закодированный по стандарту 'image'base64''. Атрибут:::* '''''filename''''' — Имя файла.
<waybill>
<auth extra="8" login="login" pass="pass" />
<client>CLIENT</client>
<orders>
<order orderno="1234567" ordercode="33331" />
</orders>
<form>1</form>
<start>5</start>
<integration>21</integration>
</waybill>
</source>
'''waybill''' — Корневой контейнер. Обязательный элемент
* '''auth''' — Авторизация. Обязательный элемент
* '''client''' — Признак клиента или агента. Необязательный элемент.:* CLIENT — Признак клиента, значение по умолчанию:* AGENT — Признак агента. В ответ отдается информация по заказам, переданным агенту на доставку* '''orders''' — Список заказов для получения печатных форм. Содержит тэги '''order''' с атрибутами:
:* '''''orderno''''' — шифр заказа
:* '''''ordercode''''' — внутренний код заказа. Указывать необходимо один из атрибутов для всех заказов. Приоритет имеет атрибут '''''ordercode'''''
:* 3 — Наклейки на страницу формата А4
:* 4 — Акты приема-передачи
* '''start''' — Имеет смысл только для form = 3. Начальная позиция первой наклейки. Используется для пропуска наклеек на листе для их экономии.
* '''integration''' - Получение наклеек от подрядчика. Не обязательный элемент, имеет смысл при наличии кода подрядчика в карточке заказа. Принимает значение:
:* 21 - подрядчик GTD
<?xml version="1.0" encoding="UTF-8"?>
<waybill>
<integration code="21">
<order code="33331">
<content>JVBERi0xLjYNJeLjz9MNC...</content>
</order>
<order code="33332">
<content>JVBERi0xLjYNJeLjz9MNC...</content>
</order>
</integration>
<content>EODIcaI8KSBlwQ 4MnEOR7Px8U8EBAyGICBnwpw
IZhQgz0ZxuPs8EBM/GcbjzB AwhBl8hwQYIO00GmEwg1CeEG
В тэге content возвращаются бинарные данные (файл pdf), закодированные в base64.
При записи в файл необходимо использовать двоичный формат записи!
'''Обратите внимание'''Блок integration содержит отдельные наклейки для заказов, что печатные формы для заборов не формируютсяпредоставленные подрядчиком, так же закодированные в base64.
 
'''Обратите внимание''' Лимит количества при единовременном получении печатных форм - 1000 штук. Если нужно получить больше - делайте это несколькими запросами.
 
'''Обратите внимание''' Печатные формы для заборов не формируются.
 
 
'''Пример ответа с ошибкой:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<waybill>
<error>Текст ошибки</error>
</waybill>
</source>
== Справочник городов ==
<city>Краснодарский край</city>
<namecontains>новгород</namecontains>
<namecontainsparts>молоково моск</namecontainsparts>
<namestarts>Моск</namestarts>
<name>Москва</name>
* '''conditions''' — Задает условия поиска. Все вложенные элементы одновременно накладывают условие «И».
:* '''city''' — Поиск по всем населенным пунктам региона.
:* '''namecontainsparts''' — Поиск населенных пунктов, название которых содержит все указанные слова, с разбиением поисковой фразы через пробел. Например "моск моло" найдет деревню "Молоково" в Московской области.
:* '''namecontains''' — Поиск населенных пунктов, название которых содержит указанный текст.
:* '''namestarts''' — Поиск населенных пунктов, название которых начинается с указанного текста.
<message></message>
</document>
<serials>
<serial>123456789</serial>
</serials>
</itemmovements>
</itemlist>
:* '''message''' — комментарий
== Получение справочника тарифов по городам ==<br>* '''serials''' — контейнер серийных номеров<div style="color: #a94442; background-color: #f2dede; border: 1px solid #ebccd1; padding: 3px 10px 10px;">* '''Обратите внимание!serial'''Если  — серийный номер единицы номенклатуры, участвующей в запросе отсутствует параметр nofederal, то Москва будет обрабатываться иначе, чем остальные города. В ответе будут города Москвы и МО, с добавленной ценой за километраждвижении</div><br>
== Серийные номера =='''Пример запроса справочника тарифов по городамдвижения номенклатуры с серийным номером:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?><tariffsserialmovements> <auth extra="8" login="login" pass="pass" /> <townfrom>Москва</townfromauth> <service>1</service> <mainonly>1 </mainonlyserial> <nofederal>1123456789</nofederalserial> </tariffsserialmovements>
</source>
* '''authserial''' — атрибут '''extra''' обязателен, по нему определяется курьерская службасерийный номер единицы номенклатуры.* '''townfrom''' — город-отправитель. Если не передан, то городом будет «Москва».* '''service''' — режим доставки. Обязательный элемент.* '''mainonly''' — необязательный элемент. Если передан, то в ответе будут данные только по городам из справочника '''Межгород''' > '''Зоны'''.* '''nofederal''' — необязательный элемент. Если передан, то в ответе город федерального значения Москва будет обрабатываться как обычный город.
 '''Пример ответа справочника тарифов по городамдвижения номенклатуры с серийным номером:'''<source lang="jsonxml">{ <?xml version="townfrom1.0": encoding="0c5b2444-70a0-4932-980cUTF-b4dc0d3f02b58",?> <serialmovements count="service16": 1,> <serialmovement> "tariffs": [<code>151500</code> { <serial>123456789</serial> "towntofias": "0c5b2444 <date>2017-70a005-493226</date> <delivered>0</delivered> <item> <code>4259</code> <name>Настольная игра Дженга</name> </item> <status> <code>5</code> <name>Возврат от покупателя</name> </status> <order> <ordercode>3374830</ordercode> <number>123660-0</number> <date>2017-980c05-b4dc0d3f02b5"24</date> <orderno>14123</orderno> <barcode>0000000670</barcode> <company>ТОВАР</company> <address>Кравченко ул.,1</address> "towntocode" <delivereddate>2017-05-29</delivereddate> <deliveredtime>12:00: 1,00</deliveredtime> <deliveredto /> </order> <document> <code>21991</code> <number>318</number> <date>2017-05-26</date> <message></message> </document> </serialmovement></serialmovements></source> ''' Описание полей ответа ''' Описание аналогично описанию полей [[#Движение номенклатуры|движения номенклатуры]]   == Серийные номера по заказу == "towntoname"'''Пример запроса движения серийных номеров заказа: "Москва город",''' <source lang="distancexml": 0,> <?xml version="pricedistance": 1.0, "pricesnewencoding=": { UTF-8"before": [?> {<orderserials> <auth extra="price8": 100, login="everylogin": 0, pass="masspass": 1></auth> <ordercode>123456789</ordercode> <orderno>123456789</orderno> <barcode>123456789</barcode></orderserials> },</source> { "price": 150,* '''ordercode''' — внутренний код заказа.* '''orderno''' — шифр заказа. "every": 0,* '''barcode''' — штрих-код заказа. "mass": 5Указывать необходимо один из идентификаторов заказа. } ], "after"'''Пример ответа движения серийных номеров заказа: [''' { <source lang="pricexml": 0,> <?xml version="every": 1, .0"massencoding=": 38.01UTF-8" ?><orderserials> <order> <code>3374830</code> <orderno>14123</orderno> }, <barcode>0000000670</barcode> { <delivereddate>2024-07-20</delivereddate> "price" <deliveredtime>10:04: 15,00</deliveredtime> "every" <assemblydate>2024-07-19 07:05: 1,34</assemblydate> </order> <items> "mass": 51.01 <item> } <code>4259</code> ] <name>Настольная игра Дженга</name> }, <article>123000</article> "deliveryPeriodMin": 1, <state>Delivered</state> "deliveryPeriodMax": 2 <serials> }<serial>123456789</serial> </serials> ]</item> </items>}</orderserials>
</source>
''' Описание полей ответа '''
* '''townfrom''' — код ФИАС города-отправителя.
* '''service''' — режим доставки.
* '''tariffs''' — cписок тарифов по городу.
:* '''towntofias''' — код ФИАС города-получателя.
:* '''towntocode''' — внутренний код города-получателя.
:* '''towntoname''' — наименование города-получателя.
:* '''distance''' — дистанция в км до города от МКАД, если в запросе townfrom — Москва.
:* '''pricedistance''' — сумма за километраж до города от МКАД, если в запросе townfrom — Москва.
:* '''pricesnew''' — ваши настройки тарифов из справочника '''Межгород''' > '''Тарифы по зонам'''.
::* '''before/after''' — контейнеры ДО/ОТ.
:::* '''price''' — цена. Если ответ идет по «before», то в цену также плюсуется сумма pricedistance
:::* '''every''' — за каждые.
:::* '''mass''' — масса.
:* '''prices''' — устаревший элемент, не используется.
:* '''deliveryPeriodMin''' — минимальный срок доставки.
:* '''deliveryPeriodMax''' — максимальный срок доставки.
== Номенклатура приходной накладной ==* '''order''' — блок заказа::* '''code'''Пример запроса номенклатуры приходной накладной — код:* '''orderno''' — шифр<source lang="xml">:* '''barcode''' — штрих-код<?xml version="1.0" encoding="UTF-8" ?>:* '''delivereddate''' — дата доставки факт:* '''deliveredtime''' — время доставки факт:* '''assemblydate''' — дата сборки<itemdoc> <auth extra="8" login="login" pass="pass"></auth>* '''item''' — блок товара: <:* '''code>21991</code>''' — код:* '''name''' — наименование</itemdoc>:* '''article''' — артикул</source>:* '''state''' — статус Доставлено (Delivered) или Возвращено (Returned):* '''serials''' — блок серийных номеров по заказу
* '''code''' — внутренний код документа приходной накладной (см. предыдущий запрос).== Получение справочника тарифов по городам ==
 '''Пример ответа движения номенклатуры:запроса справочника тарифов по городам'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8" ?><itemdoctariffs> <code>21991 <auth extra="8" login="login" pass="pass" /code> <numbertownfrom>318Москва</numbertownfrom> <dateservice>2017-05-261</dateservice> <messagemainonly></message> <items> <item code="4259" quantity="1" barcode="200300" article="123555">Настольная игра Дженга</item> </itemsmainonly> </itemdoctariffs>
</source>
* '''auth''' Описание полей ответа  — атрибут '''extra''' обязателен, по нему определяется курьерская служба.* '''codetownfrom''' — внутренний код приходной накладнойгород-отправитель. Если не передан, то городом будет «Москва».* '''numberservice''' — номер документарежим доставки. Обязательный элемент.* '''datemainonly''' — дата документа* необязательный элемент. Если передан, то в ответе будут данные только по городам из справочника '''Межгород''' > '''messageЗоны''' — комментарий.  Важно понимать, что в ответе отдаются только тарифы, указанные в разделе "Тарифы по зонам" раздела "Межгород" в офисной системе курьерской службы, т.е. считающихся междугородними. Доставка до городов, рассчитываемая по внутригородским тарифам, в ответе НЕ ОТДАЕТСЯ! 
* '''item''' — контейнер товара
:* '''code''' — внутренний код товара
:* '''barcode''' — штрихкод товара
:* '''article''' — артикул товара
:* '''quantity''' — количество поступившего товара
== Справочник филиалов =='''Пример запроса списка филиалов:ответа справочника тарифов по городам'''<source lang="xmljson"><?xml version={ "townfrom": "0c5b2444-70a0-4932-980c-b4dc0d3f02b5", "service": 1, "tariffs": [ { "towntofias": "0c5b2444-70a0-4932-980c-b4dc0d3f02b5", "towntocode": 1, "towntoname": "Москва город", "townregion": "Город Москва", "distance": 0, "pricedistance": 0, "pricesnew": { "before": [ { "price": 100, "every": 0, "mass": 1 }, { "price": 150, "every": 0, "mass": 5 } ], "after": [ { "price": 0, "every": 1, "mass": 38.001 }, { "price": 15, "every" encoding=: 1, "UTF-8mass" ?>: 51.01 } ] },<storelist> "deliveryPeriodMin": 1, <auth extra= "8deliveryPeriodMax"></auth>: 2 <json>YES</json> } <client_code>7890</client_code> ]</storelist>}</source> ''' Описание полей ответа '''* '''authtownfrom''' — Атрибут код ФИАС города-отправителя.* '''extraservice''' — обязателен, режим доставки.* '''tariffs''' — cписок тарифов по нему определяется курьерская службагороду.:* '''jsontownregion''' — Признак вывода ответа в виде JSON YES/NOрегион города-получателя.:* '''client_codetowntofias''' — Код клиента курьерской службыкод ФИАС города-получателя.:* '''towntocode''' — внутренний код города-получателя.:* '''Пример ответа:towntoname'''<source lang="xml"><?xml version="1 — наименование города-получателя.0" encoding="UTF-8" ?><storelist count="2"> <store> <code>123</code> <name>ABC</name> </store> <store> <code>456</code> <name>Филиал 2</name> </store></storelist></source> :* '''codedistance''' — Код филиаладистанция в км до города от МКАД, если в запросе townfrom — Москва.:* '''namepricedistance''' — Наименование филиаласумма за километраж до города от МКАД, если в запросе townfrom — Москва== Справочник пунктов самовывоза ==Для отображения списка пунктов выдачи (ПВЗ) есть :* '''pricesnew''' — ваши настройки тарифов из справочника '''Межгород''' > '''готовый JavaScript модульТарифы по зонам'''.: https:* '''before/after''' — контейнеры ДО/homeОТ.courierexe:::* '''price''' — цена.ru/js/measoft_map.js Инструкция Если ответ идет по использованию — внутри«before», то в цену также плюсуется сумма pricedistance:::* '''every''' — за каждые. Посмотреть пример работы можно [https::://home.courierexe.ru/pvz_test* '''mass''' — масса.html Здесь] Уникальные запросы списка ПВЗ кешируются на стороне личного кабинета и хранятся до 7 часов утра по московскому времени следующего дня. Например:* '''prices''' — устаревший элемент, если уникальный запрос с массой 2 кг был отправлен сегодня в 10 часов, то завтра в 7 утра он сброситсяне используется. Если сегодня в 18 часов в этом же запросе вы укажете массу 2 кг, в ответе вернется тот же список ПВЗ:* '''deliveryPeriodMin''' — минимальный срок доставки. Если передадите массу 3 кг, список может быть другим:* '''deliveryPeriodMax''' — максимальный срок доставки.
== Номенклатура приходной накладной =='''Пример запроса пунктов самовывозаноменклатуры приходной накладной:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8" ?>
<pvzlistitemdoc>
<auth extra="8" login="login" pass="pass"></auth>
<code>123421991</code> <client_code>7890</client_code> <city>Свердловская область</city> <town regioncode="66" country="RU">Нижний Тагил</town> <parentcode>6</parentcode> <acceptcash>YES</acceptcash> <acceptcard>YES</acceptcard> <acceptfitting>YES</acceptfitting> <maxweight>30</maxweight> <acceptindividuals>YES</acceptindividuals> <lt>57.924737</lt> <lg>59.940019</lg> <rt>57.905682</rt> <rg>59.984669</rg> <json>YES</json> <limit> <limitfrom>30</limitfrom> <limitcount>2</limitcount> <countall>YES</countall> </limit></pvzlistitemdoc>
</source>
* '''auth''' — Атрибут '''extra''' — обязателен, по нему определяется курьерская служба, '''login''' и '''pass''' позволяют авторизоваться под клиентом: для отдельного клиента могут быть ограничения по доступности некоторых ПВЗ, и в этом случае они будут учтены.* '''code''' — Внутренний внутренний коддокумента приходной накладной (см.* '''client_code''' — Код клиента курьерской службы.* '''city''' — Регион получателя. Можно указать код региона или полное наименование региона из [[#Справочник регионов|справочника регионов]].* '''town''' — Город получателя.Для тега города '''town''' можно указать код региона в атрибуте '''''regioncode''''' из [[#Справочник регионов|справочника регионов]]. Поиск будет производиться в указанном регионепредыдущий запрос).
Также можно указать страну получателя в атрибуте '''''country''''' в соответствии с [https://ru.wikipedia.org/wiki/ISO_3166-1 стандартом ISO_3166-1], например, «RU», «RUS» или «643» для России.
* '''parentcodeПример ответа движения номенклатуры:''' — Фильтр по родительскому [[#Справочник филиалов|филиалу]]* '''acceptcash''' — Фильтр по приему наличных YES<source lang="xml"><?xml version="1.0" encoding="UTF-8" ?><itemdoc> <code>21991</NOcode>* '''acceptcard''' — Фильтр по приему банковских карт YES <number>318</NOnumber>* '''acceptfitting''' — Фильтр по наличию примерки YES <date>2017-05-26</NOdate>* '''maxweight''' — Фильтр по максимальному весу, с которым работает ПВЗ* '''acceptindividuals''' — Фильтр по доступности физическим лицам YES <message></NOmessage>* '''lt''' — Широта левого верхнего угла <items>* '''lg''' — Долгота левого верхнего угла <item code="4259" quantity="1" barcode="200300" article="123555">Настольная игра Дженга</item>* '''rt''' — Широта правого нижнего угла </items>* '''rg''' — Долгота правого нижнего угла</itemdoc>* '''json''' — Признак вывода ответа в виде JSON YES</NO* '''limit''' — Ограничивает вывод результата.:* '''limitfrom''' — Задает номер записи результата, начиная с которой выдавать ответ. По-умолчанию — 0.:* '''limitcount'''- Задает количество записей результата, которые нужно вернуть. По-умолчанию — 100.:* '''countall''' — YES указывает на необходимость подсчета общего количества найденных совпадений. Это может замедлять выполнение запроса. Если отключено — в ответе не указываeтся totalcount.source>
''' Описание полей ответа '''
* '''code''' — внутренний код приходной накладной
* '''number''' — номер документа
* '''date''' — дата документа
* '''message''' — комментарий
* '''item''' — контейнер товара:* '''code''' — внутренний код товара:* '''barcode''' — штрихкод товара:* '''article''' — артикул товара:* '''quantity''' — количество поступившего товара == Справочник филиалов =='''Пример запроса списка филиалов:'''<source lang="xml"><?xml version="1.0" encoding="UTF-8" ?><storelist> <auth extra="8"></auth> <json>YES</json> <client_code>7890</client_code></storelist></source> * '''auth''' — Атрибут '''extra''' — обязателен, по нему определяется курьерская служба* '''json''' — Признак вывода ответа в виде JSON YES/NO* '''client_code''' — Код клиента курьерской службы '''Пример ответа справочника пунктов самовывоза:'''<source lang="xml">
<?xml version="1.0" encoding="UTF-8" ?>
<pvzlist storelist count="2" totalcount="40465"> <pvzstore> <code>126123</code> <clientcode>3</clientcode> <name>Нижний ТагилABC</name> <parentcode>6 </parentcodestore> <parentname>Интеграция </parentnamestore> <town code="124267" regioncode="66" regionname="Свердловская область">Нижний Тагил город456</towncode> <addressname>622036, г. Нижний Тагил, ул. Циолковского, д. 17Филиал 2</addressname> <phone>+73435417709, +73435254989 </phonestore> <comment>Новый пункт доставки</commentstorelist> <worktime>Вс 10:00-16:00, Сб 10:00-16:00, Пн-Пт 10:00-20:00</worktimesource> <traveldescription>Жилое 5-ти этажное здание, торцом к дороге, второе здание от перекрестка Пархоменко-Циолковского</traveldescription> <maxweight>10</maxweight> <acceptcash>YES</acceptcash> <acceptcard>YES</acceptcard> <acceptfitting>YES</acceptfitting> <acceptindividuals>YES</acceptindividuals> <latitude>57* '''code''' — Код филиала.93457</latitude> <longitude>59* '''name''' — Наименование филиала.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есть '''готовый JavaScript модуль''':00-16https:00, Сб 10:00-16:00, Пн-Пт 10:00-20:00</worktime> <traveldescription>Напротив ТЦ Пирамида</traveldescription> <maxweight>20<home.courierexe.ru/maxweight> <acceptcash>YES<js/acceptcash> <acceptcard>YES</acceptcard> <acceptfitting>NO<measoft_map.js Инструкция по использованию — внутри. Посмотреть пример работы можно [https:/acceptfitting> <acceptindividuals>YES</acceptindividuals> <latitude>57home.courierexe.93468<ru/latitude> <longitude>60pvz_test.55476</longitude> <uid>41116853-9c51-11eb-b2c9-cfd6c1451392</uid> </pvz></pvzlist></source>html Здесь]
* '''code''' — Код Уникальные запросы списка ПВЗ кешируются на стороне личного кабинета и хранятся до 7 часов утра по московскому времени следующего дня. Например, если уникальный запрос с массой 2 кг был отправлен сегодня в системе10 часов, то завтра в 7 утра он сбросится. Используется Если сегодня в 18 часов в этом же запросе [[API#Оформление заказа|оформления заказов]]* '''clientcode''' — Код ПВЗ используемый компанией-подрядчиком.* '''name''' — Наименование ПВЗ.* '''parentcode''' — Код родительского элемента.* '''parentname''' — Наименование родительского элемента.* '''town''' — Населенный пункт с кодом из [[#Справочник городов|справочника городов]]вы укажете массу 2 кг, а также с кодом и наименованием региона.* '''address''' — Адрес ПВЗ.* '''phone''' — Телефоны ПВЗ.* '''comment''' — Дополнительная информация.* '''worktime''' — Режим работы ПВЗ.* '''traveldescription''' — Описание местонахождения в ответе вернется тот же список ПВЗ или пути к нему.* '''maxweight''' — Максимальный весЕсли передадите массу 3 кг, с которым работает ПВЗсписок может быть другим.* '''acceptcash''' — Признак приема наличных* '''acceptcard''' — Признак приема банковских карт* '''acceptfitting''' — Наличие примерки* '''latitude''' — Широта* '''longitude''' — Долгота* '''uid''' — Уникальный идентификатор ПВЗ в системе Measoft* '''count''' — Количество записей в ответе* '''totalcount''' — Общее количество записей, отвечающее параметрам запроса
== Получение фискальных данных заказа ==Обратите внимание, что если в выборке количество ПВЗ больше '''Пример запроса получения фискальных данных:10000''' и не указаны параметры '''code''', '''json''' или '''limitcount''', то будет возвращаться ошибка. В этом случае необходимо использовать блок '''limit'''<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 countpvzlist> <auth extra="8" login="login" pass="1pass"></auth> <receiptcode>1234</code> <ordernoclient_code>1234567890</ordernoclient_code> <fdDatetimecity>2020-06-07 12:14:00Свердловская область</fdDatetimecity> <fdValuetown regioncode="66" country="RU">123Нижний Тагил</fdValuetown> <fdNumaddress>456Щёлковское шоссе</fdNumaddress> <fnSnhouse>78977</fnSnhouse> <kktNumadvanced_search>100Строка поиска</kktNumadvanced_search> <innparentcode>2226</innparentcode> <ofdUrlacceptcash>gate.ofd.ruYES</ofdUrlacceptcash> <fullUrlacceptcard>https:YES</acceptcard> <acceptfitting>YES</check.ofd.ru/123acceptfitting> <maxweight>30</fullUrlmaxweight> <priceacceptindividuals>12345YES</priceacceptindividuals> <lines count="1"respstores> YES<line/respstores> <itemlt>111176457.924737</itemlt> <namelg>Сапоги59.940019</namelg> <qtyrt>157.905682</qtyrt> <pricerg>100059.984669</pricerg> <vatRatejson>20YES</vatRatejson> <governmentCodewith_coords>Z16513LK2YES</governmentCodewith_coords> <itemTypelimit>1 <limitfrom>30</itemTypelimitfrom> <limitcount>2</linelimitcount> <countall>YES</linescountall> </receiptlimit></receiptspvzlist>
</source>
Параметры ответа:* '''ordernoauth''' — Номер заказа* Атрибут '''fdDatetimeextra''' — Дата и время пробития фискального чека* обязателен, по нему определяется курьерская служба, '''fdValuelogin''' — ФПД (фискальный признак документа)* и '''fdNumpass''' — ФИСКАЛЬНЫЙ ДОКУМЕНТ (фискальный номер чека)позволяют авторизоваться под клиентом: для отдельного клиента могут быть ограничения по доступности некоторых ПВЗ, и в этом случае они будут учтены.* '''fnSncode''' — ФН (номер фискального накопителя)Внутренний код, целое число.* '''kktNumclient_code''' — РН (регистрационный номер кассы)Код клиента курьерской службы.* '''inn''' — ИНН* '''ofdUrl''' — URL адрес (доменное имя) ОФД* '''price''' — Сумма чека* '''fullUrl''' — URL чека для просмотра онлайн* '''lines''' — Позиции чека:* '''itemcity''' — Регион получателя. Можно указать код товара:* '''name''' — региона или полное наименование товарарегиона из [[#Справочник регионов|справочника регионов]].:* '''qtytown''' — количество товараГород получателя.:* Для тега города '''pricetown''' — цена товара:* '''governmentCode''' — считанная последовательность, которая можно указать код региона в дальнейшем преобразуется по алгоритму тега 1162:* ''атрибуте 'vatRate''' — НДС товара:* 'regioncode''itemType''' — тип товара (товар, доставка и тиз [[#Справочник регионов|справочника регионов]]. дПоиск будет производиться в указанном регионе.)
== Справочник Виды срочности ==Также можно указать страну получателя в атрибуте '''''country''Пример запроса видов срочности:'''<source lang="xml"><?xml version="1в соответствии с [https://ru.wikipedia.0" encoding="UTF-8" ?><services><auth extra="8"org/><wiki/services>ISO_3166-1 стандартом ISO_3166-1], например, «RU», «RUS» или «643» для России.</source>Для формата запроса JSON фильтрация по городу работает только в связке с фильтром по адресу.
* '''address''' — Фильтр по адресу, работает только в связке с фильтром по городу* '''house''' — Фильтр по номеру дома, работает только в связке с фильтрами по адресу и городу* '''advanced_search''' — Фильтр по коду агента, наименованию, телефону или комментарию* '''parentcode''' — Фильтр по родительскому [[#Справочник филиалов|филиалу]]* '''acceptcash''' — Фильтр по приему наличных YES/NO* '''acceptcard''' — Фильтр по приему банковских карт YES/NO* '''acceptfitting''' — Фильтр по наличию примерки YES/NO* '''maxweight''' — Фильтр по максимальному весу, с которым работает ПВЗ* '''acceptindividuals''' — Фильтр по доступности физическим лицам YES/NO* '''respstores''' - Признак вывода ответственных филиалов при значении YES* '''lt''' — Широта левого верхнего угла* '''lg''' — Долгота левого верхнего угла* '''rt''' — Широта правого нижнего угла* '''rg''' — Долгота правого нижнего угла* '''json''' — Признак вывода ответа в виде JSON YES/NO* '''with_coords''' — Признак вывода ПВЗ только с наличием координат YES/NO* '''limit''' — Ограничивает вывод результата.:* '''limitfrom''' — Задает номер записи результата, начиная с которой выдавать ответ. По-умолчанию — 0.:* '''limitcount'''- Задает количество записей результата, которые нужно вернуть. По-умолчанию — 100.:* '''countall''' — YES указывает на необходимость подсчета общего количества найденных совпадений. Это может замедлять выполнение запроса. Если отключено — в ответе не указываeтся totalcount.  '''Пример ответа справочника видов срочностипунктов самовывоза:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8" ?>
<services pvzlist count="2" totalcount="40465"> <servicepvz> <code>1126</code> <clientcode>3</clientcode> <name>ЭкономНижний Тагил</name> <parentcode>6</serviceparentcode> <parentname>Интеграция<service/parentname> <town code="124267" regioncode="66" regionname="Свердловская область">2Нижний Тагил город</codetown> <nameaddress>Срочно622036, г. Нижний Тагил, ул. Циолковского, д. 17</nameaddress> <phone>+73435417709, +73435254989</servicephone> <comment>Новый пункт доставки</servicescomment> <worktime>Вс 10:00-16:00, Сб 10:00-16:00, Пн-Пт 10:00-20:00</sourceworktime> <traveldescription>Жилое 5-ти этажное здание, торцом к дороге, второе здание от перекрестка Пархоменко-Циолковского</traveldescription>== Справочник дополнительных услуг == <maxweight>10</maxweight>'''Пример запроса дополнительных услуг:''' <acceptcash>YES</acceptcash> <source lang="xml"acceptcard>YES</acceptcard> <?xml version="1.0" encoding="UTF-8"?acceptfitting>YES</acceptfitting> <advpricesacceptindividuals>YES</acceptindividuals> <latitude>57.93457<auth extra="8" login="login" pass="pass" /latitude> <visiblelongitude>NO59.95131</visiblelongitude> <uid>40606d00-9c51-11eb-b2c9-cfd6c1111392</advpricesuid> </sourcepvz> <pvz>'''advprices''' — Корневой контейнер. Обязательный элемент. <code>245</code>* '''visible''' — Признак возврата '''только''' тех услуг, что доступны для отображения в ЛК YES <clientcode>NTG1</NO. Необязательный элемент. По-умолчанию NOclientcode> <name>На Красноармейской</name> <parentcode>6</parentcode>'''Пример ответа справочника дополнительных услуг:''' <parentname>Интеграция</parentname> <source langtown code="xml124267"><?xml versionregioncode="1.066" encodingregionname="UTF-8Свердловская область" ?>Нижний Тагил город</town> <advpricesaddress> КРАСНОАРМЕЙСКАЯ, д.79<advprice/address> <codephone>1+7(3435)379-044</codephone> <namecomment>Этажей в домеВозможность примерки отсутствует</namecomment> <typeworktime>intВс 10:00-16:00, Сб 10:00-16:00, Пн-Пт 10:00-20:00</typeworktime> <traveldescription>Напротив ТЦ Пирамида</advpricetraveldescription> <maxweight>20<advprice/maxweight> <codeacceptcash>2YES</codeacceptcash> <nameacceptcard>Коэффициент надбавкиYES</nameacceptcard> <typeacceptfitting>floatNO</typeacceptfitting> </advpriceacceptindividuals> YES<advprice/acceptindividuals> <codelatitude>357.93468</codelatitude> <namelongitude>Расписаться на упаковке60.55476</namelongitude> <typeuid>bool41116853-9c51-11eb-b2c9-cfd6c1451392</typeuid> </advpricepvz></advpricespvzlist>
</source>
Параметры:* '''code''' — Код ПВЗ в системе. Используется в запросе [[API#Оформление заказа|оформления заказов]]* '''codeclientcode''' — внутренний код услугиКод ПВЗ используемый компанией-подрядчиком.* '''name''' — наименование услугиНаименование ПВЗ.* '''parentcode''' — Код родительского элемента.* '''parentname''' — Наименование родительского элемента. Если поле «название в ЛК» в настройках услуги не пусто* '''town''' — Населенный пункт с кодом из [[#Справочник городов|справочника городов]], то возвращает значение поля «название в ЛК»а также с кодом и наименованием региона.* '''address''' — Адрес ПВЗ.* '''phone''' — Телефоны ПВЗ.* '''comment''' — Дополнительная информация.* '''hineworktime''' — подсказка по доп услуге для пользователяРежим работы ПВЗ.* '''typetraveldescription''' — тип услугиОписание местонахождения ПВЗ или пути к нему. Может иметь значения::* '''boolmaxweight''' — для услуг вида «чекбокс»Максимальный вес, «Да»с которым работает ПВЗ.* '''acceptcash''' — Признак приема наличных* '''acceptcard''' — Признак приема банковских карт* '''acceptfitting''' — Наличие примерки* '''latitude''' — Широта:* '''floatlongitude''' — для числа с плавающей точкойДолгота* '''uid''' — Уникальный идентификатор ПВЗ в системе Measoft. Создается автоматически при получении данных о ПВЗ от агентов.* '''count''' — Количество записей в ответе:* '''inttotalcount''' — для целого числаОбщее количество записей, отвечающее параметрам запроса
== Расчет стоимости доставки Получение фискальных данных заказа =='''Пример запроса стоимости доставкиполучения фискальных данных:'''<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" ?>
<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>
 
Параметры:
Структура данных и заполнение полей аналогичны и совместимы с [[#Оформление заказа]].
Дополнительные поля<?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> Параметры ответа:* '''pricetypeorderno''' — Номер заказа* '''fdDatetime''' — Дата и время пробития фискального чека* '''fdValue''' — ФПД (фискальный признак документа)* '''fdNum''' — ФИСКАЛЬНЫЙ ДОКУМЕНТ (фискальный номер чека)* '''fnSn''' — ФН (номер фискального накопителя)* '''kktNum''' — тип требуемой ценыРН (регистрационный номер кассы)* '''inn''' — ИНН* '''ofdUrl''' — URL адрес (доменное имя) ОФД* '''price''' — Сумма чека* '''paytype''' — Тип оплаты чека. Возможные Принимает значения: «CUSTOMER» :* CASH — Наличными (по-умолчанию):* CARD — Безналичным способом* '''fullUrl''' — [[Личный кабинет клиента#Цена доставки URL чека для получателя|просмотра онлайн* '''lines''' — Позиции чека:* '''item''' — код товара:* '''name''' — наименование товара:* '''extcode''' — код товара во внешних системах:* '''qty''' — количество товара:* '''price''' — цена для конечного получателя]], «CLIENT» — цена курьерской службы для клиента.товара:* '''useridgovernmentCode''' — Идентификатор пользователясчитанная последовательность, строковый или числовой тип. Виртуальное поле. Необязательное. Данное поле используется совместно с настройками «Цена доставки для получателя», определяя приоритет правила. Можно использовать которая в различных CMS/CRM системах, настраивая цены для определенного покупателя.дальнейшем преобразуется по алгоритму тега 1162:* '''vatRate''' — НДС товара:* '''groupiditemType''' — Идентификатор группы пользователятип товара (товар, строковый или числовой типдоставка и т. Виртуальное поле д. Необязательное) == Справочник Виды срочности =='''Пример запроса видов срочности:'''<source lang="xml"><?xml version="1. Данное поле используется совместно с настройками «Цена доставки для получателя», определяя приоритет правила. Можно использовать в различных CMS0" encoding="UTF-8" ?><services><auth extra="8"/></services></CRM системах, настраивая цены для определенной группы покупателей.source>
Суммы НП и ОЦ, а также тип оплаты CARD имеют значение при настроенных в тарифе на вкладке Прочее долях (в процентах) от данных сумм'''Пример ответа справочника видов срочности:'''<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>
В авторизации можно опустить параметры login и pass, тогда расчет будет производиться по стандартному тарифу курьерской службы, без учета возможных отличий для конкретного клиента.<br>Объемный вес будет учитываться только при условии указания всех габаритов: длины, ширины и высоты.<br>В полях город-отправитель и город-получатель можно указывать название города (не рекомендуется!), либо код города из нашего справочника, либо 13-ти значный код КЛАДР, либо 36-ти значный код адресной системы ФИАС (AOID). == Справочник дополнительных услуг =='''Пример ответа стоимости доставкизапроса дополнительных услуг:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<calculatoradvprices> <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> <deliveryprice> <advprice code="1" price="1000">База</advprice> <advprice code="4" price="100">Процент от суммы руб</advprice> <advprice codeauth extra="5" price=8"63">Процент от объявленной стоимости</advprice> <advprice codelogin="6login" pricepass="-50pass">Скидка при доставке</advprice> </deliveryprice> </calc></calculatoradvprices>
</source>
Параметры:* '''townfromadvprices''' — Город-отправитель так, как система его распознала и привязала к справочникуКорневой контейнер. Атрибут '''code''' — код из справочника городов системы.* '''townto''' — Город-получатель так, как система его распознала и привязала к справочнику. Атрибут '''code''' — код из справочника городов системы.* '''mass''' — Масса в килограммах* '''service''' — Режим доставки — число, указывающее на запись в справочнике видов срочности (см описание на этой странице).* '''zone''' — номер тарифной зоны, по которой рассчиталась стоимость. В зависимости от зоны выбирается тарифная сетка. Так же к цене могут применяться повышающие или понижающие коэффициенты при доставке не из/в региональный центр.* '''price''' — рассчитанная стоимость доставки в валюте прайс-листа курьерской службы. Рекомендуется к использованию в отличие от одноименного атрибута родительского контейнера.* '''maxdeliverydays''' — максимальный срок доставки в рабочих днях.* '''mindeliverydate''' — минимальная дата доставки в учетом выходных днейОбязательный элемент.* '''deliveryprice''' — Данные по составляющим ценам доставки
'''''Обратите внимание:''''' В реальном ответе сервера в теге calc присутствует атрибут «price». Он оставлен для обратной совместимости, не используйте его. Пользуйтесь вложенным тегом price.
== Получение информации о клиенте =='''Пример запроса получения информации о клиентеответа справочника дополнительных услуг:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8" ?>
<clientadvprices> <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> <auth extra="8" login="login" pass="pass" /advprice> </clientadvprices>
</source>
Параметры:* '''code''' — внутренний код услуги* '''clientname''' — Корневой контейнернаименование услуги. Обязательный элементЕсли поле «название в ЛК» в настройках услуги не пусто, то возвращает значение поля «название в ЛК».* '''authhine''' — подсказка по доп услуге для пользователя* '''type''' — Авторизация. Обязательный элементтип услуги.Может иметь значения::* '''bool''' — для услуг вида «чекбокс», «Да»:* '''float''' — для числа с плавающей точкой:* '''int''' — для целого числа
== Расчет стоимости доставки =='''Пример ответа на запрос получения информации о клиентезапроса стоимости доставки:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8" ?>
<clientcalculator> <auth extra="8" login="login" pass="pass" /> <order> <pricetype>CUSTOMER</pricetype> <codesender> <town>Санкт-Петербург</town> <address>Петровка 38 офис 35</address> <coords lat="55.680327" lon="37.604456">1082</codecoords> </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></clientcalculator>
</source>
* '''code''' — Код клиента
== Список актов передачи денег ==Параметры:Структура данных и заполнение полей аналогичны и совместимы с [[#Оформление заказа]]. Дополнительные поля:* '''pricetype'''Пример запроса списка актов передачи денег — тип требуемой цены. Возможные значения:«CUSTOMER» (по-умолчанию) — [[Личный кабинет клиента#Цена доставки для получателя|цена для конечного получателя]], «CLIENT» — цена курьерской службы для клиента.* '''userid''' — Идентификатор пользователя, строковый или числовой тип. Виртуальное поле. Необязательное. Данное поле используется совместно с настройками «Цена доставки для получателя», определяя приоритет правила. Можно использовать в различных CMS/CRM системах, настраивая цены для определенного покупателя.* '''groupid''' — Идентификатор группы пользователя, строковый или числовой тип. Виртуальное поле. Необязательное. Данное поле используется совместно с настройками «Цена доставки для получателя», определяя приоритет правила. Можно использовать в различных CMS/CRM системах, настраивая цены для определенной группы покупателей.<source lang="xml"><?xml version="1Суммы НП и ОЦ, а также тип оплаты CARD имеют значение при настроенных в тарифе на вкладке Прочее долях (в процентах) от данных сумм.0" encoding="UTF-8" ?><smalist> <auth extra="8" В авторизации можно опустить параметры login="login" и pass="pass" /, тогда расчет будет производиться по стандартному тарифу курьерской службы, без учета возможных отличий для конкретного клиента.<br> Объемный вес будет учитываться только при условии указания всех габаритов: длины, ширины и высоты.<datefrombr>2016В полях город-02отправитель и город-10</datefrom> <dateto>2016получатель можно указывать название города (не рекомендуется!), либо код города из нашего справочника, либо 13-03ти значный код КЛАДР, либо 36-10</dateto></smalist></source>ти значный код адресной системы ФИАС (AOID).
'''smalist''' — Корневой контейнер. Обязательный элемент.
* '''auth''' — Авторизация. Обязательный элемент.
* '''datefrom''' — Дата «с». Необязательный элемент.
* '''dateto''' — Дата «по». Необязательный элемент.
Если интервал дат не указан, то возвращаются акты передачи денег за последний месяц.
'''Пример ответа на запрос списка актов передачи денегстоимости доставки:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<smalist countcalculator> <calc> <townfrom code="1"> Москва город<sma/townfrom> <townto code="56603">6278Иркутск город</codetownto> <numbermass>39923.7</numbermass> <actdateservice name="Экспресс">2016-02-121</actdateservice> <datepayzone>2</datepayzone> <datetoprice>2016-02-121113</datetoprice> <promiseddatepaymindeliverydays>1</promiseddatepaymindeliverydays> <pricemaxdeliverydays>637.003</pricemaxdeliverydays> <pricecorrmindeliverydate>113.002020-05-13</pricecorrmindeliverydate> <rurintervals> <workdays>13430. <interval>10:00-16:00</rurinterval> <pricekurinterval>570.16:00-22:00</pricekurinterval> </workdays> <holidays> <priceaginterval>67.12:00-16:00</priceaginterval> <payno/holidays>42423 </paynointervals> <paytypedeliveryprice> <advprice code="1" price="1000">База</advprice> <advprice code="4" price="100">Процент от суммы руб</paytypeadvprice> <paytypenameadvprice code="5" price="63">БезналПроцент от объявленной стоимости</paytypenameadvprice> <advprice code="6" price="-50">Скидка при доставке<signedcopyreceived/advprice>NO </signedcopyreceiveddeliveryprice> </smacalc></smalistcalculator>
</source>
* '''code''' — Код актаПараметры:* '''numbertownfrom''' — Номер акта в системе* Город-отправитель так, как система его распознала и привязала к справочнику. Атрибут '''actdatecode''' — Дата актакод из справочника городов системы.* '''datepaytownto''' — Дата оплаты по акту* Город-получатель так, как система его распознала и привязала к справочнику. Атрибут '''datetocode''' — Дата конечного периода для формирования АПДкод из справочника городов системы.* '''promiseddatepaymass''' — Плановая дата оплатыМасса в килограммах* '''priceservice''' — Стоимость услугРежим доставки — число, указывающее на запись в справочнике видов срочности (см описание на этой странице).* '''pricecorrzone''' — Сумма корректировкиномер тарифной зоны, по которой рассчиталась стоимость. В зависимости от зоны выбирается тарифная сетка. Так же к цене могут применяться повышающие или понижающие коэффициенты при доставке не из/в региональный центр.* '''rurprice''' — Сумма заказарассчитанная стоимость доставки в валюте прайс-листа курьерской службы. Рекомендуется к использованию в отличие от одноименного атрибута родительского контейнера.* '''pricekurmaxdeliverydays''' — Стоимость курьерской максимальный срок доставкив рабочих днях.* '''priceagmindeliverydate''' — Агентское вознаграждение* '''payno''' — Номер платежного поручения* '''paytype''' — Тип оплаты: 1 — безнал, 2 — наличными курьером, 3 — наличными минимальная дата доставки в офисе, 4 — перевод на картуучетом выходных дней.* '''paytypenameintervals''' — Строковое представление типа оплатысписок интервалов доставки для соответствующей зоны и режима срочности.* '''signedcopyreceiveddeliveryprice''' — Признак факта возврата акта YES/NOДанные по составляющим ценам доставки
== Детализация актов передачи денег =='''Пример запроса детализации актов передачи денег''Обратите внимание:'''<source lang="xml"><?xml version="1'' В реальном ответе сервера в теге calc присутствует атрибут «price». Он оставлен для обратной совместимости, не используйте его. Пользуйтесь вложенным тегом price.0" encoding="UTF-8" ?><smadetail> <auth extra="8" login="login" pass="pass" /> <code>6278</code></smadetail></source>
=== Коды и описание ошибок ==={|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] не допустимо для ПВЗ||В ПВЗ не допустим указанный тип оплаты|-|} == Получение информации о клиенте =='''smadetailПример запроса получения информации о клиенте:'''<source lang="xml"><?xml version="1.0" encoding="UTF-8" ?><client> <auth extra="8" login="login" pass="pass" /> </client></source> '''client''' — Корневой контейнер. Обязательный элемент.
* '''auth''' — Авторизация. Обязательный элемент.
* '''code''' — Код акта передачи денег (см. запрос списка АПД). Обязательный элемент.
'''Пример ответа на запрос детализации актов передачи денегполучения информации о клиенте:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8" ?><client> <code>1082</code></client></source> * '''code''' — Код клиента == Список актов передачи денег =='''Пример запроса списка актов передачи денег:'''<source lang="xml"><?xml version="1.0" encoding="UTF-8" ?><smalist> <auth extra="8" login="login" pass="pass" /> <datefrom>2016-02-10</datefrom> <dateto>2016-03-10</dateto></smalist></source> '''smalist''' — Корневой контейнер. Обязательный элемент.* '''auth''' — Авторизация. Обязательный элемент.* '''datefrom''' — Дата «с». Необязательный элемент.* '''dateto''' — Дата «по». Необязательный элемент.Если интервал дат не указан, то возвращаются акты передачи денег за последний месяц. '''Пример ответа на запрос списка актов передачи денег:'''<source lang="xml"><?xml version="1.0" encoding="UTF-8"?><smalist count="1"> <sma> <code>6278</code> <number>3992</number> <actdate>2016-02-12</actdate> <datepay></datepay> <dateto>2016-02-12</dateto> <promiseddatepay></promiseddatepay> <price>637.00</price> <pricecorr>113.00</pricecorr> <rur>13430.00</rur> <pricekur>570.00</pricekur> <priceag>67.00</priceag> <payno>42423</payno> <paytype>1</paytype> <paytypename>Безнал</paytypename> <signedcopyreceived>NO</signedcopyreceived> </sma></smalist></source> * '''code''' — Код акта* '''number''' — Номер акта в системе* '''actdate''' — Дата акта* '''datepay''' — Дата оплаты по акту* '''dateto''' — Дата конечного периода для формирования АПД* '''promiseddatepay''' — Плановая дата оплаты* '''price''' — Стоимость услуг* '''pricecorr''' — Сумма корректировки* '''rur''' — Сумма заказа* '''pricekur''' — Стоимость курьерской доставки* '''priceag''' — Агентское вознаграждение* '''payno''' — Номер платежного поручения* '''paytype''' — Тип оплаты: 1 — безнал, 2 — наличными курьером, 3 — наличными в офисе, 4 — перевод на карту* '''paytypename''' — Строковое представление типа оплаты* '''signedcopyreceived''' — Признак факта возврата акта YES/NO == Детализация актов передачи денег =='''Пример запроса детализации актов передачи денег:'''<source lang="xml"><?xml version="1.0" encoding="UTF-8" ?><smadetail> <auth extra="8" login="login" pass="pass" /> <code>6278</code></smadetail></source> '''smadetail''' — Корневой контейнер. Обязательный элемент.* '''auth''' — Авторизация. Обязательный элемент.* '''code''' — Код акта передачи денег (см. запрос списка АПД). Обязательный элемент. '''Пример ответа на запрос детализации актов передачи денег:'''<source lang="xml"><?xml version="1.0" encoding="UTF-8"?><smadetail count="2"> <specialsma> <code>42494</code> <ordercode>14424</ordercode> <orderno>11111</orderno> <orderdate>2018-01-01</orderdate> <delivereddate>2018-10-01</delivereddate> <company>Компания</company> <price>314.00</price> <rur>8800.00</rur> <inshprice>314.00</inshprice> <pricekur>270.00</pricekur> <priceag>44.00</priceag> <pricecalc>8486.00</pricecalc> <paytype>2</paytype> <paytypename>наличными курьером</paytypename> <weight>0.400</weight> <distance>0.0</distance> <status>Доставлено</status> </specialsma></smadetail>
</source>
* '''code''' — Код записи.
* '''ordercode''' — Код заказа.* '''orderno''' — Шифр заказа.* '''orderdate''' — Дата заказа.* '''delivereddate''' — Дата доставки.* '''company''' — Получатель.* '''price''' — Стоимость услуг.* '''rur''' — Сумма заказа.* '''inshprice''' — Стоимость заказа.* '''pricekur''' — Стоимость курьерской доставки.* '''priceag''' — Агентское вознаграждение.* '''pricecalc''' — Сумма для передачи агенту.* '''paytype''' — Тип оплаты: 1 — безнал, 2 — наличными курьером, 3 — наличными в офисе, 4 — перевод на карту.* '''paytypename''' — Строковое представление типа оплаты* '''weight''' — Вес заказа.* '''distance''' — Дистанция по заказу* '''status''' — Статус заказа. == Установка статуса согласования заказа ==Для возможности клиентом установки статуса согласования заказа необходимо включить переменную [[Личный кабинет курьерской службы#Заказы|Разрешить менять статус согласования]] '''Пример запроса установки статуса согласования заказа'''<source lang="xml"><?xml version="1.0" encoding="UTF-8"?><setapprovalstatus> <auth extra="8" login="login" pass="pass" /> <order ordercode="1234561"> <confirmstate>1</confirmstate> <message>Сообщение статуса</message> </order> <order ordercode="1234562"> <confirmstate>2</confirmstate> <message>Согласовано</message> </order> <order ordercode="1234563"> <confirmstate>3</confirmstate> <message>Не согласовано</message> </order></setapprovalstatus></source> * '''order''' — Контейнер заказа. Обязателен как минимум один элемент.:* '''ordercode''' — Внутренний код заказа.* '''confirmstate''' — Код статуса заказа. Все статусы с кодами можно получить запросом [[#Получение списка статусов согласования заказа|Получение списка статусов согласования заказа]]* '''message''' — Дополнительный комментарий, который отобразится в поле ''Инфо о доставке''. == Получение списка статусов согласования заказа =='''Пример запроса списка статусов согласования заказа'''<source lang="xml"><?xml version="1.0" encoding="UTF-8"?><approvalstatuses> <auth extra="8" login="login" pass="pass" /></approvalstatuses></source> '''Пример ответа списка статусов согласования заказа'''<source lang="xml"><?xml version="1.0" encoding="UTF-8" ?><approvalstatuses count="6"> <status> <code>1</code> <name>Неизвестно</name> </status> <status> <code>2</code> <name>Согласование запрошено</name> </status> <status> <code>3</code> <name>Доставка полностью согласована</name> </status> <status> <code>4</code> <name>Согласовано с изменением времени</name> </status> <status> <code>5</code> <name>Перенос на другую дату</name> </status> <status> <code>6</code> <name>Отказ</name> </status></approvalstatuses></source> == Генерация коротких ссылок ==В некоторых случаях, например, при использовании в СМС, может потребоваться использование коротких ссылок на ЛК.Для этого, необходимо отправить запрос с полной ссылкой, в ответ на который придёт хэш-код для ссылки. '''Пример запроса генерации коротких ссылок:'''<source lang="xml"><?xml version="1.0" encoding="UTF-8" ?><shortlink> <link short="0"> https://home.courierexe.ru/8/site/orders </link></shortlink></source> '''shortlink''' — Корневой контейнер. Обязательный элемент.* '''link''' — Полная ссылка, для которой необходимо получить код. Обязательный элемент. Если атрибут '''short''' равен 1, то ответ не будет содержать XML, а только хэш-код. '''Пример ответа на запрос генерации коротких ссылок:'''<source lang="xml"><?xml version="1.0" encoding="UTF-8"?><shortlink> <hash>35AF350C</hash></shortlink></source> * '''hash''' — Хэш-код ссылки. Далее, можно использовать ссылку на ЛК: <nowiki>https://home.courierexe.ru/35AF350C или curie.ru/35AF350C</nowiki>  '''Примечание!''' Сервис коротких ссылок работает только для ресурсов компании MeaSoft. == Проверка надежности покупателя ==Проверка надежности работает только для тарифа «Максимум» личного кабинета. <source lang="xml"><?xml version="1.0" encoding="UTF-8" ?><mcheck> <auth extra="8" login="login" pass="pass" /> <phones> <phone>89161147992</phone> </phones></mcheck></source> Ответ: <source lang="xml"><?xml version="1.0" encoding="UTF-8" ?><mcheck> <phones> <phone rate="90">89161147992</phone> </phones></mcheck></source>  == Размещение страниц на своем сайте (iframe) == В некоторых случаях имеет смысл разметить те или иные страницы на своем сайте. Например, чтобы клиенты могли рассчитать стоимость доставки не переходя по внешней ссылке, а там же, на сайте, калькулятор можно разместить прямо на странице такого сайта посредством так называемого фрейма — '''iframe'''. [https://ya.ru/search/?text=iframe Фрейм] — контейнер внутри обычной страницы, который позволяет загружать сторонние страницы. Пример загрузки калькулятора: <source lang="html"><iframe id="frame" src="https://home.courierexe.ru/8/calculator"> Здесь должен отобразиться калькулятор</iframe></source> Для удобства пользователей вашего сайта можно указать язык интерфейса (который переключается непосредственно на сайте) параметром '''lang''': <source lang="html"><iframe id="frame" src="https://home.courierexe.ru/8/calculator?lang=2"> Здесь должен отобразиться калькулятор</iframe></source>  <div style="color: #a94442; background-color: #f2dede; border: 1px solid #ebccd1; padding: 3px 10px 10px;">'''Обратите внимание!'''# При использовании iFrame могут не работать некоторые функции, например, подписка на push-уведомления на странице трекинга или отслеживания.# Если язык не указать, то на страницах калькулятора и трекинга отображается свой переключатель языка. Если язык указан, то переключатель не отображается. Поддерживаемые языки и их коды::'''1''' — русский:'''2''' — английский:'''4''' — узбекский</div> == Оформление манифеста == '''Пример запроса на создание манифеста:'''<source lang="xml"><?xml version="1.0" encoding="UTF-8" ?><manifest> <auth extra="8" login="login" pass="pass" /> <store_from>1</store_from> <store_to>2</store_to> <trn_code>3</trn_code> <sentdate>2024-11-07</sentdate> <places> <place> <number>1</number> <seal>7890AABBB</seal> </place> <place> <number>2</number> <seal>123456ABC</seal> </place> </places> <addresses> <address> <code>12345</code> <place>1</place> </address> <address> <code>67890</code> <place>2</place> </address> </addresses></manifest></source>  '''manifest''' - Корневой контейнер. Обязательный элемент.*'''auth''' - Авторизация. Обязательный элемент.*'''store_from''' - код филиала отправителя. Обязательный элемент.*'''store_to''' - код филиала получателя. Обязательный элемент.*'''trn_code''' - код перевозчика. Обязательный элемент.*'''sentdate''' - дата отправки манифеста. Не обязательный элемент.*'''addresses''' - корневой элемент для списка заказов.*:'''address''' - корневой элемент для заказа.*::'''code''' - наш внутренний номер заказа. Обязательный элемент.*::'''place''' - номер места заказа. Обязательный элемент, если переданы места.*'''places''' - корневой элемент для списка мест.*::'''place''' - корневой элемент для места.*::'''number''' - номер места. Обязательный элемент.*::'''seal''' - номер пломбы. Необязательный элемент.  '''Пример успешного ответа'''<source lang="xml"><?xml version="1.0" encoding="UTF-8"?><manifest> <result>OK</result></manifest></source>  '''Пример ответа с ошибкой'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<shortlinkmanifest> <hash>35AF350C</hash></shortlink></source> * '''hash''' — Хэш-код ссылки. Далее, можно использовать ссылку на ЛК: <nowiki>https://home.courierexe.ru/35AF350C или curie.ru/35AF350C</nowiki>  '''Примечание!''' Сервис коротких ссылок работает только для ресурсов компании MeaSoft. == Проверка надежности покупателя ==Проверка надежности работает только для тарифа «Максимум» личного кабинета. <source lang="xml"><?xml version="1.0" encodingresult error="UTF-8Текст ошибки" ?><mcheck> <auth extra="8" login="login" pass="pass" /> <phones> <phone>89161147992</phone> ERROR</phonesresult></mcheckmanifest>
</source>
Ответ:'''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>
50
правок

Навигация