Изменения

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

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

API предназначено для интеграции клиентов (интернет-магазинов и прочих компаний-заказчиков доставки) с [http://courierexe.ru/our_clients.htm курьерскими службами], работающими под управлением системы [https://curie.ru/ MeaSoft].

Для работы с популярными CMS и CRM-системами разработаны модули интеграции, перечисленные в таблице ниже.  '''Модули распространяются бесплатно, без гарантий со стороны разработчика''', и не являются средством полной автоматизации взаимодействия с курьерской службой. Модули — Модули — это помощь разработчикам интернет-магазинов в построении интеграции с курьерскими службами. '''Ответственность за корректность передачи данных лежит на интернет-магазине.'''Модули сторонних разработчиков обслуживаются и разрабатываются сторонними компаниями. Все вопросы по их приобретению и поддержке необходимо задавать им.

|Поддерживает версии 1420.5 .0 и выше. Подробнее см. [[Интеграция с другими системами#1C-Битрикс|описание]].

|Поддерживает версии 1.5.2.0 и выше.Инструкция в архиве

|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 1.5.5.1|описание]].<br>[https://opencartforum.com/files/file/2906-avtomatizaciya-otpravki-i-otslezhivanie-dostavok-courierexe-dlya-opencart-15x/ Альтернативный модуль сторонних разработчиков]

|Модуль предназначен для отправки заявок в КС, а плагин для расчета стоимости доставки при оформлении заказа.Инструкции в маркете

|[[Интеграция с другими системами#InSales|Инструкция по настройке]]|-|[[Файл:iiko.jpg|center|x80px]]|style="text-align: center;"|Настраивается в [[Личный кабинет клиента|ЛК пользователя]]|[[Iiko|Инструкция по настройке]]

|[[Интеграция с другими системами#LeadVertex|Инструкция по настройке]]<br>Модуль разработан и поддерживается компанией LeadVertex.

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

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

|Работает только с компонентом Virtuemart.Инструкция в архиве

|Подробнее см. [[Интеграция с другими системами#amoCRM|описание]].

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

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

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

Для отображения списка пунктов выдачи есть [https://home.courierexe.ru/js/measoft_map.js JavaScript модуль]. Инструкция по использованию — использованию — внутри. Посмотреть пример работы можно [https://home.courierexe.ru/pvz_test.html здесь].

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

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

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

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

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

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

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

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

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

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

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

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

*'''neworder''' -  — Корневой контейнер, обязательный элемент. :* '''''newfolder''''' — Признак нового заказа YES/NO. Если стоит YES, то в системе курьерской службы для данной корреспонденции создастся новый заказ. Необязательный элемент. * '''order''' — Контейнер для описания одного заказа, обязательный элемент. В одном контейнере '''neworder''' может быть много контейнеров '''order''' для создания нескольких заказов одним запросом. :* '''''orderno''''' — Номер заказа. Если присваивается клиентом — указывается здесь. Если не присваивается — можно оставить пустым, система сгенерирует свой номер, и вернет его в ответе. Система проверяет наличие заказов с указанным номером в пределах текущего календарного года, и в случае их существования — заказ создан не будет, а в ответе вернется ошибка 17 «Such number exists». Если не указан штрихкод (поле barcode), и значение поля подходит для использования его в качестве штрихкода, данное значение будет скопировано в поле «Штрихкод». Это накладывает ограничения в частности, на длину указанного поля (25 знаков, чтобы работали стандартные печатные формы). * '''barcode''' — Штрихкод заказа. Если клиент штрихкодирует свои отправления и штрихкод отличается от номера заказа, в этом поле указывается штрихкод. Если ШК содержит кириллицу или малое количество символов, то формируется ШК в формате EAN13. <spoiler text="Заполнение номера заказа (шифра) и штрих-кода">Шифр и штрих-код заполняются исходя из начальных значений:

:* '''''newfolder''''' # Если шифр и ШК пустые - оба поля заполняются автоматически значением вида XXX#YYY, а после ШК проверяется на корректность (валидируется)# Если ШК пустой, а шифр заполнен - Признак нового заказа YES/NO. ШК заполняется значением из шифра и валидируется# Если стоит YESшифр пустой, а ШК заполнен - шифр заполняется значением из ШК, после чего ШК валидируется# Если оба непустые - валидируется ШК, то в системе курьерской службы для данной корреспонденции создастся новый заказ. Необязательный элемент.шифр не проверяется

Корректный (валидный) ШК отвечает следующим требованиям:*'''order''' длина не меньше 5 символов* значение не меньше значения переменной <mparam code="MinPrePrintedNum"/>* содержит символы, которые можно использовать для формирования штрих- Контейнер для описания одного заказа, обязательный элементкод а формате Code128 (т. В одном контейнере '''neworder''' может быть много контейнеров '''order''' для создания нескольких заказов одним запросоме.все печатные символы, кроме кириллицы)

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

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

*'''sender''' -  — Информация о отправителе заказа. Необязательный контейнер.

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

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

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

:* 36-ти значный код адресной системы <rspoiler text="ФИАС">Федеральная информационная адресная система — система — единый российский государственный адресный реестр</rspoiler> (AOID)

*'''coords''' -  — Координаты получателя. Если не указаны, система будет геокодировать самостоятельно.

* '''zipcode''' — Почтовый индекс.* '''price''' — Сумма заказа (наложенный платеж) - денежные средства, которые курьер должен забрать у получателя в пользу заказчика. В случае наличия контейнера items значение этого параметра будет проигнорировано и рассчитано автоматически.* '''inshprice''' — Объявленная ценность. Если явно не указана сумма — автоматически считается как сумма по товарам.* '''deliveryprice''' — Стоимость доставки, которая устанавливается заказчиком и будет взиматься с получателя в пользу заказчика. Не имеет отношения к стоимости доставки самой курьерской службы, которая рассчитывается в соответствии с тарифамии, не указывается при оформлении заказа и добавляется в заказ автоматически при его обработке курьерской службой. В случае наличия контейнера items в него будет добавлено вложение «Доставка».:* '''''VATrate''''' — Ставка НДС — целое число процентов.* '''discount''' — Сумма скидки. Скидка «размазывается» по товарным вложениям, сумма НП уменьшается на сумму скидки. При этом вложение Скидка не создается. ВНИМАНИЕ, при использовании этого тега общая сумма может расходиться на копейки из-за округления! Старайтесь не использовать этот тег, а указывать цену товаров уже с учетом скидок.*'''paytype''' -  — Тип оплаты заказа получателем. Принимает значения::* CASH - CASH — Наличными при получении (по-умолчанию):* CARD - CARD — Картой при получении:* NO - NO — Без оплаты. Этот тип оплаты передается, если заказ уже оплачен и не требует инкассации. API добавит к товарам строку предоплаты в сумму заказа, чтобы общая сумма была 0, однако в кассовом чеке будут все товары с ценами, и оплата предоплатой, как того требует 54-ФЗ.:* OTHER - OTHER — Прочее (Предусмотрен для того, чтобы оплата поступала непосредственно в курьерскую службу посредством прочих типов оплаты - оплаты — таких как: вебмани, яденьги, картой на сайте, прочие платежные системы и ти т.д д.):* OPTION - OPTION — На выбор получателя. Этот тип оплаты нельзя передавать с заказом. Он выставляется автоматически в зависимости от настройки клиента.* '''weight''' — Общий вес заказа в килограммах.* '''quantity''' — Количество мест.* '''service''' — Режим доставки (тип услуги) передается код из справочника «[[#Справочник Видов срочности|Виды срочности]]».* '''type''' — Тип корреспонденции (отправления) передается код из справочника «Типы корреспонденции».* '''return''' — Признак необходимости возврата. Принимает значения::* NO — Возврат не требуется:* YES — Требуется возврат, например, документов:* ONLY — Требуется забрать отправление у поставщика (см. раздел «[[Личный_кабинет_клиента#Привезти ко мне|Привезти ко мне]]»). * '''return_service''' — Режим возврата (тип услуги) передается код из справочника «Виды срочности».* '''return_type''' — Тип возвратной корреспонденции (отправления) передается код из справочника «Типы корреспонденции».* '''return_weight''' — Общий вес возврата заказа в килограммах.* '''enclosure''' — Вложение.* '''instruction''' — Поручение — Примечание.* '''courier''' — Запланированный курьер. Согласно коду курьера в КС2008.* '''receiverpays''' — Признак оплаты стоимости доставки — услуг службы доставки получателем, а не заказчиком YES/NO.* '''department''' — Подразделение, в котором оформляется заказ.* '''costcode''' — Кост-код сотрудника.* '''respstore''' — Код ответственного филиала. Для ответственного филиала в который передается заказ, требуется включение параметра "Разрешить клиенту передавать заказы в этот филиал"* '''pickup''' — Признак оформления забора YES/NO. Если стоит YES, то весь заказ считается заданием на забор груза, а не на доставку! Применяется для вызова курьера к отправителю для забора других отправлений. ''Внимание!'' при добавлении в забор складских товаров, их тип '''''type''''' всегда должен быть установлен как [7] Забор товара, если будет указан другой тип, то он будет исправлен в момент добавления заказа на [7] Забор товара* '''acceptpartially''' — Признак возможности частичного выкупа товаров отправления YES/NO.* '''uid''' - Универсальный идентификатор заказа на стороне отправителя. Не обязательный параметр, ограниченного по времени действия. Время хранения в системе, - сутки. * '''items''' — Контейнер для описания вложений. <rspoiler text="Необязательный контейнер">Если для поставщика товара в системе MeaSoft не указаны полное наименование компании и ИНН в карточке клиента, заполните параметры <code>suppcompany</code> и <code>suppINN</code> в этом контейнере. Отсутствие информации о поставщике приведет к [[Настройка модуля печати кассовых чеков#Ошибка фискализации (ошибка программирования реквизита 1226)|ошибке фискализации]].</rspoiler>. Атрибуты::* '''''item''''' — Название вложения.:* '''''quantity''''' — Количество единиц товара.:* '''''mass''''' — Масса единицы товара в килограммах.:* '''''volume''''' — Объемный вес единицы товара в килограммах. При указании объемного веса значение подставляется вместо массы:* '''''length''''' — Длина единицы товара (в сантиметрах).:* '''''width''''' — Ширина единицы товара (в сантиметрах).:* '''''height''''' — Высота единицы товара (в сантиметрах).:* '''''retprice''''' — Цена единицы товара. Округляется до копеек. Должна быть с учетом всех скидок и наценок. Для вложений типов 1, 2, 3 не может быть отрицательной. <!-- , либо мы сами посчитаем скидку при указании тега order->discount -->:* '''''inshprice''''' — Объявленная ценность единицы товара. Округляется до копеек. Если не указана принимается равной '''''retprice'''''.:* '''''VATrate''''' — Ставка НДС — целое число процентов. Если товар хранится в КС (смотрите '''article''' ниже), значение берется из номенклатуры. Иначе, если значение указано, берется указанное значение, если нет - значение из настроек фирмы КС. Значение «0» означает ставку «Без НДС», ставка «0%» на данный момент не поддерживается.:* '''''barcode''''' — Штрихкод вложения.:* '''''article''''' — Артикул вложения. ''Внимание!'' Указание артикула используется только тогда, когда товар хранится на ответственном хранении в службе доставки, и необходима комплектация. В этом случае система пытается привязать товар к [[API#Справочник номенклатуры|справочнику номенклатуры]]. Если товар в справочнике не найден — система выдаст соответствующую ошибку. Если по артикулу найдено несколько товаров — система выберет один из них случайным образом, что может привести к ошибочной комплектации! Если товар НЕ на ответственном хранении — артикул указывать НЕ нужно. Позиция попадет в систему просто текстом.:* '''''itemcode''''' — Внутренний код товара, может использоваться вместо артикула. ''Внимание!'' Указание кода товара используется только тогда, когда товар хранится на ответственном хранении в службе доставки, и необходима комплектация. В этом случае система пытается привязать товар к [[API#Справочник номенклатуры|справочнику номенклатуры]]. Если товар в справочнике не найден — система выдаст соответствующую ошибку. Если товар НЕ на ответственном хранении — код товара указывать НЕ нужно.:* '''''type''''' — Тип вложения. Принимает значения::: 1 — Товар. По-умолчанию.:: 2 — Доставка. Такое вложение добавится автоматически, если заполнить order->deliveryprice:: 3 — Услуга:: 4 — Предоплата. Указывается сумма. Поле quantity игнорируется, всегда «1». В заказе сумма будет отрицательной независимо от знака в запросе. Такое вложение добавится автоматически при указании order->paytype=NO.:: 6 — Оплата кредитом. Указывается сумма. Поле quantity игнорируется, всегда «1». В заказе сумма будет отрицательной независимо от знака в запросе.:: 7 — Забор товара. Если товар нужно у получателя забрать, возможно — вернуть деньги, или его стоимость вычтется из суммы других товаров. У такого товара в заказе будет отрицательное количество независимо от знака в запросе.:* '''''extcode''''' — Внешний код строки. Используется для идентификации строк заказов при получении статусов. Необязательное поле.:* '''''origincountry''''' — Код страны-производителя в соответствии со [https://ru.wikipedia.org/wiki/ISO_3166-1 стандартом ISO_3166-1], например, «RU», «RUS» или «643» для России.:* '''''GTD''''' — Номер ГТД.:* '''''excise''''' — Сумма акциза.:* '''''suppcompany''''' — Наименование компании поставщика, если отличается от заказчика.:* '''''suppphone''''' — Номер телефона компании поставщика, если отличается от заказчика.:* '''''suppINN''''' — ИНН компании поставщика, если отличается от заказчика.:* '''''governmentCode''''' — Код товарной номенклатуры. Используется для [[Маркировка|маркированных товаров, например («Честный знак»)]]. Для кода '''Честный знак''' Нужно указывать все данные из нанесенного QR-кода кроме не читаемых символов (#29). Если код не известен — укажите знак вопроса «?», тогда курьер отсканирует код фактически передаваемого покупателю товара. Для некоторых процессов может использоваться значение «!» — в этом случае курьер сканирует серийный номер товара, но это не считается кодом маркировки. При этом, если указано значение «?» или «!» и quantity больше 1, то такое вложение растиражируется quantity раз.:* '''''govType''''' — Тип маркировки товара. В данный момент существуют следующие типы маркировки::: 1 — Честный знак. По-умолчанию.:: 2 — ГИИС ДМДК.:: 3 — Серийный номер. :* '''''extraTags''''' — Строка в формате JSON для отправки в ОФД. :: Тэг 1265 - значение отраслевого реквизита = код места деятельности аптеки :: Тэг 1262 – идентификатор ФОИВ = "020" (константа ФОИВ МИНЗДРАВа) :: Тэг 1263 - дата нормативного акта федерального органа исполнительной власти = "14.12.2018" (константа)

*'''zipcode''' - Почтовый индекс.*'''weight''' :: Тэг 1264 - Общий вес заказа в килограммах.*'''return_weight''' - Общий вес возврата заказа в килограммах.*'''quantity''' - Количество мест.*'''service''' - Режим доставки (тип услуги) передается код из справочника [[#Справочник Видов срочности|номер нормативного акта федерального органа исполнительной власти = "Виды срочности1556"]].*'''return_service''' - Режим возврата (тип услугиконстанта) передается код из справочника "Виды срочности".*'''type''' - Тип корреспонденции (отправления) передается код из справочника "Типы корреспонденции".*'''return_type''' - Тип возвратной корреспонденции (отправления) передается код из справочника "Типы корреспонденции".*'''price''' - Сумма заказа. В случае наличия контейнера items значение этого параметра будет проигнорировано и рассчитано автоматически.*'''deliveryprice''' - Сумма доставки. В случае наличия контейнера items в него будет добавлено вложение "Доставка".:* '''''VATrate''''' - Ставка НДС - целое число процентов.*'''return''' - Признак необходимости возврата.*'''return_service''' - Режим возврата (тип услуги) передается код из справочника "Виды срочности".*'''discount''' - Сумма скидки. Скидка "размазывается" по товарным вложениям, сумма НП уменьшается на сумму скидки. При этом вложение Скидка не создается. ВНИМАНИЕ, при использовании этого тега общая сумма может расходиться на копейки из-за округления! Старайтесь не использовать этот тег, а указывать цену товаров уже с учетом скидок.*'''enclosure''' - Вложение.*'''inshprice''' - Объявленная ценность. Если явно не указана сумма - автоматически считается как сумма по товарам.*'''instruction''' - Поручение - Примечание.*'''courier''' - Запланированный курьер. Согласно коду курьера в КС2008.*'''receiverpays''' - Признак оплаты стоимости доставки - услуг службы доставки получателем, а не заказчиком YES/NO.*'''department''' - Подразделение, в котором оформляется заказ.*'''pickup''' - Признак оформления забора YES/NO. Если стоит YES, то весь заказ считается заданием на забор груза, а не на доставку! Применяется для вызова курьера к отправителю для забора других отправлений. ''Внимание!'' при добавлении в забор складских товаров, их тип '''''type''''' всегда должен быть установлен как [7] Забор товара, если будет указан другой тип, то он будет исправлен в момент добавления заказа на [7] Забор товара*'''acceptpartially''' - Признак возможности частичного выкупа товаров отправления YES/NO.

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

*'''packages''' - Контейнер для описания мест. Необязательный контейнер. Атрибуты::* '''''package''''' - Название места.Пример:* '''''code''''' - Внутренний код строки.:* '''''strbarcode''''' - Штрих-код места.:* '''''mass''''' - Масса места в килограммах.:* '''''message''''' - Строка сообщения.:* '''''length''''' - Длина товарного места (в сантиметрах).:* '''''width''''' - Ширина товарного места (в сантиметрах).:* '''''height''''' - Высота товарного места (в сантиметрах).

* '''deliveryset''' - настройка [[Дифференциальная стоимость доставки | дифференцированной стоимости доставки]]<source lang="json">"item_industry_props":{"tag1262":"020","tag1263":"14. Атрибуты12.2018","tag1264":"1556","tag1265":* '''''above_price''''' - стоимость в случае полного выкупа заказа (действует как "сумма отtm=mdlp&sid=00000000XXXXXX" последней границы}, указанной в теге below_sum)"tag1212":* '''''return_price''''' - стоимость в случае возврата заказа"1":* '''''VATrate''''' - Ставка НДС - целое число процентов.</source>

* '''advpricespackages''' -  — Контейнер для описания дополнительных услугмест. Необязательный элементконтейнер. <span style="colorАтрибуты: red;>Для обработки :* '''''package''''' — Название места.:* '''''code''''' — Внутренний код строки.:* '''''strbarcode''''' — Штрихкод места.:* '''''mass''''' — Масса места в API включите дополнительные услуги килограммах.:* '''''message''''' — Строка сообщения.:* '''''length''''' — Длина товарного места (в сантиметрах).:* '''''width''''' — Ширина товарного места (в настройках полей [[Личный_кабинет_курьерской_службы#Настройка личного кабинета клиента|заказов и заборов]]</span>сантиметрах).:* '''''codeheight''''' - код услуги — Высота товарного места (в сантиметрах).:* '''''valuequantity''''' - значение услуги — Количество мест с данным набором параметров. Действует ограничение на общее количество мест в заказе. Если тип услуги bool, то Общее количество мест в значении передаем trueзаказе не может быть больше 1000.

*'''costcodedeliveryset''' - Кост-код сотрудника — настройка [[Дифференцированная стоимость доставки|дифференцированной стоимости доставки]]. Атрибуты::* '''''above_price''''' — стоимость в случае полного выкупа заказа (действует как «сумма от» последней границы, указанной в теге below_sum):* '''''return_price''''' — стоимость в случае возврата заказа:* '''''VATrate''''' — Ставка НДС — целое число процентов.

*'''overall_volumebelow''' - Общий объем, м3. Виртуальное поле. Необязательное. Из этого поля рассчитывается длина/высота/ширина места. Расчет срабатывает только если в каждом месте есть нулевые значения длины или высоты или ширины. — граница стоимости настроек:* '''''below_sum''''' — граница стоимости выкупаемого заказа:* '''''price''''' — стоимость выкупаемого заказа до соответствующей границы

*'''useridadvprices''' - Идентификатор пользователя, строковый или числовой тип — Контейнер для описания дополнительных услуг. Виртуальное полеНеобязательный элемент. Необязательное. Данное поле используется совместно с настройками <span style="Цена доставки для получателя", определяя приоритет правила. Можно использовать color: red;>Для обработки в API включите дополнительные услуги в различных CMSнастройках полей [[Личный кабинет курьерской службы#Настройка личного кабинета клиента|заказов и заборов]]</CRM системахspan>:* '''''code''''' — код услуги.:* '''''value''''' — значение услуги. Если тип услуги bool, настраивая цены для определенного покупателято в значении передаем true.

* '''overall_volume''' — Общий объем, м3. Виртуальное поле. Необязательное. Из этого поля рассчитывается длина/высота/ширина места. Расчет срабатывает только если в каждом месте есть нулевые значения длины или высоты или ширины. * '''userid''' — Идентификатор пользователя, строковый или числовой тип. Виртуальное поле. Необязательное. Данное поле используется совместно с настройками «Цена доставки для получателя», определяя приоритет правила. Можно использовать в различных CMS/CRM системах, настраивая цены для определенного покупателя. *'''groupid''' -  — Идентификатор группы пользователя, строковый или числовой тип. Виртуальное поле. Необязательное. Данное поле используется совместно с настройками "Цена «Цена доставки для получателя"получателя», определяя приоритет правила. Можно использовать в различных CMS/CRM системах, настраивая цены для определенной группы покупателей.

При передаче заказов, у которых плановая дата доставки/забора меньше ближайшей возможной, дата автоматически меняется на самую раннюю возможную. [[Личный_кабинет_курьерской_службыЛичный кабинет курьерской службы#Как считается минимальная дата возможной доставки|Подробнее]]</div>

В случае необходимости указания, помимо товаров, дополнительных услуг (например, ДОСТАВКА, комплектация, подъем на этаж и ти т.д д.) -  — их нужно указать в том же контейнере items как товары, без артикула.

При успешном выполнении запроса, создании заказа, возвращается сумма заказа в атрибуте orderprice, а также ошибка 0. При не успешном - успешном — номер ошибки и текст ее на английском языке в атрибуте errormsg, для некоторых ошибок выводится перевод на русский в атрибуте errormsgru.В атрибут orderno помещается номер заказа, в атрибут barcode - barcode — штрихкод заказа.

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

'''Пример ответа если нет == Запрос статуса заказов'''==

<?xml version="1.0" encoding="utfUTF-8"?><statusreq count> <auth extra="08"login="login" pass="pass"></auth> <client>CLIENT</client> <orderno>1234</orderno> <orderno2>5678</orderno2> <ordercode>34234</ordercode> <givencode>234534</givencode> <uid>af11c7c6-6645-4a20-9604-be911a75722d</uid> <datefrom>2016-07-21</datefrom> <dateto>2016-07-21</dateto> <target>Автозавод</target> <done>ONLY_NOT_DONE</done> <changes>ONLY_LAST</changes> <conditions> <namecontains/> <namestarts/> </conditions></statusreq>

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

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

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

 # Контейнер Периода запроса статусов (контейнеры '''statushistorydatefrom''' и '''deliverypricedateto''') ограничивается двумя месяцами — два месяца до даты '''«по»'' заполняется для тарифов [[Личный кабинет курьерской службы'.#Функции личного кабинета|Премиум и Максимум]]Если не указаны обе даты — '''dateto''' принимается равной текущей дате.# Система никогда Если не гарантирует последовательность прохождения заказом набора статусовуказана дата '''dateto''' — она принимается равной '''datefrom''' плюс 2 месяца. Т.е. Вы можете получить статус "COMPLETE", а следующим запросом - "NEW" - такое может произойти, например, если оператор ошибочно отметил заказ выполненным, а затем исправил ошибку# Если не указана дата '''datefrom''' — она принимается равной '''dateto''' минус 2 месяца.# Поиск по '''conditions''' работает только для «Номер заказа(шифр)» и только от 4 символов

<br />

=== Передача только изменившихся статусов Примеры ответов ===В нашем API предусмотрено очень удобное средство получения статусов всех заказов, без необходимости "бомбить" сервер запросами статусов по каждому заказу. Работает это так: раз в какое-то время, например, в 10 минут, вы посылаете запрос "А покажите все изменившиеся статусы". '''Пример запроса ниже. Система вам отдает ВСЕ заказы, статусы (или некоторые другие поля, см ниже) которых изменились с момента последнего запроса. Вы разбираете полученный документ, по каждому заказу сохраняете его актуальный статус в своей системе, и если все хорошо, у вас все получилось, ваша система неожиданно не упала от наплыва информации, посылаете нам запрос подтверждения получения статусов (commitlaststatus). Мы у себя отмечаем, что эти статусы вами получены, и их не надо передавать повторно. Т.о. сколько бы заказов у вас не было, статусы по ним всем почти в реальном времени вы можете получать всего 2-мя запросами.успешного ответа'''

<?xml version="1.0" encoding="UTF-8" ?><statusreqcount="23"> <auth extraorder orderno="111111" awb="qwerty" orderno2="8123123" loginordercode="login34534234" passgivencode="pass2345334"></auth> <changesbarcode>ONLY_LAST111111</changesbarcode> <streamidsender>1234 <company>МВД</streamidcompany> <person>Иванов И.И.</statusreqperson> <phone>123-45-67</sourcephone> <contacts>Система выдает все заказы, в которых, с момента последнего запроса в этом режиме, изменилось хотя бы одно из полей: <phone>+74951234567</phone> orderno </contacts> status <town code="23432">Санкт-Петербург</town> delivereddate deliveredtime deliveredto receiver- <address>date receiver-Петровка 38 офис 35</address>address price После успешной обработки ответа необходимо отметить полученные статусы успешно полученными, отправив запрос <date>2014-03-22</date> <time_min>09:00<source lang="xml"/time_min> <?xml version="1.0" encoding="UTF-8" ?time_max>14:00</time_max> <commitlaststatus/sender> <auth extra="8" login="login" pass="pass"></auth>receiver> <clientcompany>CLIENTМВД</clientcompany> <streamidperson>1234Иванов И.И.</streamidperson> </commitlaststatusphone></source> '''Описание полей запроса''' *'''auth''' 123-45-67 - АвторизацияИван (916)234. Обязательный элемент45.*'''streamid''' - Идентификатор потока. Если у вас несколько интеграций и каждая нуждается в получении статусов21 Петр, вы можете передавать данный параметр и тем самым разделять получение и отметку об успешном получении статусов по заказам. Значение должно входить в промежуток от 100 до 10000, включительно. Необязательный элементmvd@mail. ru</phone>*'''client''' - Признак клиента или агента. Необязательный элемент.:* CLIENT - Признак клиента, значение по умолчанию:* AGENT - Признак агента. В ответ отдается информация по заказам, переданным агенту на доставку В случае успеха Вы получите ответ <contacts> <phone>+74951234567<source lang="xml"/phone> <?xml version="1.0" encoding="UTF-8" ?phone>+79162344521</phone> <commitlaststatus error="0"email>OKmvd@mail.ru</commitlaststatusemail> </sourcecontacts> <inn>1112223335</inn>Данный способ передачи статусов гарантирует полную корректную передачу статусов, даже в случае, если в нашей системе статус изменился в промежутке времени между запросом статусов и подтверждением их получения. Если система не получила подтверждение успешной передачи статуса, она будет считать информацию не переданной, и выдаст ее при повторном запросе. <zipcode>125480</zipcode> <div styletown code="153361" regioncode="color: #a94442; background-color: #f2dede; border: 1px solid #ebccd1; padding: 3px 10px 10px;78" regionname="Санкт-Петербург город">Санкт-Петербург город</town>'''Обратите внимание!''' # При данном способе передачи ( <changesaddress>ONLY_LASTПетровка 38 офис 35</changesaddress> <area>Район 1</area> <pvz>) система просматривает заказы, оформленные за последние 3 месяца. Если заказ сделан ранее - изменение статуса по нему не попадет в результат выполнения данного запроса.# Система всегда выдает текущий статус. Т.е. Вы можете одним запросом получить статус "NEW", а следующим - "COMPLETE". В промежутке между запросами отправление могло пройти через несколько промежуточных статусов. Если нужна гарантия получения всех промежуточных статусов, нужно анализировать блок statushistory (может не заполняться в следствии ограничений версии или тарифа конкретной службы доставки). <code>126</code> <clientcode>QWERTY</clientcode># Система никогда не гарантирует последовательность прохождения заказом набора статусов. Т.е. Вы можете получить статус "COMPLETE", а следующим запросом </pvz> <date>2014- "NEW" 03- такое может произойти, например, если оператор ошибочно отметил заказ выполненным, а затем исправил ошибку.22</divdate> <time_min>09:00<br /time_min> <time_max>14:00</time_max> <coords lat="55.680327" lon= Трекинг заказа по номеру == Запрос трекинга по номеру предназначен для выдачи минимальной обезличенной информации о конкретном заказе не авторизованному пользователю. Наша система имеет для этого интерфейс по адресу "home37.courierexe.ru/{код экстра}/tracking604456". Вы можете либо сделать ссылку на такую страницу на своем сайте, либо разместить ее iframe'ом у себя, либо сделать свою и пользоваться нашим API. Этот интерфейс создан специально для выдачи информации живому пользователю сайта. Для получения статусов заказов в свою информационную систему нужно использовать запрос "statusreq", желательно с параметром changes=ONLY_LAST! '''Пример запроса:'''><source lang="xml"/coords> <?xml version="1.0" encoding="UTF-8"?deliveryPIN>1234</deliveryPIN> <tracking/receiver> <extraprice>8387.5</extraprice> <ordernoinshprice>1234387.5</ordernoinshprice> <paytype code="1">CASH</trackingpaytype> <weight>5.1</sourceweight> '''Пример ответа:''' <source lang="xml"quantity>2</quantity> <?xml version="1.0" encoding="UTF-8"?service>2<tracking/service> <order orderno="111111"type>3</type> <barcodereturn>111111NO</barcodereturn> <AWBreturn_service>1111112</AWBservice> <senderreturn_type>3</return_type> <town code="return_weight>5.1" country="RU">Москва город</townreturn_weight> <datereturn_message>2014-03-22Доставлено в целости</datereturn_message> <time_minpickup>09:00NO</time_minpickup> <time_maxprint_check>14:00YES</time_maxprint_check> <waittime>12</senderwaittime> <receiverenclosure> <town code="1" country="RU">Москва городДетские игрушки</townenclosure> <zipcodeinstruction>125480Проверить при покупателе, подписать акт</zipcodeinstruction> <date>2014-03-22</date> currcoords lat="55.680327" lon="37.604456" accuracy="50" RequestDateTime="2014-04-21 18:07:45"><time_min/currcoords>09:00 </time_mincourier> <time_maxcode>14:0026</time_maxcode> <name>Иванов Владимир Петрович</receivername> <pricephone>387.5+79161234567</pricephone> <inshprice>387.5</inshpricecourier> <paytype>CASH</paytypedeliveryprice total="158.6" delivery="100.00" return="58.6"> <weight>5.advprice code="1" price="150">База</weightadvprice> <quantityadvprice code="2" price="0">2% от объявленной стоимости</quantityadvprice> <serviceadvprice code="3" price="8.6">2Топливный сбор</serviceadvprice> <typeadvprice code="4" price="0">3Округление</typeadvprice> <return>NO</return/deliveryprice> <return_servicereceiverpays>2NO</servicereceiverpays> <return_dateacceptpartially>NO</return_dateacceptpartially> <return_time></return_time> <return_message></return_message> <waittime>12</waittime> <enclosure>Детские игрушки</enclosure> <instruction>Проверить при покупателе, подписать акт</instruction> <deliveryprice totalstatus eventstore="филиал в Санкт-Петербурге" eventtime="2016-06-02 17:22:00" createtimegmt="2016-06-03 16:14:44" message="158.6" deliverytitle="100.00Доставлен" eventtown="Санкт-Петербург город" returncolor="58.616777215" >COMPLETE</status> <courierstatushistory> <code>26</code> <name>Иванов Владимир Петрович</name> <phone>+79161234567</phone> </courier> <currcoords latstatus eventstore="Офис в Москве" eventtime="2016-05-30 10:20:00" createtimegmt="55.6803272016-06-03 16:14:44" lon message="37.604456" accuracytitle="50Новый" RequestDateTimeeventtown="2014-04-21 18:07:45Москва город" country="RU" >NEW</status> <status eventstore="филиал Офис в Санкт-ПетербургеМоскве" eventtime="2016-06-02 01 17:2238:00" createtimegmt="2016-06-03 16:14:44" message="филиал в Санкт-Петербурге" title="ДоставленПланируется отправка" eventtown="Москва город" country="RU">COMPLETEDEPARTURING</status> <statushistory> <status eventstore="Офис в Москве" eventtime="2016-0506-30 1001 19:2053:00" createtimegmt="2016-06-03 16:14:44" message="филиал в Санкт-Петербурге" title="НовыйОтправлено со склада">NEW</status> <status eventstoreeventtown="Офис Москва город" country="RU">DEPARTURE</status> <status eventstore="филиал в МосквеСанкт-Петербурге" eventtime="2016-06-01 1702 07:3841:00" createtimegmt="2016-06-03 16:14:44" message="филиал в " title="Получен складом" eventtown="Санкт-ПетербургеПетербург город" titlecountry="Планируется отправкаRU">DEPARTURINGACCEPTED</status> <status eventstore="Офис филиал в МосквеСанкт-Петербурге" eventtime="2016-06-01 1902 09:5317:00" createtimegmt="2016-06-03 16:14:44" message="филиал в Санкт-Петербурге" title="Отправлено со складаВыдан курьеру на доставку" eventtown=">DEPARTUREСанкт-Петербург город" country="RU">DELIVERY</status> <status eventstore="филиал в Санкт-Петербурге" eventtime="2016-06-02 0717:4122:00" createtimegmt="2016-06-03 16:14:44" message="" title="Получен складомДоставлен (предварительно)" eventtown=">ACCEPTED<Санкт-Петербург город" country="RU">COURIERDELIVERED</status> <status eventstore="филиал в Санкт-Петербурге" eventtime="2016-06-02 0917:1722:00" createtimegmt="2016-06-03 16:14:44" message="" title="Выдан курьеру на доставкуДоставлен" eventtown=">DELIVERY</Санкт-Петербург город" country="RU">COMPLETE</status> </statushistory> <status eventstore="филиал в Санкт-Петербурге" eventtime="2016-06-02 17:22:00" createtimegmt="customstatecode>2<customstatecode> <clientstatecode></clientstatecode> <deliveredto>Иванова, секр.</deliveredto> <delivereddate>2016-06-03 16:1402</delivereddate> <deliveredtime>17:44" message="" title="Доставлен (предварительно)">COURIERDELIVERED22</statusdeliveredtime> <status eventstore="филиал в Санкт-Петербурге" eventtime="2016department>Отдел</department> <costcode>cc12345</costcode> <outstrbarcode>EXT123456</outstrbarcode> <respstore>14</respstore> <partner>Офис на Ленина</partner> <arrival>2016-0605-02 1723:22:0021</arrival> <receipt fdNum="124555" createtimegmtfnSn="2016-06-03 16:14:449289000100295555" messagekktNum="0001611984048555" titleinn="Доставлен7722756555" fdValue="2899551555" summ="387.5" ofdUrl="gate.ofd.ru">COMPLETEhttps://ofd.ru/rec/7722756555/0001611984048555/9289000100295555/124555/2899551555</statusreceipt> </statushistoryitems> <deliveredto>Иванова, секр.</deliveredto> <delivereddate>2016-06-02</delivereddate> <deliveredtime>17:22</deliveredtime> <outstrbarcode>EXT123456</outstrbarcode> <items> <item codeitem code="34533" extcode="abc123" quantity="1" mass="0.2" retprice="37.5" VATrate="0" barcode="2345625213125" article="345331" extcodereturns="abc1230" quantityorigincountry="1040" massGTD="0.2" retpriceexcise="370.500" VATrategovernmentCode="011223311" barcodesuppcompany="2345625213125Поставщик" articlesuppINN="11112223334" returnssuppphone="079161234567" origincountry>Мяч</item> <item code="04034456" GTDextcode="abc124" excisequantity="0.002" governmentCodemass="112233112" suppcompanyretprice="Поставщик100" VATrate="10" barcode="4645625213138" article="2" suppINNreturns="11122233340" suppphonegovernmentCode="79161234567">МячОбруч</item> <item code="3445634421" extcode="abc124abc125" quantity="23" mass="20.3" retprice="10050" VATrate="1018" barcode="46456252131382345625213126" itemcode="44123" article="23" returns="0" governmentCode="">ОбручПогремушка желтая</item> <item code/items> <packages> <package code="33331" strbarcode="ORD0000001" mass="1" message="" got="34421YES" extcode></package> <package code="abc12533332" quantitystrbarcode="3ORD0000002" mass="02.35" message="" retprice="50" VATrate="18" barcode="2345625213126" article="3" returns="0" governmentCodegot="NO">Погремушка желтая</itempackage> </itemspackages>

</trackingstatusreq> </source> '''Пример ответа если нет заказов''' <source lang="xml"><?xml version="1.0" encoding="utf-8"?><statusreq count="0"></statusreq>

<source lang="xml"><?xml version="1.0" encoding="utf-8"?><request><error error="1" errormsg="authorization error"></error></request></source> '''Получение информации в формате 17 TRACKПример ответа при ошибке синтаксиса'''

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

=== Описание полей ответа статусов ===Все поля ответа соответствуют структуре order при создании заказа, с некоторыми добавлениями: * Атрибуты контейнера '''order'''::* '''''awb'''''Пример ответа — Номер накладной в системе курьерской службы.:* '''''orderno2''''' — Номер накладной в подсистеме срочной доставки курьерской службы.<pre>{:* '''''ordercode''''' — внутренний код заказа в системе, применяется для некоторых внутренних операций. "number":"ExtNumber"* '''''givencode''''' — внутренний код заказа в системе,применяется для некоторых внутренних операций. *'''paytype''' - Тип оплаты заказа получателем. Принимает значения::: CASH - Наличными при получении (по-умолчанию):: CARD - Картой при получении "oriNumber":"1234": NO - Без оплаты.:: OTHER - Прочее (Предусмотрен для того, чтобы оплата поступала непосредственно в курьерскую службу посредством прочих типов оплаты - таких как: вебмани, яденьги, картой на сайте,прочие платежные системы и т.д.) "oriCountry"* Атрибуты контейнера '''paytype''':** '''''code''''' - (integer) внутренний код типа оплаты заказа в системном справочнике "RUТипы оплаты корреспонденции". Не обязательный элемент.  * атрибут '''''code''''' контейнера '''item''' — внутренний код строки заказа в системе,применяется для некоторых внутренних операций. "destCountry":"RU"* '''''returns''''' — количество данного товара,от которого отказался получатель. Не нулевое только в случае частичного отказа. * атрибут '''''got''''' контейнера '''package''' — признак принятого места YES / NO. "status":"Complete"* '''''returns''''' — количество данного товара,от которого отказался получатель. Не нулевое только в случае частичного отказа.  "events"* '''''area''''' в контейнере '''receiver''' — район/метро получателя.* '''''coords''''' в контейнере '''receiver''' — координаты получателя.* '''''deliveryPIN''''' в контейнере '''receiver''' — Пин-код.* '''pickup''' — признак оформления забора, возможные значения:['''YES''', '''NO'''. Если указано '''YES''', то весь заказ считается заданием на забор груза, а не на доставку. {* '''currcoords''' — текущие координаты заказа. Атрибуты: "time":"2016-06-02 17* '''''lat''''' — широта:22* '''''lon''''' — долгота:00",* '''''accuracy''''' — точность в метрах "location":"RU"* '''''RequestDateTime''''' — дата/время последнего обновления координат. * '''courier''' — Данные курьера, которому выдан заказ. Если заказ не выдан,то выводятся данные запланированного курьера.* '''waittime ''' — Время ожидания курьера. "content"* '''deliveryprice''' — Стоимость услуг в валюте расчетов с клиентом. Атрибуты:"Complete" },:* '''''total''''' — общая стоимость услуг {:* '''''delivery''''' — стоимость доставки «Туда» "time":"2016* '''''return''''' — стоимость доставки «Обратно» (если order-06-02 17>return=YES)Тэг '''deliveryprice''' включает список дополнительных услуг (только для тарифа «Премиум»)::22* '''''advprice''''' — наименование дополнительной услуги:00",* '''''code''''' — код дополнительной услуги "location":"RU",* '''''price''''' — стоимость дополнительной услуги  "content"* '''status''' — статус доставки (список статусов см. ниже). Атрибуты (заполняются начиная с версии системы 2008.0.0.670):"Courierdelivered" }:* '''''eventstore''''' — филиал,к которому относится текущий статус {:* '''''eventtime''''' — время события по часовому поясу места его наступления. :* '''''createtimegmt''''' — время по GMT создания записи о смене статуса в БД. Используется для сортировки записей, чтобы соблюсти хронологическую последовательность. <spoiler text="timeПодробнее">Большинство событий фиксируются в полях eventtime и createtimegmt на основании одного действия, тогда они отличаются только сдвигом от GMT. Однако, если курьер доставил отправление 10.10.2010 в 20:"201600, по какой-06-02 09то причине не внес это в мобильное приложение, на следующий день сдал накладную, и в 9 утра оператор внесла, что он доставил вчера в 20:1700. Тогда в createtimegmt будет сегодня 6 утра (для Москвы), а в eventtime — вчера в 20:00". При этом оператор по каким-то причинам может внести время вручения раньше, чем какое-то предыдущее событие, т.о. нарушится последовательность времени в eventtime,но при сортировке по createtimegmt все-равно все будет правильно.</spoiler> "location":"RU"* '''''message''''' — наименование филиала-получателя,при передаче между филиалами "content":"Delivery"* '''''title''''' — русское наименование статуса * '''statushistory''' — история статусов доставки. Содержит список контейнеров '''status'''. Заполняется только для тарифа «Премиум» начиная с версии системы 2008.0.0.670.* '''customstatecode''' — код внутреннего статуса курьерской службы. Значения уточняйте в курьерской службе. Назначаются курьерской службой в разделе «Справочники» — «Статусы» — «15 Статусы корреспонденции». Справочник не передается через API клиенту по причине возможного наличия в нем внутренних технологических статусов курьерской службы.* '''clientstatecode''' — код статуса клиента. Используется, если клиент предлагает свои коды статусов доставки/причин недоставки. }* '''deliveredto''' — данные из поля «Инфо. о доставке» (может быть информация о доставке,причина недоставки и т. п.).* '''delivereddate''' — дата вручения. {* '''deliveredtime''' — время вручения. В случае недоставки может быть пустым. "time":"2016* '''arrival''' — плановая дата прибытия в формате гггг-06мм-02 07дд чч:41мм:00"сс. Заполняется только при использовании автоматических систем планирования (Максоптра, Яндекс доставка), во всех остальных случаях - пустое.* '''outstrbarcode''' — код у подрядчика (код заказа во внешней системе). Используется в интеграциях с внешними системами.* '''partner''' — текущий филиал/подрядчик.* '''return_message''' — информация о возврате* '''department''' — Подразделение,в котором оформляется заказ. Контейнер '''status''' может принимать следующие значения:: AWAITING_SYNC — Ожидает синхронизации. Данные заказа пока не появились в службе доставки. "location":"RU"'''NEW''' — Успешно создан,передан в службу доставки.: NEWPICKUP — Создан забор.: PICKUP — Забран у отправителя.: WMSASSEMBLED — Скомплектован на складе фулфилмента.: WMSDISASSEMBLED — Разукомплектован на склад фулфилмента.: '''ACCEPTED''' — Получен складом.: CUSTOMSPROCESS — Производится таможенный контроль.: CUSTOMSFINISHED — Таможенный контроль произведен.: CONFIRM — Согласована доставка.: UNCONFIRM — Не удалось согласовать доставку. "content":"Accepted"DEPARTURING — Планируется отправка со склада на другой склад. },: DEPARTURE — Отправлено со склада на другой склад. {: INVENTORY — Инвентаризация. Убедились в наличии отправления на складе. "time":"2016-06-01 19PICKUPREADY — Готов к выдаче в ПВЗ.:53'''DELIVERY''' — Выдан курьеру на доставку.:00"COURIERDELIVERED — Доставлен (предварительно, ожидает подтверждения менеджером,чтобы перейти в статус COMPLETE). "location":"RU"COURIERPARTIALLY — Частично доставлен (предварительно, ожидает подтверждения менеджером,чтобы перейти в статус PARTIALLY). "content":"Departure"COURIERCANCELED — Отказ (предварительно, после этого ожидается COURIERRETURN). }: COURIERRETURN — Возвращено курьером. Курьер не смог доставить до получателя и вернул заказ обратно на склад. Это промежуточный статус,после которого менеджер выясняет, нужно ли повторно доставлять (статусы DATECHANGE/DELIVERY) или это окончательная недоставка (CANCELED).: DATECHANGE — Перенос даты доставки. { "time":"2016-06-01 17'''COMPLETE''' — Доставлен.:38'''PARTIALLY''' — Доставлен частично.:00"'''CANCELED''' — Не доставлен (Возврат/Отмена). После этого статуса отправление должны вернуть заказчику,будут статусы RETURNING и RETURNED : RETURNING — Планируется возврат заказчику (после CANCELED).: RETURNED — Возвращен заказчику.: LOST — Утрачен/утерян. : PARTLYRETURNING — Планируется возврат остатков.: PARTLYRETURNED — Остаток возвращен.: TRANSACCEPTED — Прибыл на склад перевозчика. "location":"RU",PICKUPTRANS — Забран у перевозчика.  '''Примечание.''' В будущем возможно дополнение используемого набора статусов.  "content<div style="color: #a94442; background-color: #f2dede; border: 1px solid #ebccd1; padding:3px 10px 10px;"Departuring">'''Обратите внимание!''' # Контейнер '''statushistory''' и '''deliveryprice''' заполняется для тарифов [[Личный кабинет курьерской службы#Функции личного кабинета|Премиум и Максимум]]. }# Система никогда не гарантирует последовательность прохождения заказом набора статусов. То есть Вы можете получить статус «COMPLETE», а следующим запросом — «NEW» — такое может произойти,например, если оператор ошибочно отметил заказ выполненным, а затем исправил ошибку. {</div><br> "time"=== Передача только изменившихся статусов ===В нашем API предусмотрено удобное средство получения статусов всех заказов, без необходимости «бомбить» сервер запросами статусов по каждому заказу. Работает это так:"2016-05-30 раз, например, в 10минут, вы посылаете запрос «покажите все изменившиеся статусы». Пример запроса ниже. Система вам отдает ВСЕ заказы, статусы (или некоторые другие поля, см. ниже) которых изменились с момента последнего запроса. Вы разбираете полученный документ, по каждому заказу сохраняете его актуальный статус в своей системе, и если все хорошо, у вас все получилось, ваша система неожиданно не упала от наплыва информации, посылаете нам запрос подтверждения получения статусов (commitlaststatus). Мы у себя отмечаем, что эти статусы вами получены и их не надо передавать повторно. Таким образом, сколько бы заказов у вас ни было, статусы по ним всем почти в реальном времени вы можете получать всего двумя запросами. Для получения только изменившихся статусов отправьте запрос:20:00<source lang="xml",> <?xml version="location1.0":encoding="RUUTF-8",?><statusreq> <auth extra="content8":login="login" pass="Newpass"></auth> } <changes>ONLY_LAST</changes> ] <streamid>1234</streamid></statusreq>}</presource>

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

'''Обратите внимание!'''# Данные запроса изменения указываются '''полностью'''При этом способе передачи (<changes>ONLY_LAST</changes>) система просматривает заказы, как если бы оформленные за последние 3 месяца. Если заказ создавался впервыесделан ранее, изменение статуса по нему не попадет в результат выполнения запроса.# При отсутствии вложения в запросе изменения данное вложение '''Система всегда выдает текущий статус. Вы можете одним запросом получить статус «NEW», а следующим — «COMPLETE». Между запросами отправление могло пройти через несколько промежуточных статусов. Если нужна гарантия получения всех промежуточных статусов, нужно анализировать блок statushistory (может не удаляется''' из заказа, но его количество становится равным 0заполняться вследствие ограничений версии или тарифа конкретной службы доставки).# При одновременном изменении заказа в API и системе курьерской службы приоритет отдается данным системы курьерской службыСистема не гарантирует последовательность прохождения заказом набора статусов. Вы можете получить статус «COMPLETE», а следующим запросом «NEW» — такое может произойти, например, если оператор ошибочно отметил заказ выполненным, а затем исправил ошибку. То есть изменения в API приняты не будут!

=== Описание полей запроса изменения =Трекинг заказа по номеру ==Все поля запроса соответствуют структуре order при создании заказа за исключением:* вместо корневого тэга '''neworder''' указывается '''editorder'''* тэг штрих-кода '''barcode''' Запрос трекинга по номеру предназначен для выдачи минимальной обезличенной информации о конкретном заказе не указывается, поскольку присваивается при создании заказаавторизованному пользователю.* Наша система имеет для вложений '''item''' указывается внутренний этого интерфейс по адресу «home.courierexe.ru/{код вложения в атрибуте '''code''', который можно получить при получении статуса заказа. === Описание полей ответа изменения ===Все поля ответа соответствуют ответу при создании заказа за исключением корневого тэга — вместо '''neworder''' возвращается '''editorder'''экстра}/tracking». == Отмена заказа ==Запрос предназначен для отмены заказовВы можете либо сделать ссылку на такую страницу на своем сайте, по которым не было произведено изменений статуса доставкилибо разместить ее [[#Размещение страниц на своем сайте (iframe)|iframe’ом]] у себя, статуса корреспонденции, времени доставки, то есть заказов, которые ещё не в работелибо сделать свою и пользоваться нашим API. Отменять заказы могут курьерские службы с тарифами «Премиум» и «Максимум»Этот интерфейс создан специально для выдачи информации живому пользователю сайта. Чтобы разрешить отмену Для получения статусов заказов, в личном кабинете курьерской службы перейдите в '''Параметры''' > '''Расширенные''' и установите флажок '''Разрешить отмену и изменение заказов'''. При отмене заказа поле «Инфо о доставке» получает значение «Отменено заказчиком»свою информационную систему нужно использовать запрос «statusreq», поле «Дата доставки» — текущую дату, а «Вручил курьер» — системную запись «ОТМЕНА».желательно с параметром changes=ONLY_LAST! '''Пример запроса отмены заказа:'''

<?xml version="1.0" encoding="UTF-8" ?><cancelordertracking> <auth extra=">8" login="login" pass="pass" </extra> <order orderno="" ordercode="123456" /> 1234<order /orderno="123aaa" ordercode="" /></cancelordertracking>

 '''Описание полей:''' '''cancelorder''' — Корневой контейнер. Обязательный элемент.* '''auth''' — Авторизация. Обязательный элемент.* '''order''' — Контейнер отменяемого заказа. Обязательный элемент. Запрос может содержать более одного контейнера '''order'''. Атрибуты::* '''''orderno''''' — Шифр заказа.:* '''''ordercode''''' — Внутренний код заказа.Обратите внимание, что должен быть указан хотя бы один из атрибутов ''orderno'' или ''ordercode''!  '''Пример ответа:'''<source lang="xml"><?xml version="1.0" encoding="UTF-8" ?><cancelordertracking> <order orderno="123test111111" ordercode> <barcode>111111</barcode> <AWB>111111</AWB> <sender> <town code="1234561" errorcountry="0RU" errormsg>Москва город</town> <date>2014-03-22</date> <time_min>09:00</time_min> <time_max>14:00</time_max> </sender> <receiver> <town code="OK1" errormsgrucountry="УспешноRU" >Москва город</town> <zipcode>125480</zipcode> <date>2014-03-22</date> <time_min>09:00</time_min> <time_max>14:00</time_max> </receiver> <price>387.5</price> <inshprice>387.5<order orderno/inshprice> <paytype>CASH</paytype> <weight>5.1</weight> <quantity>2</quantity> <service>2</service> <type>3</type> <return>NO</return> <return_service>2</return_service> <return_date></return_date> <return_time></return_time> <return_message></return_message> <waittime>12</waittime> <enclosure>Детские игрушки</enclosure> <instruction>Проверить при покупателе, подписать акт</instruction> <deliveryprice total="158.6" delivery="100.00" return="123aaa58.6" ordercode/> <courier> <code>26</code> <name>Иванов Владимир Петрович</name> <phone>+79161234567</phone> </courier> <currcoords lat="55.680327" errorlon="5237.604456" errormsgaccuracy="order not found50" errormsgruRequestDateTime="Заказ не найден2014-04-21 18:07:45" /> <status eventstore="филиал в Санкт-Петербурге" eventtime="2016-06-02 17:22:00" createtimegmt="2016-06-03 16:14:44" message="" title="Доставлен">COMPLETE</cancelorderstatus> <statushistory> <status eventstore="Офис в Москве" eventtime="2016-05-30 10:20:00" createtimegmt="2016-06-03 16:14:44" message="" title="Новый">NEW</sourcestatus> <status eventstore="Офис в Москве" eventtime="2016-06-01 17:38:00" createtimegmt="2016-06-03 16:14:44" message="филиал в Санкт-Петербурге" title="Планируется отправка">DEPARTURING</status> <status eventstore="Офис в Москве" eventtime="2016-06-01 19:53:00" createtimegmt= Добавление вложений к накладной "2016-06-03 16:14:44" message="филиал в Санкт-Петербурге" title="Отправлено со склада">DEPARTURE</status> '''Пример запроса <status eventstore="филиал в Санкт-Петербурге" eventtime="2016-06-02 07:41:00" createtimegmt="2016-06-03 16:14:'''44" message="" title="Получен складом">ACCEPTED</status> <source langstatus eventstore="филиал в Санкт-Петербурге" eventtime="2016-06-02 09:17:00" createtimegmt="2016-06-03 16:14:44" message="" title="xmlВыдан курьеру на доставку">DELIVERY</status> <?xml versionstatus eventstore="филиал в Санкт-Петербурге" eventtime="1.02016-06-02 17:22:00" encodingcreatetimegmt="UTF2016-06-803 16:14:44" message="" title="Доставлен (предварительно)" ?>COURIERDELIVERED<addattachments/status> <auth extrastatus eventstore="филиал в Санкт-Петербурге" eventtime="2016-06-02 17:22:00" createtimegmt="82016-06-03 16:14:44" loginmessage="login" passtitle="passДоставлен" >COMPLETE</status> <orderno/statushistory> <deliveredto>Иванова, секр.</deliveredto> <delivereddate>2016-06-02</delivereddate> <deliveredtime>17:22</deliveredtime> <outstrbarcode>1234567EXT123456</ordernooutstrbarcode> <attachmentsitems> <item namecode="34533" extcode="abc123" quantity="1" mass="0.2" retprice="37.5" VATrate="0" barcode="2345625213125" article="1" returns="0" origincountry="040" GTD="" excise="photo10.jpg00" governmentCode="11223311" suppcompany="Поставщик" suppINN="1112223334" suppphone="79161234567">JVBERi0xLjMN1wb25lbnQgMQМяч</item> JUBQREYwMTIzNDU2Nzg5IDI NMyAwIG9iag08PA0vVHlwZSA U3VidHlwZSAvSW1hZ2UNL1d pZHRoIDE4MDgNL0hlaWdodCA ggNCAwIFINL0JpdHNQZXJDb 21wb25lbnQgMQ0vRGVjb2RlU ENL0NvbHVtbnMgMTgwOA0+P g0vSW1hZ2VNYXNrIHRydWUNL XhEZWNvZGUNPj4Nc3RyZWFt DQ <item code="34456" extcode="abc124" quantity="2" mass="2" retprice="100" VATrate="10" barcode="4645625213138" article="2" returns="0" governmentCode="">Обруч</item> <item namecode="34421" extcode="abc125" quantity="3" mass="photo20.jpg3" retprice="50" VATrate="18" barcode="2345625213126" article="3" returns="0" governmentCode="">VBERi0xLjMNAwIG9iag0HRoJПогремушка желтая</item> JUBQREYwMTIzNDU2Nzg5IDI NMyAwIG9iag08PA0vVHlwZSA vWE9iamVjdA0vU3VidHlwZS AvSW1hZ2UNL1dpZHRoIDEzNj gNL0hlaWdodCAxMzMzDS9MZ W5ndGggNCAwIFINL0JpdHNQZ XJDb21wb25lbnQgMQ0vRGVj b2RlUGFybXMgPDwNL0sgLTEN L0NvbHVtbnMgMTM2OA0+Pg0 vSW </itemitems> </attachmentsorder></addattachmentstracking></source>

'''Описание полей:Получение информации в формате 17 TRACK'''

'''addattachments''' - Корневой контейнер. Обязательный элемент.*'''auth''' - Авторизация. Обязательный элемент.*'''orderno''' - Номер заказа. Обязательный элемент. Может использоваться тэг <ordercode> с указанием внутреннего кода заказа.*'''attachments''' - Обязательный элемент, в котором перечисляются передаваемые данные файлов.**'''item''' - Бинарные данные (файл), закодированные в base64. Обязательный элемент.***'''name''' - Атрибут элемента '''item''', в котором передается имя файла. Обязательный элемент.  '''Пример ответазапроса:'''

<addattachmentstracking17> <attachmentsextra> <item name="photo1.jpg" error="0" errormsg="OK" errormsgru="Успешно" /> <item name="photo2.jpg" error="0" errormsg="OK" errormsgru="Успешно" /> </attachments>8</addattachments></source> == Получение вложений к накладной == '''Пример запроса:'''<source lang="xml"><?xml version="1.0" encoding="UTF-8" ?><attachments> <auth extra="8" login="login" pass="pass" /> <orderno>12345671234</orderno></attachmentstracking17></source> '''Описание полей:''' '''attachments''' - Корневой контейнер. Обязательный элемент.*'''auth''' - Авторизация. Обязательный элемент.*'''orderno''' - Номер/код заказа. Обязательный элемент. 

<source lang=pre>{ "number":"ExtNumber", "oriNumber":"1234", "oriCountry":"RU", "destCountry":"RU", "status":"Complete", "events":[ { "time":"2016-06-02 17:22:00", "location":"RU", "content":"xmlComplete" }, { ">time":"2016-06-02 17:22:00", "location":"RU", "content":"Courierdelivered" }, { "time":"2016-06-02 09:17:00", "location":"RU", "content":"Delivery" }, {<?xml version= "1.0time" encoding=:"UTF2016-806-02 07:41:00"?>, "location":"RU", "content":"Accepted" },<attachments> { <item name= "doc1.docxtime" size=:"356542016-06-01 19:53:00">JVBERi0xLjMN, JUBQREYwMTIzNDU2Nzg5IDI NMyAwIG9iag08PA0vVHlwZSA "location":"RU", U3VidHlwZSAvSW1hZ2UNL1d pZHRoIDE4MDgNL0hlaWdodCA "content":"Departure" ggNCAwIFINL0JpdHNQZXJDb 21wb25lbnQgMQ0vRGVjb2RlU }, ENL0NvbHVtbnMgMTgwOA0+P g0vSW1hZ2VNYXNrIHRydWUNL { XhEZWNvZGUNPj4Nc3RyZWFt DQ</item> "time":"2016-06-01 17:38:00", "location":"RU", <item name= "photo2.jpgcontent" size=:"74861Departuring">VBERi0xLjMN JUBQREYwMTIzNDU2Nzg5IDI NMyAwIG9iag08PA0vVHlwZSA }, { vWE9iamVjdA0vU3VidHlwZS AvSW1hZ2UNL1dpZHRoIDEzNj "time":"2016-05-30 10:20:00", gNL0hlaWdodCAxMzMzDS9MZ W5ndGggNCAwIFINL0JpdHNQZ "location":"RU", XJDb21wb25lbnQgMQ0vRGVj b2RlUGFybXMgPDwNL0sgLTEN "content":"New" L0NvbHVtbnMgMTM2OA0+Pg0 vSW</item> }</attachments> ]}</sourcepre> В тегах item возвращаются бинарные данные (файлы), закодированные в base64.

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

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

<div style="color: #a94442; background-color: #f2dede; border: 1px solid #ebccd1; padding: 3px 10px 10px;">'''Обратите внимание!'''# Данные запроса изменения указываются '''полностью''', как если бы заказ создавался впервые.# При необходимости к заказу отсутствии вложения в запросе изменения данное вложение '''не удаляется''' из заказа, но его количество становится равным 0.# При одновременном изменении заказа в API и системе курьерской службы приоритет отдается данным системы курьерской службы. То есть изменения в API приняты не будут.</div> При редактировании заказа может быть отменен запланированный курьер. Это зависит от значения переменной '''Справочники''' > '''Переменные''' > '''Корреспонденция''' > '''Автоматически устанавливать заплан. курьера по району''':* '''Нет''' — при редактировании заказа по АПИ курьер не изменяется;* '''Район''' — если изменен адрес доставки, курьер сбрасывается;* '''Район или дата план. доставки''' — если изменен адрес доставки или плановая дата вручения, курьер сбрасывается. === Описание полей запроса изменения ===Все поля запроса соответствуют структуре order при создании заказа за исключением: * значение '''orderno''' данным методом изменить нельзя.* значение '''barcode''' изменяется в случае явного его указания. В случае отсутствия или пустого значения - остается прежним.* вместо корневого тэга '''neworder''' указывается '''editorder''';* тэг курьера '''courier''' можно изменить только при включенной настройке '''Разрешить изменение курьера по АПИ''';* для вложений '''item''' указывается внутренний код вложения в атрибуте '''code''', который можно получить при получении статуса заказа.* для мест '''package''' указывается внутренний код вложения в атрибуте '''code''', который можно прикрепить изображенияполучить при получении статуса заказа.  Необходимо иметь в виду, что: # Заказ нельзя изменить, пока он не синхронизирован с системой (пока предыдущие изменения не переданы в бэк-офис)# Удаление вложений и мест выполняется не моментально, а в процессе синхронизации с бэк-офисом (для записей указываются метки Удалено) === Описание полей ответа изменения ===Все поля ответа соответствуют ответу при создании заказа за исключением корневого тэга — вместо '''neworder''' возвращается '''editorder'''. == Отмена заказа ==Запрос предназначен для отмены заказов. Отменять заказы могут курьерские службы с тарифами «Премиум» и «Максимум». Разрешения для отмены заказов и статусы в которых заказы можно отменять описаны в разделе '''Изменение заказов''' При отмене заказа поле «Инфо о доставке» получает значение «Отменено заказчиком», поле «Дата доставки» — текущую дату, а «Вручил курьер» — системную запись «ОТМЕНА».

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

<setorderinfocancelorder>

<order orderno="" ordercode="123456"> <message>Получил Иванов</message> <outstrbarcode>7654312</outstrbarcode> </order> <order ordercodeorderno="234567123aaa"> <status>PICKUPREADY</status> <eventtime>2016-05-30 10:20:00</eventtime> <message>Клиент отказался от покупки</message> <paytype>CASH</paytype> <items> <item code="34533" quantityordercode="1" reason="0" /> <item code="34456" quantity="0" reason="0" /> <item code="34421" quantity="2" reason="0" /> </items> <image filename="filename1.jpg"> /9j/4AAQSkZJRgA BAQAAAQABAAD/2wBDAA0JCg sKCA0LCgsODg0PEyAVExISEy ccHhcgLikxMC4pLSwzOko+M zZGNywtQFdBRkxOUlNSMj5aY VpQYEpRUk//2wBDAQ4ODhMR EyYVFSZPNS01T09PT09PT09P T09PT09PT09PT09PT09PT09 PT09PT09PT09PT09PT09PT09 PT09PT0//wAARCAYACAADAS IA</image> </order></setorderinfocancelorder>

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

<?xml version="1.0" encoding="UTF-8"?><setorderinfocancelorder> <order orderno="123test" ordercode="123456" error="0" errormsg="OK" errormsgru="Успешно" /> <order orderno="123aaa" ordercode="234567" error="5952" errormsg="value [date_put] is already setorder not found" errormsgru="Значение [Дата доставки] уже указаноЗаказ не найден" /></setorderinfocancelorder>

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

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

<waybilladdattachments>

<ordersorderno>1234567</orderno> <attachments> <order ordernoitem name="1234567" ordercode="33331photo1.jpg" >JVBERi0xLjMN1wb25lbnQgMQ JUBQREYwMTIzNDU2Nzg5IDI NMyAwIG9iag08PA0vVHlwZSA U3VidHlwZSAvSW1hZ2UNL1d pZHRoIDE4MDgNL0hlaWdodCA ggNCAwIFINL0JpdHNQZXJDb 21wb25lbnQgMQ0vRGVjb2RlU ENL0NvbHVtbnMgMTgwOA0+P g0vSW1hZ2VNYXNrIHRydWUNL XhEZWNvZGUNPj4Nc3RyZWFt DQ</item> <order ordernoitem name="1234568photo2.jpg" ordercode="33332" />VBERi0xLjMNAwIG9iag0HRoJ JUBQREYwMTIzNDU2Nzg5IDI NMyAwIG9iag08PA0vVHlwZSA vWE9iamVjdA0vU3VidHlwZS AvSW1hZ2UNL1dpZHRoIDEzNj gNL0hlaWdodCAxMzMzDS9MZ W5ndGggNCAwIFINL0JpdHNQZ XJDb21wb25lbnQgMQ0vRGVj b2RlUGFybXMgPDwNL0sgLTEN L0NvbHVtbnMgMTM2OA0+Pg0 vSW</ordersitem> <form>1</formattachments></waybilladdattachments>

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

<waybilladdattachments> <contentattachments>EODIcaI8KSBlwQ 4MnEOR7Px8U8EBAyGICBnwpw IZhQgz0ZxuPs8EBM <item name="photo1.jpg" error="0" errormsg="OK" errormsgru="Успешно" /GcbjzB AwhBl8hwQYIO00GmEwg1CeEG > mqYTChNU0wqf8l8nz4zgc+K fCno+zwU5GjOZmzXGcbEQYIM 4zkegRE40zWzONyoNNMIOIa cWnp6aDCGEGE9NQmoQd2mg00 79U4f3hPTwnfp6Sdrafeqpa JDpFw <item name="photo2.jpg" error="0" errormsg="OK" errormsgru="Успешно" /1aYT077VNNNdO00G3q > mqqvp9p2E7T0/wiFemv8uG6 OM</contentattachments></waybilladdattachments>

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

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

<townlistattachments> <auth extraitem name="doc1.docx" size="835654" />JVBERi0xLjMN <codesearch>JUBQREYwMTIzNDU2Nzg5IDI NMyAwIG9iag08PA0vVHlwZSA <zipcode>110000</zipcode> U3VidHlwZSAvSW1hZ2UNL1d pZHRoIDE4MDgNL0hlaWdodCA <kladrcode>0100000100800</kladrcode> ggNCAwIFINL0JpdHNQZXJDb 21wb25lbnQgMQ0vRGVjb2RlU <fiascode>bd21979d-46f8-49d0-9105-e8d65172a983</fiascode> <code>123</code> ENL0NvbHVtbnMgMTgwOA0+P g0vSW1hZ2VNYXNrIHRydWUNL XhEZWNvZGUNPj4Nc3RyZWFt DQ</codesearchitem> <conditions> <city>Краснодарский край</city> <namecontains>новгород</namecontains> <namestarts>Моск</namestarts> <name>Москва</item name="photo2.jpg" size="74861">VBERi0xLjMN <fullname>Москва город</fullname> JUBQREYwMTIzNDU2Nzg5IDI NMyAwIG9iag08PA0vVHlwZSA <country>1</country> vWE9iamVjdA0vU3VidHlwZS AvSW1hZ2UNL1dpZHRoIDEzNj </conditions>gNL0hlaWdodCAxMzMzDS9MZ W5ndGggNCAwIFINL0JpdHNQZ <limit> <limitfrom>30</limitfrom> <limitcount>10</limitcount> <countall>YES</countall>XJDb21wb25lbnQgMQ0vRGVj b2RlUGFybXMgPDwNL0sgLTEN L0NvbHVtbnMgMTM2OA0+Pg0 vSW</limititem></townlistattachments>

Внутри контейнера townlist все элементы могут как отсутствоватьВ тегах item возвращаются бинарные данные (файлы), так и комбинироваться. Поиск не чувствителен к региструзакодированные в base64.

*'''auth''' - Авторизация, необязательный элемент. Используется в случае включенного и настроенного ограничения по населенным пунктам в конкретной курьерской службе== Изменение статуса агентом ==Запрос изменения статуса заказа позволяет установить окончательный статус заказа — «Доставлен» или «Не доставлен (Возврат/Отмена)».

*'''codesearch''' - Поиск по кодам. В случае использования - контейнеры conditions Кроме этого, устанавливается дата и limit игнорируются.:* '''zipcode''' - Поиск по индексу. Обратите внимание на то, что один почтовый индекс может распространяться на несколько населенных пунктов. В этом случае система вернет несколько записей.:* '''kladrcode''' - Поиск по 13-ти значному коду КЛАДР.:* '''fiascode''' - Поиск по коду ФИАС время (AOGUIDпри необходимости).:* изменения статуса, а также сообщение в поле ''Инфо о доставке'code''' - Поиск по коду в системе.

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

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

<?xml version="1.0" encoding="UTF-8"?><townlist countsetorderinfo> <auth extra="38" pagelogin="1login" totalcountpass="3" totalpages="1pass"/> <townorder ordercode="123456"> <codemessage>26379Получил Иванов</codemessage> <cityoutstrbarcode> <code>237654312</codeoutstrbarcode> <name>Краснодарский край </nameorder> </cityorder ordercode="234567"> <namestatus>Сочи городPICKUPREADY</namestatus> <fiascodeeventtime>79da737a2016-603b05-4c19-9b54-9114c96fb91230 10:20:00</fiascodeeventtime> <kladrcodemessage>2300000700000Клиент отказался от покупки</kladrcodemessage> <shortname paytype>CASH</paytype> (not yet supported) <typename storeprice>123</storeprice> (not yet supported) <coords latitems> <item code="34533" quantity="1" reason="43.58550" longovernmentCode="39.723111223311" /> <item code="34456" quantity="0" reason="0" /town> <townitem code="34421" quantity="2" reason="0" /> <code>40331</codeitems> <cityimage filename="filename1.jpg"> <code>32</code> <name>Брянская область<9j/name>4AAQSkZJRgA <BAQAAAQABAAD/city>2wBDAA0JCg sKCA0LCgsODg0PEyAVExISEy <name>Сочилов хутор</name>ccHhcgLikxMC4pLSwzOko+M zZGNywtQFdBRkxOUlNSMj5aY <fiascode>c9c96c67-2cc9-4f10-afde-fd32417ea216<VpQYEpRUk//fiascode>2wBDAQ4ODhMR EyYVFSZPNS01T09PT09PT09P <kladrcode>3201900011100</kladrcode>T09PT09PT09PT09PT09PT09 PT09PT09PT09PT09PT09PT09 PT09PT0//wAARCAYACAADAS IA<shortname /image> <typename /order> <coords lat="52.6407" lon="33.1724" /setorderinfo> </townsource> <town> <code>114016</code> <city>'''Описание полей запроса статуса:''' '''setorderinfo''' — Корневой контейнер. Обязательный элемент.* '''auth''' — Авторизация. Обязательный элемент.* '''order''' — Контейнер заказа. Обязательный элемент. Запрос может содержать более одного контейнера '''order'''. Атрибут '''''ordercode''''' — внутренний код заказа. <code>60</code>* '''status''' — Новый статус заказа. Доступны статусы из раздела [[#Описание полей ответа статусов]], кроме AWAITING_SYNC и NEW. <name>Псковская область</name>* '''eventtime''' — Дата и время изменения статуса. Обязательно при указании статуса. </city>* '''message''' — Текст сообщения ''Инфо о доставке''. <name>Сочихино деревня</name>* '''outstrbarcode''' — код у подрядчика (код заказа во внешней системе). Используется в интеграциях с внешними системами. <fiascode>10df7588-19c1-49d1-a387-9de1cf3eb26f<* '''paytype''' — Тип оплаты заказа. Допустимые значения CASH/fiascode>CARD. <kladrcode>6001900015400</kladrcode>* '''storeprice''' — Агентское вознаграждение. <shortname />* '''items''' — Контейнер для описания вложений '''item''' . Атрибуты: <typename />:* '''''code''''' — Код вложения. <coords lat="56:* '''''quantity''''' — Количество доставленных единиц вложения.6003" lon="29:* '''''reason''''' — Причина недоставки, выбирается из соответствующего списка статусов.3542" /> </town>:* '''''governmentCode''''' — Указание кода ТН для вложения при необходимости.</townlist>* '''image''' — Контейнер прикрепляемого изображения. Содержит текст файла изображения, закодированный по стандарту ''base64''. Контейнер '''order''' может содержать более одного контейнера '''image'''. Атрибут:</source>:* '''''filename''''' — Имя файла.

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

<regionlistsetorderinfo> <codesearchorder ordercode="123456" error="0" errormsg="OK" errormsgru="Успешно" /> <codeorder ordercode="234567" error="59" errormsg="value [date_put] is already set" errormsgru="Значение [Дата доставки] уже указано" />77</codesetorderinfo> </codesearchsource> == Получение документов для печати =='''Пример запроса получения печатных форм:'''<conditionssource lang="xml"> <namecontains?xml version="1.0" encoding="UTF-8" ?>край<waybill> <auth extra="8" login="login" pass="pass" /namecontains> <namestartsorders>Моск <order orderno="1234567" ordercode="33331" /namestarts> <fullnameorder orderno="1234568" ordercode="33332" />Московская область </fullnameorders> <countryform>RU1</countryform> <start>5</conditionsstart></regionlistwaybill>

<regionlist count="2"waybill> <citycontent>EODIcaI8KSBlwQ 4MnEOR7Px8U8EBAyGICBnwpw <code>80< IZhQgz0ZxuPs8EBM/code>GcbjzB AwhBl8hwQYIO00GmEwg1CeEG <country> mqYTChNU0wqf8l8nz4zgc+K fCno+zwU5GjOZmzXGcbEQYIM <code>1</code> <name>Россия</name> <id>643</id> <ShortName1>RU</ShortName1> <ShortName2>RUS</ShortName2> </country> <name>Агинский Бурятский автономный округ</name> 4zkegRE40zWzONyoNNMIOIa cWnp6aDCGEGE9NQmoQd2mg00 <79U4f3hPTwnfp6Sdrafeqpa JDpFw/city>1aYT077VNNNdO00G3q <city> <code>1</code> <country> <code>1<mqqvp9p2E7T0/code> <name>Россия</name> <id>643</id> <ShortName1>RU</ShortName1> <ShortName2>RUS</ShortName2> </country> <name>Адыгея республика</name> wiFemv8uG6 OM</citycontent></regionlistwaybill>

'''Пример запроса справочника улиц:'''<source lang="xml"><?xml version="1В тэге content возвращаются бинарные данные (файл pdf), закодированные в base64.0" encoding="UTF-8"?><streetlist> <conditions> <town>Москва город</town> // ОБЯЗАТЕЛЬНОЕ ПОЛЕПри записи в файл необходимо использовать двоичный формат записи! <namecontains>Хохло</namecontains> <namestarts>Академика Х</namestarts> <name>Академика Хохлова</name> <fullname>Академика Хохлова ул.</fullname> </conditions> <limit> <limitfrom>30</limitfrom> <limitcount>10</limitcount> <countall>YES</countall> </limit></streetlist></source>

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

'''Пример ответас ошибкой:'''

<streetlist count="1" page="1" totalcount="3" totalpages="1"waybill> <streeterror> <name>Академика Хохлова ул.</name> <shortname>Академика Хохлова</shortname> <typename>ул.</typename> Текст ошибки</streeterror></streetlistwaybill>

В ответе улицы сортируются по алфавиту. == Справочник номенклатуры городов == '''Пример запроса справочника номенклатурыгородов:'''

<?xml version="1.0" encoding="UTF-8" ?><itemlisttownlist> <auth extra="8" login="login" pass="pass"/> </authcodesearch> <codesearchzipcode>110000</zipcode> <codekladrcode>1234560100000100800</codekladrcode> <articlefiascode>FD343bd21979d-46f8-49d0-9105-e8d65172a983</articlefiascode> <barcodecode>2345625213125123</barcodecode> </codesearch> <conditions> <namecontainscity>телевизорКраснодарский край</namecontainscity> <namestartsnamecontains>sonyновгород</namestartsnamecontains> <namenamecontainsparts>Sony KDL-55W905 ЖК-телевизормолоково моск</namenamecontainsparts> <quantitynamestarts>EXISTING_ONLYМоск</quantitynamestarts> <storename>2Москва</storename> <fullname>Москва город</conditionsfullname> <exceptcountry> <code>1234781</codecountry> </exceptconditions> <limit> <limitfrom>30</limitfrom> <limitcount>10</limitcount> <countall>YES</countall> </limit></itemlisttownlist>

Внутри контейнера itemlist townlist все элементы могут как отсутствовать, так и комбинироваться. Поиск не чувствителен к регистру. *'''codesearchauth''' - Поиск по кодам — Авторизация, необязательный элемент. В Используется в случае использования - контейнеры conditions включенного и limit игнорируются.:* '''code''' - Поиск по внутреннему коду системы.:* '''article''' - Поиск по артикулу.:* '''barcode''' - Поиск настроенного ограничения по штрих-кодунаселенным пунктам в конкретной курьерской службе.

*'''conditionscodesearch''' - Задает условия поиска — Поиск по кодам. Все вложенные элементы одновременно накладывают условие "И"В случае использования — контейнеры conditions и limit игнорируются.:* '''namecontainszipcode''' -  — Поиск товаровпо индексу. Обратите внимание на то, название которых содержит указанный текстчто один почтовый индекс может распространяться на несколько населенных пунктов. В этом случае система вернет несколько записей.:* '''namestartskladrcode'''  — Поиск по 13- Поиск товаров, название которых начинается с указанного текстати значному коду КЛАДР.:* '''namefiascode''' -  — Поиск товаров, название которых соответствует указанному тексту.:* '''quantity''' - Наличие на складе. Принимает значения EXISTING_ONLY - Только в наличии, NOT_EXISTING_ONLY - Только не в наличии, ALL - Все. ''Это поле может быть недоступным в некоторых установкахпо коду ФИАС (AOGUID).'':* '''storecode''' -  — Поиск товаров по определенному складукоду в системе.

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

*'''limit''' -  — Ограничивает вывод результата.:* '''limitfrom''' -  — Задает номер записи результата, начиная с которой выдавать ответ. По-умолчанию — 0.:* '''limitcount''' - Задает количество записей результата, которые нужно вернуть. По-умолчанию — 10000.:* '''countall''' — YES указывает на необходимость подсчета общего количества найденных совпадений. Это может замедлять выполнение запроса. Если отключено — в ответе не указываются totalcount и totalpages.

<itemlist townlist count="3" totalcountpage="31" pagetotalcount="13" totalpages="1"> <itemtown> <code>12345626379</code> <articlecity>FD343 <code>23</articlecode> <barcodename>2345625213125Краснодарский край</barcodename> </city> <name>Sony KDL-55W905 ЖК-телевизорСочи город</name> <retpricefiascode>6500079da737a-603b-4c19-9b54-9114c96fb912</retpricefiascode> <purchpricekladrcode>500002300000700000</purchpricekladrcode> <weightshortname />5.1 (not yet supported) <typename /weight> (not yet supported) <lengthcoords lat="43.5855" lon="39.7231" />50 </lengthtown> <town> <widthcode>3040331</widthcode> <heightcity> <code>4032</heightcode> <VATratename>20Брянская область</VATratename> <CountInPallet>30</CountInPalletcity> <HasSerialsname>1Сочилов хутор</HasSerialsname> <CountryOfOriginfiascode>Малайзияc9c96c67-2cc9-4f10-afde-fd32417ea216</CountryOfOriginfiascode> (not yet supported) <Messagekladrcode>Хороший телевизор3201900011100</Messagekladrcode> <Message2shortname />Снова хороший телевизор <typename /Message2> <quantitycoords lat="52.6407" lon="33.1724" />12 </quantitytown> <town> <reservedcode>3114016</reservedcode> <itemcity> ... <code>60</itemlistcode> <name>Псковская область</sourcename> '''Описание полей:'''*'''code''' - Внутренний идентификатор, присвоенный системой.*'''article''' - Артикул, назначенный клиентом (поставщиком).*'''barcode''' - Штрих-код производителя.*'''name''' - Наименование.*'''retprice''' - Розничная цена по-умолчанию. При оформлении заказа цена используется та, которая указана в заказе.*'''purchprice''' - Закупочная цена.*'''weight''' - Масса в килограммах.*'''length''' - Длина в сантиметрах.*'''width''' - Ширина в сантиметрах.*'''height''' - Высота в сантиметрах.*'''VATrate''' - Ставка НДС, целое число процентов.*'''CountInPallet''' - Количество штук в паллете.*'''HasSerials''' - Требует учета серийных номеров. Принимает значения 1 - да, 0 - нет.*'''CountryOfOrigin''' - Наименование страны происхождения на русском языке.*'''Message''' - Комментарий.*'''Message2''' - Дополнительный комментарий.*'''quantity''' - Количество на складе. Товары, уже собранные в заказы в этом количестве не присутствуют, считаются покинувшими товарный склад. ''Это поле может быть недоступным в некоторых установках.''*'''reserved''' - Количество зарезервированного товара. Может превышать остаток на складе, если покупатели ждут следующей поставки. ''Это поле может быть недоступным в некоторых установках.'' == Движение номенклатуры == '''Пример запроса движения номенклатуры:''' <source lang="xml"/city> <?xml version="1.0" encoding="UTF-8" ?name>Сочихино деревня<itemmovements/name> <auth extra="8" login="login" pass="pass"fiascode>10df7588-19c1-49d1-a387-9de1cf3eb26f</authfiascode> <codekladrcode>42596001900015400</codekladrcode> <datefromshortname />2020-10-01 <typename /datefrom> <datetocoords lat="56.6003" lon="29.3542" />2020-10-02 </datetotown></itemmovementstownlist>

*'''code''' - внутренний код товара в справочнике номенклатурыВ ответе города сортируются по популярности, важности (районные центры и т.*'''datefrom''' - дата начала периода д.*'''dateto''' - дата окончания периода.Может быть указан или код, или период), или код и период одновременнотолько затем — по алфавиту.

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

<?xml version="1.0" encoding="UTF-8" ?><itemmovements count="16"regionlist> <itemmovementcodesearch> <code>15150077</code> </codesearch> <conditions> <datenamecontains>2017-05-26край</datenamecontains> <retpricenamestarts>0Моск</retpricenamestarts> <quantityfullname>1Московская область</quantityfullname> <deliveredcountry>RU</country> </conditions></regionlist></source> '''Пример ответа:'''<source lang="xml"><?xml version="1.0" encoding="UTF-8"?><regionlist count="2"> <city> <code>80</deliveredcode> <itemcountry> <code>42591</code> <name>Настольная игра ДженгаРоссия</name> <id>643</itemid> <ShortName1>RU<status/ShortName1> <codeShortName2>5RUS</codeShortName2> </country> <name>Возврат от покупателяАгинский Бурятский автономный округ</name> </city> <city> <code>1</statuscode> <storecountry>

<name>офис в МосквеРоссия</name> </store> <order> <ordercode>3374830</ordercode> <number>123660-0</number> <date>2017-05-24</date> <orderno>14123</orderno> <barcode>0000000670</barcode> <companyid>ТОВАР643</companyid> <addressShortName1>Кравченко ул., 1RU</addressShortName1> <delivereddate>2017-05-29</delivereddateShortName2> <deliveredtime>12:00:00</deliveredtime> RUS<deliveredto /ShortName2> </ordercountry> <document> <codename>21991Адыгея республика</code> <number>318</number> <date>2017-05-26</date> <message></message> </documentname> </itemmovementscity></itemlistregionlist>

''' Описание полей ответа '''== Справочник улиц ==*'''codeПример запроса справочника улиц:''' - внутренний код операции движения*'''date''' - дата операции<source lang="xml">*'''retprice''' <?xml version="1.0" encoding="UTF- цена товара8"?>*'''quantity''' - количество товара операции<streetlist>*'''delivered''' - количество доставленного товара <conditions> <town>Москва город</town> // ОБЯЗАТЕЛЬНОЕ ПОЛЕ!*'''item''' - контейнер товара <namecontains>Хохло</namecontains>:* '''code''' - внутренний код товара <namestarts>Академика Х</namestarts>:* ''' <name''' - наименование товара *'''status''' - контейнер статуса операции:* '''code''' - код статуса:* '''name''' - наименование *'''store''' - контейнер филиала, к которому относится операция:* '''code''' - код филиала:* '''>Академика Хохлова</name''' - наименование филиала *'''order''' - контейнер корреспонденции:* '''ordercode''' - внутренний код заказа>:* '''number''' - номер заказа <fullname>Академика Хохлова ул.</fullname>:* '''date''' - дата заказа </conditions>:* '''orderno''' - шифр <limit>:* '''barcode''' - штрих-код <limitfrom>30</limitfrom>:* '''company''' - компания <limitcount>10</limitcount>:* '''address''' - адрес <countall>YES</countall>:* '''delivereddate''' - дата вручения </limit>:* '''deliveredtime''' - время вручения:* '''deliveredto''' - данные о вручении, либо причина недоставки *'''document''' - контейнер документа операции:* '''code''' - внутренний код документа:* '''number''' - номер документа:* '''extnumber''' - внешний номер документа:* '''date''' - дата документа</streetlist>:* '''message''' - комментарий</source>

<div style="color* '''limit''' — Ограничивает вывод результата.: #a94442; background* '''limitfrom''' — Задает номер записи результата, начиная с которой выдавать ответ. По-colorумолчанию — 0.: #f2dede; border* '''limitcount'''- Задает количество записей результата, которые нужно вернуть. По-умолчанию — 10000.: 1px solid #ebccd1; padding: 3px 10px 10px;">* '''Обратите внимание!countall'''#  — YES указывает на необходимость подсчета общего количества найденных совпадений. Это может замедлять выполнение запроса. Если в запросе townfrom - Москваотключено, то в ответе будут отданы города Москвы не указываются totalcount и МОtotalpages.</div><br />

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

<tariffs> <auth extrastreetlist count="1" page="81" logintotalcount="login3" passtotalpages="pass1" > <street> <code>124</code> <townfromname>МоскваАкадемика Хохлова ул.</townfromname> <serviceshortname>1Академика Хохлова</serviceshortname> <mainonlytypename>1ул.</typename> </mainonlystreet> </tariffsstreetlist>

*'''auth''' — атрибут '''extra''' обязателен, по нему определяется курьерская служба.*'''townfrom''' — город-отправитель. Если не передан, то городом будет «Москва».*'''service''' — режим доставки. Обязательный элемент.*'''mainonly''' — необязательный элемент. Если передан, то в В ответе будут данные только улицы сортируются по городам из справочника '''Межгород''' > '''Зоны'''алфавиту.

== Справочник номенклатуры =='''Пример ответа запроса справочника тарифов по городамноменклатуры:'''<source lang="jsonxml">{ "townfrom<?xml version=": "0c5b2444-70a0-4932-980c-b4dc0d3f02b5", "service": 1, .0"tariffs": [ { encoding="towntofias": "7339e834-2cb4-4734-a4c7UTF-1fca2c66e5628",?> "towntocode": "482",<itemlist> <auth extra="towntoname8": login="Уфа городlogin", pass="distancepass": 12,></auth> "pricedistance": 350, <codesearch> "pricesnew": { <code>123456</code> "before": [ <article>FD343</article> { <barcode>2345625213125</barcode> "price": "100", </codesearch> "every": "0", <conditions> "mass": "1" <namecontains>телевизор</namecontains> }, <namestarts>sony</namestarts> { <name>Sony KDL-55W905 ЖК-телевизор</name> "price": "200", <quantity>EXISTING_ONLY</quantity> "every": "1", "mass": " <store>2"</store> } </conditions> ], <except> "after": [ <code>123478</code> { </except> "price": "300", <limit> "every": "1", <limitfrom>30</limitfrom> "mass": "3" } ] }, "deliveryPeriodMin": 4, <limitcount>10</limitcount> "deliveryPeriodMax": 5 } <countall>YES</countall> ]</limit>}</itemlist>

''' Описание полей ответа '''Внутри контейнера itemlist все элементы могут как отсутствовать, так и комбинироваться. Поиск не чувствителен к регистру.* '''townfromcodesearch''' — код ФИАС города-отправителя — Поиск по кодам.* '''service''' — режим доставкиВ случае использования — контейнеры conditions и limit игнорируются.:*'''tariffscode''' — cписок тарифов  — Поиск по городувнутреннему коду системы.:* '''towntofiasarticle''' — код ФИАС города-получателя — Поиск по артикулу.:* '''towntocodebarcode''' — внутренний код города-получателя — Поиск по штрихкоду.:* '''towntonameconditions''' — наименование города-получателя — Задает условия поиска. Все вложенные элементы одновременно накладывают условие «И».:* '''distancenamecontains''' — дистанция в км до города от МКАД — Поиск товаров, если в запросе townfrom - Москваназвание которых содержит указанный текст.:* '''pricedistancenamestarts''' — сумма за километраж до города от МКАД — Поиск товаров, если в запросе townfrom - Москваназвание которых начинается с указанного текста.:* '''pricesnew''' — ваши настройки тарифов из справочника '''Межгород''' > '''Тарифы по зонамname''' — Поиск товаров, название которых соответствует указанному тексту.::* '''pricequantity''' — цена — Наличие на складе. Принимает значения EXISTING_ONLY — Только в наличии, NOT_EXISTING_ONLY — Только не в наличии, ALL — Все. В цену также плюсуется сумма pricedistance::* ''Это поле может быть недоступным в некоторых установках.'every''' — за каждые.::* '''massstore''' — масса — Поиск товаров по определенному складу.:* '''prices''' — устаревший элемент, не используется.:* '''deliveryPeriodMinexcept''' — минимальный срок доставки — Описание исключений для корректного определения количества зарезервированной номенклатуры.:* '''deliveryPeriodMaxcode''' — максимальный срок доставки — Код заказа.

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

<?xml version="1.0" encoding="UTF-8" ?><itemdoc> <auth extraitemlist count="3" totalcount="83" loginpage="login1" passtotalpages="pass1"> <item> <code>123456</code> <article>FD343</article> <barcode>2345625213125</barcode> <name>Sony KDL-55W905 ЖК-телевизор</name> <retprice>65000</retprice> <purchprice>50000</authpurchprice> <weight>5.1</weight> <length>50</length> <width>30</width> <height>40</height> <VATrate>20</VATrate> <CountInPallet>30</CountInPallet> <CountInBox>2</CountInBox> <HasSerials>1</HasSerials> <CountryOfOrigin>Малайзия</CountryOfOrigin> (not yet supported) <Message>Хороший телевизор</Message> <Message2>Снова хороший телевизор</Message2> <quantity>12<code/quantity> <reserved>219913</codereserved> <item> ...</itemdocitemlist>

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

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

<itemdocitemmovements> <codeauth extra="8" login="login" pass="pass">21991</codeauth> <numbercode>3184259</numbercode> <datedatefrom>20172020-0510-2601</datedatefrom> <messagedateto>2020-10-02</message> <items> <item code="4259" quantity="1" barcode="200300" article="123555">Настольная игра Дженга</item> </itemsdateto></itemdocitemmovements>

''' Описание полей ответа '''* '''code''' -  — внутренний код приходной накладнойтовара в справочнике номенклатуры.* '''numberdatefrom''' - номер документа — дата начала периода.* '''datedateto''' -  — дата документаокончания периода.* '''message''' - комментарийМожет быть указан или код, или период, или код и период одновременно.

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

<storelistitemmovements count="16"> <auth extra="8"itemmovement> <code>151500</authcode> <jsondate>YES2017-05-26</jsondate> <client_coderetprice>78900</client_coderetprice> <quantity>1</storelistquantity> <delivered>0</sourcedelivered> <item>*'''auth''' - Атрибут '''extra''' - обязателен, по нему определяется курьерская служба <code>4259</code>*'''json''' - Признак вывода ответа в виде JSON YES <name>Настольная игра Дженга</NOname>*'''client_code''' - Код клиента курьерской службы </item> <status>'''Пример ответа:''' <code>5</code> <source lang="xml"name>Возврат от покупателя<?xml version="1.0" encoding="UTF-8" ?/name> <storelist count="2"/status> <store> <code>1231</code> <name>ABCофис в Москве</name> </store> <order> <ordercode>3374830</ordercode> <number>123660-0</number> <date>2017-05-24</date> <orderno>14123</orderno> <barcode>0000000670</barcode> <company>ТОВАР</company> <address>Кравченко ул., 1</address> <delivereddate>2017-05-29</delivereddate> <deliveredtime>12:00:00</deliveredtime> <deliveredto /> <store/order> <document> <code>45621991</code> <number>318</number> <date>2017-05-26</date> <message><name/message>Филиал 2 </namedocument> </storeitemmovements></storelistitemlist>

''' Описание полей ответа '''*'''code''' - Код филиала.  — внутренний код операции движения* '''date''' — дата операции* '''retprice''' — цена товара* '''quantity''' — количество товара операции*'''namedelivered''' - Наименование филиала. — количество доставленного товара

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

* '''Пример запроса пунктов самовывозаstore''' — контейнер филиала, к которому относится операция:* '''<source lang="xml"><?xml version="1.0" encoding="UTF-8" ?><pvzlist> <auth extra="8" login="login" pass="pass"></auth> <code>1234</code>''' — код филиала <client_code>7890</client_code> <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></pvzlist></source>:* '''name''' — наименование филиала

*'''authorder''' - Атрибут  — контейнер корреспонденции:* '''extraordercode''' - обязателен, по нему определяется курьерская служба,  — внутренний код заказа:* '''loginnumber''' и  — номер заказа:* '''passdate''' позволяют авторизоваться под клиентом — дата заказа: для отдельного клиента могут быть ограничения по доступности некоторых ПВЗ, и в этом случае они будут учтены.*'''codeorderno''' - Внутренний код. — шифр:*'''client_codebarcode''' - Код клиента курьерской службы. — штрихкод:*'''citycompany''' - Регион получателя. Можно указать код региона или полное наименование региона из [[#Справочник регионов|справочника регионов]]. — компания:*'''townaddress''' - Город получателя. — адресДля тега города :* '''delivereddate''town' — дата вручения:* '' можно указать код региона в атрибуте 'deliveredtime''' — время вручения:* 'regioncode''deliveredto''' из [[#Справочник регионов|справочника регионов]]. Поиск будет производиться в указанном регионе. — данные о вручении, либо причина недоставки

Также можно указать страну получателя в атрибуте * '''document''country' — контейнер документа операции:* '''code''' — внутренний код документа:* '''number''' — номер документа:* '''extnumber''' в соответствии с [https — внешний номер документа://ru.wikipedia.org/wiki/ISO_3166-1 стандартом ISO_3166-1], например, "RU", "RUS" или "643" для России.* '''date''' — дата документа:* '''message''' — комментарий

*'''parentcode''' - Фильтр == Получение справочника тарифов по родительскому [[#Справочник филиалов|филиалу]]*'''acceptcash''' - Фильтр по приему наличных YES/NO*'''acceptcard''' - Фильтр по приему банковских карт YES/NO*'''acceptfitting''' - Фильтр по наличию примерки YES/NO*'''maxweight''' - Фильтр по максимальному весу, с которым работает ПВЗ*'''acceptindividuals''' - Фильтр по доступности физическим лицам YES/NO*'''lt''' - Широта левого верхнего угла*'''lg''' - Долгота левого верхнего угла*'''rt''' - Широта правого нижнего угла*'''rg''' - Долгота правого нижнего угла*'''json''' - Признак вывода ответа в виде JSON YES/NO*'''limit''' - Ограничивает вывод результата.:* '''limitfrom''' - Задает номер записи результата, начиная с которой выдавать ответ. По-умолчанию - 0.:* '''limitcount'''- Задает количество записей результата, которые нужно вернуть. По-умолчанию - 100.:* '''countall''' - YES указывает на необходимость подсчета общего количества найденных совпадений. Это может замедлять выполнение запроса. Если отключено - в ответе не указываeтся totalcount.городам ==

* '''auth''' — атрибут '''extra''' обязателен, по нему определяется курьерская служба.* '''townfrom''' — город-отправитель. Если не передан, то городом будет «Москва».* '''service''' — режим доставки. Обязательный элемент.* '''mainonly''' — необязательный элемент. Если передан, то в ответе будут данные только по городам из справочника '''Межгород''' > '''Зоны'''.   '''Пример ответа справочника пунктов самовывоза:тарифов по городам'''<source lang="xmljson"><?xml version={ "1.0townfrom" encoding=: "UTF0c5b2444-70a0-4932-980c-8b4dc0d3f02b5" ?>,<pvzlist count= "2service" totalcount=: 1, "40465tariffs">: [ <pvz> { <code>126</code> <clientcode>3</clientcode> <name>Нижний Тагил</name> <parentcode>6</parentcode> <parentname>Интеграция</parentname> <town code= "124267towntofias" regioncode=: "660c5b2444-70a0-4932-980c-b4dc0d3f02b5" regionname=, "Свердловская областьtowntocode">Нижний Тагил город</town> <address>622036, г. Нижний Тагил, ул. Циолковского: 1, д. 17</address> <phone>+73435417709 "towntoname": "Москва город", +73435254989</phone> <comment>Новый пункт доставки</comment> <worktime>Вс 10 "townregion":00-16:00"Город Москва", Сб 10 "distance":00-16:000, Пн-Пт 10 "pricedistance":00-20:00</worktime> <traveldescription>Жилое 5-ти этажное здание, торцом к дороге0, второе здание от перекрестка Пархоменко-Циолковского</traveldescription> <maxweight>10</maxweight> "pricesnew": { <acceptcash>YES</acceptcash> "before": [ <acceptcard>YES</acceptcard> { <acceptfitting>YES</acceptfitting> "price": 100, <acceptindividuals>YES</acceptindividuals> "every": 0, <latitude>57.93457</latitude> "mass": 1 <longitude>59.95131</longitude> }, <uid>40606d00-9c51-11eb-b2c9-cfd6c1111392</uid> { </pvz> "price": 150, <pvz> "every": 0, <code>245</code> "mass": 5 <clientcode>NTG1</clientcode> } <name>На Красноармейской</name> ], <parentcode>6</parentcode> "after": [ <parentname>Интеграция</parentname> { <town code= "124267price" regioncode=: 0, "66every" regionname=: 1, "Свердловская областьmass">Нижний Тагил город</town>: 38.01 <address>КРАСНОАРМЕЙСКАЯ }, д.79</address> <phone>+7(3435)379-044</phone> <comment>Возможность примерки отсутствует</comment> { <worktime>Вс 10 "price":00-16:0015, Сб 10 "every":00-16:001, Пн-Пт 10 "mass":00-20:00</worktime>51.01 <traveldescription>Напротив ТЦ Пирамида</traveldescription> } <maxweight>20</maxweight> ] <acceptcash>YES</acceptcash> }, <acceptcard>YES</acceptcard> "deliveryPeriodMin": 1, <acceptfitting>NO</acceptfitting> "deliveryPeriodMax": 2 <acceptindividuals>YES</acceptindividuals> } <latitude>57.93468</latitude> <longitude>60.55476</longitude>] <uid>41116853-9c51-11eb-b2c9-cfd6c1451392</uid> </pvz></pvzlist>}

*'''codeОписание полей ответа ''' - Код ПВЗ в системе. Используется в запросе [[API#Оформление заказа|оформления заказов]]*'''clientcodetownfrom'''  — код ФИАС города- Код ПВЗ используемый компанией-подрядчикомотправителя.*'''nameservice''' - Наименование ПВЗ — режим доставки.*'''parentcodetariffs''' - Код родительского элемента — cписок тарифов по городу.:*'''parentnametownregion'''  — регион города- Наименование родительского элементаполучателя.:*'''towntowntofias'''  — код ФИАС города- Населенный пункт с кодом из [[#Справочник городов|справочника городов]], а также с кодом и наименованием регионаполучателя.:*'''addresstowntocode'''  — внутренний код города- Адрес ПВЗполучателя.:*'''phonetowntoname'''  — наименование города- Телефоны ПВЗполучателя.:*'''commentdistance''' - Дополнительная информация — дистанция в км до города от МКАД, если в запросе townfrom — Москва.:*'''worktimepricedistance''' - Режим работы ПВЗ — сумма за километраж до города от МКАД, если в запросе townfrom — Москва.:*'''traveldescriptionpricesnew''' - Описание местонахождения ПВЗ или пути к нему.* — ваши настройки тарифов из справочника '''maxweightМежгород''' - Максимальный вес, с которым работает ПВЗ.*> '''acceptcashТарифы по зонам''' - Признак приема наличных.::*'''acceptcardbefore/after''' - Признак приема банковских карт — контейнеры ДО/ОТ.:::*'''acceptfittingprice''' - Наличие примерки — цена. Если ответ идет по «before», то в цену также плюсуется сумма pricedistance:::*'''latitudeevery''' - Широта — за каждые.:::*'''longitudemass''' - Долгота — масса.:*'''uidprices''' - Уникальный идентификатор ПВЗ в системе Measoft — устаревший элемент, не используется.:*'''countdeliveryPeriodMin''' - Количество записей в ответе — минимальный срок доставки.:*'''totalcountdeliveryPeriodMax''' - Общее количество записей, отвечающее параметрам запроса — максимальный срок доставки.

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

<?xml version="1.0" encoding="UTF-8"?><receiptdataitemdoc> <auth extra="8" login="login" pass="pass" /> <orders/auth> <order orderno="123456" /code> 21991<order orderno="890111C" /code> </ordersitemdoc></receiptdatasource>

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

  <?xml version="1.0" encoding="UTF-8"?><receipts count="1"itemdoc> <receiptcode> <orderno>12345621991</ordernocode> <fdDatetimenumber>2020-06-07 12:14:00318</fdDatetimenumber> <fdValuedate>1232017-05-26</fdValuedate> <fdNummessage>456</fdNummessage> <fnSn>789</fnSnitems> <kktNum>100</kktNum> <inn>222</inn> <ofdUrl>gate.ofd.ru</ofdUrl> <fullUrl>https://check.ofd.ru/123</fullUrl> <price>12345</price> <lines countitem code="4259" quantity="1" barcode="200300" article="123555"> <line> <item>1111764Настольная игра Дженга</item> <name>Сапоги</name> <qty>1</qty> <price>1000</price> <vatRate>20</vatRate> <governmentCode>Z16513LK2</governmentCode> <itemType>1</itemType> </line> </lines> </receiptitems></receiptsitemdoc>

Параметры ответа:*'''ordernoОписание полей ответа ''' - Номер заказа*'''fdDatetimecode''' - Дата и время пробития фискального чека — внутренний код приходной накладной*'''fdValuenumber''' - ФПД (фискальный признак  — номер документа)*'''fdNumdate''' - ФИСКАЛЬНЫЙ ДОКУМЕНТ (фискальный номер чека)*'''fnSn''' - ФН (номер фискального накопителя)*'''kktNum''' - РН (регистрационный номер кассы)*'''inn''' - ИНН*'''ofdUrl''' - URL адрес (доменное имя) ОФД*'''price''' - Сумма чека*'''fullUrl''' - URL чека для просмотра онлайн*'''lines''' - Позиции чека:*'''item''' - код товара:*'''name''' - наименование товара:*'''qty''' - количество товара:*'''price''' - цена товара:*'''governmentCode''' - считанная последовательность, которая в дальнейшем преобразуется по алгоритму тега 1162:*'''vatRate''' - НДС товара — дата документа:*'''itemTypemessage''' - тип товара (товар, доставка и т.д.) — комментарий

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

<servicesstorelist> <auth extra="8"></auth> <json>YES</json> <client_code>7890</client_code></servicesstorelist>

* '''auth''' — Атрибут '''extra''' — обязателен, по нему определяется курьерская служба* '''json''' — Признак вывода ответа в виде JSON YES/NO* '''client_code''' — Код клиента курьерской службы '''Пример ответа справочника видов срочности:'''

<services storelist count="2"> <servicestore> <code>1123</code> <name>ЭкономABC</name> </servicestore> <servicestore> <code>2456</code> <name>СрочноФилиал 2</name> </servicestore></servicesstorelist>

== Справочник пунктов самовывоза ==Для отображения списка пунктов выдачи (ПВЗ) есть '''Пример запроса дополнительных услуг:готовый JavaScript модуль'''<source lang="xml"><?xml version="1: https://home.courierexe.0" encoding="UTF-8"?><advprices> <auth extra="8" login="login" pass="pass" ru/js/> <visible>NO<measoft_map.js Инструкция по использованию — внутри. Посмотреть пример работы можно [https:/visible></advprices><home.courierexe.ru/source>pvz_test.html Здесь]

'''advprices''' - Корневой контейнерУникальные запросы списка ПВЗ кешируются на стороне личного кабинета и хранятся до 7 часов утра по московскому времени следующего дня. Обязательный элементНапример, если уникальный запрос с массой 2 кг был отправлен сегодня в 10 часов, то завтра в 7 утра он сбросится. *'''visible''' - Признак возврата '''только''' тех услугЕсли сегодня в 18 часов в этом же запросе вы укажете массу 2 кг, что доступны для отображения в ЛК YES/NOответе вернется тот же список ПВЗ. Необязательный элементЕсли передадите массу 3 кг, список может быть другим. По-умолчанию NO

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

<advpricespvzlist> <advpriceauth extra="8" login="login" pass="pass"></auth> <code>11234</code> <client_code>7890</client_code> <city>Свердловская область</city> <town regioncode="66" country="RU">Нижний Тагил</town> <address>Щёлковское шоссе</address> <house>77</house> <parentcode>6</parentcode> <acceptcash>YES</acceptcash> <nameacceptcard>Этажей в домеYES</nameacceptcard> <typeacceptfitting>intYES</typeacceptfitting> <maxweight>30</advpricemaxweight> <advpriceacceptindividuals>YES</acceptindividuals> <lt>57.924737<code/lt> <lg>59.940019</lg> <rt>257.905682</codert> <namerg>Коэффициент надбавки59.984669</namerg> <typejson>floatYES</typejson> <with_coords>YES</advpricewith_coords> <advpricelimit> <codelimitfrom>330</codelimitfrom> <namelimitcount>Расписаться на упаковке2</namelimitcount> <typecountall>boolYES</typecountall> </advpricelimit></advpricespvzlist>

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

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

<calculator> <auth extrapvzlist count="8" login="login2" passtotalcount="pass40465" /> <orderpvz> <code>126</code> <pricetypeclientcode>CUSTOMER3</pricetypeclientcode> <name>Нижний Тагил<sender/name> <townparentcode>Санкт-Петербург6</townparentcode> <addressparentname>Петровка 38 офис 35Интеграция</addressparentname> <coords lattown code="55.680327124267" regioncode="66" lonregionname="37.604456Свердловская область">Нижний Тагил город</town> <address>622036, г. Нижний Тагил, ул. Циолковского, д. 17</coordsaddress> <phone>+73435417709, +73435254989</senderphone> <receivercomment>Новый пункт доставки</comment> <zipcodeworktime>125480Вс 10:00-16:00, Сб 10:00-16:00, Пн-Пт 10:00-20:00</zipcodeworktime> <town regioncode="78" country="RU"traveldescription>СанктЖилое 5-Петербургти этажное здание, торцом к дороге, второе здание от перекрестка Пархоменко-Циолковского</towntraveldescription> <maxweight>10</maxweight> <addressacceptcash>Петровка 38 офис 35YES</addressacceptcash> <pvzacceptcard>124YES</pvzacceptcard> <coords lat="55.680327" lon="37.604456"acceptfitting>YES</coordsacceptfitting> <acceptindividuals>YES</receiveracceptindividuals> <weightlatitude>557.193457</weightlatitude> <servicelongitude>259.95131</servicelongitude> <paytypeuid>CASH40606d00-9c51-11eb-b2c9-cfd6c1111392</paytypeuid> </pvz> <pvz> <pricecode>387.5245</pricecode> <deliverypriceclientcode>150NTG1</deliverypriceclientcode> <inshpricename>387.5На Красноармейской</inshpricename> <parentcode>6<packages/parentcode> <package mass="1"parentname>Интеграция</packageparentname> <package masstown code="2.5124267" lengthregioncode="1066" widthregionname="Свердловская область">Нижний Тагил город</town> <address>КРАСНОАРМЕЙСКАЯ, д.79</address> <phone>+7(3435)379-044</phone> <comment>Возможность примерки отсутствует</comment> <worktime>Вс 10:00-16:00, Сб 10:00-16:00, Пн-Пт 10:00-20" height="30":00</worktime> <traveldescription>Напротив ТЦ Пирамида</traveldescription> <maxweight>20</maxweight> <acceptcash>YES</acceptcash> <acceptcard>YES</acceptcard> <acceptfitting>NO</acceptfitting> <acceptindividuals>YES</packageacceptindividuals> <latitude>57.93468</packageslatitude> <useridlongitude>user12360.55476</useridlongitude> <groupiduid>customer41116853-9c51-11eb-b2c9-cfd6c1451392</groupiduid> </orderpvz></calculatorpvzlist>

В авторизации можно опустить параметры login и pass, тогда расчет будет производиться по стандартному тарифу курьерской службы, без учета возможных отличий для конкретного клиента.<br>'''Пример ответа получения фискальных данных:'''Объемный вес будет учитываться только при условии указания всех габаритов: длины, ширины и высоты.<brsource lang="xml">В полях город-отправитель и город-получатель можно указывать название города (не рекомендуется!), либо код города из нашего справочника, либо 13-ти значный код КЛАДР, либо 36-ти значный код адресной системы ФИАС (AOID).

<calculatorreceipts count="1"> <calcreceipt> <townfrom code="1"orderno>Москва город123456</townfromorderno> <townto code="56603"fdDatetime>Иркутск город2020-06-07 12:14:00</towntofdDatetime> <massfdValue>3.7123</massfdValue> <service name="Экспресс"fdNum>1456</servicefdNum> <zonefnSn>2789</zonefnSn> <pricekktNum>1113100</pricekktNum> <mindeliverydaysinn>1222</mindeliverydaysinn> <maxdeliverydaysofdUrl>3gate.ofd.ru</maxdeliverydaysofdUrl> <mindeliverydatefullUrl>2020-05-13https://check.ofd.ru/123</mindeliverydatefullUrl> <deliverypriceprice>12345</price> <advprice codelines count="1" > <line> <item>1111764</item> <name>Сапоги</name> <qty>1</qty> <price=">1000">База</advpriceprice> <advprice code="4" price="100"vatRate>Процент от суммы руб20</advpricevatRate> <advprice code="5" price="63"governmentCode>Процент от объявленной стоимостиZ16513LK2</advpricegovernmentCode> <advprice code="6" price="-50"itemType>1</itemType>Скидка при доставке </advpriceline> </deliverypricelines> </calcreceipt></calculatorreceipts>

Параметрыответа:*'''townfromorderno''' - Город-отправитель так, как система его распознала  — Номер заказа* '''fdDatetime''' — Дата и привязала к справочнику. Атрибут время пробития фискального чека* '''fdValue''' — ФПД (фискальный признак документа)* '''codefdNum''' - код из справочника городов системы. — ФИСКАЛЬНЫЙ ДОКУМЕНТ (фискальный номер чека)*'''towntofnSn''' - Город-получатель так, как система его распознала и привязала к справочнику. Атрибут  — ФН (номер фискального накопителя)* '''codekktNum''' - код из справочника городов системы. — РН (регистрационный номер кассы)*'''massinn''' - Масса в килограммах — ИНН*'''serviceofdUrl''' - Режим доставки - число, указывающее на запись в справочнике видов срочности  — URL адрес (см описание на этой страницедоменное имя).ОФД* '''price''' — Сумма чека* '''fullUrl''' — URL чека для просмотра онлайн* '''lines''' — Позиции чека:* '''item''' — код товара:* '''name''' — наименование товара:*'''zoneqty''' - номер тарифной зоны, по которой рассчиталась стоимость. В зависимости от зоны выбирается тарифная сетка. Так же к цене могут применяться повышающие или понижающие коэффициенты при доставке не из/в региональный центр. — количество товара:*'''price''' - рассчитанная стоимость доставки в валюте прайс-листа курьерской службы. Рекомендуется к использованию в отличие от одноименного атрибута родительского контейнера. — цена товара:*'''maxdeliverydaysgovernmentCode''' - максимальный срок доставки  — считанная последовательность, которая в рабочих днях.дальнейшем преобразуется по алгоритму тега 1162:*'''mindeliverydatevatRate''' - минимальная дата доставки в учетом выходных дней.  — НДС товара:*'''deliverypriceitemType''' - Данные по составляющим ценам доставки — тип товара (товар, доставка и т. д.)

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

<clientservices> <auth extra="8" login="login" pass="pass" /> </clientservices>

'''client''' - Корневой контейнер. Обязательный элемент.*'''auth''' - Авторизация. Обязательный элемент. '''Пример ответа на запрос получения информации о клиентесправочника видов срочности:'''

<clientservices count="2"> <service> <code>10821</code> <name>Эконом</name> </service> <service> <code>2</code> <name>Срочно</name> </service></clientservices></source>

*'''code''' - Код клиента == Список актов передачи денег Справочник дополнительных услуг == '''Пример запроса списка актов передачи денегдополнительных услуг:'''

<?xml version="1.0" encoding="UTF-8" ?><smalistadvprices> <auth extra="8" login="login" pass="pass" /> <datefrom>2016-02-10</datefrom> <dateto>2016-03-10</dateto></smalistadvprices>

'''smalistadvprices''' -  — Корневой контейнер. Обязательный элемент.*'''auth''' - Авторизация. Обязательный элемент.*'''datefrom''' - Дата "с". Необязательный элемент.*'''dateto''' - Дата "по". Необязательный элемент.Если интервал дат не указан, то возвращаются акты передачи денег за последний месяц.

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

<?xml version="1.0" encoding="UTF-8"?><smalist count="1"advprices> <smaadvprice> <code>62781</code> <numbername>3992Этажей в доме</numbername> <actdatetype>2016-02-12int</actdatetype> <datepay> </datepayadvprice> <dateto>2016-02-12 </datetoadvprice> <promiseddatepaycode>2</promiseddatepaycode> <pricename>637.00Коэффициент надбавки</pricename> <pricecorrtype>113.00float</pricecorrtype> <rur>13430.00 </ruradvprice> <pricekur>570.00</pricekuradvprice> <priceagcode>67.003</priceag> <payno>42423</payno> <paytype>1</paytypecode> <paytypenamename>БезналРасписаться на упаковке</paytypenamename> <signedcopyreceivedtype>NObool</signedcopyreceivedtype> </smaadvprice></smalistadvprices>

Параметры:*'''code''' - Код акта — внутренний код услуги*'''numbername''' - Номер акта  — наименование услуги. Если поле «название в ЛК» в настройках услуги не пусто, то возвращает значение поля «название в системе*'''actdate''' - Дата актаЛК».*'''datepayhine''' - Дата оплаты  — подсказка по акту*'''dateto''' - Дата конечного периода доп услуге для формирования АПДпользователя*'''promiseddatepaytype''' - Плановая дата оплаты — тип услуги. Может иметь значения::*'''pricebool''' - Стоимость  — для услугвида «чекбокс», «Да»:*'''pricecorrfloat''' - Сумма корректировки*'''rur''' - Сумма заказа*'''pricekur''' - Стоимость курьерской доставки*'''priceag''' - Агентское вознаграждение*'''payno''' - Номер платежного поручения — для числа с плавающей точкой*'''paytype''' - Тип оплаты: 1 - безнал, 2 - наличными курьером, 3 - наличными в офисе, 4 - перевод на карту*'''paytypenameint''' - Строковое представление типа оплаты*'''signedcopyreceived''' - Признак факта возврата акта YES/NO — для целого числа

== Детализация актов передачи денег Расчет стоимости доставки == '''Пример запроса детализации актов передачи денегстоимости доставки:'''

<calculator> <auth extra="8" login="login" pass="pass" /> <order> <pricetype>CUSTOMER</pricetype> <sender> <town>Санкт-Петербург</town> <address>Петровка 38 офис 35</address> <coords lat="55.680327" lon="37.604456"></coords> </sender> <receiver> <zipcode>125480</zipcode> <town regioncode="78" country="RU">Санкт-Петербург</town> <address>Петровка 38 офис 35</address> <pvz>124</pvz> <coords lat="55.680327" lon="37.604456"></coords> </receiver> <weight>5.1</weight> <service>2</service> <paytype>CASH</paytype> <price>387.5</price> <deliveryprice>150</deliveryprice> <inshprice>387.5</inshprice> <packages> <package mass="1" quantity="5"></package> <package mass="2.5" length="10" width="20" height="30"></package> </packages> <userid>user123</userid> <groupid>customer</groupid> </order></calculator></source>  Параметры:Структура данных и заполнение полей аналогичны и совместимы с [[#Оформление заказа]]. Дополнительные поля:* '''pricetype''' — тип требуемой цены. Возможные значения: «CUSTOMER» (по-умолчанию) — [[Личный кабинет клиента#Цена доставки для получателя|цена для конечного получателя]], «CLIENT» — цена курьерской службы для клиента.* '''userid''' — Идентификатор пользователя, строковый или числовой тип. Виртуальное поле. Необязательное. Данное поле используется совместно с настройками «Цена доставки для получателя», определяя приоритет правила. Можно использовать в различных CMS/CRM системах, настраивая цены для определенного покупателя.* '''groupid''' — Идентификатор группы пользователя, строковый или числовой тип. Виртуальное поле. Необязательное. Данное поле используется совместно с настройками «Цена доставки для получателя», определяя приоритет правила. Можно использовать в различных CMS/CRM системах, настраивая цены для определенной группы покупателей. Суммы НП и ОЦ, а также тип оплаты CARD имеют значение при настроенных в тарифе на вкладке Прочее долях (в процентах) от данных сумм. В авторизации можно опустить параметры login и pass, тогда расчет будет производиться по стандартному тарифу курьерской службы, без учета возможных отличий для конкретного клиента.<br>Объемный вес будет учитываться только при условии указания всех габаритов: длины, ширины и высоты.<br>В полях город-отправитель и город-получатель можно указывать название города (не рекомендуется!), либо код города из нашего справочника, либо 13-ти значный код КЛАДР, либо 36-ти значный код адресной системы ФИАС (AOID).  '''Пример ответа стоимости доставки:'''<source lang="xml"><?xml version="1.0" encoding="UTF-8"?><calculator> <calc> <townfrom code="1">Москва город</townfrom> <townto code="56603">Иркутск город</townto> <mass>3.7</mass> <service name="Экспресс">1</service> <zone>2</zone> <price>1113</price> <mindeliverydays>1</mindeliverydays> <maxdeliverydays>3</maxdeliverydays> <mindeliverydate>2020-05-13</mindeliverydate> <intervals> <workdays> <interval>10:00-16:00</interval> <interval>16:00-22:00</interval> </workdays> <holidays> <interval>12:00-16:00</interval> </holidays> </intervals> <deliveryprice> <advprice code="1" price="1000">База</advprice> <advprice code="4" price="100">Процент от суммы руб</advprice> <advprice code="5" price="63">Процент от объявленной стоимости</advprice> <advprice code="6" price="-50">Скидка при доставке</advprice> </deliveryprice> </calc></calculator></source> Параметры:* '''townfrom''' — Город-отправитель так, как система его распознала и привязала к справочнику. Атрибут '''code''' — код из справочника городов системы.* '''townto''' — Город-получатель так, как система его распознала и привязала к справочнику. Атрибут '''code''' — код из справочника городов системы.* '''mass''' — Масса в килограммах* '''service''' — Режим доставки — число, указывающее на запись в справочнике видов срочности (см описание на этой странице).* '''zone''' — номер тарифной зоны, по которой рассчиталась стоимость. В зависимости от зоны выбирается тарифная сетка. Так же к цене могут применяться повышающие или понижающие коэффициенты при доставке не из/в региональный центр.* '''price''' — рассчитанная стоимость доставки в валюте прайс-листа курьерской службы. Рекомендуется к использованию в отличие от одноименного атрибута родительского контейнера.* '''maxdeliverydays''' — максимальный срок доставки в рабочих днях.* '''mindeliverydate''' — минимальная дата доставки в учетом выходных дней.* '''intervals''' — список интервалов доставки для соответствующей зоны и режима срочности.* '''deliveryprice''' — Данные по составляющим ценам доставки '''''Обратите внимание:''''' В реальном ответе сервера в теге calc присутствует атрибут «price». Он оставлен для обратной совместимости, не используйте его. Пользуйтесь вложенным тегом price. == Получение информации о клиенте =='''Пример запроса получения информации о клиенте:'''<source lang="xml"><?xml version="1.0" encoding="UTF-8" ?><client> <auth extra="8" login="login" pass="pass" /> </client></source> '''client''' — Корневой контейнер. Обязательный элемент.* '''auth''' — Авторизация. Обязательный элемент. '''Пример ответа на запрос получения информации о клиенте:'''<source lang="xml"><?xml version="1.0" encoding="UTF-8" ?><client> <code>1082</code></client></source> * '''code''' — Код клиента == Список актов передачи денег =='''Пример запроса списка актов передачи денег:'''<source lang="xml"><?xml version="1.0" encoding="UTF-8" ?><smalist> <auth extra="8" login="login" pass="pass" /> <datefrom>2016-02-10</datefrom> <dateto>2016-03-10</dateto></smalist></source> '''smalist''' — Корневой контейнер. Обязательный элемент.* '''auth''' — Авторизация. Обязательный элемент.* '''datefrom''' — Дата «с». Необязательный элемент.* '''dateto''' — Дата «по». Необязательный элемент.Если интервал дат не указан, то возвращаются акты передачи денег за последний месяц. '''Пример ответа на запрос списка актов передачи денег:'''<source lang="xml"><?xml version="1.0" encoding="UTF-8"?><smalist count="1"> <sma> <code>6278</code> <number>3992</number> <actdate>2016-02-12</actdate> <datepay></datepay> <dateto>2016-02-12</dateto> <promiseddatepay></promiseddatepay> <price>637.00</price> <pricecorr>113.00</pricecorr> <rur>13430.00</rur> <pricekur>570.00</pricekur> <priceag>67.00</priceag> <payno>42423</payno> <paytype>1</paytype> <paytypename>Безнал</paytypename> <signedcopyreceived>NO</signedcopyreceived> </sma></smalist></source> * '''code''' — Код акта* '''number''' — Номер акта в системе* '''actdate''' — Дата акта* '''datepay''' — Дата оплаты по акту* '''dateto''' — Дата конечного периода для формирования АПД* '''promiseddatepay''' — Плановая дата оплаты* '''price''' — Стоимость услуг* '''pricecorr''' — Сумма корректировки* '''rur''' — Сумма заказа* '''pricekur''' — Стоимость курьерской доставки* '''priceag''' — Агентское вознаграждение* '''payno''' — Номер платежного поручения* '''paytype''' — Тип оплаты: 1 — безнал, 2 — наличными курьером, 3 — наличными в офисе, 4 — перевод на карту* '''paytypename''' — Строковое представление типа оплаты* '''signedcopyreceived''' — Признак факта возврата акта YES/NO == Детализация актов передачи денег =='''Пример запроса детализации актов передачи денег:'''<source lang="xml"><?xml version="1.0" encoding="UTF-8" ?><smadetail> <auth extra="8" login="login" pass="pass" /> <code>6278</code></smadetail></source> '''smadetail''' -  — Корневой контейнер. Обязательный элемент.*'''auth''' -  — Авторизация. Обязательный элемент.*'''code''' -  — Код акта передачи денег (см. запрос списка АПД). Обязательный элемент. '''Пример ответа на запрос детализации актов передачи денег:'''<source lang="xml"><?xml version="1.0" encoding="UTF-8"?><smadetail count="2"> <specialsma> <code>42494</code> <ordercode>14424</ordercode> <orderno>11111</orderno>

<delivereddate>2018-10-01</delivereddate> <company>Компания</company> <price>314.00</price> <rur>8800.00</rur> <inshprice>314.00</inshprice> <pricekur>270.00</pricekur> <priceag>44.00</priceag> <pricecalc>8486.00</pricecalc> <paytype>2</paytype> <paytypename>наличными курьером</paytypename> <weight>0.400</weight> <distance>0.0</distance> <status>Доставлено</status> </specialsma></smadetail></source> * '''code''' — Код записи.* '''ordercode''' — Код заказа.* '''orderno''' — Шифр заказа.* '''orderdate''' — Дата заказа.* '''delivereddate''' — Дата доставки.* '''company''' — Получатель.* '''price''' — Стоимость услуг.* '''rur''' — Сумма заказа.* '''inshprice''' — Стоимость заказа.* '''pricekur''' — Стоимость курьерской доставки.* '''priceag''' — Агентское вознаграждение.* '''pricecalc''' — Сумма для передачи агенту.* '''paytype''' — Тип оплаты: 1 — безнал, 2 — наличными курьером, 3 — наличными в офисе, 4 — перевод на карту.* '''paytypename''' — Строковое представление типа оплаты* '''weight''' — Вес заказа.* '''distance''' — Дистанция по заказу* '''status''' — Статус заказа. == Генерация коротких ссылок ==В некоторых случаях, например, при использовании в СМС, может потребоваться использование коротких ссылок на ЛК.Для этого, необходимо отправить запрос с полной ссылкой, в ответ на который придёт хэш-код для ссылки. '''Пример запроса генерации коротких ссылок:'''<source lang="xml"><?xml version="1.0" encoding="UTF-8" ?><shortlink> <link short="0"> https://home.courierexe.ru/8/site/orders </link></shortlink></source> '''shortlink''' — Корневой контейнер. Обязательный элемент.* '''link''' — Полная ссылка, для которой необходимо получить код. Обязательный элемент. Если атрибут '''short''' равен 1, то ответ не будет содержать XML, а только хэш-код. '''Пример ответа на запрос генерации коротких ссылок:'''<source lang="xml"><?xml version="1.0" encoding="UTF-8"?><shortlink> <hash>35AF350C</hash></shortlink></source> * '''hash''' — Хэш-код ссылки. Далее, можно использовать ссылку на ЛК: <nowiki>https://home.courierexe.ru/35AF350C или curie.ru/35AF350C</nowiki>  '''Примечание!''' Сервис коротких ссылок работает только для ресурсов компании MeaSoft. == Проверка надежности покупателя ==Проверка надежности работает только для тарифа «Максимум» личного кабинета. <source lang="xml"><?xml version="1.0" encoding="UTF-8" ?><mcheck> <auth extra="8" login="login" pass="pass" /> <phones> <phone>89161147992</phone> </phones></mcheck></source> Ответ: <source lang="xml"><?xml version="1.0" encoding="UTF-8" ?><mcheck> <phones> <phone rate="90">89161147992</phone> </phones></mcheck>

== Генерация коротких ссылок Размещение страниц на своем сайте (iframe) ==

В некоторых случаях, например, при использовании в СМС, может потребоваться использование коротких ссылок имеет смысл разметить те или иные страницы на ЛК.Для этого, необходимо отправить запрос с полной ссылкой, в ответ на который придёт хэш-код для ссылкисвоем сайте.

Например, чтобы клиенты могли рассчитать стоимость доставки не переходя по внешней ссылке, а там же, на сайте, калькулятор можно разместить прямо на странице такого сайта посредством так называемого фрейма — '''Пример запроса генерации коротких ссылок:iframe'''<source lang="xml"><?xml version="1.0" encoding="UTF-8" ?><shortlink> <link short="0"> https://home.courierexe.ru/8/site/orders </link></shortlink></source>

'''shortlink''' - Корневой [https://ya.ru/search/?text=iframe Фрейм] — контейнер. Обязательный элемент.*'''link''' - Полная ссылка, для которой необходимо получить код. Обязательный элемент. Если атрибут '''short''' равен 1, то ответ не будет содержать XMLвнутри обычной страницы, а только хэш-кодкоторый позволяет загружать сторонние страницы.Пример загрузки калькулятора:

'''Пример ответа на запрос генерации коротких ссылок:'''<source lang="xmlhtml"><?xml versioniframe id="1.0frame" encodingsrc="UTF-https://home.courierexe.ru/8/calculator"?><shortlink> <hash>35AF350C</hash> Здесь должен отобразиться калькулятор</shortlinkiframe>

*Для удобства пользователей вашего сайта можно указать язык интерфейса (который переключается непосредственно на сайте) параметром '''hashlang''' - Хэш-код ссылки. Далее, можно использовать ссылку на ЛК: <nowiki>https://home.courierexe.ru/35AF350C или curie.ru/35AF350C</nowiki> 

'''Примечание!''' Сервис коротких ссылок работает только для ресурсов компании MeaSoft. == Проверка надежности покупателя == Проверка надежности работает только для тарифа "Максимум" личного кабинета. <source lang="xmlhtml"><?xml versioniframe id="1.0frame" encodingsrc="UTF-https://home.courierexe.ru/8" /calculator?><mcheck> <auth extralang=2"8" login="login" pass="pass" /> <phones> <phone>89161147992</phone> </phones>Здесь должен отобразиться калькулятор</mcheckiframe>

<source lang="xml">Поддерживаемые языки и их коды:<?xml version=":'''1.0" encoding="UTF-8" ?>''' — русский<mcheck>:'''2''' — английский <phones> <phone rate="90">89161147992</phone> </phones></mcheck></source>:'''4''' — узбекский