Изменения

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

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

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

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

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

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

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

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

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

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

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

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

|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 Скачать]|[[Интеграция с другими системами#Wordpress|Инструкция]]

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

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

Для подключения к площадке Вашего <source lang=xml><auth extra="8" login="login" pass="pass"></auth></source> Описание параметров:* '''extra''' — экстра-код, уникальный идентификатор компании, с которой вы интегрируетесь.* '''login''' — логин клиента необходимо иметь три параметра: ;* '''pass''' — пароль клиента;* '''measoftid''' — системная переменная, используемая системой.

1. '''Параметр extra''' (Цифровой код, уникальный идентификатор компании. Запросите этот параметр эти данные у компаниикурьерской службы, с к которой Вы интегрируетесь)вы подключаетесь. Посмотреть этот код можно Курьерская служба передает временный пароль, его нужно сменить после первого входа в интерфейсе программы КС2008 через основное меню '''"Справочники - Дополнительные возможности"'''[[Личный кабинет клиента|ЛК клиента]]. Цифровое значение будет указано во второй гиперссылке (на скриншоте ниже отмечено "звездочкой"):

[[Файл== Авторизация курьерской службы ==Если курьерской службе требуется подключение под своими учетным данными, используйте строку вида:extra1.png|750px]]

2. '''Логин''' - параметр учетной записи для ЛК клиента и API, указывается в карточке клиента на вкладке '''<source lang=xml><auth extra="Прочее8"''' в поле '''login="Имя пользователяlogin"'''. Возможно, что в программе КС2008 понадобится создать новую карточку клиента (на скриншоте ниже).pass="pass" clientcode="123"></auth></source>

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

*'''coords''' -  — Координаты получателя. Если не указаны, система будет геокодировать самостоятельно. * '''zipcode''' — Почтовый индекс.* '''price''' — Сумма заказа (наложенный платеж) - денежные средства, которые курьер должен забрать у получателя в пользу заказчика. В случае наличия контейнера items значение этого параметра будет проигнорировано и рассчитано автоматически.* '''inshprice''' — Объявленная ценность. Если явно не указана сумма — автоматически считается как сумма по товарам.* '''deliveryprice''' — Стоимость доставки, которая устанавливается заказчиком и будет взиматься с получателя в пользу заказчика. Не имеет отношения к стоимости доставки самой курьерской службы, которая рассчитывается в соответствии с тарифамии, не указывается при оформлении заказа и добавляется в заказ автоматически при его обработке курьерской службой. В случае наличия контейнера items в него будет добавлено вложение «Доставка».:* '''''VATrate''''' — Ставка НДС — целое число процентов.* '''discount''' — Сумма скидки. Скидка «размазывается» по товарным вложениям, сумма НП уменьшается на сумму скидки. При этом вложение Скидка не создается. ВНИМАНИЕ, при использовании этого тега общая сумма может расходиться на копейки из-за округления! Старайтесь не использовать этот тег, а указывать цену товаров уже с учетом скидок.* '''paytype''' — Тип оплаты заказа получателем. Принимает значения::* CASH — Наличными при получении (по-умолчанию):* 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 "Declared value" «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||Specify a valid "weight" Inappropriate «Weight» or "paytype" «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

: '''COMPLETE''' RETURNING — Планируется возврат заказчику (после CANCELED).: RETURNED — Возвращен заказчику.: LOST — Утрачен/утерян. : PARTLYRETURNING — Планируется возврат остатков.: PARTLYRETURNED — ДоставленОстаток возвращен.: '''PARTIALLY''' TRANSACCEPTED — Доставлен частичноПрибыл на склад перевозчика.: '''CANCELED''' 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''' указывается внутренний код вложения активен (не доставлен, не возвращен в атрибуте '''code''', который можно получить при получении статуса заказат.ч.курьером)

Значение '''ordernoПример запроса:''' данным методом изменить нельзя<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>

=== Описание полей ответа изменения ===гдеВсе поля ответа соответствуют ответу при создании заказа за исключением корневого тэга — вместо *'''neworderextra''' возвращается - код экстраклиента в системе Measoft.*acq.'''editordercode'''- внутренний код платформы эквайринга в системе 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'Разрешить отмену и изменение заказов'''. При отмене заказа поле «Инфо о доставке» получает значение «Отменено заказчиком», поле «Дата доставки» — текущую дату, а «Вручил курьер» — системную запись «ОТМЕНА».уникальный в пределах экстраклиента

где*'''Пример запроса отмены acqlink''' - ссылка на оплату заказа:*acqlink.'''amount''' - тип integer сумма платежа в копейках в общем случае, в других случаях в соответствии с типом валюты*acqlink.'''extid''' - идентификатор счета на стороне платежной системы*acqlink.'''error''- код ошибки, если отличается от 0, означает невозможность получения ссылки на оплату, в этом случае ссылки на оплату не будет и ответ будет выглядеть так:

<?xml version="1.0" encoding="UTF-8" ?><cancelorder> <auth extraacqlink error="82" loginmessage="loginОшибка авторизации: Invalid token" passamount="pass2000" /> <order orderno="" ordercode="123456" /> <order orderno="123aaa" ordercodeextid="" /></cancelorder>

Возможные типы ошибок получения ссылки:* '''1''' - не настроен эквайринг, либо не найден заказ* '''2''' - ошибка на стороне эквайринга* '''3'''Описание полей:- запрещающий статус курьера (заказ доставлен, частично доставлен)* '''4'''- оплата заказа не разрешена

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

'''Пример ответа:'''<source lang="xml"><?xml version="1.0" encoding="UTF-8" ?><cancelorder> <order orderno="123test" ordercode="123456" errorОписание полей запроса изменения ="0" errormsg="OK" errormsgru="Успешно" /> <Все поля запроса соответствуют структуре order orderno="123aaa" ordercode="" error="52" errormsg="order not found" errormsgru="Заказ не найден" /></cancelorder></source>при создании заказа за исключением:

== Добавление * значение '''orderno''' данным методом изменить нельзя.* значение '''barcode''' изменяется в случае явного его указания. В случае отсутствия или пустого значения - остается прежним.* вместо корневого тэга '''neworder''' указывается '''editorder''';* тэг курьера '''courier''' можно изменить только при включенной настройке '''Разрешить изменение курьера по АПИ''';* для вложений к накладной =='''item''' указывается внутренний код вложения в атрибуте '''code''', который можно получить при получении статуса заказа.* для мест '''package''' указывается внутренний код вложения в атрибуте '''code''', который можно получить при получении статуса заказа.

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

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

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

<?xml version="1.0" encoding="UTF-8"?><addattachmentscancelorder> <attachments> <item nameauth extra="photo1.jpg8" errorlogin="0login" errormsgpass="OK" errormsgru="Успешноpass" /> <item nameorder orderno="photo2.jpg" errorordercode="0123456" errormsg/> <order orderno="OK123aaa" errormsgruordercode="Успешно" /> </attachments></addattachmentscancelorder>

'''attachmentscancelorder''' -  — Корневой контейнер. Обязательный элемент.*'''auth''' -  — Авторизация. Обязательный элемент.*'''ordernoorder''' - Номер/код  — Контейнер отменяемого заказа. Обязательный элемент.Запрос может содержать более одного контейнера '''order'''. Атрибуты::* '''''orderno''''' — Шифр заказа.:* '''''ordercode''''' — Внутренний код заказа.Обратите внимание, что должен быть указан хотя бы один из атрибутов ''orderno'' или ''ordercode''!

<?xml version="1.0" encoding="UTF-8"?><attachmentscancelorder> <item nameorder orderno="doc1.docx123test" sizeordercode="35654123456" error="0" errormsg="OK" errormsgru="Успешно">JVBERi0xLjMN JUBQREYwMTIzNDU2Nzg5IDI NMyAwIG9iag08PA0vVHlwZSA U3VidHlwZSAvSW1hZ2UNL1d pZHRoIDE4MDgNL0hlaWdodCA ggNCAwIFINL0JpdHNQZXJDb 21wb25lbnQgMQ0vRGVjb2RlU ENL0NvbHVtbnMgMTgwOA0+P g0vSW1hZ2VNYXNrIHRydWUNL XhEZWNvZGUNPj4Nc3RyZWFt DQ</item> <item nameorder orderno="123aaa" ordercode="photo2.jpg" sizeerror="7486152" errormsg="order not found" errormsgru="Заказ не найден">VBERi0xLjMN JUBQREYwMTIzNDU2Nzg5IDI NMyAwIG9iag08PA0vVHlwZSA vWE9iamVjdA0vU3VidHlwZS AvSW1hZ2UNL1dpZHRoIDEzNj gNL0hlaWdodCAxMzMzDS9MZ W5ndGggNCAwIFINL0JpdHNQZ XJDb21wb25lbnQgMQ0vRGVj b2RlUGFybXMgPDwNL0sgLTEN L0NvbHVtbnMgMTM2OA0+Pg0 vSW</item></attachmentscancelorder>

Запрос изменения статуса заказа позволяет установить окончательный статус заказа - "Доставлен" или "Не доставлен (Возврат/Отмена)". Кроме этого, устанавливается дата и время (при необходимости) изменения статуса, а также сообщение в поле ''Инфо о доставке''. При необходимости к заказу можно прикрепить изображения.  '''Пример запроса изменения статуса:'''

<setorderinfoaddattachments>

<order ordercode="123456"orderno> <message>Получил Иванов1234567</message> <outstrbarcode>7654312</outstrbarcodeorderno> </orderattachments> <order ordercodeitem name="234567photo1.jpg">JVBERi0xLjMN1wb25lbnQgMQ <status>PICKUPREADY</status>JUBQREYwMTIzNDU2Nzg5IDI NMyAwIG9iag08PA0vVHlwZSA <eventtime>2016-05-30 10:20:00</eventtime>U3VidHlwZSAvSW1hZ2UNL1d pZHRoIDE4MDgNL0hlaWdodCA <message>Клиент отказался от покупки</message>ggNCAwIFINL0JpdHNQZXJDb 21wb25lbnQgMQ0vRGVjb2RlU <paytype>CASH</paytype>ENL0NvbHVtbnMgMTgwOA0+P g0vSW1hZ2VNYXNrIHRydWUNL XhEZWNvZGUNPj4Nc3RyZWFt DQ<items> <item code="34533" quantity="1" reason="0" /> <item code="34456" quantity="0" reason="0" /> <item code="34421" quantity="2" reason="0" /> </items> <image filenamename="filename1photo2.jpg"> /9j/4AAQSkZJRgAVBERi0xLjMNAwIG9iag0HRoJ BAQAAAQABAAD/2wBDAA0JCg sKCA0LCgsODg0PEyAVExISEyJUBQREYwMTIzNDU2Nzg5IDI NMyAwIG9iag08PA0vVHlwZSA ccHhcgLikxMC4pLSwzOko+M zZGNywtQFdBRkxOUlNSMj5aYvWE9iamVjdA0vU3VidHlwZS AvSW1hZ2UNL1dpZHRoIDEzNj VpQYEpRUk//2wBDAQ4ODhMR EyYVFSZPNS01T09PT09PT09PgNL0hlaWdodCAxMzMzDS9MZ W5ndGggNCAwIFINL0JpdHNQZ T09PT09PT09PT09PT09PT09 PT09PT09PT09PT09PT09PT09XJDb21wb25lbnQgMQ0vRGVj b2RlUGFybXMgPDwNL0sgLTEN PT09PT0//wAARCAYACAADAS IAL0NvbHVtbnMgMTM2OA0+Pg0 vSW</imageitem> </orderattachments></setorderinfoaddattachments>

'''Описание полей запроса статуса:''' '''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''''' - Имя файла.

<setorderinfoaddattachments> <order ordercodeattachments> <item name="123456photo1.jpg" error="0" errormsg="OK" errormsgru="Успешно" /> <order ordercodeitem name="234567photo2.jpg" error="590" errormsg="value [date_put] is already setOK" errormsgru="Значение [Дата доставки] уже указаноУспешно" /> </attachments></setorderinfoaddattachments>

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

<waybillattachments>

<ordersorderno> 1234567<order orderno="1234567" ordercode="33331" /> <order orderno="1234568" ordercode="33332" /> </orders> <form>1</form></waybillattachments>

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

<waybillattachments> <contentitem name="doc1.docx" timestamp="2025-01-01 12:00:00" size="35654">EODIcaI8KSBlwQ 4MnEOR7Px8U8EBAyGICBnwpw JVBERixLjMN IZhQgz0ZxuPs8EBMUwLJdLwIDKxTn+AScMjKqor7Xm3sp1yj1k6BzlPdX2Qsiit6yg3g1fCI4YVAgclUOIY5tDra2LvAcIS 5/+8PsL/sXb0+aoper/9kL/4Ov/YE9QsHwyg7YZTtKICy0YVIYb4Nt7L1tPUMfaX9NpuTsvFCtBAvYG eJVZoZ2tm6+fZVqAavZpeLizVLtct1a+xvG0+bTSkw3Ac8PhdNfL4smrT2hSgPJLfyaVGyA2ndyW22t sFtTP5knktPNumSZ56QsFRPJkaU8ExDxAcMYMDIoBiIoR4/dDjHMbMW/EW4fiB1pvWmV2ONWIl1Xdub Xg1ob0qWX9W4qagsqzGhjRLsEGeJGVXg9oVC+XkJa9esrhGUmC0tuKEla+AplVO/OtHwXcW0FWui1z7 6KHrtobuWV0xa9sCEiSvb91w3ePHOvfcveo5xt9o4ZevHF7ZOeKxV5qmVx2MI44a1L+Mhk5YuGT12xd Ibsb7r+j9bff/unQlv0al6HBnoD5G89q4+tkjgDtvwwARmqm2aa2Jgvmth8mrXquTNtl2u467vbF/5r vnMt9uesu21Me1bjeNJGlVfAaCtw+/GcbjzB AwhBl8hwQYIO00GmEwg1CeEG jfenJ/fWjqa7ygExx+L0BcTGroxrKexQXIQ1ImfEW7ZRJZa+O ip7xJmmNESMxrgu/dquBbGypjJpFDJVRH1rVPR1Ifl4aFS5IEdDWZFSdyBBWKWhVSVu517ZgzOCFAwp mqYTChNU0wqf8l8nz4zgcwwbFph29g4fTaxnvn/3X78x+Tt56ZNffArgULt+HByvy7+yz6U6XWMawCi3+6gJXN0S+K fCnojf4t+zwU5GjOZmzXGcbEQYIM HT34wg 4zkegRE40zWzONyoNNMIOIa cWnp6aDCGEGE9NQmoQd2mg00 km7/HDp55YTSWMoCMgZsvZkBrXtIv4WA7xgkT4YpYpxjwLvnsWKkGE+pDbxER0UUWlpVFRY4oilTfM4 79U4f3hPTwnfp6Sdrafeqpa JDpFwMIzgCPgxjOlZ87ceA7ceRJrgpipFGyugPQ4OTI2S8lWJoqTpHJlJbNOeYM7zTcoVxSNyJXiYWSAMklT q/xd+3fd3/1aYT077VNNNdO00G3q USq2V1rJ7RyBLHsuDSiLwgaOFc5LUCRGI+QWuBAsIwPlZrgRpSMseJyTzD15PKiIRE7bc Rggk5ijXAPpqISetD4wVm0AD2LHuBZdaxmK3HOKIZoG0QLmiZdVqspXnFIJwVyCKhWiDCI4bzH8Y76w TAnwM67HIqMISOkmJXY8mlYhpiNa7g2oTBkKxo4wgnvETQIUUrlFOn9KdOreDiKQx071rN4N61yRAi1 mqqvp9p2E7T07EGRhSOgoeLYv+k41+KZ1SVBXAuDjB+xuxnQmm8wJDcP5IRn+5penzbR/wiFemv8uG6 OMivm7qleHK5o790w8ejXchI vOHIPWtWwYhtAO34LdDXqFqWxZEBLNstMCwwITBTWirxk12zuUppp</contentitem></waybillattachments></source> В тегах item возвращаются бинарные данные (файлы), закодированные в base64.

В тэге content возвращаются бинарные данные Кроме этого, устанавливается дата и время (файл pdfпри необходимости)изменения статуса, закодированные а также сообщение в base64поле ''Инфо о доставке''.

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

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

<?xml version="1.0" encoding="UTF-8"?><townlistsetorderinfo> <auth extra="8" login="login" pass="pass" /> <codesearchorder ordercode="123456"> <zipcodemessage>110000Получил Иванов</zipcodemessage> <kladrcodeoutstrbarcode>01000001008007654312</kladrcodeoutstrbarcode> <fiascode/order>bd21979d-46f8-49d0-9105-e8d65172a983 </fiascodeorder ordercode="234567"> <codestatus>123PICKUPREADY</codestatus> </codesearcheventtime> 2016-05-30 10:20:00<conditions/eventtime> <citymessage>Краснодарский крайКлиент отказался от покупки</citymessage> <namecontainspaytype>новгородCASH</namecontainspaytype> <namestartsstoreprice>Моск123</namestartsstoreprice> <nameitems>Москва <item code="34533" quantity="1" reason="0" governmentCode="11223311" /name> <fullnameitem code="34456" quantity="0" reason="0" />Москва город <item code="34421" quantity="2" reason="0" /fullname> <country>1</countryitems> </conditionsattachments> <limitattachment filename="filename1.jpg">/9j/4AAQSkZJRgA <limitfrom>30 BAQAAAQABAAD/2wBDAA0JCg sKCA0LCgsODg0PEyAVExISEy ccHhcgLikxMC4pLSwzOko+M zZGNywtQFdBRkxOUlNSMj5aY VpQYEpRUk//2wBDAQ4ODhMR EyYVFSZPNS01T09PT09PT09P T09PT09PT09PT09PT09PT09 PT09PT09PT09PT09PT09PT09 PT09PT0//wAARCAYACAADAS IA</limitfromattachment> <limitcountattachment filename="filename2.jpg">10/9j/4AAQSkZJRgA BAQAAAQABAAD/2wBDAA0JCg sKCA0LCgsODg0PEyAVExISEy ccHhcgLikxMC4pLSwzOko+M zZGNywtQFdBRkxOUlNSMj5aY VpQYEpRUk//2wBDAQ4ODhMR EyYVFSZPNS01T09PT09PT09P T09PT09PT09PT09PT09PT09 PT09PT09PT09PT09PT09PT09 PT09PT0//wAARCAYACAADAS IA</limitcountattachment> <countall>YES</countallattachments> </limitorder></townlistsetorderinfo>

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

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

<townlist countsetorderinfo> <order ordercode="3123456" pageerror="10" totalcounterrormsg="3OK" totalpageserrormsgru="1Успешно"/> <town> <code>26379<order ordercode="234567" error="59" errormsg="value [date_put] is already set" errormsgru="Значение [Дата доставки] уже указано" /code> <city> <code>23</codesetorderinfo> <name>Краснодарский край</namesource> </city> <name>Сочи город</name>== Получение документов для печати == <fiascode>79da737a-603b-4c19-9b54-9114c96fb912</fiascode>'''Пример запроса получения печатных форм:''' <kladrcode>2300000700000</kladrcodesource lang="xml"> <shortname /> (not yet supported) <typename /> (not yet supported) <coords lat?xml version="431.58550" lonencoding="39.7231UTF-8" /?> </townwaybill> <town> <code>40331<auth extra="8" login="login" pass="pass" /code> <cityclient> <code>32CLIENT</codeclient> <name>Брянская область</nameorders> </city> <name>Сочилов хутор</name> <fiascode>c9c96c67-2cc9-4f10-afde-fd32417ea216</fiascode> <kladrcode>3201900011100</kladrcode> <shortname /> <typename order orderno="1234567" ordercode="33331" /> <coords latorder orderno="52.64071234568" lonordercode="33.172433332" /> </townorders> <townform> <code>1140161</codeform> <citystart> <code>605</codestart> <name>Псковская область</name> </city> <name>Сочихино деревня</name> <fiascode>10df7588-19c1-49d1-a387-9de1cf3eb26f</fiascode> <kladrcode>6001900015400</kladrcode> <shortname /> <typename /integration> <coords lat="56.6003" lon="29.3542" /> 21</townintegration></townlistwaybill>

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

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

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

<streetlistwaybill> <error>Текст ошибки</error></waybill></source> == Справочник городов =='''Пример запроса справочника городов:'''<source lang="xml"><?xml version="1.0" encoding="UTF-8"?><townlist> <auth extra="8" /> <codesearch> <zipcode>110000</zipcode> <kladrcode>0100000100800</kladrcode> <fiascode>bd21979d-46f8-49d0-9105-e8d65172a983</fiascode> <code>123</code> </codesearch>

<towncity>Москва городКраснодарский край</towncity> // ОБЯЗАТЕЛЬНОЕ ПОЛЕ! <namecontains>Хохлоновгород</namecontains> <namecontainsparts>молоково моск</namecontainsparts> <namestarts>Академика ХМоск</namestarts> <name>Академика ХохловаМосква</name> <fullname>Академика Хохлова ул.Москва город</fullname> <country>1</country>

</streetlisttownlist>

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

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

* '''Пример ответаcodesearch''' — Поиск по кодам. В случае использования — контейнеры conditions и limit игнорируются.:* '''zipcode''' — Поиск по индексу. Обратите внимание на то, что один почтовый индекс может распространяться на несколько населенных пунктов. В этом случае система вернет несколько записей.<source lang="xml"><?xml version="1:* '''kladrcode''' — Поиск по 13-ти значному коду КЛАДР.0" encoding="UTF-8"?><streetlist count="1" page="1" totalcount="3" totalpages="1"> <street> <name>Академика Хохлова ул:* '''fiascode''' — Поиск по коду ФИАС (AOGUID).</name> <shortname>Академика Хохлова</shortname> <typename>ул:* '''code''' — Поиск по коду в системе.</typename> </street></streetlist></source>

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

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

<?xml version="1.0" encoding="UTF-8" ?><itemlist> <auth extratownlist count="3" page="81" logintotalcount="login3" passtotalpages="pass1"> <town> <code>26379</authcode> <codesearchcity> <code>12345623</code> <articlename>Краснодарский край</name> </city> <name>Сочи город</name> <fiascode>79da737a-603b-4c19-9b54-9114c96fb912</fiascode>FD343 <kladrcode>2300000700000</articlekladrcode> <barcodeshortname />2345625213125 (not yet supported) <typename /barcode> (not yet supported) <coords lat="43.5855" lon="39.7231" /codesearch> </town> <town> <conditionscode>40331</code> <city> <namecontainscode>телевизор32</namecontainscode> <namestartsname>sonyБрянская область</namestartsname> </city> <name>Сочилов хутор</name>Sony KDL <fiascode>c9c96c67-2cc9-4f10-55W905 ЖКafde-телевизорfd32417ea216</namefiascode> <quantitykladrcode>EXISTING_ONLY3201900011100</quantitykladrcode> <storeshortname />2 <typename /store> <coords lat="52.6407" lon="33.1724" /conditions> </town> <town> <exceptcode>114016</code> <city> <code>12347860</code> <name>Псковская область</name> </exceptcity> <limitname>Сочихино деревня</name> <limitfromfiascode>3010df7588-19c1-49d1-a387-9de1cf3eb26f</limitfromfiascode> <limitcountkladrcode>106001900015400</limitcountkladrcode> <countallshortname />YES <typename /countall> <coords lat="56.6003" lon="29.3542" /> </limittown></itemlisttownlist>

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

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

<itemlist count="3" totalcount="3" page="1" totalpages="1"regionlist> <itemcodesearch> <code>12345677</code> <article/codesearch>FD343 </articleconditions> <barcodenamecontains>2345625213125край</barcodenamecontains> <namenamestarts>Sony KDL-55W905 ЖК-телевизорМоск</namenamestarts> <retpricefullname>65000Московская область</retpricefullname> <purchpricecountry>50000RU</purchpricecountry> <weight/conditions>5.1</weightregionlist> <length>50</lengthsource> '''Пример ответа:'''<widthsource lang="xml">30</width?xml version="1.0" encoding="UTF-8"?> <heightregionlist count="2">40 </heightcity> <VATratecode>2080</VATratecode> <CountInPalletcountry>30 <code>1</CountInPalletcode> <HasSerialsname>1Россия</HasSerialsname> <CountryOfOriginid>Малайзия643</CountryOfOriginid> (not yet supported) <MessageShortName1>Хороший телевизорRU</MessageShortName1> <Message2ShortName2>Снова хороший телевизорRUS</Message2ShortName2> <quantity>12</quantitycountry> <reservedname>3Агинский Бурятский автономный округ</reservedname> <item/city> ...<city> <code>1</itemlistcode> </sourcecountry> '''Описание полей:'''*''' <code''' - Внутренний идентификатор, присвоенный системой.*'''article''' - Артикул, назначенный клиентом (поставщиком).*'''barcode''' - Штрих-код производителя.*'''name''' - Наименование.*'''retprice''' - Розничная цена по-умолчанию. При оформлении заказа цена используется та, которая указана в заказе.*'''purchprice''' - Закупочная цена.*'''weight''' - Масса в килограммах.*'''length''' - Длина в сантиметрах.*'''width''' - Ширина в сантиметрах.*'''height''' - Высота в сантиметрах.*'''VATrate''' - Ставка НДС, целое число процентов.*'''CountInPallet''' - Количество штук в паллете.*'''HasSerials''' - Требует учета серийных номеров. Принимает значения >1 - да, 0 - нет.*'''CountryOfOrigin''' - Наименование страны происхождения на русском языке.*'''Message''' - Комментарий.*'''Message2''' - Дополнительный комментарий.*'''quantity''' - Количество на складе. Товары, уже собранные в заказы в этом количестве не присутствуют, считаются покинувшими товарный склад. ''Это поле может быть недоступным в некоторых установках.''*'''reserved''' - Количество зарезервированного товара. Может превышать остаток на складе, если покупатели ждут следующей поставки. ''Это поле может быть недоступным в некоторых установках.'' == Движение номенклатуры == '''Пример запроса движения номенклатуры:'''<source lang="xml"/code> <?xml version="1.0" encoding="UTF-8" ?name>Россия<itemmovements/name> <auth extra="8" login="login" pass="pass"id>643</authid> <codeShortName1>4259RU</codeShortName1> <ShortName2>RUS<datefrom/ShortName2>2020-10-01 </datefromcountry> <datetoname>2020-10-02Адыгея республика</name> </datetocity></itemmovementsregionlist>

*'''code''' - внутренний код товара в справочнике номенклатуры.*'''datefrom''' - дата начала периода.*'''dateto''' - дата окончания периода.Может быть указан или код, или период, или код и период одновременно. == Справочник улиц =='''Пример ответа движения номенклатурызапроса справочника улиц:'''

<?xml version="1.0" encoding="UTF-8" ?><itemmovements count="16"streetlist> <itemmovementconditions> <codetown>151500Москва город</codetown> <date>2017-05-26< /date> <retprice>0</retprice>ОБЯЗАТЕЛЬНОЕ ПОЛЕ! <quantitynamecontains>1Хохло</quantitynamecontains> <deliverednamestarts>0Академика Х</deliverednamestarts> <item> <code>4259</code> <name>Настольная игра ДженгаАкадемика Хохлова</name> </itemfullname> <status> <code>5Академика Хохлова ул.</codefullname> <name>Возврат от покупателя </nameconditions> </statuslimit> <store> <code>1</code> <namelimitfrom>офис в Москве30</namelimitfrom> </store> <order> <ordercode>3374830</ordercode> <number>123660-0</number> <date>2017-05-24</date> <orderno>14123</orderno> <barcode>0000000670</barcode> <company>ТОВАР</company> <address>Кравченко ул., 1</address> <delivereddate>2017-05-29</delivereddate> <deliveredtimelimitcount>12:00:0010</deliveredtime> <deliveredto /limitcount> </order> <document> <code>21991</code> <number>318</number> <date>2017-05-26</date> <messagecountall>YES</message> </documentcountall> </itemmovementslimit></itemliststreetlist></source> ''' Описание полей ответа '''*'''code''' - внутренний код операции движения*'''dateconditions''' - дата операции*'''retprice''' - цена товара*'''quantity''' - количество товара операции*'''delivered''' - количество доставленного товара *'''item''' - контейнер товара — Задает условия поиска. Все вложенные элементы одновременно накладывают условие «И».:* '''codetown''' - внутренний  — Обязательное поле. Название или код товаранаселенного пункта.:* '''namenamecontains''' - наименование товара *'''status''' - контейнер статуса операции — Поиск улиц, название которых содержит указанный текст.:* '''codenamestarts''' - код статуса — Поиск улиц, название которых начинается с указанного текста.:* '''name''' - наименование *'''store''' - контейнер филиала — Поиск улиц, к которому относится операцияназвание которых соответствует указанному тексту.:* '''codefullname''' - код филиала:* '''name''' - наименование филиала — Поиск улиц, для которых название вместе с типом соответствует указанному тексту. *'''orderlimit''' - контейнер корреспонденции:* '''ordercode''' - внутренний код заказа — Ограничивает вывод результата.:* '''numberlimitfrom''' -  — Задает номер заказа:* '''date''' записи результата, начиная с которой выдавать ответ. По- дата заказаумолчанию — 0.:* '''ordernolimitcount''' - шифр:* '''barcode''' Задает количество записей результата, которые нужно вернуть. По- штрих-кодумолчанию — 10000.:* '''companycountall''' - компания:* '''address''' - адрес:* '''delivereddate''' - дата вручения:* '''deliveredtime''' - время вручения:* '''deliveredto''' - данные о вручении — YES указывает на необходимость подсчета общего количества найденных совпадений. Это может замедлять выполнение запроса. Если отключено, либо причина недоставкив ответе не указываются totalcount и totalpages. *'''document''' - контейнер документа операцииПример ответа:* '''code''' - внутренний код документа:* '''number''' - номер документа<source lang="xml">:* '''extnumber''' <?xml version="1.0" encoding="UTF- внешний номер документа:* '''date''' - дата документа:* '''message''' - комментарий8"?><streetlist count="1" page= Получение справочника тарифов по городам "1" totalcount="3" totalpages="1"> <street> <code>124<br /code> <div style="color: #a94442; background-color: #f2dede; border: 1px solid #ebccd1; padding: 3px 10px 10px;"name>Академика Хохлова ул.</name>'''Обратите внимание!''' <shortname>Академика Хохлова</shortname>Если в запросе отсутствует параметр nofederal, то Москва будет обрабатываться иначе, чем остальные города <typename>ул. В ответе будут города Москвы и МО, с добавленной ценой за километраж</typename> </street></divstreetlist><br /source> В ответе улицы сортируются по алфавиту. == Справочник номенклатуры =='''Пример запроса справочника тарифов по городамноменклатуры:'''

<?xml version="1.0" encoding="UTF-8"?><tariffsitemlist> <auth extra="8" login="login" pass="pass" ></auth> <townfromcodesearch>Москва <code>123456</townfromcode> <servicearticle>1FD343</servicearticle> <mainonlybarcode>12345625213125</mainonlybarcode> <nofederal/codesearch>1 <conditions> <namecontains>телевизор</namecontains> <namestarts>sony</nofederalnamestarts> <name>Sony KDL-55W905 ЖК-телевизор</name> <quantity>EXISTING_ONLY</quantity> <store>2</store> </conditions> <except> <code>123478</code> </except> <limit> <limitfrom>30</limitfrom> <limitcount>10</limitcount> <countall>YES</countall> </limit> </tariffsitemlist>

Внутри контейнера itemlist все элементы могут как отсутствовать, так и комбинироваться. Поиск не чувствителен к регистру.*'''authcodesearch''' — атрибут  — Поиск по кодам. В случае использования — контейнеры conditions и limit игнорируются.:* '''extracode''' обязателен,  — Поиск по нему определяется курьерская службавнутреннему коду системы.:*'''townfromarticle''' — город-отправитель — Поиск по артикулу. Если не передан, то городом будет «Москва»:* '''barcode''' — Поиск по штрихкоду. *'''serviceconditions''' — режим доставки — Задает условия поиска. Обязательный элементВсе вложенные элементы одновременно накладывают условие «И».:*'''mainonlynamecontains''' — необязательный элемент — Поиск товаров, название которых содержит указанный текст. Если передан, то в ответе будут данные только по городам из справочника :* '''Межгородnamestarts''' >  — Поиск товаров, название которых начинается с указанного текста.:* '''Зоныname''' — Поиск товаров, название которых соответствует указанному тексту.:*'''nofederalquantity''' — необязательный элемент — Наличие на складе. Если переданПринимает значения EXISTING_ONLY — Только в наличии, то NOT_EXISTING_ONLY — Только не в ответе город федерального значения Москва будет обрабатываться как обычный городналичии, ALL — Все. ''Это поле может быть недоступным в некоторых установках.'':* '''store''' — Поиск товаров по определенному складу.

* '''limit''' — Ограничивает вывод результата.:* '''limitfrom''' — Задает номер записи результата, начиная с которой выдавать ответ.:* '''limitcount''' — Задает количество записей результата, которые нужно вернуть. '''Пример ответа справочника тарифов по городам:'''<source lang="jsonxml">{ <?xml version="townfrom1.0": encoding="0c5b2444-70a0-4932UTF-980c-b4dc0d3f02b58",?> <itemlist count="service3": 1, totalcount="tariffs3": [ { page="towntofias1": "0c5b2444-70a0-4932-980c-b4dc0d3f02b5", "towntocodetotalpages=": 1, "towntoname": "Москва город",> "distance": 0, <item> "pricedistance": 0, <code>123456</code> "pricesnew": { <article>FD343</article> "before": [ <barcode>2345625213125</barcode> { <name>Sony KDL-55W905 ЖК-телевизор</name> "price": 100, <retprice>65000</retprice> "every": 0, <purchprice>50000</purchprice> "mass": <weight>5.1</weight> }, <length>50</length> { <width>30</width> "price": 150, <height>40</height> "every": 0, <VATrate>20</VATrate> "mass": 5 <CountInPallet>30</CountInPallet> } <CountInBox>2</CountInBox> ], <HasSerials>1</HasSerials> "after": [ <CountryOfOrigin>Малайзия</CountryOfOrigin> (not yet supported) { <Message>Хороший телевизор</Message> "price": 0, <Message2>Снова хороший телевизор</Message2> "every": 1, <quantity>12</quantity> "mass": 38.01 <reserved>3</reserved> }, <item> { "price": 15, "every": 1, "mass": 51 ...01 } ] }, "deliveryPeriodMin": 1, "deliveryPeriodMax": 2 } ]}</itemlist></source> ''' Описание полей ответа :'''* '''townfromcode''' — код ФИАС города-отправителя — Внутренний идентификатор, присвоенный системой.* '''servicearticle''' — режим доставки — Артикул, назначенный клиентом (поставщиком).*'''tariffsbarcode''' — cписок тарифов по городу — Штрихкод производителя.:* '''towntofiasname''' — код ФИАС города-получателя — Наименование.:* '''towntocoderetprice''' — внутренний код города — Розничная цена по-получателяумолчанию. При оформлении заказа цена используется та, которая указана в заказе.:* '''towntonamepurchprice''' — наименование города-получателя — Закупочная цена.:* '''distanceweight''' — дистанция  — Масса в км до города от МКАД, если килограммах.* '''length''' — Длина в запросе townfrom - Москвасантиметрах.:* '''pricedistancewidth''' — сумма за километраж до города от МКАД, если  — Ширина в запросе townfrom - Москвасантиметрах.:* '''pricesnewheight''' — ваши настройки тарифов из справочника  — Высота в сантиметрах.* '''МежгородVATrate''' >  — Ставка НДС, целое число процентов.* '''Тарифы по зонамCountInPallet''' — Количество штук в паллете.::* '''before/afterCountInBox''' — контейнеры ДО/ОТ — Количество штук в упаковке.:::* '''priceHasSerials''' — цена — Требует учета серийных номеров. Если ответ идет по "before"Принимает значения 1 — да, то в цену также плюсуется сумма pricedistance0 — нет.:::* '''everyCountryOfOrigin''' — за каждые — Наименование страны происхождения на русском языке.:::* '''massMessage''' — масса — Комментарий.:* '''pricesMessage2''' — устаревший элемент, не используется — Дополнительный комментарий.:* '''deliveryPeriodMinquantity''' — минимальный срок доставки — Количество на складе.Товары, уже собранные в заказы в этом количестве не присутствуют, считаются покинувшими товарный склад. ''Это поле может быть недоступным в некоторых установках.'':* '''deliveryPeriodMaxreserved''' — Количество зарезервированного товара. Может превышать остаток на складе, если покупатели ждут следующей поставки. '' — максимальный срок доставкиЭто поле может быть недоступным в некоторых установках.'' == Номенклатура приходной накладной Движение номенклатуры == '''Пример запроса движения номенклатуры приходной накладной:'''

<itemdocitemmovements>

<code>219914259</code> <datefrom>2020-10-01</datefrom> <dateto>2020-10-02</dateto></itemdocitemmovements>

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

<itemdocitemmovements count="16"> <codeitemmovement>21991 </code> <number>318151500</numbercode> <date>2017-05-26</date> <retprice>0</retprice> <messagequantity>1</messagequantity> <itemsdelivered>0</delivered> <item > <code=">4259" quantity="1" barcode="200300" article="123555"</code> <name>Настольная игра Дженга</name> </item> <status> <code>5</itemscode> <name>Возврат от покупателя</itemdocname> </sourcestatus> <store>''' Описание полей ответа '''* ''' <code''' - внутренний код приходной накладной* '''number''' - номер документа* '''date''' - дата документа* '''message''' - комментарий *'''item''' - контейнер товара:* '''>1</code''' - внутренний код товара>:* '''barcode''' - штрих-код товара <name>офис в Москве</name>:* '''article''' - артикул товара </store>:* '''quantity''' - количество поступившего товара == Справочник филиалов == '''Пример запроса списка филиалов:''' <order> <ordercode>3374830<source lang="xml"/ordercode> <?xml version="1.number>123660-0" encoding="UTF-8" ?</number> <date>2017-05-24<storelist/date> <auth extra="8"orderno>14123</authorderno> <jsonbarcode>YES0000000670</jsonbarcode> <client_codecompany>7890ТОВАР</client_codecompany> <address>Кравченко ул., 1</storelistaddress> </sourcedelivereddate> *'''auth''' 2017- Атрибут '''extra''' 05- обязателен, по нему определяется курьерская служба*'''json''' - Признак вывода ответа в виде JSON YES29</NOdelivereddate>*'''client_code''' - Код клиента курьерской службы '''Пример ответа <deliveredtime>12:00:'''00<source lang="xml"/deliveredtime> <?xml version="1.0" encoding="UTF-8" ?deliveredto /> <storelist count="2"/order> <storedocument> <code>12321991</code> <number>318</number> <namedate>ABC2017-05-26</namedate> <message></storemessage> <store/document> <codeserials> <serial>456123456789</codeserial> <name>Филиал 2</nameserials> </storeitemmovements></storelistitemlist>

''' Описание полей ответа '''* '''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''' — комментарий * '''serials''' — контейнер серийных номеров:* '''serial''' — серийный номер единицы номенклатуры, участвующей в движении

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

<pvzlistserialmovements> <auth extra="8" login="login" pass="pass"></auth> <codeserial>1234123456789</code> <client_code>7890</client_code> <city>Свердловская область</city> <town regioncode="66" country="RU">Нижний Тагил</town> <parentcode>6</parentcode> <acceptcash>YES</acceptcash> <acceptcard>YES</acceptcard> <acceptfitting>YES</acceptfitting> <maxweight>30</maxweight> <acceptindividuals>YES</acceptindividuals> <lt>57.924737</lt> <lg>59.940019</lg> <rt>57.905682</rt> <rg>59.984669</rg> <json>YES</json> <limit> <limitfrom>30</limitfrom> <limitcount>2</limitcount> <countall>YES</countall> </limitserial></pvzlistserialmovements></source>

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

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

<pvzlist serialmovements count="2" totalcount="4046516"> <pvzserialmovement> <code>126151500</code> <clientcodeserial>3123456789</clientcodeserial> <namedate>Нижний Тагил2017-05-26</namedate> <parentcodedelivered>60</parentcodedelivered> <parentname>Интеграция</parentnameitem> <town code="124267" regioncode="66" regionname="Свердловская область">Нижний Тагил город4259</towncode> <addressname>622036, г. Нижний Тагил, ул. Циолковского, д. 17Настольная игра Дженга</addressname> <phone>+73435417709, +73435254989</phoneitem> <comment>Новый пункт доставки</commentstatus> <worktimecode>Вс 10:00-16:00, Сб 10:00-16:00, Пн-Пт 10:00-20:005</worktimecode> <traveldescriptionname>Жилое 5-ти этажное здание, торцом к дороге, второе здание Возврат от перекрестка Пархоменко-Циолковскогопокупателя</traveldescriptionname> <maxweight>10</maxweightstatus> <acceptcash>YES</acceptcashorder> <acceptcardordercode>YES3374830</acceptcardordercode> <acceptfittingnumber>YES</acceptfitting> <acceptindividuals>YES</acceptindividuals> <latitude>57.93457123660-0</latitudenumber> <longitudedate>59.95131</longitude> <uid>40606d00-9c51-11eb2017-b2c905-cfd6c1111392</uid> </pvz> <pvz> <code>245</code> <clientcode>NTG124</clientcodedate> <nameorderno>На Красноармейской14123</nameorderno> <parentcodebarcode>60000000670</parentcodebarcode> <parentnamecompany>ИнтеграцияТОВАР</parentnamecompany> <town code="124267" regioncode="66" regionname="Свердловская область">Нижний Тагил город</town> <address>КРАСНОАРМЕЙСКАЯКравченко ул., д.791</address> <phonedelivereddate>+7(3435)3792017-04405-29</phonedelivereddate> <comment>Возможность примерки отсутствует </commentdeliveredtime> <worktime>Вс 10:00-1612:00, Сб 10:00-16:00, Пн-Пт 10:00-20:00</worktimedeliveredtime> <traveldescription>Напротив ТЦ Пирамида</traveldescription> <maxweight>20 <deliveredto /maxweight> <acceptcash>YES</acceptcashorder> <acceptcard>YES</acceptcarddocument> <acceptfittingcode>NO21991</acceptfittingcode> <acceptindividualsnumber>YES318</acceptindividualsnumber> <latitudedate>57.934682017-05-26</latitudedate> <longitudemessage>60.55476</longitudemessage> <uid>41116853-9c51-11eb-b2c9-cfd6c1451392</uiddocument> </pvzserialmovement></pvzlistserialmovements></source> ''' Описание полей ответа ''' Описание аналогично описанию полей [[#Движение номенклатуры|движения номенклатуры]]

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

<?xml version="1.0" encoding="UTF-8"?><receiptdataorderserials> <auth extra="8" login="login" pass="pass" ></auth> <ordersordercode>123456789</ordercode> <order orderno="123456" >123456789</orderno> <barcode>123456789<order orderno="890111C" /barcode> </ordersorderserials></receiptdatasource>

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

<receipts counttariffs> <auth extra="18" login="login"> <receipt> <orderno>123456</orderno> <fdDatetime>2020-06-07 12:14:00</fdDatetime> <fdValue>123</fdValue> <fdNum>456</fdNum> <fnSn>789</fnSn> <kktNum>100</kktNum> <inn>222</inn> <ofdUrl>gate.ofd.ru</ofdUrl> <fullUrl>https://check.ofd.ru/123</fullUrl> <price>12345</price> <lines countpass="1pass"> <line> <item>1111764</item> <nametownfrom>СапогиМосква</nametownfrom> <qtyservice>1</qtyservice> <pricemainonly>10001</pricemainonly> <vatRate>20</vatRatetariffs> <governmentCode>Z16513LK2</governmentCodesource> <itemType>1</itemType> </line>* '''auth''' — атрибут '''extra''' обязателен, по нему определяется курьерская служба. </lines>* '''townfrom''' — город-отправитель. Если не передан, то городом будет «Москва». </receipt>* '''service''' — режим доставки. Обязательный элемент.</receipts></source* '''mainonly''' — необязательный элемент. Если передан, то в ответе будут данные только по городам из справочника '''Межгород''' >'''Зоны'''.

== Справочник дополнительных услуг == '''Пример запроса дополнительных услуг:ответа справочника тарифов по городам'''<source lang="xmljson"><?xml version={ "townfrom": "0c5b2444-70a0-4932-980c-b4dc0d3f02b5", "service": 1.0, "tariffs": [ { "towntofias" encoding=: "UTF0c5b2444-70a0-4932-980c-8b4dc0d3f02b5", "towntocode"?>: 1,<advprices> "towntoname": "Москва город", <auth extra= "8townregion" login=: "loginГород Москва" pass=, "passdistance" />: 0, <visible>NO</visible> "pricedistance": 0,</advprices> "pricesnew": {</source> "before": [ {'''advprices''' - Корневой контейнер. Обязательный элемент. "price": 100,*'''visible''' - Признак возврата '''только''' тех услуг "every": 0, что доступны для отображения в ЛК YES/NO. Необязательный элемент. По-умолчанию NO "mass": 1 }, {'''Пример ответа справочника дополнительных услуг "price":'''150,<source lang= "xmlevery">: 0,<?xml version= "1.0mass" encoding=: 5 } ], "UTF-8after" ?>: [<advprices> { <advprice> "price": 0, <code> "every": 1</code>, <name>Этажей в доме</name> "mass": 38.01 <type>int</type> }, </advprice> { <advprice> "price": 15, <code>2</code> "every": 1, <name>Коэффициент надбавки</name> "mass": 51.01 <type>float</type> } </advprice> ] <advprice> }, <code>3</code> "deliveryPeriodMin": 1, <name>Расписаться на упаковке</name> "deliveryPeriodMax": 2 <type>bool</type> } </advprice> ]</advprices>}

Параметры''' Описание полей ответа '''* '''townfrom''' — код ФИАС города-отправителя.* '''service''' — режим доставки.* '''tariffs''' — cписок тарифов по городу.:* '''townregion''' — регион города-получателя.:*'''codetowntofias'''  — код ФИАС города- получателя.:* '''towntocode''' — внутренний код услугигорода-получателя.:*'''nametowntoname'''  — наименование города- наименование услугиполучателя. Если поле "название :* '''distance''' — дистанция в ЛК" км до города от МКАД, если в настройках услуги не пустозапросе townfrom — Москва.:* '''pricedistance''' — сумма за километраж до города от МКАД, то возвращает значение поля "название если в ЛК"запросе townfrom — Москва.:* '''pricesnew''' — ваши настройки тарифов из справочника '''Межгород''' > '''Тарифы по зонам'''.::* '''before/after''' — контейнеры ДО/ОТ.:::*'''hineprice''' - подсказка  — цена. Если ответ идет по доп услуге для пользователя«before», то в цену также плюсуется сумма pricedistance:::*'''typeevery''' - тип услуги — за каждые. Может иметь значения:::* '''mass''' — масса.:*'''boolprices''' - для услуг вида "чекбокс" — устаревший элемент, "Да"не используется.:*'''floatdeliveryPeriodMin''' - для числа с плавающей точкой — минимальный срок доставки.:*'''intdeliveryPeriodMax''' — максимальный срок доставки. == Номенклатура приходной накладной =='''Пример запроса номенклатуры приходной накладной:''' <source lang="xml"><?xml version="1.0" encoding="UTF- для целого числа8" ?><itemdoc> <auth extra="8" login="login" pass="pass"></auth> <code>21991</code></itemdoc></source> * '''code''' — внутренний код документа приходной накладной (см. предыдущий запрос).

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

<calculatoritemdoc> <auth extra="8" login="login" pass="pass" /code> 21991<order/code> <pricetypenumber>CUSTOMER318</pricetypenumber> <senderdate> <town>Санкт2017-Петербург</town> <address>Петровка 38 офис 35</address> <coords lat="55.680327" lon="37.604456"></coords> </sender> <receiver> <zipcode>125480</zipcode> <town regioncode="78" country="RU">Санкт05-Петербург26</towndate> <addressmessage>Петровка 38 офис 35</addressmessage> <pvz>124 </pvzitems> <coords latitem code="55.680327" lon=4259"37.604456"></coords> </receiver> <weight>5.1</weight> <service>2</service> <paytype>CASH</paytype> <price>387.5</price> <deliveryprice>150</deliveryprice> <inshprice>387.5</inshprice> <packages> <package massquantity="1"></package> <package mass="2.5" length="10" widthbarcode="20200300" heightarticle="30123555">Настольная игра Дженга</packageitem> </packages> <userid>user123</userid> <groupid>customer</groupid> </orderitems></calculatoritemdoc>

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

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

В авторизации можно опустить параметры login и pass* '''auth''' — Атрибут '''extra''' — обязателен, тогда расчет будет производиться по стандартному тарифу нему определяется курьерская служба* '''json''' — Признак вывода ответа в виде JSON YES/NO* '''client_code''' — Код клиента курьерской службы, без учета возможных отличий для конкретного клиента.<br>Объемный вес будет учитываться только при условии указания всех габаритов: длины, ширины и высоты.<br>В полях город-отправитель и город-получатель можно указывать название города (не рекомендуется!), либо код города из нашего справочника, либо 13-ти значный код КЛАДР, либо 36-ти значный код адресной системы ФИАС (AOID).

 '''Пример ответа стоимости доставки:'''

<?xml version="1.0" encoding="UTF-8"?><calculatorstorelist count="2"> <calcstore> <townfrom code="1">Москва город123</townfrom> <townto code="56603">Иркутск город</townto> <massname>3.7ABC</mass> <service name="Экспресс">1</service> <zone>2 </zonestore> <price>1113</price> <mindeliverydays>1</mindeliverydays> <maxdeliverydays>3</maxdeliverydays> <mindeliverydate>2020-05-13 </mindeliverydatestore> <deliveryprice> <advprice code="1" price="1000">База456</advprice> <advprice code="4" price="100">Процент от суммы руб</advprice> <advprice code="5" price="63"name>Процент от объявленной стоимостиФилиал 2</advprice> <advprice code="6" price="-50">Скидка при доставке</advprice> </deliverypricename> </calcstore></calculatorstorelist>

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

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

Обратите внимание, что если в выборке количество ПВЗ больше '''Пример запроса получения информации о клиенте:10000''' и не указаны параметры '''code''', '''json''' или '''limitcount''', то будет возвращаться ошибка. В этом случае необходимо использовать блок '''limit'''<source lang="xml"><?xml version="1.0" encoding="UTF-8" ?><client> <auth extra="8" login="login" pass="pass" /> </client></source>

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

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

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

== Список актов передачи денег ==Также можно указать страну получателя в атрибуте '''''country''''' в соответствии с [https://ru.wikipedia.org/wiki/ISO_3166-1 стандартом ISO_3166-1], например, «RU», «RUS» или «643» для России.Для формата запроса 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.

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

<smalistpvzlist count="2" totalcount="40465"> <auth extrapvz> <code>126</code> <clientcode>3</clientcode> <name>Нижний Тагил</name> <parentcode>6</parentcode> <parentname>Интеграция</parentname> <town code="8124267" loginregioncode="login66" passregionname="passСвердловская область" >Нижний Тагил город</town> <address>622036, г. Нижний Тагил, ул. Циолковского, д. 17</address> <phone>+73435417709, +73435254989</phone> <comment>Новый пункт доставки</comment> <datefromworktime>2016Вс 10:00-16:00, Сб 10:00-0216:00, Пн-Пт 10:00-20:00</datefromworktime> <datetotraveldescription>2016Жилое 5-03ти этажное здание, торцом к дороге, второе здание от перекрестка Пархоменко-Циолковского</traveldescription> <maxweight>10</datetomaxweight> <acceptcash>YES</smalistacceptcash> <acceptcard>YES</sourceacceptcard> <acceptfitting>YES</acceptfitting>'''smalist''' - Корневой контейнер. Обязательный элемент. <acceptindividuals>YES</acceptindividuals>*'''auth''' - Авторизация. Обязательный элемент <latitude>57.93457</latitude>*'''datefrom''' - Дата "с". Необязательный элемент <longitude>59.*'''dateto''' - Дата "по". Необязательный элемент.Если интервал дат не указан, то возвращаются акты передачи денег за последний месяц. '''Пример ответа на запрос списка актов передачи денег:'''95131<source lang="xml"/longitude> <?xml version="1.0" encoding="UTFuid>40606d00-9c51-11eb-b2c9-8"?cfd6c1111392</uid> <smalist count="1"/pvz> <smapvz> <code>6278245</code> <numberclientcode>3992NTG1</numberclientcode> <actdatename>2016-02-12На Красноармейской</actdatename> <datepayparentcode>6</datepayparentcode> <datetoparentname>2016-02-12Интеграция</datetoparentname> <promiseddatepaytown code="124267" regioncode="66" regionname="Свердловская область">Нижний Тагил город</promiseddatepaytown> <priceaddress>637КРАСНОАРМЕЙСКАЯ, д.0079</priceaddress> <pricecorrphone>113.00+7(3435)379-044</pricecorrphone> <rurcomment>13430.00Возможность примерки отсутствует</rurcomment> <pricekurworktime>570.Вс 10:00-16:00, Сб 10:00-16:00, Пн-Пт 10:00-20:00</pricekurworktime> <priceagtraveldescription>67.00Напротив ТЦ Пирамида</priceagtraveldescription> <paynomaxweight>4242320</paynomaxweight> <paytypeacceptcash>1YES</paytypeacceptcash> <paytypenameacceptcard>БезналYES</paytypenameacceptcard> <signedcopyreceivedacceptfitting>NO</signedcopyreceivedacceptfitting> <acceptindividuals>YES</acceptindividuals> <latitude>57.93468</latitude> <longitude>60.55476</longitude> <uid>41116853-9c51-11eb-b2c9-cfd6c1451392</uid> </smapvz></smalistpvzlist>

*'''code'''  — Код ПВЗ в системе. Используется в запросе [[API#Оформление заказа|оформления заказов]]* '''clientcode''' — Код ПВЗ используемый компанией- подрядчиком.* '''name''' — Наименование ПВЗ.* '''parentcode''' — Код актародительского элемента.* '''parentname''' — Наименование родительского элемента.* '''town''' — Населенный пункт с кодом из [[#Справочник городов|справочника городов]], а также с кодом и наименованием региона.*'''numberaddress''' - Номер акта в системе — Адрес ПВЗ.*'''actdatephone''' - Дата акта — Телефоны ПВЗ.*'''datepaycomment''' - Дата оплаты по акту — Дополнительная информация.*'''datetoworktime''' - Дата конечного периода для формирования АПД — Режим работы ПВЗ.*'''promiseddatepaytraveldescription''' - Плановая дата оплаты — Описание местонахождения ПВЗ или пути к нему.*'''pricemaxweight''' - Стоимость услуг — Максимальный вес, с которым работает ПВЗ.*'''pricecorracceptcash''' - Сумма корректировки — Признак приема наличных*'''ruracceptcard''' - Сумма заказа — Признак приема банковских карт*'''pricekuracceptfitting''' - Стоимость курьерской доставки — Наличие примерки*'''priceaglatitude''' - Агентское вознаграждение — Широта*'''paynolongitude''' - Номер платежного поручения — Долгота*'''paytypeuid''' - Тип оплаты: 1 - безнал, 2 - наличными курьером, 3 - наличными  — Уникальный идентификатор ПВЗ в офисе, 4 - перевод на картусистеме Measoft. Создается автоматически при получении данных о ПВЗ от агентов.*'''paytypenamecount''' - Строковое представление типа оплаты — Количество записей в ответе*'''signedcopyreceivedtotalcount''' - Признак факта возврата акта YES/NO — Общее количество записей, отвечающее параметрам запроса

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

<?xml version="1.0" encoding="UTF-8" ?><smadetailreceiptdata> <auth extra="8" login="login" pass="pass" /> <codeorders>6278 <order orderno="123456" /code> <order orderno="890111C" /smadetail> </orders></receiptdata>  

'''smadetailПример ответа получения фискальных данных:''' - Корневой контейнер. Обязательный элемент.*'''auth''' - Авторизация. Обязательный элемент.<source lang="xml">*'''code''' - Код акта передачи денег (см. запрос списка АПД). Обязательный элемент.

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

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

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

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