Изменения

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

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

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

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

Описание параметров: * '''extra''' —  — экстра-код, уникальный идентификатор компании, с которой вы интегрируетесь. * '''login''' —  — логин клиента;* '''pass''' —  — пароль клиента.

Описание: * '''extra''' —  — уникальный идентификатор компании;* '''login''' —  — логин курьерской службы;* '''pass''' —  — пароль курьерской службы;* '''clientcode''' —  — внутренний код клиента (вкладка '''Клиенты''', столбец «Внутренний код»).

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

На стороне курьерской службы имеется веб-сервис по адресу: 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 минут каждого часа;

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

*'''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 - CLNT — префикс клиента, 00123 - 00123 — номер заказа, 01-03 - 03 — номер транспортного места в заказе. В поле barcode нужно указать CLNT00123__ (система поймет, что 2 последних символа могут быть любыми и будут отражать штрихкоды к одному заказу). Если вы не сами печатаете накладные с указанным штрихкодом, то указанный штрихкод не должен быть длиннее 25 знаков, иначе он не поместится на стандартных печатных формах.

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

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

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

:* наименование ПВЗ в виде строки "ПВЗ " + "Наименование ПВЗ"«Наименование ПВЗ»

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

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

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

*'''paytype''' -  — Тип оплаты заказа получателем. Принимает значения::* CASH - CASH — Наличными при получении (по-умолчанию):* CARD - CARD — Картой при получении:* NO - NO — Без оплаты. Этот тип оплаты передается, если заказ уже оплачен и не требует инкассации. API добавит к товарам строку предоплаты в сумму заказа, чтобы общая сумма была 0, однако в кассовом чеке будут все товары с ценами, и оплата предоплатой, как того требует 54-ФЗ.:* OTHER - OTHER — Прочее (Предусмотрен для того, чтобы оплата поступала непосредственно в курьерскую службу посредством прочих типов оплаты - оплаты — таких как: вебмани, яденьги, картой на сайте, прочие платежные системы и ти т.д д.):* OPTION - OPTION — На выбор получателя. Этот тип оплаты нельзя передавать с заказом. Он выставляется автоматически в зависимости от настройки клиента.

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

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

*'''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.

*'''costcode''' -  — Кост-код сотрудника.*'''respstore''' -  — Код ответственного филиала.

*'''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.||Укажите значение поля «Дополнительные услуги».

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

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

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

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

:* '''''awb''''' -  — Номер накладной в системе курьерской службы.:* '''''orderno2''''' -  — Номер накладной в подсистеме срочной доставки курьерской службы.:* '''''ordercode''''' -  — внутренний код заказа в системе, применяется для некоторых внутренних операций.:* '''''givencode''''' -  — внутренний код заказа в системе, применяется для некоторых внутренних операций.

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

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

* '''''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 — RETURNING — Планируется возврат заказчику (после CANCELED).: RETURNED — RETURNED — Возвращен заказчику.: LOST — LOST — Утрачен/утерян.

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

<br />

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

Функция ищет последний заказ по номеру среди заказов всех клиентов. Выдает неперсонализированную информацию о текущем состоянии заказа.<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|Запроса статусов заказов]].

* '''Нет''' —  — при редактировании заказа по АПИ курьер не изменяется;* '''Район''' —  — если изменен адрес доставки, курьер сбрасывается;* '''Район или дата план. доставки''' —  — если изменен адрес доставки или плановая дата вручения, курьер сбрасывается.

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

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

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

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

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

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

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

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

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

Если в запросе отсутствует параметр nofederal, то Москва будет обрабатываться иначе, чем остальные города. В ответе будут города Москвы и МО, с добавленной ценой за километраж

<br />

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

* '''townfrom''' —  — код ФИАС города-отправителя.* '''service''' —  — режим доставки.*'''tariffs''' —  — cписок тарифов по городу.:* '''towntofias''' —  — код ФИАС города-получателя.:* '''towntocode''' —  — внутренний код города-получателя.:* '''towntoname''' —  — наименование города-получателя.:* '''distance''' —  — дистанция в км до города от МКАД, если в запросе townfrom - townfrom — Москва.:* '''pricedistance''' —  — сумма за километраж до города от МКАД, если в запросе townfrom - townfrom — Москва.:* '''pricesnew''' —  — ваши настройки тарифов из справочника '''Межгород''' > '''Тарифы по зонам'''.::* '''before/after''' —  — контейнеры ДО/ОТ.:::* '''price''' —  — цена. Если ответ идет по "before"«before», то в цену также плюсуется сумма pricedistance:::* '''every''' —  — за каждые.:::* '''mass''' —  — масса.:* '''prices''' —  — устаревший элемент, не используется.:* '''deliveryPeriodMin''' —  — минимальный срок доставки.:* '''deliveryPeriodMax''' —  — максимальный срок доставки.

*'''code''' -  — внутренний код документа приходной накладной (см. предыдущий запрос).

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

*'''item''' -  — контейнер товара:* '''code''' -  — внутренний код товара:* '''barcode''' - штрих-код  — штрихкод товара:* '''article''' -  — артикул товара:* '''quantity''' -  — количество поступившего товара

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

