Изменения

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

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

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

|Поддерживает версии 1.5.2.0 и выше. Подробнее см. [[PrestaShop|описание]].

|style="text-align: center;"|[https://courierexe.ru/download/api/opencart.zip Скачать для версии 1.5.5.1]<br>[https://courierexe.ru/download/api/measoft_oc2.ocmod.zip Скачать для версии 2.0]<br>[https://courierexe.ru/download/api/measoft_oc2.3.ocmod.zip Скачать для версии 2.3]<br>[https://courierexe.ru/download/api/measoft_ос3measoft_oc3.ocmod.zip Скачать для версии 3.0]|Поддерживает версии с 1.5.5.1.<br>Скачивайте модули для своей версии OpenCart.<br>Подробнее см. [[OpenCart|описание]].<br>[https://opencartforum.com/files/file/2906-avtomatizaciya-otpravki-i-otslezhivanie-dostavok-courierexe-dlya-opencart-15x/ Альтернативный модуль сторонних разработчиков]

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

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

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

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

|style="height:50px; text-align: center;"|[https://home.courierexe.ru/moysklad/step1 Настроить интеграцию с MeaSoft]

|style="text-align: center;"|[https://courierexe.ru/download/apiwordpress/wordpress.zip php Скачать]

|[[Файл:webhooks.jpg|center|x100px]]|style="height:100px; text-align: center;"|'''Читайте описание [[Webhook'''|на этой странице]]|Передача информации о статусах и заказах в вашу систему|-|[[Файл:Logo_tilda_black.png|center|x100px]]|style="text-align: center;"|Читайте описание [[WebhookTilda|на данной этой странице]]|Передача информаци о статусах и заказах в вашу системуРаботает только на платных тарифах

Для отображения списка пунктов выдачи есть [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 «Such number exists"exists». Если не указан штрих-код штрихкод (поле barcode), и значение поля подходит для использования его в качестве штрих-кодаштрихкода, данное значение будет скопировано в поле "Штрих-код"«Штрихкод». Это накладывает ограничения в частности, на длину указанного поля (25 знаков, чтобы работали стандартные печатные формы).

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

<spoiler text="Заполнение номера заказа (шифра) и штрих-кода">Шифр и штрих-код заполняются исходя из начальных значений: # Если шифр и ШК пустые - оба поля заполняются автоматически значением вида XXX#YYY, а после ШК проверяется на корректность (валидируется)# Если ШК пустой, а шифр заполнен - ШК заполняется значением из шифра и валидируется# Если шифр пустой, а ШК заполнен - шифр заполняется значением из ШК, после чего ШК валидируется# Если оба непустые - валидируется ШК, шифр не проверяется Корректный (валидный) ШК отвечает следующим требованиям:* длина не меньше 5 символов* значение не меньше значения переменной <mparam code="MinPrePrintedNum"/>* содержит символы, которые можно использовать для формирования штрих-код а формате Code128 (т.е.все печатные символы, кроме кириллицы) Если ШК не прошел проверку, то:* если переменная <mparam code="StoreInvLength"/> равна 0, ШК заполняются автоматически значением вида XXX#YYY (или приравнивается шифру в том же формате)* если переменная <mparam code="StoreInvLength"/> больше 0, ШК заполняются автоматически сквозным номером (если шифр в формате XXX#YYY, то шифр приравнивается ШК)</spoiler> В случае наличия нескольких мест и раздельной их маркировки в этом поле допустимы маски в виде символов подчеркивания, говорящие о позициях штрихкода, переменных для разных мест в рамках одного заказа.<br>''Например'': В заказе номер 123 имеется 20 товарных вложений, которые упакованы в 3 транспортных места. Клиент формирует 3 штрихкода на транспортные места: CLNT0012301, CLNT0012302, CLNT0012303, где CLNT — префикс клиента, 00123 — номер заказа, 01-03 — номер транспортного места в заказе. В поле barcode нужно указать CLNT00123__ (система поймет, что 2 последних символа могут быть любыми и будут отражать штрихкоды к одному заказу). Если вы не сами печатаете накладные с указанным штрихкодом, то указанный штрихкод не должен быть длиннее 25 знаков, иначе он не поместится на стандартных печатных формах. *'''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 — Наличными при получении (по-умолчанию):* CARD — Картой при получении:* NO — Без оплаты. Этот тип оплаты передается, если заказ уже оплачен и не требует инкассации. API добавит к товарам строку предоплаты в сумму заказа, чтобы общая сумма была 0, однако в кассовом чеке будут все товары с ценами, и оплата предоплатой, как того требует 54-ФЗ.:* OTHER — Прочее (Предусмотрен для того, чтобы оплата поступала непосредственно в курьерскую службу посредством прочих типов оплаты — таких как: вебмани, яденьги, картой на сайте, прочие платежные системы и т. д.):* 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 — Серийный номер.:* '''''message''''' — Строка сообщения.:* '''''extraTags''''' — Строка в формате JSON для отправки в ОФД. :: Тэг 1265 - значение отраслевого реквизита = код места деятельности аптеки :: Тэг 1262 – идентификатор ФОИВ = "020" (константа ФОИВ МИНЗДРАВа) :: Тэг 1263 - дата нормативного акта федерального органа исполнительной власти = "14.12.2018" (константа) :: Тэг 1264 - номер нормативного акта федерального органа исполнительной власти = "1556"(константа) :: Тэг 1212 - Признак предмета расчета :: Пример: <source lang="json">"item_industry_props":{"tag1262":"020","tag1263":"14.12.2018","tag1264":"1556","tag1265":"tm=mdlp&sid=00000000XXXXXX"},"tag1212": "1"</source> 

*Для клиентов из '''paytypeУзбекистана''' - Тип оплаты заказа получателем. Принимает значения:необходимо указывать код ИКПУ и код упаковки в следующем формате:* CASH - Наличными при получении (по-умолчанию):* CARD - Картой при получении<source lang="json">"ikpu":* NO - Без оплаты. Этот тип оплаты передается, если заказ уже оплачен и не требует инкассации. API добавит к товарам строку предоплаты в сумму заказа, чтобы общая сумма была 0, однако в кассовом чеке будут все товары с ценами"123123123", и оплата предоплатой, как того требует 54-ФЗ.:* OTHER - Прочее (Предусмотрен для того, чтобы оплата поступала непосредственно в курьерскую службу посредством прочих типов оплаты - таких как"packageCode": вебмани, яденьги, картой на сайте, прочие платежные системы и т.д.)"123456":* OPTION - На выбор получателя. Этот тип оплаты нельзя передавать с заказом. Он выставляется автоматически в зависимости от настройки клиента.</source>

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

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

* '''below''' -  — граница стоимости настроек:* '''''below_sum''''' -  — граница стоимости выкупаемого заказа:* '''''price''''' -  — стоимость выкупаемого заказа до соответствующей границы

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

*'''costcodeextrafields'''  — Контейнер для описания расширенных полей. Необязательный элемент. Может содержать несколько элементов extrafield* '''extrafield''' — Контейнер для описания расширенного поля.:* '''''name''''' — наименование переменной. Может содержать только латинские буквы, цифры и знак подчеркивания "_", но начинаться может только с буквы. Максимальная длина - Кост20 символов.:* '''''value''''' — значение переменной. Максимальная длина -код сотрудника250 символов.

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

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

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

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

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

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

|3||Specify a valid "Price" «Price» field value.||Укажите корректное значение поля «Сумма».

|4||Specify a valid "Weight" «Weight» field value.||Укажите корректное значение поля «Вес».

|7||Specify the "Recipient address" «Recipient address» field value.||Укажите значение поля «Адрес получателя».

|8||Specify the "Recipient phone" «Recipient phone» field value.||Укажите значение поля «Телефон получателя».

|9||Specify the "Recipient name" «Recipient name» field value.||Укажите значение поля «ФИО получателя».

|10||Specify a valid "Quantity" «Quantity» field value.||Укажите корректное значение поля «Количество».

|11||Specify a valid "Declared value" «Declared value» field value.||Укажите корректное значение поля «Объявленная ценность».

|20||Specify a valid "Delivery mode" «Delivery mode» field value.||Укажите корректное значение поля «Режим доставки».

|21||Specify a valid "Return «Return trip mode" mode» field value.||Укажите корректное значение поля «Режим возврата».

|22||Specify a valid "Delivery type" «Delivery type» field value.||Укажите корректное значение поля «Тип доставки».

|23||Specify a valid "Return «Return shipment type" type» field value.||Укажите корректное значение поля «Тип возврата».

|30||Specify the "Order number" «Order number» field value.||Укажите значение поля «Номер заказа».

|31||Specify the "Barcode" «Barcode» field value.||Укажите значение поля «Штрихкод».

|32||Specify the "Sender company" «Sender company» field value.||Укажите значение поля «Компания-отправитель».

|33||Specify the "Sender name" «Sender name» field value.||Укажите значение поля «ФИО отправителя».

|34||Specify the "Sender phone" «Sender phone» field value.||Укажите значение поля «Телефон отправителя».

|35||Specify the "Sender «Sender city/town" town» field value.||Укажите значение поля «Город отправителя».

|36||Specify the "Sender address" «Sender address» field value.||Укажите значение поля «Адрес отправителя».

|37||Specify the "Pickup date" «Pickup date» field value.||Укажите значение поля «Дата забора».

|38||Specify the "Pickup «Pickup time from" from» field value.||Укажите значение поля «Время забора с».

|39||Specify the "Pickup «Pickup time to" to» field value.||Укажите значение поля «Время забора до».

|40||Specify the "Recipient company" «Recipient company» field value.||Укажите значение поля «Компания-получатель».

|41||Specify the "Recipient name" «Recipient name» field value.||Укажите значение поля «ФИО получателя».

|42||Specify the "Recipient phone" «Recipient phone» field value.||Укажите значение поля «Телефон получателя».

|43||Specify the "Recipient «Recipient city/town" town» field value.||Укажите значение поля «Город получателя».

|44||Specify the "Recipient address" «Recipient address» field value.||Укажите значение поля «Адрес получателя».

|45||Specify the "Delivery date" «Delivery date» field value.||Укажите значение поля «Дата доставки».

|46||Specify the "Delivery «Delivery time from" from» field value.||Укажите значение поля «Время доставки с».

|47||Specify the "Delivery «Delivery time to" to» field value.||Укажите значение поля «Время доставки до».

|48||Specify the "Recipient postcode" «Recipient postcode» field value.||Укажите значение поля «Индекс получателя».

|49||Specify the "Weight" «Weight» field value.||Укажите значение поля «Вес».

|50||Specify the "Payment type" «Payment type» field value.||Укажите значение поля «Тип оплаты».

|51||Specify the "Quantity" «Quantity» field value.||Укажите значение поля «Количество».

|52||Specify the "Amount" «Amount» field value.||Укажите значение поля «Сумма».

|53||Specify the "Declared value" «Declared value» field value.||Укажите значение поля «Объявленная стоимость».

|54||Specify the "Description" «Description» field value.||Укажите значение поля «Описание».

|55||Specify the "Instruction" «Instruction» field value.||Укажите значение поля «Поручение».

|56||Specify the "Delivery mode" «Delivery mode» field value.||Укажите значение поля «Режим доставки».

|57||Specify the "Shipment type" «Shipment type» field value.||Укажите значение поля «Тип отправления».

|59||Specify the "Return «Return trip mode" mode» field value.||Укажите значение поля «Режим возврата»

|60||Specify the "Return «Return shipment type" type» field value.||Укажите значение поля «Тип возврата».

|68||Select the "Payment «Payment by recipient" recipient» field value.||Укажите значение поля «Оплата получателем».

|75||Specify a valid "Item weight" «Item weight» field value.||Укажите корректное значение поля «Масса единицы товара».

|76||Specify a valid "Quantity" «Quantity» field value.||Укажите корректное значение поля «Количество товара».

|77||Specify a valid "Item price" «Item price» field value.||Укажите корректное значение поля «Цена единицы товара».

|78||Specify a valid "Delivery «Delivery time from" from» field value.||Укажите корректное значение поля «Время доставки с».

|79||Specify a valid "Delivery «Delivery time to" to» field value.||Укажите корректное значение поля «Время доставки до».

|80||Specify a valid "Pickup «Pickup time from" from» field value.||Укажите корректное значение поля «Время забора с».

|81||Specify a valid "Pickup «Pickup time to" to» field value.||Укажите корректное значение поля «Время забора до».

|82||Specify a valid "Pickup point" «Pickup point» field value.||Укажите корректное значение поля «ПВЗ».

|85||Specify a valid "Weight «Weight at return trip" trip» field value.||Укажите корректное значение поля «Вес возврата».

|86||Specify the "Weight «Weight at return trip" trip» field value.||Укажите значение поля «Вес возврата».

|90||Inappropriate "Weight" «Weight» or "Pay type" «Pay type» field value for the selected city or town. Please review and correct the values.||Значение поля «Масса» или «Тип оплаты» для выбранного города указано некорректно или отсутствует. Проверьте значения и исправьте.

|108||Specify the "Additional services" «Additional services» field value.||Укажите значение поля «Дополнительные услуги».

|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/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.||Дублирование кода дополнительной услуги в заказе|-|144||Incorrect extrafields.||Некорректные расширенные поля.|-|} === Запрос статуса заказов Передача значений полей в форме создания заказа в Личном Кабинете через GET параметры ===Если вам требуется передавать значения полей в форме создания заказа в Личном Кабинете через GET параметры, то вы можете подробно ознакомиться с этим на данной странице - [[Личный_кабинет_клиента#Передача и подстановка значений полей формы создания заказа через GET параметры]]

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

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

# Периода запроса статусов (контейнеры '''datefrom''' и '''dateto''') ограничивается двумя месяцами &mdash; месяцами — два месяца до даты '''"по"«по»'''.# Если не указаны обе даты &mdash; даты — '''dateto''' принимается равной текущей дате.# Если не указана дата '''dateto''' &mdash;  — она принимается равной '''datefrom''' плюс 2 месяца.# Если не указана дата '''datefrom''' &mdash;  — она принимается равной '''dateto''' минус 2 месяца.# Поиск по '''conditions''' работает только для «Номер заказа(шифр)» и только от 4 символов

<br /> === Примеры ответов ===

<pickupprice>NO387.5</pickupprice> <inshprice>387.5</inshprice> <paytype code="1">CASH</paytype>

<status eventstore="филиал в Санкт-Петербурге" eventtime="2016-06-02 17:22:00" createtimegmt="2016-06-03 16:14:44" message="" title="Доставлен" eventtown="Санкт-Петербург город" color="16777215">COMPLETE</status>

<status eventstore="Офис в Москве" eventtime="2016-05-30 10:20:00" createtimegmt="2016-06-03 16:14:44" message="" title="Новый" eventtown="Москва город" country="RU">NEW</status> <status eventstore="Офис в Москве" eventtime="2016-06-01 17:38:00" createtimegmt="2016-06-03 16:14:44" message="филиал в Санкт-Петербурге" title="Планируется отправка" eventtown="Москва город" country="RU">DEPARTURING</status> <status eventstore="Офис в Москве" eventtime="2016-06-01 19:53:00" createtimegmt="2016-06-03 16:14:44" message="филиал в Санкт-Петербурге" title="Отправлено со склада" eventtown="Москва город" country="RU">DEPARTURE</status> <status eventstore="филиал в Санкт-Петербурге" eventtime="2016-06-02 07:41:00" createtimegmt="2016-06-03 16:14:44" message="" title="Получен складом" eventtown="Санкт-Петербург город" country="RU">ACCEPTED</status> <status eventstore="филиал в Санкт-Петербурге" eventtime="2016-06-02 09:17:00" createtimegmt="2016-06-03 16:14:44" message="" title="Выдан курьеру на доставку" eventtown="Санкт-Петербург город" country="RU">DELIVERY</status> <status eventstore="филиал в Санкт-Петербурге" eventtime="2016-06-02 17:22:00" createtimegmt="2016-06-03 16:14:44" message="" title="Доставлен (предварительно)" eventtown="Санкт-Петербург город" country="RU">COURIERDELIVERED</status> <status eventstore="филиал в Санкт-Петербурге" eventtime="2016-06-02 17:22:00" createtimegmt="2016-06-03 16:14:44" message="" title="Доставлен" eventtown="Санкт-Петербург город" country="RU">COMPLETE</status>

<outstrbarcodereceipt fdNum="124555" fnSn="9289000100295555" kktNum="0001611984048555" inn="7722756555" fdValue="2899551555" summ="387.5" ofdUrl="gate.ofd.ru">EXT123456<https://ofd.ru/rec/7722756555/0001611984048555/9289000100295555/outstrbarcode> <return_message>Доставлено в целости<124555/return_message> <department>Отдел2899551555</departmentreceipt>

<item code="34533" extcode="abc123" quantity="1" mass="0.2" retprice="37.5" VATrate="0" barcode="2345625213125" article="1" returns="0" origincountry="040" GTD="" excise="0.00" governmentCode="11223311" govType="1" suppcompany="Поставщик" suppINN="1112223334" suppphone="79161234567">Мяч</item> <item code="34456" extcode="abc124" quantity="2" mass="2" retprice="100" VATrate="10" barcode="4645625213138" article="2" returns="0" governmentCode="" govType="1">Обруч</item> <item code="34421" extcode="abc125" quantity="3" mass="0.3" retprice="50" VATrate="18" barcode="2345625213126" itemcode="44123" article="3" returns="0" governmentCode="" govType="1">Погремушка желтая</item>

:* '''''awb''''' -  — Номер накладной в системе курьерской службы.:* '''''orderno2''''' -  — Номер накладной в подсистеме срочной доставки курьерской службы.:* '''''ordercode''''' -  — внутренний код заказа в системе, применяется для некоторых внутренних операций.:* '''''givencode''''' -  — внутренний код заказа в системе, применяется для некоторых внутренних операций. *'''paytype''' - Тип оплаты заказа получателем. Принимает значения::: CASH - Наличными при получении (по-умолчанию):: CARD - Картой при получении:: NO - Без оплаты.:: OTHER - Прочее (Предусмотрен для того, чтобы оплата поступала непосредственно в курьерскую службу посредством прочих типов оплаты - таких как: вебмани, яденьги, картой на сайте, прочие платежные системы и т.д.)* Атрибуты контейнера '''paytype''':** '''''code''''' - (integer) внутренний код типа оплаты заказа в системном справочнике "Типы оплаты корреспонденции". Не обязательный элемент. 

* атрибут '''''code''''' контейнера '''item''' -  — внутренний код строки заказа в системе, применяется для некоторых внутренних операций.:* '''''returns''''' -  — количество данного товара, от которого отказался получатель. Не нулевое только в случае частичного отказа.

* атрибут '''''got''''' контейнера '''package''' -  — признак принятого места YES / NO.:* '''''returns''''' -  — количество данного товара, от которого отказался получатель. Не нулевое только в случае частичного отказа.

* '''''area''''' в контейнере '''receiver''' — район/метро получателя.* '''''coords''''' в контейнере '''receiver''' -  — координаты получателя.* '''''deliveryPIN''''' в контейнере '''receiver''' -  — Пин-код.* '''pickup''' -  — признак оформления забора, возможные значения: '''YES''', '''NO'''. Если указано '''YES''', то весь заказ считается заданием на забор груза, а не на доставку.* '''currcoords''' -  — текущие координаты заказа. Атрибуты::* '''''lat''''' -  — широта:* '''''lon''''' -  — долгота:* '''''accuracy''''' -  — точность в метрах:* '''''RequestDateTime''''' -  — дата/время последнего обновления координат.

* '''courier''' -  — Данные курьера, которому выдан заказ. Если заказ не выдан, то выводятся данные запланированного курьера.* '''waittime ''' -  — Время ожидания курьера.* '''deliveryprice''' -  — Стоимость услуг в валюте расчетов с клиентом. Атрибуты::* '''''total''''' -  — общая стоимость услуг:* '''''delivery''''' -  — стоимость доставки "Туда"«Туда»:* '''''return''''' -  — стоимость доставки "Обратно" «Обратно» (если order->return=YES)Тэг '''deliveryprice''' включает список дополнительных услуг (только для тарифа "Премиум"«Премиум»)::* '''''advprice''''' -  — наименование дополнительной услуги:* '''''code''''' -  — код дополнительной услуги:* '''''price''''' -  — стоимость дополнительной услуги

* '''status''' -  — статус доставки (список статусов см. ниже). Атрибуты (заполняются начиная с версии системы 2008.0.0.670)::* '''''eventstore''''' -  — филиал, к которому относится текущий статус:* '''''eventtime''''' -  — время события по часовому поясу места его наступления.:* '''''createtimegmt''''' -  — время по GMT создания записи о смене статуса в БД. Используется для сортировки записей, чтобы соблюсти хронологическую последовательность. <spoiler text="Подробнее">Большинство событий фиксируются в полях eventtime и createtimegmt на основании одного действия, тогда они отличаются только сдвигом от GMT. Однако, если курьер доставил отправление 10.10.2010 в 20:00, по какой-то причине не внес это в мобильное приложение, на следующий день сдал накладную, и в 9 утра оператор внесла, что он доставил вчера в 20:00. Тогда в createtimegmt будет сегодня 6 утра (для Москвы), а в eventtime - eventtime — вчера в 20:00. При этом оператор по каким-то причинам может внести время вручения раньше, чем какое-то предыдущее событие, т.о. нарушится последовательность времени в eventtime, но при сортировке по createtimegmt все-равно все будет правильно.</spoiler>:* '''''message''''' -  — наименование филиала-получателя, при передаче между филиалами:* '''''title''''' -  — русское наименование статуса

* '''statushistory''' -  — история статусов доставки. Содержит список контейнеров '''status'''. Заполняется только для тарифа "Премиум" «Премиум» начиная с версии системы 2008.0.0.670.* '''customstatecode''' -  — код внутреннего статуса курьерской службы. Значения уточняйте в курьерской службе. Назначаются курьерской службой в разделе "Справочники" - "Статусы" - "15 «Справочники» — «Статусы» — «15 Статусы корреспонденции"корреспонденции». Справочник не передается через API клиенту по причине возможного наличия в нем внутренних технологических статусов курьерской службы.* '''clientstatecode''' -  — код статуса клиента. Используется, если клиент предлагает свои коды статусов доставки/причин недоставки.* '''deliveredto''' -  — данные из поля «Инфо. о вручениидоставке» (может быть информация о доставке, либо причина недоставкии т. п.).* '''delivereddate''' -  — дата вручения.* '''deliveredtime''' -  — время вручения. В случае недоставки может быть пустым.* '''arrival''' -  — плановая дата прибытия в формате гггг-мм-дд чч:мм:сс. Заполняется только при использовании автоматических систем планирования (Максоптра, Яндекс доставка), во всех остальных случаях - пустое.* '''outstrbarcode''' -  — код у подрядчика (код заказа во внешней системе). Используется в интеграциях с внешними системами.* '''partner''' — текущий филиал/подрядчик.* '''return_message''' -  — информация о возврате* '''department''' -  — Подразделение, в котором оформляется заказ.

: AWAITING_SYNC — AWAITING_SYNC — Ожидает синхронизации. Данные заказа пока не появились в службе доставки.: '''NEW''' —  — Успешно создан, передан в службу доставки.: NEWPICKUP — NEWPICKUP — Создан забор.: PICKUP — PICKUP — Забран у отправителя.: WMSASSEMBLED — WMSASSEMBLED — Скомплектован на складе фулфилмента.: WMSDISASSEMBLED — WMSDISASSEMBLED — Разукомплектован на склад фулфилмента.: '''ACCEPTED''' —  — Получен складом.: CUSTOMSPROCESS — CUSTOMSPROCESS — Производится таможенный контроль.: CUSTOMSFINISHED — CUSTOMSFINISHED — Таможенный контроль произведен.: CONFIRM — CONFIRM — Согласована доставка.: UNCONFIRM — UNCONFIRM — Не удалось согласовать доставку.: DEPARTURING — DEPARTURING — Планируется отправка со склада на другой склад.: DEPARTURE — DEPARTURE — Отправлено со склада на другой склад.: INVENTORY — INVENTORY — Инвентаризация. Убедились в наличии отправления на складе.: PICKUPREADY — PICKUPREADY — Готов к выдаче в ПВЗ.: '''DELIVERY''' —  — Выдан курьеру на доставку.: COURIERDELIVERED — COURIERDELIVERED — Доставлен (предварительно, ождает ожидает подтверждения менеджером, чтобы перейти в статус COMPLETE).: COURIERPARTIALLY — COURIERPARTIALLY — Частично доставлен (предварительно, ождает ожидает подтверждения менеджером, чтобы перейти в статус PARTIALLY).: COURIERCANCELED — COURIERCANCELED — Отказ (предварительно, после этого ожидается COURIERRETURN).: COURIERRETURN — COURIERRETURN — Возвращено курьером. Курьер не смог доставить до получателя и вернул заказ обратно на склад. Это промежуточный статус, после которого менеджер выясняет, нужно ли повторно доставлять (статусы DATECHANGE/DELIVERY) или это окончательная недоставка (CANCELED).: DATECHANGE — DATECHANGE — Перенос даты доставки. : '''COMPLETE''' — Доставлен.: '''PARTIALLY''' — Доставлен частично.: '''CANCELED''' — Не доставлен (Возврат/Отмена). После этого статуса отправление должны вернуть заказчику, будут статусы RETURNING и RETURNED : RETURNING — Планируется возврат заказчику (после CANCELED).: RETURNED — Возвращен заказчику.: LOST — Утрачен/утерян.

: '''COMPLETE''' PARTLYRETURNING — ДоставленПланируется возврат остатков.: '''PARTIALLY''' PARTLYRETURNED — Доставлен частичноОстаток возвращен.: '''CANCELED''' TRANSACCEPTED — Не доставлен (Возврат/Отмена)Прибыл на склад перевозчика.: PICKUPTRANS — Забран у перевозчика. После этого статуса отправление должны вернуть заказчику, будут статусы RETURNING и RETURNED

# Контейнер '''packages''' не возвращает более 1000 элементов.# Система никогда не гарантирует последовательность прохождения заказом набора статусов. Т.е. То есть Вы можете получить статус "COMPLETE"«COMPLETE», а следующим запросом - "NEW" - запросом — «NEW» — такое может произойти, например, если оператор ошибочно отметил заказ выполненным, а затем исправил ошибку.

<br />

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

Для получения только изменившихся статусов отправьте запрос:

Система выдает все заказы, в которых, с момента последнего запроса в этом режиме, изменилось хотя бы одно из полей:

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

*'''auth''' - Авторизация — авторизация. Обязательный элемент.*'''streamid''' - Идентификатор  — идентификатор потока. Если у вас несколько интеграций и каждая нуждается в получении статусов, вы можете передавать данный параметр и тем самым разделять получение и отметку об успешном получении статусов по заказам. Значение должно входить в промежуток от 100 до 10000, включительно. Необязательный элемент. *'''client''' - Признак  — признак клиента или агента. Необязательный элемент.:* CLIENT - Признак CLIENT — признак клиента, значение по умолчанию:* AGENT - Признак AGENT — признак агента. В ответ отдается информация по заказам, переданным агенту на доставку

В случае успеха Вы вы получите ответ :

Данный Такой способ передачи статусов гарантирует полную корректную передачу статусов, даже в случае, если в нашей системе статус изменился в промежутке времени между запросом статусов и подтверждением их получения. Если система не получила подтверждение успешной передачи статуса, она будет считать информацию не переданной, непереданной и выдаст ее при повторном запросе.

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

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

Запрос трекинга по номеру предназначен для выдачи минимальной обезличенной информации о конкретном заказе не авторизованному пользователю. Наша система имеет для этого интерфейс по адресу "home.courierexe.ru/{код экстра}/tracking". Вы можете либо сделать ссылку на такую страницу на своем сайте, либо разместить ее iframe'ом у себя, либо сделать свою и пользоваться нашим API. Этот интерфейс создан специально для выдачи информации живому пользователю сайта. Для получения статусов заказов в свою информационную систему нужно использовать запрос "statusreq", желательно с параметром changes=ONLY_LAST!''Пример'''

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

<?xml version="1.0" encoding="UTF-8"?><trackingstatusreq> <auth extra="8" login="login" pass="pass"></auth> <changes>8ONLY_LAST</extrachanges> <ordernolimit>12345</ordernolimit></trackingstatusreq>

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

<?xml version="1.0" encoding="UTF-8" ?><commitlaststatus> <auth extra="8" login="login" pass="pass"></auth> <acs> <ac>11111</ac> <ac>22222</ac> <ac>33333</ac> <ac>44444</ac> <ac>55555</ac> </acs></commitlaststatus></source>  * '''acs''' — контейнер. Обязательный элемент.* '''ac''' — атрибут''' ordercode''' контейнера '''order''' полученного на этапе запроса '''statusreq'''. Помимо приведенных в примере параметров, вы также можете передавать и остальные, описанные ранее, например '''streamid'''. == Трекинг заказа по номеру ==Запрос трекинга по номеру предназначен для выдачи минимальной обезличенной информации о конкретном заказе не авторизованному пользователю. Наша система имеет для этого интерфейс по адресу «home.courierexe.ru/{код экстра}/tracking». Вы можете либо сделать ссылку на такую страницу на своем сайте, либо разместить ее [[#Размещение страниц на своем сайте (iframe)|iframe’ом]] у себя, либо сделать свою и пользоваться нашим API. Этот интерфейс создан специально для выдачи информации живому пользователю сайта. Для получения статусов заказов в свою информационную систему нужно использовать запрос «statusreq», желательно с параметром changes=ONLY_LAST! '''Пример запроса:'''<source lang="xml"><?xml version="1.0" encoding="UTF-8"?><tracking> <extra>8</extra> <orderno>1234</orderno></tracking></source> '''Пример ответа:'''<source lang="xml"><?xml version="1.0" encoding="UTF-8"?>

<order orderno="111111" ordercode="12345">

<return_service>2</servicereturn_service>

Функция ищет последний заказ по номеру среди заказов всех клиентов. Выдает неперсонализированную информацию о текущем состоянии заказа.<br />Описание контейнеров ответа аналогично описанию [[API#.D0.97.D0.B0.D0.BF.D1.80.D0.BE.D1.81_81 .D1.81.D1.82.D0.B0.D1.82.D1.83.D1.81.D0.B0_B0 .D0.B7.D0.B0.D0.BA.D0.B0.D0.B7.D0.BE.D0.B2|Запроса статусов заказов]]. == Изменение заказа ==Запрос предназначен для изменения заказов, по которым не было произведено изменений статуса корреспонденции, времени доставки — то есть заказов, которые ещё не в работе.

# Данные запроса изменения указываются '''полностью''', как если бы заказ создавался впервыеЭтим методом вы можете только получить ссылку на оплату.# При отсутствии вложения в запросе изменения данное вложение '''не удаляется''' из заказа, но Фискализация этого платежа идет отдельным процессом. По его количество становится равным 0.# При одновременном изменении заказа возможности уточняйте в API и системе курьерской службы приоритет отдается данным системы курьерской службыслужбе поддержки. То есть изменения в API приняты не будут!

=== Описание полей запроса изменения ===Заказ доступен для оплаты, если:Все поля запроса соответствуют структуре order при создании * тип оплаты заказа за исключением:не наличными, а например картой или по договору, альтернативой может стать установка параметра "Спрашивать тип оплаты" в карточке клиента.* заказ имеет наложенный платеж* вместо корневого тэга '''neworder''' указывается '''editorder'''не оплачен* тэг штрих-кода '''barcode''' активен (не указываетсядоставлен, поскольку присваивается при создании заказане возвращен в т.ч.курьером) * для вложений '''item''' указывается внутренний код вложения в атрибуте Пример запроса:'''<source lang="xml"><?xml version="1.0" encoding="UTF-8"?><acqlink> <extra>8</extra> <acq> <code>2</code> </acq> <order> <code>12345</code''', который можно получить при получении статуса заказа.> </order></acqlink></source>

Значение где*'''ordernoextra''' данным методом изменить нельзя- код экстраклиента в системе Measoft.*acq.'''code''' - внутренний код платформы эквайринга в системе Measoft. (известен в МП из [https://wiki.courierexe.ru/index.php/API#.D0.A2.D1.80.D0.B5.D0.BA.D0.B8.D0.BD.D0.B3_.D0.B7.D0.B0.D0.BA.D0.B0.D0.B7.D0.B0_.D0.BF.D0.BE_.D0.BD.D0.BE.D0.BC.D0.B5.D1.80.D1.83 Трекинга]) *order.'''ordercode''' - внутренний код заказа, типа ''int'', уникальный в пределах экстраклиента

'''Пример ответа:'''<source lang="xml"><?xml version="1.0" encoding="UTF-8"?><acqlink error="0" amount="2000" extid="161083231">https://qr.nspk.ru/AD10001A7GLVGA9YDO2I0789SIOPV3?type= Описание полей ответа изменения 02&amp;bank=1000011&amp;sum=2000&amp;cur=RUB&amp;crc=7E9C</acqlink>Все поля ответа соответствуют ответу при создании заказа за исключением корневого тэга — вместо '''neworder''' возвращается '''editorder'''.</source>

== Отмена где*'''acqlink''' - ссылка на оплату заказа ==Запрос предназначен для отмены заказов*acqlink.'''amount''' - тип integer сумма платежа в копейках в общем случае, по которым не было произведено изменений статуса доставкив других случаях в соответствии с типом валюты*acqlink.'''extid''' - идентификатор счета на стороне платежной системы*acqlink.'''error'' - код ошибки, статуса корреспонденцииесли отличается от 0, времени доставкиозначает невозможность получения ссылки на оплату, то есть заказов, которые ещё в этом случае ссылки на оплату не в работебудет и ответ будет выглядеть так:<source lang="xml"><?xml version="1.0" encoding="UTF-8"?><acqlink error="2" message="Ошибка авторизации: Invalid token" amount="2000" extid=""/></source>

Отменять заказы могут курьерские службы с тарифами «Премиум» и «Максимум»где*acqlink. Чтобы разрешить отмену заказов, в личном кабинете курьерской службы перейдите в '''Параметрыmessage''' > '''Расширенные''' и установите флажок '''Разрешить отмену и изменение заказов'''.- текст ошибки возвращаемой эквайрингом

При отмене заказа поле «Инфо о доставке» получает значение «Отменено заказчиком»Возможные типы ошибок получения ссылки:* '''1''' - не настроен эквайринг, поле «Дата доставки» — текущую датулибо не найден заказ* '''2''' - ошибка на стороне эквайринга* '''3''' - запрещающий статус курьера (заказ доставлен, а «Вручил курьер» — системную запись «ОТМЕНА».частично доставлен)* '''4''' - оплата заказа не разрешена

Изменять заказы могут курьерские службы с тарифами «Премиум» и «Максимум». Чтобы разрешить изменение заказов, в личном кабинете курьерской службы перейдите в '''Пример запроса отмены заказа:Настройки'''<source lang="xml"><?xml version="1'''Заказы''' и в разделе '''Отмена и редактирование''' установите флажок '''Разрешить отмену и изменение заказов'''.0" encoding="UTF-8" ?><cancelorder> Вы также можете пометить в списке '''Статусы для отмены и редактирования заказов''' <auth extra="8" login="login" pass="pass" /> <order orderno="" ordercode="123456" /> <order orderno="123aaa" ordercode="" /></cancelorder></source>галками статусы корреспонденции, для которых возможны отмена и изменение заказов. По умолчанию (когда в этом списке ничего не выбрано) редактирование и отмена разрешены для статуса «Новый»

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

'''cancelorder''' — Корневой контейнер. Обязательный элемент.* '''auth''' — Авторизация. Обязательный элемент.* '''order''' — Контейнер отменяемого При отмене заказаполе «Инфо о доставке» получает значение «Отменено заказчиком», поле «Дата доставки» — текущую дату, а «Вручил курьер» — системную запись «ОТМЕНА». Обязательный элемент. Запрос может содержать более одного контейнера '''order'''. Атрибуты::* '''''orderno''''' — Шифр заказа.:* '''''ordercode''''' — Внутренний код заказа.Обратите внимание, что должен быть указан хотя бы один из атрибутов ''orderno'' или ''ordercode''!

'''Пример запроса отмены заказа:'''<source lang="xml"><?xml version="1.0" encoding="UTF-8" ?><cancelorder> <auth extra="8" login="login" pass="pass" /> <order orderno="" ordercode="123456" /> <order orderno="123aaa" ordercode="" /></cancelorder></source>  '''Описание полей:''' '''cancelorder''' — Корневой контейнер. Обязательный элемент.* '''auth''' — Авторизация. Обязательный элемент.* '''order''' — Контейнер отменяемого заказа. Обязательный элемент. Запрос может содержать более одного контейнера '''order'''. Атрибуты::* '''''orderno''''' — Шифр заказа.:* '''''ordercode''''' — Внутренний код заказа.Обратите внимание, что должен быть указан хотя бы один из атрибутов ''orderno'' или ''ordercode''!  '''Пример ответа:'''

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

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

<item name="doc1.docx" timestamp="2025-01-01 12:00:00" size="35654">JVBERi0xLjMNJVBERixLjMN JUBQREYwMTIzNDU2Nzg5IDI NMyAwIG9iag08PA0vVHlwZSAUwLJdLwIDKxTn+AScMjKqor7Xm3sp1yj1k6BzlPdX2Qsiit6yg3g1fCI4YVAgclUOIY5tDra2LvAcIS U3VidHlwZSAvSW1hZ2UNL1d pZHRoIDE4MDgNL0hlaWdodCA5/+8PsL/sXb0+aoper/9kL/4Ov/YE9QsHwyg7YZTtKICy0YVIYb4Nt7L1tPUMfaX9NpuTsvFCtBAvYG ggNCAwIFINL0JpdHNQZXJDb 21wb25lbnQgMQ0vRGVjb2RlUeJVZoZ2tm6+fZVqAavZpeLizVLtct1a+xvG0+bTSkw3Ac8PhdNfL4smrT2hSgPJLfyaVGyA2ndyW22t ENL0NvbHVtbnMgMTgwOA0sFtTP5knktPNumSZ56QsFRPJkaU8ExDxAcMYMDIoBiIoR4/dDjHMbMW/EW4fiB1pvWmV2ONWIl1Xdub Xg1ob0qWX9W4qagsqzGhjRLsEGeJGVXg9oVC+XkJa9esrhGUmC0tuKEla+AplVO/OtHwXcW0FWui1z7 6KHrtobuWV0xa9sCEiSvb91w3ePHOvfcveo5xt9o4ZevHF7ZOeKxV5qmVx2MI44a1L+Mhk5YuGT12xd Ibsb7r+j9bff/unQlv0al6HBnoD5G89q4+tkjgDtvwwARmqm2aa2Jgvmth8mrXquTNtl2u467vbF/5r vnMt9uesu21Me1bjeNJGlVfAaCtw+/jfenJ/fWjqa7ygExx+P g0vSW1hZ2VNYXNrIHRydWUNLL0BcTGroxrKexQXIQ1ImfEW7ZRJZa+O XhEZWNvZGUNPj4Nc3RyZWFt DQ<ip7xJmmNESMxrgu/item>dquBbGypjJpFDJVRH1rVPR1Ifl4aFS5IEdDWZFSdyBBWKWhVSVu517ZgzOCFAwp wwbFph29g4fTaxnvn/3X78x+Tt56ZNffArgULt+HByvy7+yz6U6XWMawCi3+6gJXN0S+jf4t+HT34wg <item name="photo2.jpg" size="74861">VBERi0xLjMN km7/HDp55YTSWMoCMgZsvZkBrXtIv4WA7xgkT4YpYpxjwLvnsWKkGE+pDbxER0UUWlpVFRY4oilTfM4 JUBQREYwMTIzNDU2Nzg5IDI NMyAwIG9iag08PA0vVHlwZSAMIzgCPgxjOlZ87ceA7ceRJrgpipFGyugPQ4OTI2S8lWJoqTpHJlJbNOeYM7zTcoVxSNyJXiYWSAMklT vWE9iamVjdA0vU3VidHlwZS AvSW1hZ2UNL1dpZHRoIDEzNj q/xd+3fd3/USq2V1rJ7RyBLHsuDSiLwgaOFc5LUCRGI+QWuBAsIwPlZrgRpSMseJyTzD15PKiIRE7bc gNL0hlaWdodCAxMzMzDS9MZ W5ndGggNCAwIFINL0JpdHNQZ Rggk5ijXAPpqISetD4wVm0AD2LHuBZdaxmK3HOKIZoG0QLmiZdVqspXnFIJwVyCKhWiDCI4bzH8Y76w XJDb21wb25lbnQgMQ0vRGVj b2RlUGFybXMgPDwNL0sgLTEN TAnwM67HIqMISOkmJXY8mlYhpiNa7g2oTBkKxo4wgnvETQIUUrlFOn9KdOreDiKQx071rN4N61yRAi1 L0NvbHVtbnMgMTM2OA07EGRhSOgoeLYv+k41+KZ1SVBXAuDjB+xuxnQmm8wJDcP5IRn+Pg0 vSW5penzbR/ivm7qleHK5o790w8ejXchI vOHIPWtWwYhtAO34LdDXqFqWxZEBLNstMCwwITBTWirxk12zuUppp</item>

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

<item code="34533" quantity="1" reason="0" governmentCode="11223311" />

<image attachments> <attachment filename="filename1.jpg"> /9j/4AAQSkZJRgA BAQAAAQABAAD/2wBDAA0JCg sKCA0LCgsODg0PEyAVExISEy ccHhcgLikxMC4pLSwzOko+M zZGNywtQFdBRkxOUlNSMj5aY VpQYEpRUk//2wBDAQ4ODhMR EyYVFSZPNS01T09PT09PT09P T09PT09PT09PT09PT09PT09 PT09PT09PT09PT09PT09PT09 PT09PT0//wAARCAYACAADAS IA</attachment> <attachment filename="filename2.jpg"> /9j/4AAQSkZJRgA BAQAAAQABAAD/2wBDAA0JCg sKCA0LCgsODg0PEyAVExISEy ccHhcgLikxMC4pLSwzOko+M zZGNywtQFdBRkxOUlNSMj5aY VpQYEpRUk//2wBDAQ4ODhMR EyYVFSZPNS01T09PT09PT09P T09PT09PT09PT09PT09PT09 PT09PT09PT09PT09PT09PT09 PT09PT0//wAARCAYACAADAS IA</imageattachment> </attachments>

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

'''waybill''' -  — Корневой контейнер. Обязательный элемент*'''auth''' -  — Авторизация. Обязательный элемент* '''client''' — Признак клиента или агента. Необязательный элемент.:* CLIENT — Признак клиента, значение по умолчанию:* AGENT — Признак агента. В ответ отдается информация по заказам, переданным агенту на доставку*'''orders''' -  — Список заказов для получения печатных форм. Содержит тэги '''order''' с атрибутами::* '''''orderno''''' -  — шифр заказа:* '''''ordercode''''' -  — внутренний код заказа. Указывать необходимо один из атрибутов для всех заказов. Приоритет имеет атрибут '''''ordercode'''''*'''form''' -  — Формат накладной. Не обязательный элемент. Принимает значения::* 1 - 1 — Подробная накладная (по-умолчанию):* 2 - 2 — Наклейки Zebra:* 3 - 3 — Наклейки на страницу формата А4:* 4 - 4 — Акты приема-передачи* '''start''' — Имеет смысл только для form = 3. Начальная позиция первой наклейки. Используется для пропуска наклеек на листе для их экономии.* '''integration''' - Получение наклеек от подрядчика. Не обязательный элемент, имеет смысл при наличии кода подрядчика в карточке заказа. Принимает значение::* 21 - подрядчик GTD

*'''auth''' -  — Авторизация, необязательный элемент. Используется в случае включенного и настроенного ограничения по населенным пунктам в конкретной курьерской службе.

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

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

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

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

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

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

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

*'''conditions''' -  — Задает условия поиска. Все вложенные элементы одновременно накладывают условие "И"«И».:* '''namecontains''' -  — Поиск товаров, название которых содержит указанный текст.:* '''namestarts''' -  — Поиск товаров, название которых начинается с указанного текста.:* '''name''' -  — Поиск товаров, название которых соответствует указанному тексту.:* '''quantity''' -  — Наличие на складе. Принимает значения EXISTING_ONLY - EXISTING_ONLY — Только в наличии, NOT_EXISTING_ONLY - NOT_EXISTING_ONLY — Только не в наличии, ALL - ALL — Все. ''Это поле может быть недоступным в некоторых установках.'':* '''store''' -  — Поиск товаров по определенному складу.

*'''except''' -  — Описание исключений для корректного определения количества зарезервированной номенклатуры.:* '''code''' -  — Код заказа.

*'''limit''' -  — Ограничивает вывод результата.:* '''limitfrom''' -  — Задает номер записи результата, начиная с которой выдавать ответ.:* '''limitcount''' -  — Задает количество записей результата, которые нужно вернуть.

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

*'''code''' -  — внутренний код товара в справочнике номенклатуры.*'''datefrom''' -  — дата начала периода.*'''dateto''' -  — дата окончания периода.

*'''code''' -  — внутренний код операции движения*'''date''' -  — дата операции*'''retprice''' -  — цена товара*'''quantity''' -  — количество товара операции*'''delivered''' -  — количество доставленного товара

*'''item''' -  — контейнер товара:* '''code''' -  — внутренний код товара:* '''name''' -  — наименование товара

*'''status''' -  — контейнер статуса операции:* '''code''' -  — код статуса:* '''name''' -  — наименование

*'''store''' -  — контейнер филиала, к которому относится операция:* '''code''' -  — код филиала:* '''name''' -  — наименование филиала

*'''order''' -  — контейнер корреспонденции:* '''ordercode''' -  — внутренний код заказа:* '''number''' -  — номер заказа:* '''date''' -  — дата заказа:* '''orderno''' -  — шифр:* '''barcode''' - штрих-код — штрихкод:* '''company''' -  — компания:* '''address''' -  — адрес:* '''delivereddate''' -  — дата вручения:* '''deliveredtime''' -  — время вручения:* '''deliveredto''' -  — данные о вручении, либо причина недоставки

*'''document''' -  — контейнер документа операции:* '''code''' -  — внутренний код документа:* '''number''' -  — номер документа:* '''extnumber''' -  — внешний номер документа:* '''date''' -  — дата документа:* '''message''' -  — комментарий

== Получение справочника тарифов по городам ==<br />* '''serials''' — контейнер серийных номеров<div style="color: #a94442; background-color: #f2dede; border: 1px solid #ebccd1; padding: 3px 10px 10px;">* '''Обратите внимание!serial'''Если  — серийный номер единицы номенклатуры, участвующей в запросе отсутствует параметр nofederal, то Москва будет обрабатываться иначе, чем остальные города. В ответе будут города Москвы и МО, с добавленной ценой за километраж</div><br />движении

*== Серийные номера =='''auth''' — атрибут Пример запроса движения номенклатуры с серийным номером:'''<source lang="xml"><?xml version="1.0" encoding="UTF-8" ?><serialmovements> <auth extra''' обязателен, по нему определяется курьерская служба.="8" login="login" pass="pass"></auth>*'''townfrom''' — город-отправитель. Если не передан, то городом будет «Москва». <serial>123456789</serial>*'''service''' — режим доставки. Обязательный элемент.</serialmovements>*'''mainonly''' — необязательный элемент. Если передан, то в ответе будут данные только по городам из справочника '''Межгород''' </source> '''Зоны'''. *'''nofederalserial''' — необязательный элемент. Если передан, то в ответе город федерального значения Москва будет обрабатываться как обычный город — серийный номер единицы номенклатуры.

'''Пример ответа справочника тарифов по городамдвижения номенклатуры с серийным номером:'''<source lang="jsonxml">{ <?xml version="townfrom1.0": encoding="0c5b2444-70a0-4932-980cUTF-b4dc0d3f02b58",?> <serialmovements count="service16": 1,> <serialmovement> "tariffs": [<code>151500</code> { <serial>123456789</serial> "towntofias": "0c5b2444 <date>2017-70a005-4932-980c-b4dc0d3f02b5",26</date> "towntocode": 1, "towntoname": "Москва город", "distance": <delivered>0,</delivered> "pricedistance": 0, <item> "pricesnew": { <code>4259</code> "before": [ <name>Настольная игра Дженга</name> { </item> "price": 100, <status> "every": 0, <code>5</code> "mass": 1 <name>Возврат от покупателя</name> }, </status> { <order> "price": 150, <ordercode>3374830</ordercode> "every": <number>123660-0,</number> "mass": 5 <date>2017-05-24</date> } <orderno>14123</orderno> ], <barcode>0000000670</barcode> "after": [ <company>ТОВАР</company> { "price": 0 <address>Кравченко ул., "every": 1,</address> "mass": 38.01 <delivereddate>2017-05-29</delivereddate> }, { "price" <deliveredtime>12: 15, "every"00: 1,00</deliveredtime> "mass": 51.01 <deliveredto /> } </order> ] <document> }, <code>21991</code> "deliveryPeriodMin": 1, <number>318</number> "deliveryPeriodMax": 2 <date>2017-05-26</date> } <message></message> ]</document> </serialmovement>}</serialmovements>

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

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

<itemdocorderserials> <auth extra="8" login="login" pass="pass"></auth> <codeordercode>21991123456789</codeordercode> <orderno>123456789</orderno> <barcode>123456789</barcode></itemdocorderserials>

*'''codeordercode'''  — внутренний код заказа.* '''orderno''' — шифр заказа.* '''barcode''' — штрих- внутренний код документа приходной накладной (смзаказа. предыдущий запрос)Указывать необходимо один из идентификаторов заказа.

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

<itemdocorderserials> <order> <code>219913374830</code> <orderno>14123</orderno> <numberbarcode>3180000000670</numberbarcode> <datedelivereddate>20172024-0507-2620</datedelivereddate> <deliveredtime>10:04:00</deliveredtime> <assemblydate>2024-07-19 07:05:34<message/assemblydate> </messageorder>

<item > <code=">4259" quantity="1" barcode="200300" article="123555"</code> <name>Настольная игра Дженга</name> <article>123000</article> <state>Delivered</state> <serials> <serial>123456789</serial> </serials> </item>

</itemdocorderserials>

*'''itemorder''' - контейнер товара — блок заказа::* '''code''' - внутренний  — код товара:* '''orderno''' — шифр:* '''barcode''' -  — штрих-код товара:* '''articledelivereddate''' — дата доставки факт:* '''deliveredtime''' - артикул товара — время доставки факт:* '''quantityassemblydate''' - количество поступившего товара — дата сборки

* '''item''' — блок товара::* '''code''' — код:* '''name''' — наименование:* '''article''' — артикул:* '''state''' — статус Доставлено (Delivered) или Возвращено (Returned):* '''serials''' — блок серийных номеров по заказу == Справочник филиалов Получение справочника тарифов по городам ==

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

<?xml version="1.0" encoding="UTF-8" ?><storelisttariffs> <auth extra="8"login="login" pass="pass" /> <townfrom>Москва</authtownfrom> <jsonservice>YES1</jsonservice> <client_codemainonly>78901</client_codemainonly> </storelisttariffs>

*'''auth''' - Атрибут  — атрибут '''extra''' - обязателен, по нему определяется курьерская служба.*'''jsontownfrom'''  — город- Признак вывода ответа в виде JSON YES/NOотправитель. Если не передан, то городом будет «Москва».* '''service''' — режим доставки. Обязательный элемент.*'''client_codemainonly''' — необязательный элемент. Если передан, то в ответе будут данные только по городам из справочника '''Межгород''' > ''' - Код клиента курьерской службыЗоны'''.

'''Пример запроса пунктов самовывоза:ответа справочника тарифов по городам'''<source lang="xmljson"><?xml version={ "townfrom": "0c5b2444-70a0-4932-980c-b4dc0d3f02b5", "service": 1, "tariffs": [ { "towntofias": "0c5b2444-70a0-4932-980c-b4dc0d3f02b5", "towntocode": 1., "towntoname": "Москва город", "townregion": "Город Москва", "distance": 0, "pricedistance": 0, "pricesnew" encoding=: { "UTF-8before" ?>: [<pvzlist> { <auth extra= "8price" login=: 100, "loginevery" pass=: 0, "passmass"></auth>: 1 <code>1234</code> }, <client_code>7890</client_code> { <city>Свердловская область</city> "price": 150, <town regioncode= "66every" country=: 0, "RUmass">Нижний Тагил</town>: 5 <parentcode>6</parentcode> } <acceptcash>YES</acceptcash> ], <acceptcard>YES</acceptcard> "after": [ <acceptfitting>YES</acceptfitting> { <maxweight>30</maxweight> "price": 0, <acceptindividuals>YES</acceptindividuals> "every": 1, <lt>57 "mass": 38.924737</lt>01 }, { "price": 15, <lg>59.940019</lg> "every": 1, <rt>57 "mass": 51.905682</rt>01 <rg>59.984669</rg> } <json>YES</json> ] <limit> }, <limitfrom>30</limitfrom> "deliveryPeriodMin": 1, <limitcount> "deliveryPeriodMax": 2</limitcount> } <countall>YES</countall> </limit>]</pvzlist>}

*'''authОписание полей ответа ''' - Атрибут * '''extratownfrom'''  — код ФИАС города- обязателен, по нему определяется курьерская служба, отправителя.* '''loginservice''' и  — режим доставки.* '''passtariffs''' позволяют авторизоваться под клиентом: для отдельного клиента могут быть ограничения  — cписок тарифов по доступности некоторых ПВЗ, и в этом случае они будут учтеныгороду.:*'''codetownregion'''  — регион города- Внутренний кодполучателя.:*'''client_codetowntofias'''  — код ФИАС города- Код клиента курьерской службыполучателя.:*'''citytowntocode'''  — внутренний код города- Регион получателя. Можно указать код региона или полное наименование региона из [[#Справочник регионов|справочника регионов]].:*'''towntowntoname'''  — наименование города- Город получателя.Для тега города :* '''towndistance''' можно указать код региона  — дистанция в км до города от МКАД, если в атрибуте запросе townfrom — Москва.:* '''pricedistance''regioncode' — сумма за километраж до города от МКАД, если в запросе townfrom — Москва.:* '''pricesnew'' ' — ваши настройки тарифов из [[#Справочник регионов|справочника регионов]]'''Межгород''' > '''Тарифы по зонам'''. Поиск будет производиться ::* '''before/after''' — контейнеры ДО/ОТ.:::* '''price''' — цена. Если ответ идет по «before», то в указанном регионецену также плюсуется сумма pricedistance:::* '''every''' — за каждые.:::* '''mass''' — масса.:* '''prices''' — устаревший элемент, не используется.:* '''deliveryPeriodMin''' — минимальный срок доставки.:* '''deliveryPeriodMax''' — максимальный срок доставки.

Также можно указать страну получателя в атрибуте == Номенклатура приходной накладной =='''Пример запроса номенклатуры приходной накладной:''country''''' в соответствии с [https://ru<source lang="xml"><?xml version="1.wikipedia.org/wiki/ISO_31660" encoding="UTF-1 стандартом ISO_3166-1], например, 8" ?><itemdoc> <auth extra="RU8", login="RUSlogin" или pass="643pass" для России. *'''parentcode''' - Фильтр по родительскому [[#Справочник филиалов|филиалу]]*'''acceptcash''' - Фильтр по приему наличных YES></NOauth>*'''acceptcard''' - Фильтр по приему банковских карт YES <code>21991</NOcode>*'''acceptfitting''' - Фильтр по наличию примерки YES</NO*'''maxweight''' - Фильтр по максимальному весу, с которым работает ПВЗ*'''acceptindividuals''' - Фильтр по доступности физическим лицам YES/NO*'''lt''' - Широта левого верхнего угла*'''lg''' - Долгота левого верхнего угла*'''rt''' - Широта правого нижнего угла*'''rg''' - Долгота правого нижнего углаitemdoc>*'''json''' - Признак вывода ответа в виде JSON YES</NO*'''limit''' - Ограничивает вывод результата.:* '''limitfrom''' - Задает номер записи результата, начиная с которой выдавать ответ. По-умолчанию - 0.:* '''limitcount'''- Задает количество записей результата, которые нужно вернуть. По-умолчанию - 100.:* '''countall''' - YES указывает на необходимость подсчета общего количества найденных совпадений. Это может замедлять выполнение запроса. Если отключено - в ответе не указываeтся totalcount.source>

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

<pvzlist count="2" totalcount="40465"itemdoc> <pvz> <code>12621991</code> <clientcodenumber>3318</clientcodenumber> <namedate>Нижний Тагил2017-05-26</namedate> <parentcodemessage>6</parentcodemessage> <parentname>Интеграция</parentnameitems> <town item code="1242674259" regioncodequantity="661" regionnamebarcode="Свердловская область200300" article="123555">Нижний Тагил городНастольная игра Дженга</townitem> <address>622036, г. Нижний Тагил, ул. Циолковского, д. 17 </addressitems> <phone>+73435417709, +73435254989</phoneitemdoc> <comment>Новый пункт доставки</commentsource> <worktime>Вс 10:00-16:00, Сб 10:00-16:00, Пн-Пт 10:00-20:00</worktime> <traveldescription>Жилое 5-ти этажное здание, торцом к дороге, второе здание от перекрестка Пархоменко-Циолковского</traveldescription>''' Описание полей ответа ''' <maxweight>10</maxweight>* '''code''' — внутренний код приходной накладной <acceptcash>YES</acceptcash>* '''number''' — номер документа <acceptcard>YES</acceptcard>* '''date''' — дата документа <acceptfitting>YES</acceptfitting>* '''message''' — комментарий <acceptindividuals>YES</acceptindividuals> <latitude>57.93457</latitude>* '''item''' — контейнер товара <longitude>59.95131</longitude>:* '''code''' — внутренний код товара <uid>40606d00-9c51-11eb-b2c9-cfd6c1111392</uid>:* '''barcode''' — штрихкод товара </pvz>:* '''article''' — артикул товара <pvz>:* '''quantity''' — количество поступившего товара <code>245</code> <clientcode>NTG1</clientcode>== Справочник филиалов == <name>На Красноармейской</name>'''Пример запроса списка филиалов:''' <parentcode>6</parentcodesource lang="xml"> <parentname>Интеграция</parentname> <town code?xml version="1242671.0" regioncodeencoding="66" regionname="Свердловская областьUTF-8"?>Нижний Тагил город</townstorelist> <addressauth extra="8">КРАСНОАРМЕЙСКАЯ, д.79</addressauth> <phonejson>+7(3435)379-044YES</phonejson> <commentclient_code>Возможность примерки отсутствует7890</commentclient_code> <worktime>Вс 10:00-16:00, Сб 10:00-16:00, Пн-Пт 10:00-20:00</worktimestorelist> <traveldescription>Напротив ТЦ Пирамида</traveldescriptionsource> <maxweight>20</maxweight> <acceptcash>YES</acceptcash>* '''auth''' — Атрибут '''extra''' — обязателен, по нему определяется курьерская служба <acceptcard>* '''json''' — Признак вывода ответа в виде JSON YES</acceptcard> <acceptfitting>NO</acceptfitting> <acceptindividuals>YES</acceptindividuals> <latitude>57.93468</latitude> <longitude>60.55476</longitude> <uid>41116853-9c51-11eb-b2c9-cfd6c1451392</uid> </pvz></pvzlist></source>* '''client_code''' — Код клиента курьерской службы

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

<?xml version="1.0" encoding="UTF-8"?><receiptdatastorelist count="2"> <store> <code>123</code> <name>ABC</name> <auth extra="8" login="login" pass="pass" /store> <ordersstore> <code>456</code> <name>Филиал 2<order orderno="123456" /name> <order orderno="890111C" /store> </ordersstorelist></receiptdatasource>

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

'''Пример запроса пунктов самовывоза:'''<source lang="xml"><?xml version="1.0" encoding="UTF-8"?><receipts countpvzlist> <auth extra="8" login="login" pass="1pass"></auth> <code>1234<receipt/code> <ordernoclient_code>1234567890</ordernoclient_code> <fdDatetimecity>2020-06-07 12:14:00Свердловская область</fdDatetimecity> <fdValuetown regioncode="66" country="RU">123Нижний Тагил</fdValuetown> <fdNumaddress>456Щёлковское шоссе</fdNumaddress> <fnSnhouse>78977</fnSnhouse> <kktNumparentcode>1006</kktNumparentcode> <innacceptcash>222YES</innacceptcash> <ofdUrlacceptcard>gate.ofd.ruYES</ofdUrlacceptcard> <fullUrlacceptfitting>https:YES<//check.ofd.ru/123acceptfitting> <maxweight>30</fullUrlmaxweight> <priceacceptindividuals>12345YES</priceacceptindividuals> <lines count="1"respstores> YES<line/respstores> <itemlt>111176457.924737</itemlt> <namelg>Сапоги59.940019</namelg> <qtyrt>157.905682</qtyrt> <pricerg>100059.984669</pricerg> <vatRatejson>20YES</vatRatejson> <governmentCodewith_coords>Z16513LK2YES</governmentCodewith_coords> <limit> <itemTypelimitfrom>130</itemTypelimitfrom> <limitcount>2</linelimitcount> <countall>YES</linescountall> </receiptlimit></receiptspvzlist>

Параметры ответа:*'''ordernoauth''' - Номер заказа* — Атрибут '''fdDatetimeextra''' - Дата и время пробития фискального чека* — обязателен, по нему определяется курьерская служба, '''fdValuelogin''' - ФПД (фискальный признак документа)*и '''fdNumpass''' - ФИСКАЛЬНЫЙ ДОКУМЕНТ (фискальный номер чека)позволяют авторизоваться под клиентом: для отдельного клиента могут быть ограничения по доступности некоторых ПВЗ, и в этом случае они будут учтены.*'''fnSncode''' - ФН (номер фискального накопителя) — Внутренний код.*'''kktNumclient_code''' - РН (регистрационный номер кассы) — Код клиента курьерской службы.*'''inncity''' - ИНН — Регион получателя. Можно указать код региона или полное наименование региона из [[#Справочник регионов|справочника регионов]].*'''ofdUrltown''' - URL адрес (доменное имя) ОФД — Город получателя.*Для тега города '''pricetown''' - Сумма чека*можно указать код региона в атрибуте '''fullUrl''regioncode' - URL чека для просмотра онлайн*'''lines''' - Позиции чека:*'''item''' - код товараиз [[#Справочник регионов|справочника регионов]]. Поиск будет производиться в указанном регионе.:*'''name''' - наименование товара:*Также можно указать страну получателя в атрибуте '''qty''' - количество товара:*'''price''' - цена товара:*'country''governmentCode''' - считанная последовательность, которая в дальнейшем преобразуется по алгоритму тега 1162соответствии с [https:*'''vatRate''' //ru.wikipedia.org/wiki/ISO_3166- НДС товара:*'''itemType''' 1 стандартом ISO_3166- тип товара (товар1], доставка и тнапример, «RU», «RUS» или «643» для России.дДля формата запроса JSON фильтрация по городу работает только в связке с фильтром по адресу.)

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

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

<services pvzlist count="2" totalcount="40465"> <servicepvz> <code>1126</code> <clientcode>3</clientcode> <name>ЭкономНижний Тагил</name> <parentcode>6</serviceparentcode> <parentname>Интеграция<service/parentname> <town code="124267" regioncode="66" regionname="Свердловская область">Нижний Тагил город</town> <address>2622036, г. Нижний Тагил, ул. Циолковского, д. 17</address> <phone>+73435417709, +73435254989</codephone> <namecomment>СрочноНовый пункт доставки</namecomment> <worktime>Вс 10:00-16:00, Сб 10:00-16:00, Пн-Пт 10:00-20:00</serviceworktime> <traveldescription>Жилое 5-ти этажное здание, торцом к дороге, второе здание от перекрестка Пархоменко-Циолковского</servicestraveldescription> <maxweight>10</sourcemaxweight> <acceptcash>YES</acceptcash>== Справочник дополнительных услуг == <acceptcard>YES</acceptcard> <acceptfitting>YES</acceptfitting>'''Пример запроса дополнительных услуг:''' <acceptindividuals>YES</acceptindividuals> <latitude>57.93457<source lang="xml"/latitude> <?xml version="1longitude>59.0" encoding="UTF95131</longitude> <uid>40606d00-9c51-11eb-b2c9-8"?cfd6c1111392</uid> </pvz> <pvz> <code>245</code> <clientcode>NTG1</clientcode> <name>На Красноармейской</name> <parentcode>6</parentcode> <parentname>Интеграция<advprices/parentname> <auth extratown code="8124267" loginregioncode="login66" passregionname="passСвердловская область" >Нижний Тагил город</town> <visibleaddress>КРАСНОАРМЕЙСКАЯ, д.79</address> <phone>+7(3435)379-044</phone> <comment>Возможность примерки отсутствует</comment> <worktime>Вс 10:00-16:00, Сб 10:00-16:00, Пн-Пт 10:00-20:00</worktime> <traveldescription>Напротив ТЦ Пирамида</traveldescription> <maxweight>20</maxweight> <acceptcash>YES</acceptcash> <acceptcard>YES</acceptcard> <acceptfitting>NO</visibleacceptfitting> <acceptindividuals>YES</acceptindividuals> <latitude>57.93468</latitude> <longitude>60.55476</longitude> <uid>41116853-9c51-11eb-b2c9-cfd6c1451392</uid> </pvz></advpricespvzlist>

* '''code''' — Код ПВЗ в системе. Используется в запросе [[API#Оформление заказа|оформления заказов]]* '''advpricesclientcode'''  — Код ПВЗ используемый компанией- Корневой контейнерподрядчиком.* '''name''' — Наименование ПВЗ.* '''parentcode''' — Код родительского элемента.* '''parentname''' — Наименование родительского элемента.* '''town''' — Населенный пункт с кодом из [[#Справочник городов|справочника городов]], а также с кодом и наименованием региона.* '''address''' — Адрес ПВЗ.* '''phone''' — Телефоны ПВЗ. Обязательный элемент* '''comment''' — Дополнительная информация. *'''visibleworktime''' -  — Режим работы ПВЗ.* '''traveldescription''' — Описание местонахождения ПВЗ или пути к нему.* '''maxweight''' — Максимальный вес, с которым работает ПВЗ.* '''acceptcash''' — Признак приема наличных* '''acceptcard''' — Признак возврата приема банковских карт* '''толькоacceptfitting''' тех услуг, что доступны для отображения  — Наличие примерки* '''latitude''' — Широта* '''longitude''' — Долгота* '''uid''' — Уникальный идентификатор ПВЗ в ЛК YES/NOсистеме Measoft. Необязательный элементСоздается автоматически при получении данных о ПВЗ от агентов. По-умолчанию NO* '''count''' — Количество записей в ответе* '''totalcount''' — Общее количество записей, отвечающее параметрам запроса

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

<?xml version="1.0" encoding="UTF-8" ?><advpricesreceiptdata> <advprice> <code>1<auth extra="8" login="login" pass="pass" /code> <name>Этажей в доме</name> <type>int</type> </advprice> <advpriceorders> <code>2 <order orderno="123456" /code> <name>Коэффициент надбавки <order orderno="890111C" /name> <type>float</type> </advprice> <advprice> <code>3</code> <name>Расписаться на упаковке</nameorders> <type>bool</typereceiptdata> </advprice></advprices>

Параметры:*'''code''' - внутренний код услуги*'''name''' - наименование услуги. Если поле "название в ЛК" в настройках услуги не пусто, то возвращает значение поля "название в ЛК".*'''hine''' - подсказка по доп услуге для пользователя*'''typeПример ответа получения фискальных данных:''' - тип услуги. Может иметь значения::*'''bool''' - для услуг вида "чекбокс<source lang=", xml"Да":*'''float''' - для числа с плавающей точкой:*'''int''' - для целого числа>

'''Пример запроса стоимости доставки:'''<source lang="xml"><?xml version="1.0" encoding="UTF-8" ?><calculator> <auth extrareceipts count="8" login="login" pass="pass1" /> <orderreceipt> <pricetypeorderno>CUSTOMER123456</pricetypeorderno> <fdDatetime>2020-06-07 12:14:00<sender/fdDatetime> <townfdValue>Санкт-Петербург123</townfdValue> <addressfdNum>Петровка 38 офис 35456</addressfdNum> <coords lat="55.680327" lon="37.604456"fnSn>789</coordsfnSn> </senderkktNum> 100<receiver/kktNum> <zipcodeinn>125480222</zipcodeinn> <town regioncode="78" country="RU"ofdUrl>Санкт-Петербургgate.ofd.ru</townofdUrl> <addressfullUrl>Петровка 38 офис 35https://check.ofd.ru/123</addressfullUrl> <pvzprice>12412345</pvzprice> <coords latlines count="55.680327" lon="37.6044561"></coords> </receiverline> <weightitem>5.11111764</weightitem> <servicename>2Сапоги</servicename> <paytypeqty>CASH1</paytypeqty> <price>387.51000</price> <deliverypricevatRate>15020</deliverypricevatRate> <inshpricegovernmentCode>387.5Z16513LK2</inshpricegovernmentCode> <packagesitemType> 1<package mass="1"/itemType> </packageline> <package mass="2.5" length="10" width="20" height="30"/lines> </packagereceipt> </packagesreceipts> <userid/source>user123 Параметры ответа:* '''orderno''' — Номер заказа* '''fdDatetime''' — Дата и время пробития фискального чека* '''fdValue''' — ФПД (фискальный признак документа)* '''fdNum''' — ФИСКАЛЬНЫЙ ДОКУМЕНТ (фискальный номер чека)* '''fnSn''' — ФН (номер фискального накопителя)* '''kktNum''' — РН (регистрационный номер кассы)* '''inn''' — ИНН* '''ofdUrl''' — URL адрес (доменное имя) ОФД* '''price''' — Сумма чека* '''fullUrl''' — URL чека для просмотра онлайн* '''lines''' — Позиции чека:* '''item''' — код товара:* '''name''' — наименование товара:* '''qty''' — количество товара:* '''price''' — цена товара:* '''governmentCode''' — считанная последовательность, которая в дальнейшем преобразуется по алгоритму тега 1162:* '''vatRate''' — НДС товара:* '''itemType''' — тип товара (товар, доставка и т. д.) == Справочник Виды срочности =='''Пример запроса видов срочности:'''</useridsource lang="xml"> <groupid?xml version="1.0" encoding="UTF-8" ?>customer</groupidservices> <auth extra="8"/order></calculatorservices>

Параметры:Структура данных и заполнение полей аналогичны и совместимы с [[#Оформление заказа]].== Справочник дополнительных услуг == Дополнительные поля:*'''pricetypeПример запроса дополнительных услуг:''' - тип требуемой цены<source lang="xml"><?xml version="1. Возможные значения: 0"CUSTOMERencoding=" (поUTF-умолчанию) - [[Личный кабинет клиента#Цена доставки для получателя|цена для конечного получателя]], 8"?><advprices> <auth extra="8" login="CLIENTlogin" - цена курьерской службы для клиента.*'''userid''' - Идентификатор пользователя, строковый или числовой тип. Виртуальное поле. Необязательное. Данное поле используется совместно с настройками pass="Цена доставки для получателяpass", определяя приоритет правила. Можно использовать в различных CMS/CRM системах, настраивая цены для определенного покупателя.></advprices>*'''groupid''' - Идентификатор группы пользователя, строковый или числовой тип. Виртуальное поле. Необязательное. Данное поле используется совместно с настройками "Цена доставки для получателя", определяя приоритет правила. Можно использовать в различных CMS</CRM системах, настраивая цены для определенной группы покупателей.source>

Суммы НП и ОЦ, а также тип оплаты CARD имеют значение при настроенных в тарифе на вкладке Прочее долях (в процентах) от данных сумм'''advprices''' — Корневой контейнер. Обязательный элемент.

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

<?xml version="1.0" encoding="UTF-8"?><calculatoradvprices> <calcadvprice> <townfrom code=">1">Москва город</townfromcode> <townto code="56603"name>Иркутск городЭтажей в доме</towntoname> <masstype>3.7int</masstype> <service name="Экспресс">1 </serviceadvprice> <zone>2</zoneadvprice> <pricecode>11132</pricecode> <mindeliverydaysname>1Коэффициент надбавки</mindeliverydaysname> <maxdeliverydaystype>3float</maxdeliverydaystype> <mindeliverydate>2020-05-13 </mindeliverydateadvprice> <deliverypriceadvprice> <advprice code="1" price="1000">База3</advpricecode> <advprice code="4" price="100"name>Процент от суммы рубРасписаться на упаковке</advpricename> <advprice code="5" price="63"type>Процент от объявленной стоимостиbool</advpricetype> <advprice code="6" price="-50">Скидка при доставке </advprice> </deliveryprice> </calc></calculatoradvprices>

*'''townfrom''' - Город-отправитель так, как система его распознала и привязала к справочнику. Атрибут '''code''' -  — внутренний код из справочника городов системы.услуги*'''towntoname''' - Город-получатель так, как система его распознала и привязала к справочнику — наименование услуги. Атрибут '''code''' - код из справочника городов системы.*'''mass''' - Масса Если поле «название в ЛК» в килограммах*'''service''' - Режим доставки - числонастройках услуги не пусто, указывающее на запись то возвращает значение поля «название в справочнике видов срочности (см описание на этой странице)ЛК».*'''zonehine''' - номер тарифной зоны,  — подсказка по которой рассчиталась стоимость. В зависимости от зоны выбирается тарифная сетка. Так же к цене могут применяться повышающие или понижающие коэффициенты при доставке не из/в региональный центр.доп услуге для пользователя*'''pricetype''' - рассчитанная стоимость доставки в валюте прайс-листа курьерской службы. Рекомендуется к использованию в отличие от одноименного атрибута родительского контейнера — тип услуги.Может иметь значения::*'''maxdeliverydaysbool''' - максимальный срок доставки в рабочих днях. — для услуг вида «чекбокс», «Да»:*'''mindeliverydatefloat''' - минимальная дата доставки в учетом выходных дней.  — для числа с плавающей точкой:*'''deliverypriceint''' - Данные по составляющим ценам доставки — для целого числа

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

<clientcalculator> <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"></clientcoords> </sourcesender> <receiver> <zipcode>125480</zipcode>'''client''' <town regioncode="78" country="RU">Санкт- Корневой контейнерПетербург</town> <address>Петровка 38 офис 35</address> <pvz>124</pvz> <coords lat="55. Обязательный элемент680327" lon="37.604456"></coords> </receiver>*'''auth''' - Авторизация <weight>5. Обязательный элемент1</weight> <service>2</service> <paytype>CASH</paytype> <price>387.5</price> <deliveryprice>150</deliveryprice>'''Пример ответа на запрос получения информации о клиенте:''' <inshprice>387.5</inshprice> <packages> <source langpackage mass="1" quantity="xml5"></package> <?xml versionpackage mass="12.05" encodinglength="UTF-810" width="20" height="30" ?></package> <client/packages> <codeuserid>1082user123</codeuserid> <groupid>customer</clientgroupid> </sourceorder></calculator>*'''code''' - Код клиента</source>

'''Пример запроса списка актов передачи денегПараметры:'''<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>

Дополнительные поля:* '''smalistpricetype'''  — тип требуемой цены. Возможные значения: «CUSTOMER» (по- Корневой контейнер. Обязательный элементумолчанию) — [[Личный кабинет клиента#Цена доставки для получателя|цена для конечного получателя]], «CLIENT» — цена курьерской службы для клиента.*'''authuserid''' - Авторизация — Идентификатор пользователя, строковый или числовой тип. Виртуальное поле. Обязательный элементНеобязательное.*'''datefrom''' - Дата "Данное поле используется совместно с"настройками «Цена доставки для получателя», определяя приоритет правила. Необязательный элементМожно использовать в различных CMS/CRM системах, настраивая цены для определенного покупателя.*'''datetogroupid''' - Дата "по" — Идентификатор группы пользователя, строковый или числовой тип. Виртуальное поле. Необязательный элементНеобязательное.Если интервал дат не указанДанное поле используется совместно с настройками «Цена доставки для получателя», определяя приоритет правила. Можно использовать в различных CMS/CRM системах, то возвращаются акты передачи денег за последний месяцнастраивая цены для определенной группы покупателей.

'''Пример ответа Суммы НП и ОЦ, а также тип оплаты CARD имеют значение при настроенных в тарифе на запрос списка актов передачи денег:'''<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''' - Дата оплаты В авторизации можно опустить параметры login и pass, тогда расчет будет производиться по акту*'''dateto''' - Дата конечного периода стандартному тарифу курьерской службы, без учета возможных отличий для формирования АПДконкретного клиента.<br>*'''promiseddatepay''' - Плановая дата оплаты*'''price''' - Стоимость услугОбъемный вес будет учитываться только при условии указания всех габаритов: длины, ширины и высоты.<br>*'''pricecorr''' В полях город- Сумма корректировки*'''rur''' отправитель и город- Сумма заказа*'''pricekur''' - Стоимость курьерской доставки*'''priceag''' - Агентское вознаграждение*'''payno''' - Номер платежного поручения*'''paytype''' - Тип оплаты: 1 - безналполучатель можно указывать название города (не рекомендуется!), 2 - наличными курьеромлибо код города из нашего справочника, 3 либо 13- наличными в офисети значный код КЛАДР, 4 - перевод на карту*'''paytypename''' - Строковое представление типа оплаты*'''signedcopyreceived''' либо 36- Признак факта возврата акта YES/NOти значный код адресной системы ФИАС (AOID).

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

<?xml version="1.0" encoding="UTF-8" ?><smadetailcalculator> <auth extracalc> <townfrom code="81" login>Москва город</townfrom> <townto code="login56603" pass>Иркутск город</townto> <mass>3.7</mass> <service name="passЭкспресс" >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">6278Процент от объявленной стоимости</advprice> <advprice code="6" price="-50">Скидка при доставке</advprice> </deliveryprice> </calc></smadetailcalculator>

Параметры:* '''smadetailtownfrom'''  — Город- Корневой контейнеротправитель так, как система его распознала и привязала к справочнику. Обязательный элементАтрибут '''code''' — код из справочника городов системы.*'''authtownto'''  — Город- Авторизацияполучатель так, как система его распознала и привязала к справочнику. Обязательный элементАтрибут '''code''' — код из справочника городов системы.*'''codemass''' — Масса в килограммах* '''service''' - Код акта передачи денег  — Режим доставки — число, указывающее на запись в справочнике видов срочности (смописание на этой странице).* '''zone''' — номер тарифной зоны, по которой рассчиталась стоимость. В зависимости от зоны выбирается тарифная сетка. Так же к цене могут применяться повышающие или понижающие коэффициенты при доставке не из/в региональный центр.* '''price''' — рассчитанная стоимость доставки в валюте прайс-листа курьерской службы. Рекомендуется к использованию в отличие от одноименного атрибута родительского контейнера. запрос списка АПД)* '''maxdeliverydays''' — максимальный срок доставки в рабочих днях.* '''mindeliverydate''' — минимальная дата доставки в учетом выходных дней.* '''intervals''' — список интервалов доставки для соответствующей зоны и режима срочности.* '''deliveryprice''' — Данные по составляющим ценам доставки '''''Обратите внимание:''''' В реальном ответе сервера в теге calc присутствует атрибут «price». Он оставлен для обратной совместимости, не используйте его. Обязательный элементПользуйтесь вложенным тегом price.

=== Коды и описание ошибок ==={|class=wikitable!Код ошибки!Английское описание!Русское описание!Примечание|-|15||tarif not found||Тариф не найден||Ошибка получения тарифов: для клиента не указан тариф|-|19||field [town to] cannot be empty||Поле [город получателя] не может быть пустым||Необходимо указать город получателя или ПВЗ|-|20||field [weight] is incorrect||Некорректное значение [масса]||Значение массы некорректное, например, не является числом. Его необходимо исправить|-|21||town from not found||Город отправителя не найден||Системе не удалось найти указанный населенный пункт отправителя|-|22||town to not found||Город получателя не найден||Системе не удалось найти указанный населенный пункт отправителя|-|23||field [weight] cannot be empty||Поле [масса] не может быть пустым||Необходимо указать значение массы отправления, поле [weight]|-|36||subtown not found||Город в регионе не найден||Не настроено направление доставки до города в регионе: не добавлен регион или указанный город отсутствует в списке региона|-|37||zoneprice not found||Тариф зоны не найден||Отсутствуют зоны тарификации или для них не указаны стоимости|-|38||tarif not found - 1||Тариф не найден 1||Результаты расчета отсутствуют: общая ошибка в случае, если других ошибок нет, но результат пустой |-|39||tarif not found - 2||Тариф не найден 2||Ошибка получения тарифов: для клиента не настроен тариф или тарификация от количества заказов|-|82||field [weight] exceeded limit PVZ||Значение [weight] превышает ограничение ПВЗ||Указанное значение массы больше, чем максимально допустимое для указанного ПВЗ|-|83||attribute [paytype] not allowed PVZ||Значение [paytype] не допустимо для ПВЗ||В ПВЗ не допустим указанный тип оплаты|-|} == Получение информации о клиенте =='''Пример ответа на запрос детализации актов передачи денегзапроса получения информации о клиенте:'''

<?xml version="1.0" encoding="UTF-8" ?><client> <auth extra="8" login="login" pass="pass" /> </client></source> '''client''' — Корневой контейнер. Обязательный элемент.* '''auth''' — Авторизация. Обязательный элемент. '''Пример ответа на запрос получения информации о клиенте:'''<source lang="xml"><?xml version="1.0" encoding="UTF-8" ?><client> <code>1082</code></client></source> * '''code''' — Код клиента == Список актов передачи денег =='''Пример запроса списка актов передачи денег:'''<source lang="xml"><?xml version="1.0" encoding="UTF-8" ?><smalist> <auth extra="8" login="login" pass="pass" /> <datefrom>2016-02-10</datefrom> <dateto>2016-03-10</dateto></smalist></source> '''smalist''' — Корневой контейнер. Обязательный элемент.* '''auth''' — Авторизация. Обязательный элемент.* '''datefrom''' — Дата «с». Необязательный элемент.* '''dateto''' — Дата «по». Необязательный элемент.Если интервал дат не указан, то возвращаются акты передачи денег за последний месяц. '''Пример ответа на запрос списка актов передачи денег:'''<source lang="xml"><?xml version="1.0" encoding="UTF-8"?><smalist count="1"> <sma> <code>6278</code> <number>3992</number> <actdate>2016-02-12</actdate> <datepay></datepay> <dateto>2016-02-12</dateto> <promiseddatepay></promiseddatepay> <price>637.00</price> <pricecorr>113.00</pricecorr> <rur>13430.00</rur> <pricekur>570.00</pricekur> <priceag>67.00</priceag> <payno>42423</payno> <paytype>1</paytype> <paytypename>Безнал</paytypename> <signedcopyreceived>NO</signedcopyreceived> </sma></smalist></source> * '''code''' — Код акта* '''number''' — Номер акта в системе* '''actdate''' — Дата акта* '''datepay''' — Дата оплаты по акту* '''dateto''' — Дата конечного периода для формирования АПД* '''promiseddatepay''' — Плановая дата оплаты* '''price''' — Стоимость услуг* '''pricecorr''' — Сумма корректировки* '''rur''' — Сумма заказа* '''pricekur''' — Стоимость курьерской доставки* '''priceag''' — Агентское вознаграждение* '''payno''' — Номер платежного поручения* '''paytype''' — Тип оплаты: 1 — безнал, 2 — наличными курьером, 3 — наличными в офисе, 4 — перевод на карту* '''paytypename''' — Строковое представление типа оплаты* '''signedcopyreceived''' — Признак факта возврата акта YES/NO == Детализация актов передачи денег =='''Пример запроса детализации актов передачи денег:'''<source lang="xml"><?xml version="1.0" encoding="UTF-8" ?><smadetail> <auth extra="8" login="login" pass="pass" /> <code>6278</code></smadetail></source> '''smadetail''' — Корневой контейнер. Обязательный элемент.* '''auth''' — Авторизация. Обязательный элемент.* '''code''' — Код акта передачи денег (см. запрос списка АПД). Обязательный элемент. '''Пример ответа на запрос детализации актов передачи денег:'''<source lang="xml"><?xml version="1.0" encoding="UTF-8"?><smadetail count="2"> <specialsma> <code>42494</code> <ordercode>14424</ordercode> <orderno>11111</orderno> <orderdate>2018-01-01</orderdate> <delivereddate>2018-10-01</delivereddate> <company>Компания</company> <price>314.00</price> <rur>8800.00</rur>

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

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

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