Изменения

Для работы с популярными CMS и CRM-системами разработаны модули интеграции, перечисленные в таблице ниже .

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

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

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

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

|Работает только с компонентом 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 Скачать]

|style="height:100px; text-align[[Файл: webhooks.jpg|center;"|'''Webhook'''x100px]]

* '''pass''' — пароль клиента;* '''measoftid''' — системная переменная, используемая системой.

<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>

:* '''''orderno''''' — Номер заказа. Если присваивается клиентом — указывается здесь. Если не присваивается — можно оставить пустым, система сгенерирует свой номер, и вернет его в ответе. Система проверяет '''у клиента''' наличие заказов с указанным номером в '''пределах текущего календарного года''', которые '''не являются недоставленными''', и в случае их существования — заказ создан не будет, а в ответе вернется ошибка 17 «Such number exists». Если не указан штрихкод (поле barcode), и значение поля подходит для использования его в качестве штрихкода, данное значение будет скопировано в поле «Штрихкод». Это накладывает ограничения в частности, на длину указанного поля (25 знаков, чтобы работали стандартные печатные формы).

* '''barcode''' — Штрихкод заказа. Если клиент штрихкодирует свои отправления и штрихкод отличается от номера заказа, в этом поле указывается штрихкод. Если ШК содержит кириллицу или малое количество символов, то формируется ШК в формате EAN13. <spoiler text="Заполнение номера заказа (шифра) и штрих-кода">Шифр и штрих-код заполняются исходя из начальных значений: # Если шифр и ШК пустые - оба поля заполняются автоматически значением вида XXX#YYY, а после ШК проверяется на корректность (валидируется)# Если ШК пустой, а шифр заполнен - ШК заполняется значением из шифра и валидируется# Если шифр пустой, а ШК заполнен - шифр заполняется значением из ШК, после чего ШК валидируется# Если оба непустые - валидируется ШК, шифр не проверяется Корректный (валидный) ШК отвечает следующим требованиям:* длина не меньше 5 символов* значение не меньше значения переменной <mparam code="MinPrePrintedNum"/>* содержит символы, которые можно использовать для формирования штрих-код а формате Code128 (т.е.все печатные символы, кроме кириллицы) Если ШК не прошел проверку, то:* если переменная <mparam code="StoreInvLength"/> равна 0, ШК заполняются автоматически значением вида XXX#YYY (или приравнивается шифру в том же формате)* если переменная <mparam code="StoreInvLength"/> больше 0, ШК заполняются автоматически сквозным номером (если шифр в формате XXX#YYY, то шифр приравнивается ШК)</spoiler> В случае наличия нескольких мест и раздельной их маркировки в этом поле допустимы маски в виде символов подчеркивания, говорящие о позициях штрихкода, переменных для разных мест в рамках одного заказа.<br>

:* наименование ПВЗ в виде строки "ПВЗ " + «Наименование ПВЗ».  При указании ПВЗ в поле адреса необходимо проверять значение поля город получателя (он должен соответствовать данным ПВЗ) либо не передавать его вообще.