*'''code''' -  — Код филиала. *'''name''' -  — Наименование филиала.

Для отображения списка пунктов выдачи (ПВЗ) есть '''готовый JavaScript модуль''': https://home.courierexe.ru/js/measoft_map.js Инструкция по использованию - внутри. Посмотреть пример работы можно [https://home.courierexe.ru/pvz_test.html Здесь] Уникальные запросы списка ПВЗ кешируются на стороне личного кабинета и хранятся до 7 часов утра по московскому времени следующего дня. Например, если уникальный запрос с массой 2 кг 2 кг был отправлен сегодня в 10 часов, то завтра в 7 утра он сбросится. Если сегодня в 18 часов в этом же запросе вы укажете массу 2 кг2 кг, в ответе вернется тот же список ПВЗ. Если передадите массу 3 кг3 кг, список может быть другим.

*'''auth''' -  — Атрибут '''extra''' -  — обязателен, по нему определяется курьерская служба, '''login''' и '''pass''' позволяют авторизоваться под клиентом: для отдельного клиента могут быть ограничения по доступности некоторых ПВЗ, и в этом случае они будут учтены.*'''code''' -  — Внутренний код.*'''client_code''' -  — Код клиента курьерской службы.*'''city''' -  — Регион получателя. Можно указать код региона или полное наименование региона из [[#Справочник регионов|справочника регионов]].*'''town''' -  — Город получателя.

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

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

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

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

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

*'''code''' -  — внутренний код услуги*'''name''' -  — наименование услуги. Если поле "название «название в ЛК" ЛК» в настройках услуги не пусто, то возвращает значение поля "название «название в ЛК"ЛК».*'''hine''' -  — подсказка по доп услуге для пользователя*'''type''' -  — тип услуги. Может иметь значения::*'''bool''' -  — для услуг вида "чекбокс"«чекбокс», "Да"«Да»:*'''float''' -  — для числа с плавающей точкой:*'''int''' -  — для целого числа

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

*'''townfrom''' -  — Город-отправитель так, как система его распознала и привязала к справочнику. Атрибут '''code''' -  — код из справочника городов системы.*'''townto''' -  — Город-получатель так, как система его распознала и привязала к справочнику. Атрибут '''code''' -  — код из справочника городов системы.*'''mass''' -  — Масса в килограммах*'''service''' -  — Режим доставки - доставки — число, указывающее на запись в справочнике видов срочности (см описание на этой странице).*'''zone''' -  — номер тарифной зоны, по которой рассчиталась стоимость. В зависимости от зоны выбирается тарифная сетка. Так же к цене могут применяться повышающие или понижающие коэффициенты при доставке не из/в региональный центр.*'''price''' -  — рассчитанная стоимость доставки в валюте прайс-листа курьерской службы. Рекомендуется к использованию в отличие от одноименного атрибута родительского контейнера.*'''maxdeliverydays''' -  — максимальный срок доставки в рабочих днях.*'''mindeliverydate''' -  — минимальная дата доставки в учетом выходных дней. *'''deliveryprice''' -  — Данные по составляющим ценам доставки

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

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

*'''code''' -  — Код клиента

'''smalist''' -  — Корневой контейнер. Обязательный элемент.*'''auth''' -  — Авторизация. Обязательный элемент.*'''datefrom''' -  — Дата "с"«с». Необязательный элемент.*'''dateto''' -  — Дата "по"«по». Необязательный элемент.

*'''code''' -  — Код акта*'''number''' -  — Номер акта в системе*'''actdate''' -  — Дата акта*'''datepay''' -  — Дата оплаты по акту*'''dateto''' -  — Дата конечного периода для формирования АПД*'''promiseddatepay''' -  — Плановая дата оплаты*'''price''' -  — Стоимость услуг*'''pricecorr''' -  — Сумма корректировки*'''rur''' -  — Сумма заказа*'''pricekur''' -  — Стоимость курьерской доставки*'''priceag''' -  — Агентское вознаграждение*'''payno''' -  — Номер платежного поручения*'''paytype''' -  — Тип оплаты: 1 - 1 — безнал, 2 - 2 — наличными курьером, 3 - 3 — наличными в офисе, 4 - 4 — перевод на карту*'''paytypename''' -  — Строковое представление типа оплаты*'''signedcopyreceived''' -  — Признак факта возврата акта YES/NO

'''smadetail''' -  — Корневой контейнер. Обязательный элемент.*'''auth''' -  — Авторизация. Обязательный элемент.*'''code''' -  — Код акта передачи денег (см. запрос списка АПД). Обязательный элемент.

*'''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''' -  — Статус заказа.

'''shortlink''' -  — Корневой контейнер. Обязательный элемент.*'''link''' -  — Полная ссылка, для которой необходимо получить код. Обязательный элемент. Если атрибут '''short''' равен 1, то ответ не будет содержать XML, а только хэш-код.

*'''hash''' -  — Хэш-код ссылки.

 Проверка надежности работает только для тарифа "Максимум" «Максимум» личного кабинета.