* '''service''' — Режим доставки (тип услуги) передается код из справочника «[[#Справочник Видов Виды срочности|Виды срочности]]».* '''type''' — Тип корреспонденции (отправления) передается код из справочника «Типы корреспонденции».* '''return''' — Признак необходимости возврата. Принимает значения::* NO — Возврат не требуется:* YES — Требуется возврат, например, документов:* ONLY — Требуется забрать отправление у поставщика (см. раздел «[[Личный_кабинет_клиента#Привезти ко мне|Привезти ко мне]]»).

* '''pricereturn_weight''' — Сумма Общий вес возврата заказа. В случае наличия контейнера items значение этого параметра будет проигнорировано и рассчитано автоматически.* '''deliveryprice''' — Сумма доставки. В случае наличия контейнера items в него будет добавлено вложение «Доставка».:* '''''VATrate''''' — Ставка НДС — целое число процентов.* '''return''' — Признак необходимости возврата.* '''return_service''' — Режим возврата (тип услуги) передается код из справочника «Виды срочности».* '''discount''' — Сумма скидки. Скидка «размазывается» по товарным вложениям, сумма НП уменьшается на сумму скидки. При этом вложение Скидка не создается. ВНИМАНИЕ, при использовании этого тега общая сумма может расходиться на копейки из-за округления! Старайтесь не использовать этот тег, а указывать цену товаров уже с учетом скидоккилограммах.

:* '''''VATrate''''' — Ставка НДС — целое число процентов. Если товар хранится в КС (смотрите '''article''' ниже), значение берется из номенклатуры. Иначе, если значение не указано, подставляется берется указанное значение, если нет - значение «20»из настроек фирмы КС. Значение «0» означает ставку «Без НДС», ставка «0%» на данный момент не поддерживается.

:* '''''governmentCode''''' — Код товарной номенклатуры. Используется для [[Маркировка|маркированных товаров , например («Честный знак»)]]. Для кода '''Честный знак''' Нужно указывать все данные из нанесенного QR-кода кроме не читаемых символов (#29). Если код не известен — укажите знак вопроса «?», тогда курьер отсканирует код фактически передаваемого покупателю товара. Для некоторых процессов может использоваться значение «!» — в этом случае курьер сканирует серийный номер товара, но это не считается кодом маркировки. При этом, если указано значение «?» или «!» и quantity больше 1, то такое вложение растиражируется quantity раз.:* '''''govType''''' — Тип маркировки товара. В данный момент существуют следующие типы маркировки::: 1 — Честный знак. По-умолчанию.:: 2 — ГИИС ДМДК.:: 3 — Серийный номер.:* '''''message''''' — Строка сообщения.:* '''''extraTags''''' — Строка в формате JSON для отправки в ОФД. :: Тэг 1265 - значение отраслевого реквизита = код места деятельности аптеки :: Тэг 1262 – идентификатор ФОИВ = "020" (константа ФОИВ МИНЗДРАВа) :: Тэг 1263 - дата нормативного акта федерального органа исполнительной власти = "14.12.2018" (константа) :: Тэг 1264 - номер нормативного акта федерального органа исполнительной власти = "1556"(константа) :: Тэг 1212 - Признак предмета расчета :: Пример: <source lang="json">"item_industry_props":{"tag1262":"020","tag1263":"14.12.2018","tag1264":"1556","tag1265":"tm=mdlp&sid=00000000XXXXXX"},"tag1212": "1"</source>  Для клиентов из '''Узбекистана''' необходимо указывать код ИКПУ и код упаковки в следующем формате:<source lang="json">"ikpu":"123123123","packageCode":"123456"</source>  

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

|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 параметры]] == Запрос статуса заказов == === Пример запроса статуса заказа ===

* '''orderno''' — Номер Идентификатор заказау клиента (шифр). Необязательный элемент.

* '''orderno2''' — Номер заказа из срочных. Необязательный элемент.* '''uid''' — Уникальный идентификатор, если он был добавлен при создании заказа. Необязательный элемент. Запрос информации по uid возможен в течении суток после создания заказа

<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>

<arrivaldepartment>2016-05-02 23:21Отдел</arrivaldepartment> <costcode>cc12345</costcode>

<return_messagearrival>Доставлено в целости2016-05-02 23:21</return_messagearrival> <departmentreceipt fdNum="124555" fnSn="9289000100295555" kktNum="0001611984048555" inn="7722756555" fdValue="2899551555" summ="387.5" ofdUrl="gate.ofd.ru">Отделhttps://ofd.ru/rec/7722756555/0001611984048555/9289000100295555/124555/2899551555</departmentreceipt>

<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>

* '''arrival''' — плановая дата прибытия в формате гггг-мм-дд чч: мм: сс. Заполняется только при использовании автоматических систем планирования (Максоптра, Яндекс доставка), во всех остальных случаях - пустое.

: COURIERDELIVERED — Доставлен (предварительно, ождает ожидает подтверждения менеджером, чтобы перейти в статус COMPLETE).: COURIERPARTIALLY — Частично доставлен (предварительно, ождает ожидает подтверждения менеджером, чтобы перейти в статус PARTIALLY).

=== Лимитирование запросов ===Дает возможность получить не все измененные заказы, а только какое-то определенное количество. Помогает на случай, если у вас скопилось очень много измененных заказов и нужно их грузить лимитировано. После успешной обработки получнных заказов, '''обязательно''' нужно вызвать commitlaststatus с кодами обработанных заказов.  '''Пример запроса:''' Для получения ограниченного числа изменившихся заказов отправьте запрос:

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

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

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

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

При редактировании Заказ доступен для оплаты, если:* тип оплаты заказа не наличными, а например картой или по договору, альтернативой может быть отменен запланированный курьерстать установка параметра "Спрашивать тип оплаты" в карточке клиента. Это зависит от значения переменной '''Справочники''' > '''Переменные''' > '''Корреспонденция''' > '''Автоматически устанавливать заплан. курьера по району''':* '''Нет''' — при редактировании заказа по АПИ курьер заказ имеет наложенный платеж* не изменяется;оплачен* '''Район''' — если изменен адрес доставкиактивен (не доставлен, курьер сбрасывается;* '''Район или дата планне возвращен в т. доставки''' — если изменен адрес доставки или плановая дата вручения, курьер сбрасываетсяч.курьером)

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

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

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

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

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

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

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

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

* значение '''Пример ответа:orderno'''данным методом изменить нельзя.<source lang="xml"><?xml version="1* значение '''barcode''' изменяется в случае явного его указания.0" encoding="UTFВ случае отсутствия или пустого значения -8" ?>остается прежним.<cancelorder>* вместо корневого тэга '''neworder''' указывается '''editorder'''; <order orderno="123test" ordercode="123456" error="0" errormsg="OK" errormsgru="Успешно" />* тэг курьера '''courier''' можно изменить только при включенной настройке '''Разрешить изменение курьера по АПИ'''; <order orderno="123aaa" ordercode="" error="52" errormsg="order not found" errormsgru="Заказ не найден" />* для вложений '''item''' указывается внутренний код вложения в атрибуте '''code''', который можно получить при получении статуса заказа.</cancelorder></source>* для мест '''package''' указывается внутренний код вложения в атрибуте '''code''', который можно получить при получении статуса заказа.

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

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

<attachmentscancelorder>

<order orderno="" ordercode="123456" />1234567 <order orderno="123aaa" ordercode="" /orderno></attachmentscancelorder>

'''attachmentscancelorder''' — Корневой контейнер. Обязательный элемент.

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

== Изменение статуса агентом ==Метод позволяет прикрепить файлы к корреспонденции.Запрос изменения статуса заказа позволяет установить окончательный статус заказа — «Доставлен» или «Не доставлен (Возврат/Отмена)»Размер загружаемого файла не должен превышать 1 Мб.

Кроме этого, устанавливается дата и время (при необходимости) изменения статуса, а также сообщение в поле ''Инфо о доставке''. При необходимости к заказу можно прикрепить изображения.  '''Пример запроса изменения статуса:'''

<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>

'''Описание полей запроса статуса:'''

'''setorderinfoaddattachments''' — Корневой контейнер. Обязательный элемент.

* '''orderorderno''' — Контейнер Номер заказа. Обязательный элемент. Запрос может содержать более одного контейнера '''order'''. Атрибут '''''Может использоваться тэг <ordercode''''' — внутренний код > с указанием внутреннего кода заказа.* '''statusattachments''' — Новый статус заказа. Доступны статусы из раздела [[#Описание полей ответа статусов]]Обязательный элемент, кроме AWAITING_SYNC и NEWв котором перечисляются передаваемые данные файлов.* '''eventtime''' — Дата и время изменения статуса. Обязательно при указании статуса.* '''message''' — Текст сообщения ''Инфо о доставке''.* '''outstrbarcodeitem''' — код у подрядчика Бинарные данные (код заказа во внешней системефайл). Используется , закодированные в интеграциях с внешними системамиbase64.* '''paytype''' — Тип оплаты заказа. Допустимые значения CASH/CARDОбязательный элемент.* '''items''' — Контейнер для описания вложений '''item''' . Атрибуты::* '''''code''''' — Код вложения.:* '''''quantity''name''' — Количество доставленных единиц вложения.:* Атрибут элемента '''''reason''item''' — Причина недоставки, выбирается из соответствующего списка статусов.* '''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+/jfenJ/fWjqa7ygExx+L0BcTGroxrKexQXIQ1ImfEW7ZRJZa+O ip7xJmmNESMxrgu/GcbjzB AwhBl8hwQYIO00GmEwg1CeEG dquBbGypjJpFDJVRH1rVPR1Ifl4aFS5IEdDWZFSdyBBWKWhVSVu517ZgzOCFAwp mqYTChNU0wqf8l8nz4zgcwwbFph29g4fTaxnvn/3X78x+Tt56ZNffArgULt+HByvy7+yz6U6XWMawCi3+6gJXN0S+jf4t+K fCnoHT34wg km7/HDp55YTSWMoCMgZsvZkBrXtIv4WA7xgkT4YpYpxjwLvnsWKkGE+zwU5GjOZmzXGcbEQYIM pDbxER0UUWlpVFRY4oilTfM4 4zkegRE40zWzONyoNNMIOIa cWnp6aDCGEGE9NQmoQd2mg00 MIzgCPgxjOlZ87ceA7ceRJrgpipFGyugPQ4OTI2S8lWJoqTpHJlJbNOeYM7zTcoVxSNyJXiYWSAMklT 79U4f3hPTwnfp6Sdrafeqpa JDpFwq/xd+3fd3/1aYT077VNNNdO00G3q USq2V1rJ7RyBLHsuDSiLwgaOFc5LUCRGI+QWuBAsIwPlZrgRpSMseJyTzD15PKiIRE7bc Rggk5ijXAPpqISetD4wVm0AD2LHuBZdaxmK3HOKIZoG0QLmiZdVqspXnFIJwVyCKhWiDCI4bzH8Y76w TAnwM67HIqMISOkmJXY8mlYhpiNa7g2oTBkKxo4wgnvETQIUUrlFOn9KdOreDiKQx071rN4N61yRAi1 mqqvp9p2E7T07EGRhSOgoeLYv+k41+KZ1SVBXAuDjB+xuxnQmm8wJDcP5IRn+5penzbR/wiFemv8uG6 OMivm7qleHK5o790w8ejXchI vOHIPWtWwYhtAO34LdDXqFqWxZEBLNstMCwwITBTWirxk12zuUppp</contentitem></waybillattachments>

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

<townlist countsetorderinfo> <order ordercode="3123456" pageerror="10" totalcounterrormsg="3OK" totalpageserrormsgru="1Успешно"/> <townorder ordercode="234567" error="59" errormsg="value [date_put] is already set" errormsgru="Значение [Дата доставки] уже указано" /> <code/setorderinfo>26379</codesource> <city> <code>23</code>== Получение документов для печати =='''Пример запроса получения печатных форм:''' <name>Краснодарский край</namesource lang="xml"> </city?xml version="1.0" encoding="UTF-8" ?> <name>Сочи город</namewaybill> <fiascode>79da737a-603b-4c19-9b54-9114c96fb912 <auth extra="8" login="login" pass="pass" /fiascode> <kladrcodeclient>2300000700000CLIENT</kladrcodeclient> <shortname /orders> (not yet supported) <typename order orderno="1234567" ordercode="33331" /> (not yet supported) <coords latorder orderno="43.58551234568" lonordercode="39.723133332" /> </townorders> <townform> <code>403311</codeform> <city> <codestart>325</codestart> <nameintegration>Брянская область21</nameintegration> </citywaybill> <name>Сочилов хутор</namesource> <fiascode>c9c96c67-2cc9-4f10-afde-fd32417ea216</fiascode> <kladrcode>3201900011100</kladrcode>'''Описание полей:'''  <shortname />'''waybill''' — Корневой контейнер. Обязательный элемент <typename />* '''auth''' — Авторизация. Обязательный элемент <coords lat="52* '''client''' — Признак клиента или агента.6407" lon="33Необязательный элемент.1724" /> </town>:* CLIENT — Признак клиента, значение по умолчанию <town>:* AGENT — Признак агента. В ответ отдается информация по заказам, переданным агенту на доставку <code>114016</code>* '''orders''' — Список заказов для получения печатных форм. Содержит тэги '''order''' с атрибутами: <city>:* '''''orderno''''' — шифр заказа <code>60</code>:* '''''ordercode''''' — внутренний код заказа. Указывать необходимо один из атрибутов для всех заказов. Приоритет имеет атрибут '''''ordercode''''' <name>Псковская область</name>* '''form''' — Формат накладной. Не обязательный элемент. Принимает значения: </city> <name>Сочихино деревня</name> <fiascode>10df7588:* 1 — Подробная накладная (по-19c1-49d1-a387-9de1cf3eb26f</fiascode>умолчанию) <kladrcode>6001900015400</kladrcode>:* 2 — Наклейки Zebra <shortname />:* 3 — Наклейки на страницу формата А4 <typename />:* 4 — Акты приема-передачи <coords lat* '''start''' — Имеет смысл только для form ="563. Начальная позиция первой наклейки.6003" lon="29Используется для пропуска наклеек на листе для их экономии.3542" /> </town>* '''integration''' - Получение наклеек от подрядчика. Не обязательный элемент, имеет смысл при наличии кода подрядчика в карточке заказа. Принимает значение:</townlist></source>:* 21 - подрядчик GTD

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

<regionlistwaybill> <codesearchintegration code="21"> <order code="33331"> <content>77JVBERi0xLjYNJeLjz9MNC...</codecontent> </codesearchorder> <conditionsorder code="33332"> <namecontainscontent>крайJVBERi0xLjYNJeLjz9MNC...</namecontainscontent> <namestarts/order>Моск </namestartsintegration> <fullnamecontent>Московская область<EODIcaI8KSBlwQ 4MnEOR7Px8U8EBAyGICBnwpw IZhQgz0ZxuPs8EBM/fullname>GcbjzB AwhBl8hwQYIO00GmEwg1CeEG mqYTChNU0wqf8l8nz4zgc+K fCno+zwU5GjOZmzXGcbEQYIM 4zkegRE40zWzONyoNNMIOIa cWnp6aDCGEGE9NQmoQd2mg00 <country>RU< 79U4f3hPTwnfp6Sdrafeqpa JDpFw/country>1aYT077VNNNdO00G3q mqqvp9p2E7T0/wiFemv8uG6 OM</conditionscontent></regionlistwaybill>

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

<regionlist count="2"waybill> <cityerror> <code>80</code> <country> <code>1</code> <name>Россия</name> <id>643</id> <ShortName1>RU</ShortName1> <ShortName2>RUS</ShortName2> </country> <name>Агинский Бурятский автономный округ</name> </city> <city> <code>1</code> <country> <code>1</code> <name>Россия</name> <id>643</id> <ShortName1>RU</ShortName1> <ShortName2>RUS</ShortName2> </country> <name>Адыгея республика</name> Текст ошибки</cityerror></regionlistwaybill>

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

<streetlisttownlist> <conditionsauth extra="8" /> <codesearch> <zipcode>110000</zipcode> <kladrcode>0100000100800</kladrcode> <fiascode>bd21979d-46f8-49d0-9105-e8d65172a983</fiascode> <towncode>Москва город123</towncode> </codesearch> <conditions> <city>Краснодарский край</ ОБЯЗАТЕЛЬНОЕ ПОЛЕ!city> <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">:* '''kladrcode''' — Поиск по 13-ти значному коду КЛАДР.:* '''fiascode''' — Поиск по коду ФИАС (AOGUID).:* '''code''' — Поиск по коду в системе. * '''conditions''' — Задает условия поиска. Все вложенные элементы одновременно накладывают условие «И».<?xml version="1:* '''city''' — Поиск по всем населенным пунктам региона.0" encoding="UTF-8"?><streetlist count=:* '''namecontainsparts''' — Поиск населенных пунктов, название которых содержит все указанные слова, с разбиением поисковой фразы через пробел. Например "1моск моло" page=найдет деревню "1Молоково" totalcount="3" totalpages="1">в Московской области. <street>:* '''namecontains''' — Поиск населенных пунктов, название которых содержит указанный текст. <code>124</code>:* '''namestarts''' — Поиск населенных пунктов, название которых начинается с указанного текста. <:* '''name>Академика Хохлова ул''' — Поиск населенных пунктов, название которых соответствует указанному тексту.</name> <shortname>Академика Хохлова</shortname>:* '''fullname''' — Поиск населенных пунктов, название вместе с типом населенного пункта которых соответствует указанному тексту. <typename>ул.<:* '''country''' — Поиск только по стране с указанным внутренним кодом или текстовым кодом в соответствии [https:/typename> </street><ru.wikipedia.org/streetlist><wiki/source>ISO_3166-1 стандартом ISO_3166-1], например, «RU», «RUS» для России.

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

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

<?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Пример запроса справочника:''' — Задает условия поиска. Все вложенные элементы одновременно накладывают условие «И»<source lang="xml"><?xml version="1.0" encoding="UTF-8"?>:* '''namecontains''' — Поиск товаров, название которых содержит указанный текст.<regionlist>:* '''namestarts''' — Поиск товаров, название которых начинается с указанного текста. <codesearch>:* '''name''' — Поиск товаров, название которых соответствует указанному тексту. <code>77</code>:* '''quantity''' — Наличие на складе. Принимает значения EXISTING_ONLY — Только в наличии, NOT_EXISTING_ONLY — Только не в наличии, ALL — Все. ''Это поле может быть недоступным в некоторых установках.'' </codesearch>:* '''store''' — Поиск товаров по определенному складу. <conditions> <namecontains>край</namecontains>* '''except''' — Описание исключений для корректного определения количества зарезервированной номенклатуры. <namestarts>Моск</namestarts>:* '''code''' — Код заказа. <fullname>Московская область</fullname> <country>RU</country>* '''limit''' — Ограничивает вывод результата. </conditions>:* '''limitfrom''' — Задает номер записи результата, начиная с которой выдавать ответ.</regionlist>:* '''limitcount''' — Задает количество записей результата, которые нужно вернуть.</source>

<itemlist regionlist count="3" totalcount="3" page="1" totalpages="12"> <itemcity> <code>12345680</code> <article>FD343</articlecountry> <barcodecode>23456252131251</barcodecode> <name>Sony KDL-55W905 ЖК-телевизорРоссия</name> <retpriceid>65000643</retpriceid> <purchpriceShortName1>50000RU</purchpriceShortName1> <weightShortName2>5.1RUS</weightShortName2> <length>50</lengthcountry> <widthname>30Агинский Бурятский автономный округ</widthname> <height/city>40 </heightcity> <VATratecode>201</VATratecode> <CountInPallet>30</CountInPalletcountry> <CountInBoxcode>21</CountInBoxcode> <HasSerialsname>1Россия</HasSerialsname> <CountryOfOriginid>Малайзия643</CountryOfOriginid> (not yet supported) <MessageShortName1>Хороший телевизорRU</MessageShortName1> <Message2ShortName2>Снова хороший телевизорRUS</Message2ShortName2> <quantity>12</quantitycountry> <reservedname>3Адыгея республика</reservedname> <item/city> ...</itemlistregionlist>

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

<?xml version="1.0" encoding="UTF-8" ?><itemmovementsstreetlist> <auth extra="8" login="login" pass="pass"conditions> <town>Москва город</authtown> // ОБЯЗАТЕЛЬНОЕ ПОЛЕ! <codenamecontains>4259Хохло</codenamecontains> <datefromnamestarts>Академика Х</namestarts> <name>Академика Хохлова</name> <fullname>Академика Хохлова ул.</fullname> </conditions> <limit> <limitfrom>30</limitfrom> <limitcount>2020-10-01</datefromlimitcount> <datetocountall>2020-10-02YES</countall> </datetolimit></itemmovementsstreetlist>

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

* '''limit''' — Ограничивает вывод результата.:* '''limitfrom''' — Задает номер записи результата, начиная с которой выдавать ответ. По-умолчанию — 0.:* '''limitcount'''- Задает количество записей результата, которые нужно вернуть. По-умолчанию — 10000.:* '''countall''' — YES указывает на необходимость подсчета общего количества найденных совпадений. Это может замедлять выполнение запроса. Если отключено, в ответе не указываются totalcount и totalpages. '''Пример ответа движения :'''<source lang="xml"><?xml version="1.0" encoding="UTF-8"?><streetlist count="1" page="1" totalcount="3" totalpages="1"> <street> <code>124</code> <name>Академика Хохлова ул.</name> <shortname>Академика Хохлова</shortname> <typename>ул.</typename> </street></streetlist></source> В ответе улицы сортируются по алфавиту. == Справочник номенклатуры =='''Пример запроса справочника номенклатуры:'''

<itemmovements count="16"itemlist> <itemmovement> <codeauth extra="8" login="login" pass="pass">151500</codeauth> <date>2017-05-26</date> <retprice>0</retprice> <quantity>1</quantity> <delivered>0</delivered> <itemcodesearch> <code>4259123456</code> <name>Настольная игра Дженга</name> </item> <status> <codearticle>5FD343</codearticle> <namebarcode>Возврат от покупателя2345625213125</namebarcode> </statuscodesearch> <storeconditions> <codenamecontains>1телевизор</codenamecontains> <name>офис в Москве</namenamestarts> sony</store> <ordernamestarts> <ordercode>3374830</ordercode> <number>123660-0</numbername> <date>2017Sony KDL-0555W905 ЖК-24телевизор</datename> <ordernoquantity>14123EXISTING_ONLY</ordernoquantity> <barcodestore>00000006702</barcodestore> <company>ТОВАР </companyconditions> <address>Кравченко ул., 1 </addressexcept> <delivereddatecode>2017-05-29123478</delivereddate> <deliveredtime>12:00:00</deliveredtime> <deliveredto /code> </orderexcept> <documentlimit> <codelimitfrom>2199130</codelimitfrom> <numberlimitcount>31810</numberlimitcount> <datecountall>2017-05-26YES</date> <message></messagecountall> </document> </itemmovementslimit></itemlist></source>

''' Описание полей ответа '''Внутри контейнера itemlist все элементы могут как отсутствовать, так и комбинироваться. Поиск не чувствителен к регистру.* '''codecodesearch''' — внутренний код операции движенияПоиск по кодам. В случае использования — контейнеры conditions и limit игнорируются.:* '''date''' — дата операции* '''retpricecode''' — цена товараПоиск по внутреннему коду системы.:* '''quantityarticle''' — количество товара операцииПоиск по артикулу.:* '''deliveredbarcode''' — количество доставленного товараПоиск по штрихкоду.

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

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

* '''storelimit''' — контейнер филиала, к которому относится операцияОграничивает вывод результата.:* '''codelimitfrom''' — код филиалаЗадает номер записи результата, начиная с которой выдавать ответ.:* '''namelimitcount''' — наименование филиалаЗадает количество записей результата, которые нужно вернуть.

* '''orderПример ответа:''' — контейнер корреспонденции:* '''ordercode''' — внутренний код заказа<source lang="xml"><?xml version="1.0" encoding="UTF-8"?><itemlist count="3" totalcount="3" page="1" totalpages="1">:* '''number''' — номер заказа <item>:* '''date''' — дата заказа <code>123456</code>:* '''orderno''' — шифр <article>FD343</article>:* ''' <barcode>2345625213125</barcode''' — штрихкод> <name>Sony KDL-55W905 ЖК-телевизор</name> <retprice>65000</retprice> <purchprice>50000</purchprice> <weight>5.1</weight> <length>50</length> <width>30</width> <height>40</height> <VATrate>20</VATrate> <CountInPallet>30</CountInPallet> <CountInBox>2</CountInBox> <HasSerials>1</HasSerials> <CountryOfOrigin>Малайзия</CountryOfOrigin> (not yet supported) <Message>Хороший телевизор</Message> <Message2>Снова хороший телевизор</Message2> <quantity>12</quantity>:* '''company''' — компания <reserved>3</reserved>:* '''address''' — адрес <item>:* '''delivereddate''' — дата вручения ...:* '''deliveredtime''' — время вручения</itemlist>:* '''deliveredto''' — данные о вручении, либо причина недоставки</source>

'''Описание полей:'''* '''documentcode''' — контейнер документа операцииВнутренний идентификатор, присвоенный системой.:* '''codearticle''' — внутренний код документаАртикул, назначенный клиентом (поставщиком).:* '''numberbarcode''' — номер документаШтрихкод производителя.:* '''extnumbername''' — внешний номер документаНаименование.:* '''dateretprice''' — дата документаРозничная цена по-умолчанию. При оформлении заказа цена используется та, которая указана в заказе.:* '''messagepurchprice''' — комментарийЗакупочная цена.* '''weight''' — Масса в килограммах.== Получение справочника тарифов по городам ==* '''length''' — Длина в сантиметрах.<br>* '''width''' — Ширина в сантиметрах.<div style="color: #a94442; background-color: #f2dede; border: 1px solid #ebccd1; padding: 3px 10px 10px;">* '''height''' — Высота в сантиметрах.* '''Обратите внимание!VATrate''' — Ставка НДС, целое число процентов.Если * '''CountInPallet''' — Количество штук в запросе отсутствует параметр nofederalпаллете.* '''CountInBox''' — Количество штук в упаковке.* '''HasSerials''' — Требует учета серийных номеров. Принимает значения 1 — да, то Москва будет обрабатываться иначе0 — нет.* '''CountryOfOrigin''' — Наименование страны происхождения на русском языке.* '''Message''' — Комментарий.* '''Message2''' — Дополнительный комментарий.* '''quantity''' — Количество на складе. Товары, чем остальные городауже собранные в заказы в этом количестве не присутствуют, считаются покинувшими товарный склад. ''Это поле может быть недоступным в некоторых установках.''* '''reserved''' — Количество зарезервированного товара. В ответе будут города Москвы и МОМожет превышать остаток на складе, с добавленной ценой за километраж</div><br>если покупатели ждут следующей поставки. ''Это поле может быть недоступным в некоторых установках.''

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

<?xml version="1.0" encoding="UTF-8"?><tariffsitemmovements> <auth extra="8" login="login" pass="pass" /> <townfrom>Москва</townfromauth> <servicecode>14259</servicecode> <mainonlydatefrom>12020-10-01</mainonlydatefrom> <nofederaldateto>12020-10-02</nofederaldateto> </tariffsitemmovements>

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

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

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

== Номенклатура приходной накладной ==* '''item'''Пример запроса номенклатуры приходной накладной — контейнер товара:* '''<source lang="xml"><?xml version="1.0" encoding="UTF-8" ?><itemdoc> <auth extra="8" login="login" pass="pass"></auth> <code>21991</code>''' — внутренний код товара</itemdoc></source>:* '''name''' — наименование товара

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

* '''order''' — контейнер корреспонденции:* '''ordercode''' — внутренний код заказа:* '''number''' — номер заказа:* '''date''' — дата заказа:* '''orderno''' — шифр:* '''barcode''' — штрихкод:* '''company''' — компания:* '''address''' — адрес:* '''delivereddate''' — дата вручения:* '''deliveredtime''' — время вручения:* '''deliveredto''' — данные о вручении, либо причина недоставки * '''document''' — контейнер документа операции:* '''code''' — внутренний код документа:* '''number''' — номер документа:* '''extnumber''' — внешний номер документа:* '''date''' — дата документа:* '''message''' — комментарий * '''serials''' — контейнер серийных номеров:* '''serial''' — серийный номер единицы номенклатуры, участвующей в движении   == Серийные номера =='''Пример ответа запроса движения номенклатурыс серийным номером:'''

<itemdocserialmovements> <code>21991</code> <number>318</number> <date>2017-05-26</date> <message></message> <items> <item codeauth extra="42598" quantitylogin="1login" barcodepass="200300" article="123555pass">Настольная игра Дженга</itemauth> <serial>123456789</itemsserial></itemdocserialmovements>

''' Описание полей ответа '''* '''code''' — внутренний код приходной накладной* '''numberserial''' — серийный номер документа* '''date''' — дата документа* '''message''' — комментарий * '''item''' — контейнер товараединицы номенклатуры.:* '''code''' — внутренний код товара:* '''barcode''' — штрихкод товара:* '''article''' — артикул товара:* '''quantity''' — количество поступившего товара == Справочник филиалов =='''Пример запроса списка филиаловответа движения номенклатуры с серийным номером:'''

<storelistserialmovements count="16"> <serialmovement> <code>151500</code> <serial>123456789</serial> <date>2017-05-26</date> <delivered>0<auth extra="8"/delivered> <item> <code>4259</code> <name>Настольная игра Дженга</name> </item> <status> <code>5</code> <name>Возврат от покупателя</name> </status> <order> <ordercode>3374830</authordercode> <jsonnumber>YES123660-0</jsonnumber> <client_codedate>78902017-05-24</client_codedate> <orderno>14123</storelistorderno> <barcode>0000000670</sourcebarcode> <company>ТОВАР</company>* '''auth''' — Атрибут '''extra''' — обязателен <address>Кравченко ул., по нему определяется курьерская служба1</address> <delivereddate>2017-05-29</delivereddate> <deliveredtime>12:00:00</deliveredtime>* '''json''' — Признак вывода ответа в виде JSON YES <deliveredto /NO>* '''client_code''' — Код клиента курьерской службы </order> <document> <code>21991</code> <number>318</number> <date>2017-05-26</date> <message></message> </document> </serialmovement></serialmovements></source>

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

<storelist countorderserials> <auth extra="28"login="login" pass="pass"></auth> <ordercode>123456789</ordercode> <storeorderno>123456789</orderno> <barcode>123456789</barcode></orderserials></source> * '''ordercode''' — внутренний код заказа.* '''orderno''' — шифр заказа.* '''barcode''' — штрих-код заказа.Указывать необходимо один из идентификаторов заказа.  '''Пример ответа движения серийных номеров заказа:'''<source lang="xml"><?xml version="1.0" encoding="UTF-8" ?><orderserials> <order> <code>1233374830</code> <nameorderno>14123</orderno> <barcode>0000000670</barcode> <delivereddate>2024-07-20</delivereddate> <deliveredtime>10:04:00</deliveredtime> <assemblydate>ABC2024-07-19 07:05:34</nameassemblydate> </storeorder> <storeitems> <item> <code>4564259</code> <name>Филиал 2Настольная игра Дженга</name> <article>123000</article> <state>Delivered</state> <serials> <serial>123456789</serial> </serials> </item> </storeitems></storelistorderserials>

''' Описание полей ответа ''' * '''order''' — блок заказа::* '''code''' — Код филиала.код:* '''orderno''' — шифр:* '''barcode''' — штрих-код:* '''delivereddate''' — дата доставки факт:* '''deliveredtime''' — время доставки факт:* '''nameassemblydate''' — Наименование филиала.дата сборки

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

Уникальные запросы списка ПВЗ кешируются на стороне личного кабинета и хранятся до 7 часов утра == Получение справочника тарифов по московскому времени следующего дня. Например, если уникальный запрос с массой 2 кг был отправлен сегодня в 10 часов, то завтра в 7 утра он сбросится. Если сегодня в 18 часов в этом же запросе вы укажете массу 2 кг, в ответе вернется тот же список ПВЗ. Если передадите массу 3 кг, список может быть другим.городам ==

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

<?xml version="1.0" encoding="UTF-8" ?><pvzlisttariffs> <auth extra="8" login="login" pass="pass"></auth> <code>1234</code> <client_code>7890</client_code> <city>Свердловская область</city> <town regioncode="66" country="RU">Нижний Тагил</town> <parentcode>6</parentcode> <acceptcash>YES</acceptcash> <acceptcard>YES</acceptcard> <acceptfitting>YES</acceptfitting> <maxweight>30</maxweight> <acceptindividuals>YES</acceptindividuals> <lt>57.924737</lt> <lg>59.940019</lg> <rttownfrom>57.905682Москва</rttownfrom> <rgservice>59.9846691</rgservice> <json>YES</json> <limit> <limitfrom>30</limitfrom> <limitcount>2</limitcountmainonly> <countall>YES</countall> 1</limitmainonly> </pvzlisttariffs>

* '''auth''' — Атрибут атрибут '''extra''' — обязателен, по нему определяется курьерская служба, '''login''' и '''pass''' позволяют авторизоваться под клиентом: для отдельного клиента могут быть ограничения по доступности некоторых ПВЗ, и в этом случае они будут учтены.* '''codetownfrom''' — Внутренний кодгород-отправитель. Если не передан, то городом будет «Москва».* '''client_codeservice''' — Код клиента курьерской службырежим доставки. Обязательный элемент.* '''citymainonly''' — Регион получателянеобязательный элемент. Можно указать код региона или полное наименование региона Если передан, то в ответе будут данные только по городам из [[#Справочник регионов|справочника регионов]].* '''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.НЕ ОТДАЕТСЯ! 

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Параметры:* '''codeauth''' — внутренний код услуги* Атрибут '''nameextra''' — наименование услуги. Если поле «название в ЛК» в настройках услуги не пустообязателен, по нему определяется курьерская служба, '''login''' и '''pass''' позволяют авторизоваться под клиентом: для отдельного клиента могут быть ограничения по доступности некоторых ПВЗ, то возвращает значение поля «название и в ЛК»этом случае они будут учтены.* '''hinecode''' — подсказка по доп услуге для пользователяВнутренний код, целое число.* '''typeclient_code''' — тип услугиКод клиента курьерской службы. Может иметь значения::* '''boolcity''' — для услуг вида «чекбокс», «Да»Регион получателя. Можно указать код региона или полное наименование региона из [[#Справочник регионов|справочника регионов]].:* '''floattown''' — для числа с плавающей точкойГород получателя.:* Для тега города '''town''' можно указать код региона в атрибуте '''''regioncode''int''' — для целого числаиз [[#Справочник регионов|справочника регионов]]. Поиск будет производиться в указанном регионе.

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

<calculator> <auth extrapvzlist count="8" login="login2" passtotalcount="pass40465" /> <orderpvz> <code>126</code> <pricetypeclientcode>CUSTOMER3</pricetypeclientcode> <name>Нижний Тагил<sender/name> <townparentcode>Санкт-Петербург6</townparentcode> <addressparentname>Петровка 38 офис 35Интеграция</addressparentname> <coords lattown code="124267" regioncode="55.68032766" lonregionname="37.604456Свердловская область">Нижний Тагил город</coordstown> <address>622036, г. Нижний Тагил, ул. Циолковского, д. 17</senderaddress> <receiverphone>+73435417709, +73435254989</phone> <zipcodecomment>125480Новый пункт доставки</comment> <worktime>Вс 10:00-16:00, Сб 10:00-16:00, Пн-Пт 10:00-20:00</zipcodeworktime> <town regioncode="78" country="RU"traveldescription>СанктЖилое 5-Петербургти этажное здание, торцом к дороге, второе здание от перекрестка Пархоменко-Циолковского</traveldescription> <maxweight>10</maxweight> <acceptcash>YES</townacceptcash> <addressacceptcard>Петровка 38 офис 35YES</addressacceptcard> <pvzacceptfitting>124YES</pvzacceptfitting> <coords lat="55.680327" lon="37.604456"acceptindividuals>YES</coordsacceptindividuals> <latitude>57.93457</receiverlatitude> <weightlongitude>559.195131</weightlongitude> <serviceuid>240606d00-9c51-11eb-b2c9-cfd6c1111392</uid> </servicepvz> <paytypepvz>CASH <code>245</paytypecode> <priceclientcode>387.5NTG1</priceclientcode> <deliverypricename>150На Красноармейской</deliverypricename> <inshpriceparentcode>387.56</inshpriceparentcode> <packagesparentname>Интеграция</parentname> <package masstown code="1124267" quantityregioncode="66" regionname="5Свердловская область">Нижний Тагил город</packagetown> <package mass="2address>КРАСНОАРМЕЙСКАЯ, д.5" length="79</address> <phone>+7(3435)379-044</phone> <comment>Возможность примерки отсутствует</comment> <worktime>Вс 10:00-16:00, Сб 10:00-16:00, Пн-Пт 10" width=":00-20:00</worktime> <traveldescription>Напротив ТЦ Пирамида</traveldescription> <maxweight>20" height="30"</maxweight> <acceptcash>YES</acceptcash> <acceptcard>YES</acceptcard> <acceptfitting>NO</acceptfitting> <acceptindividuals>YES</packageacceptindividuals> <latitude>57.93468</packageslatitude> <useridlongitude>user12360.55476</useridlongitude> <groupiduid>customer41116853-9c51-11eb-b2c9-cfd6c1451392</groupiduid> </orderpvz></calculatorpvzlist>

Параметры:Структура == Получение фискальных данных и заполнение полей аналогичны и совместимы с [[#Оформление заказа]].== Дополнительные поля:* '''pricetype''' — тип требуемой цены. Возможные значения: «CUSTOMER» (по-умолчанию) — [[Личный кабинет клиента#Цена доставки для получателя|цена для конечного получателя]], «CLIENT» — цена курьерской службы для клиента.* '''userid''' — Идентификатор пользователя, строковый или числовой тип. Виртуальное поле. Необязательное. Данное поле используется совместно с настройками «Цена доставки для получателя», определяя приоритет правила. Можно использовать в различных CMS/CRM системах, настраивая цены для определенного покупателя.* '''groupid''' — Идентификатор группы пользователя, строковый или числовой тип. Виртуальное поле. Необязательное. Данное поле используется совместно с настройками «Цена доставки для получателя», определяя приоритет правила. Можно использовать в различных CMS/CRM системах, настраивая цены для определенной группы покупателей. Суммы НП и ОЦ, а также тип оплаты CARD имеют значение при настроенных в тарифе на вкладке Прочее долях (в процентах) от Пример запроса получения фискальных данных сумм. В авторизации можно опустить параметры login и pass, тогда расчет будет производиться по стандартному тарифу курьерской службы, без учета возможных отличий для конкретного клиента.<br>Объемный вес будет учитываться только при условии указания всех габаритов: длины, ширины и высоты.<br>В полях город-отправитель и город-получатель можно указывать название города (не рекомендуется!), либо код города из нашего справочника, либо 13-ти значный код КЛАДР, либо 36-ти значный код адресной системы ФИАС (AOID).  '''Пример ответа стоимости доставки:'''

<calculatorreceiptdata> <calc> <townfrom codeauth extra="18">Москва город</townfrom> <townto codelogin="56603login">Иркутск город</townto> <mass>3.7</mass> <service namepass="Экспрессpass">1</service> <zone>2</zone> <price>1113</price> <mindeliverydays>1</mindeliverydaysorders> <maxdeliverydays>3</maxdeliverydays> <mindeliverydate>2020-05-13</mindeliverydate> <deliveryprice> <advprice code="1" price="1000">База</advprice> <advprice code="4" priceorder orderno="100123456">Процент от суммы руб</advprice> <advprice codeorder orderno="5" price=890111C"63">Процент от объявленной стоимости</advprice> <advprice code="6" price="-50">Скидка при доставке </advpriceorders> </deliverypricereceiptdata> </calc></calculator>

Параметры:* '''townfromПример ответа получения фискальных данных:''' — Город<source lang="xml">  <?xml version="1.0" encoding="UTF-отправитель так, как система его распознала и привязала к справочнику8"?><receipts count="1"> <receipt> <orderno>123456</orderno> <fdDatetime>2020-06-07 12:14:00</fdDatetime> <fdValue>123</fdValue> <fdNum>456</fdNum> <fnSn>789</fnSn> <kktNum>100</kktNum> <inn>222</inn> <ofdUrl>gate. Атрибут '''code''' — код из справочника городов системыofd.ru</ofdUrl>* '''townto''' — Город-получатель так, как система его распознала и привязала к справочнику <fullUrl>https://check. Атрибут '''code''' — код из справочника городов системыofd.ru/123</fullUrl> <price>12345</price> <payType>2</payType> <lines count="1"> <line> <item>1111764</item>* '''mass''' — Масса в килограммах <name>Сапоги</name>* '''service''' — Режим доставки — число, указывающее на запись в справочнике видов срочности (см описание на этой странице). <extcode>27113415</extcode>* '''zone''' — номер тарифной зоны, по которой рассчиталась стоимость. В зависимости от зоны выбирается тарифная сетка. Так же к цене могут применяться повышающие или понижающие коэффициенты при доставке не из <qty>1</в региональный центр.qty>* ''' <price>1000</price''' — рассчитанная стоимость доставки в валюте прайс-листа курьерской службы. Рекомендуется к использованию в отличие от одноименного атрибута родительского контейнера.> <vatRate>20</vatRate> <governmentCode>Z16513LK2</governmentCode> <itemType>1</itemType> </line> </lines>* '''maxdeliverydays''' — максимальный срок доставки в рабочих днях. </receipt>* '''mindeliverydate''' — минимальная дата доставки в учетом выходных дней.</receipts>* '''deliveryprice''' — Данные по составляющим ценам доставки</source>

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

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

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

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

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

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

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

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

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

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

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

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

<smadetailcalculator> <auth extra="8" login="login" pass="pass" /> <order> <pricetype>CUSTOMER</pricetype> <codesender> <town>Санкт-Петербург</town> <address>Петровка 38 офис 35</address> <coords lat="55.680327" lon="37.604456"></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>6278 <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> </codeorder></smadetailcalculator>

Параметры:Структура данных и заполнение полей аналогичны и совместимы с [[#Оформление заказа]]. Дополнительные поля:* '''pricetype''' — тип требуемой цены. Возможные значения: «CUSTOMER» (по-умолчанию) — [[Личный кабинет клиента#Цена доставки для получателя|цена для конечного получателя]], «CLIENT» — цена курьерской службы для клиента.* '''userid''' — Идентификатор пользователя, строковый или числовой тип. Виртуальное поле. Необязательное. Данное поле используется совместно с настройками «Цена доставки для получателя», определяя приоритет правила. Можно использовать в различных CMS/CRM системах, настраивая цены для определенного покупателя.* '''groupid''' — Идентификатор группы пользователя, строковый или числовой тип. Виртуальное поле. Необязательное. Данное поле используется совместно с настройками «Цена доставки для получателя», определяя приоритет правила. Можно использовать в различных CMS/CRM системах, настраивая цены для определенной группы покупателей. Суммы НП и ОЦ, а также тип оплаты CARD имеют значение при настроенных в тарифе на вкладке Прочее долях (в процентах) от данных сумм. В авторизации можно опустить параметры login и pass, тогда расчет будет производиться по стандартному тарифу курьерской службы, без учета возможных отличий для конкретного клиента.<br>Объемный вес будет учитываться только при условии указания всех габаритов: длины, ширины и высоты.<br>В полях город-отправитель и город-получатель можно указывать название города (не рекомендуется!), либо код города из нашего справочника, либо 13-ти значный код КЛАДР, либо 36-ти значный код адресной системы ФИАС (AOID).  '''Пример ответа на запрос детализации актов передачи денегстоимости доставки:'''

<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> <priceag>44.00</priceag> <pricecalc>8486.00</pricecalc> <paytype>2</paytype> <paytypename>наличными курьером</paytypename> <weight>0.400</weight> <distance>0.0</distance> <status>Доставлено</status> </specialsma></smadetail>

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

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

Ответ:'''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>